@jellyfin/sdk 0.12.0 → 1.0.0

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

@@ -18,344 +18,167 @@ import type { RepositoryInfo } from './repository-info';
 import type { TrickplayOptions } from './trickplay-options';
 /**
  * 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
+     * Gets or sets the stringified PreviousVersion to be stored/loaded, because System.Version itself isn\'t xml-serializable.
      */
     '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;
     /**
      * 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 threshold in minutes after a inactive session gets closed automatically.  If set to 0 the check for inactive sessions gets disabled.
-     * @type {number}
-     * @memberof ServerConfiguration
+     * Gets or sets the threshold in minutes after a inactive session gets closed automatically. If set to 0 the check for inactive sessions gets disabled.
      */
     'InactiveSessionThreshold'?: 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
+     * 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.
      */
     'LibraryMonitorDelay'?: number;
     /**
      * Gets or sets the duration in seconds that we will wait after a library updated event before executing the library changed notification.
-     * @type {number}
-     * @memberof ServerConfiguration
      */
     'LibraryUpdateDuration'?: number;
     /**
      * Gets or sets the maximum amount of items to cache.
-     * @type {number}
-     * @memberof ServerConfiguration
      */
     'CacheSize'?: 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
-     */
     'EnableGroupingMoviesIntoCollections'?: boolean;
-    /**
-     *
-     * @type {boolean}
-     * @memberof ServerConfiguration
-     */
     'EnableGroupingShowsIntoCollections'?: 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 clients should be allowed to upload logs.
-     * @type {boolean}
-     * @memberof ServerConfiguration
      */
     'AllowClientLogUpload'?: boolean;
     /**
      * Gets or sets the dummy chapter duration in seconds, use 0 (zero) or less to disable generation altogether.
-     * @type {number}
-     * @memberof ServerConfiguration
      */
     'DummyChapterDuration'?: number;
-    /**
-     *
-     * @type {ImageResolution}
-     * @memberof ServerConfiguration
-     */
     'ChapterImageResolution'?: ImageResolution;
     /**
      * Gets or sets the limit for parallel image encoding.
-     * @type {number}
-     * @memberof ServerConfiguration
      */
     'ParallelImageEncodingLimit'?: number;
     /**
      * Gets or sets the list of cast receiver applications.
-     * @type {Array<CastReceiverApplication>}
-     * @memberof ServerConfiguration
      */
     'CastReceiverApplications'?: Array<CastReceiverApplication>;
-    /**
-     *
-     * @type {TrickplayOptions}
-     * @memberof ServerConfiguration
-     */
     'TrickplayOptions'?: TrickplayOptions;
     /**
      * Gets or sets a value indicating whether old authorization methods are allowed.
-     * @type {boolean}
-     * @memberof ServerConfiguration
      */
     'EnableLegacyAuthorization'?: boolean;
 }

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

@@ -10,32 +10,22 @@
  */
 /**
  * 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-restarting-message.d.ts

@@ -11,20 +11,11 @@
 import type { SessionMessageType } from './session-message-type';
 /**
  * Server restarting down message.
- * @export
- * @interface ServerRestartingMessage
  */
 export interface ServerRestartingMessage {
     /**
      * Gets or sets the message id.
-     * @type {string}
-     * @memberof ServerRestartingMessage
      */
     'MessageId'?: string;
-    /**
-     *
-     * @type {SessionMessageType}
-     * @memberof ServerRestartingMessage
-     */
     'MessageType'?: SessionMessageType;
 }

package/lib/generated-client/models/server-shutting-down-message.d.ts

@@ -11,20 +11,11 @@
 import type { SessionMessageType } from './session-message-type';
 /**
  * Server shutting down message.
- * @export
- * @interface ServerShuttingDownMessage
  */
 export interface ServerShuttingDownMessage {
     /**
      * Gets or sets the message id.
-     * @type {string}
-     * @memberof ServerShuttingDownMessage
      */
     'MessageId'?: string;
-    /**
-     *
-     * @type {SessionMessageType}
-     * @memberof ServerShuttingDownMessage
-     */
     'MessageType'?: SessionMessageType;
 }

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

@@ -18,182 +18,103 @@ import type { SessionUserInfo } from './session-user-info';
 import type { TranscodingInfo } from './transcoding-info';
 /**
  * Session info DTO.
- * @export
- * @interface SessionInfoDto
  */
 export interface SessionInfoDto {
-    /**
-     *
-     * @type {PlayerStateInfo}
-     * @memberof SessionInfoDto
-     */
     'PlayState'?: PlayerStateInfo;
     /**
      * Gets or sets the additional users.
-     * @type {Array<SessionUserInfo>}
-     * @memberof SessionInfoDto
      */
     'AdditionalUsers'?: Array<SessionUserInfo> | null;
-    /**
-     *
-     * @type {ClientCapabilitiesDto}
-     * @memberof SessionInfoDto
-     */
     'Capabilities'?: ClientCapabilitiesDto;
     /**
      * Gets or sets the remote end point.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'RemoteEndPoint'?: string | null;
     /**
      * Gets or sets the playable media types.
-     * @type {Array<MediaType>}
-     * @memberof SessionInfoDto
      */
     'PlayableMediaTypes'?: Array<MediaType>;
     /**
      * Gets or sets the id.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'Id'?: string | null;
     /**
      * Gets or sets the user id.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'UserId'?: string;
     /**
      * Gets or sets the username.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'UserName'?: string | null;
     /**
      * Gets or sets the type of the client.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'Client'?: string | null;
     /**
      * Gets or sets the last activity date.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'LastActivityDate'?: string;
     /**
      * Gets or sets the last playback check in.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'LastPlaybackCheckIn'?: string;
     /**
      * Gets or sets the last paused date.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'LastPausedDate'?: string | null;
     /**
      * Gets or sets the name of the device.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'DeviceName'?: string | null;
     /**
      * Gets or sets the type of the device.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'DeviceType'?: string | null;
-    /**
-     *
-     * @type {BaseItemDto}
-     * @memberof SessionInfoDto
-     */
     'NowPlayingItem'?: BaseItemDto;
-    /**
-     *
-     * @type {BaseItemDto}
-     * @memberof SessionInfoDto
-     */
     'NowViewingItem'?: BaseItemDto;
     /**
      * Gets or sets the device id.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'DeviceId'?: string | null;
     /**
      * Gets or sets the application version.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'ApplicationVersion'?: string | null;
-    /**
-     *
-     * @type {TranscodingInfo}
-     * @memberof SessionInfoDto
-     */
     'TranscodingInfo'?: TranscodingInfo;
     /**
      * Gets or sets a value indicating whether this session is active.
-     * @type {boolean}
-     * @memberof SessionInfoDto
      */
     'IsActive'?: boolean;
     /**
      * Gets or sets a value indicating whether the session supports media control.
-     * @type {boolean}
-     * @memberof SessionInfoDto
      */
     'SupportsMediaControl'?: boolean;
     /**
      * Gets or sets a value indicating whether the session supports remote control.
-     * @type {boolean}
-     * @memberof SessionInfoDto
      */
     'SupportsRemoteControl'?: boolean;
     /**
      * Gets or sets the now playing queue.
-     * @type {Array<QueueItem>}
-     * @memberof SessionInfoDto
      */
     'NowPlayingQueue'?: Array<QueueItem> | null;
     /**
-     * Gets or sets the now playing queue full items.
-     * @type {Array<BaseItemDto>}
-     * @memberof SessionInfoDto
-     */
-    'NowPlayingQueueFullItems'?: Array<BaseItemDto> | null;
-    /**
-     * Gets or sets a value indicating whether the session has a custom device name.
-     * @type {boolean}
-     * @memberof SessionInfoDto
+     * Gets or sets a value indicating whether this session has a custom device name.
      */
     'HasCustomDeviceName'?: boolean;
     /**
      * Gets or sets the playlist item id.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'PlaylistItemId'?: string | null;
     /**
      * Gets or sets the server id.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'ServerId'?: string | null;
     /**
      * Gets or sets the user primary image tag.
-     * @type {string}
-     * @memberof SessionInfoDto
      */
     'UserPrimaryImageTag'?: string | null;
     /**
      * Gets or sets the supported commands.
-     * @type {Array<GeneralCommandType>}
-     * @memberof SessionInfoDto
      */
     'SupportedCommands'?: Array<GeneralCommandType>;
 }

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

@@ -10,8 +10,6 @@
  */
 /**
  * The different kinds of messages that are used in the WebSocket api.
- * @export
- * @enum {string}
  */
 export declare const SessionMessageType: {
     readonly ForceKeepAlive: "ForceKeepAlive";

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

@@ -12,8 +12,6 @@
  */
 /**
  * The different kinds of messages that are used in the WebSocket api.
- * @export
- * @enum {string}
  */
 const SessionMessageType = {
     ForceKeepAlive: 'ForceKeepAlive',

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

@@ -10,20 +10,14 @@
  */
 /**
  * Class SessionUserInfo.
- * @export
- * @interface SessionUserInfo
  */
 export interface SessionUserInfo {
     /**
      * Gets or sets the user identifier.
-     * @type {string}
-     * @memberof SessionUserInfo
      */
     'UserId'?: string;
     /**
      * Gets or sets the name of the user.
-     * @type {string}
-     * @memberof SessionUserInfo
      */
     'UserName'?: string | null;
 }

package/lib/generated-client/models/sessions-message.d.ts

@@ -12,26 +12,15 @@ import type { SessionInfoDto } from './session-info-dto';
 import type { SessionMessageType } from './session-message-type';
 /**
  * Sessions message.
- * @export
- * @interface SessionsMessage
  */
 export interface SessionsMessage {
     /**
      * Gets or sets the data.
-     * @type {Array<SessionInfoDto>}
-     * @memberof SessionsMessage
      */
     'Data'?: Array<SessionInfoDto> | null;
     /**
      * Gets or sets the message id.
-     * @type {string}
-     * @memberof SessionsMessage
      */
     'MessageId'?: string;
-    /**
-     *
-     * @type {SessionMessageType}
-     * @memberof SessionsMessage
-     */
     'MessageType'?: SessionMessageType;
 }

package/lib/generated-client/models/sessions-start-message.d.ts

@@ -10,21 +10,12 @@
  */
 import type { SessionMessageType } from './session-message-type';
 /**
- * Sessions start message.  Data is the timing data encoded as \"$initialDelay,$interval\" in ms.
- * @export
- * @interface SessionsStartMessage
+ * Sessions start message. Data is the timing data encoded as \"$initialDelay,$interval\" in ms.
  */
 export interface SessionsStartMessage {
     /**
      * Gets or sets the data.
-     * @type {string}
-     * @memberof SessionsStartMessage
      */
     'Data'?: string | null;
-    /**
-     *
-     * @type {SessionMessageType}
-     * @memberof SessionsStartMessage
-     */
     'MessageType'?: SessionMessageType;
 }