@jellyfin/sdk 0.10.0 → 0.12.0

package/lib/generated-client/models/authentication-info-query-result.d.ts

@@ -8,9 +8,9 @@
  * 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 { AuthenticationInfo } from './authentication-info';
+import type { AuthenticationInfo } from './authentication-info';
 /**
- *
+ * Query result container.
  * @export
  * @interface AuthenticationInfoQueryResult
  */
@@ -20,7 +20,7 @@ export interface AuthenticationInfoQueryResult {
      * @type {Array<AuthenticationInfo>}
      * @memberof AuthenticationInfoQueryResult
      */
-    'Items'?: Array<AuthenticationInfo> | null;
+    'Items'?: Array<AuthenticationInfo>;
     /**
      * Gets or sets the total number of records available.
      * @type {number}

package/lib/generated-client/models/authentication-result.d.ts

@@ -8,10 +8,10 @@
  * 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 { SessionInfo } from './session-info';
-import { UserDto } from './user-dto';
+import type { SessionInfoDto } from './session-info-dto';
+import type { UserDto } from './user-dto';
 /**
- *
+ * A class representing an authentication result.
  * @export
  * @interface AuthenticationResult
  */
@@ -24,18 +24,18 @@ export interface AuthenticationResult {
     'User'?: UserDto;
     /**
      *
-     * @type {SessionInfo}
+     * @type {SessionInfoDto}
      * @memberof AuthenticationResult
      */
-    'SessionInfo'?: SessionInfo;
+    'SessionInfo'?: SessionInfoDto;
     /**
-     *
+     * Gets or sets the access token.
      * @type {string}
      * @memberof AuthenticationResult
      */
     'AccessToken'?: string | null;
     /**
-     *
+     * Gets or sets the server id.
      * @type {string}
      * @memberof AuthenticationResult
      */

package/lib/generated-client/models/backup-manifest-dto.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 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 type { BackupOptionsDto } from './backup-options-dto';
+/**
+ * Manifest type for backups internal structure.
+ * @export
+ * @interface BackupManifestDto
+ */
+export interface BackupManifestDto {
+    /**
+     * Gets or sets the jellyfin version this backup was created with.
+     * @type {string}
+     * @memberof BackupManifestDto
+     */
+    'ServerVersion'?: string;
+    /**
+     * Gets or sets the backup engine version this backup was created with.
+     * @type {string}
+     * @memberof BackupManifestDto
+     */
+    'BackupEngineVersion'?: string;
+    /**
+     * Gets or sets the date this backup was created with.
+     * @type {string}
+     * @memberof BackupManifestDto
+     */
+    'DateCreated'?: string;
+    /**
+     * Gets or sets the path to the backup on the system.
+     * @type {string}
+     * @memberof BackupManifestDto
+     */
+    'Path'?: string;
+    /**
+     *
+     * @type {BackupOptionsDto}
+     * @memberof BackupManifestDto
+     */
+    'Options'?: BackupOptionsDto;
+}

package/lib/generated-client/models/backup-options-dto.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/.
+ */
+/**
+ * Defines the optional contents of the backup archive.
+ * @export
+ * @interface BackupOptionsDto
+ */
+export interface BackupOptionsDto {
+    /**
+     * Gets or sets a value indicating whether the archive contains the Metadata contents.
+     * @type {boolean}
+     * @memberof BackupOptionsDto
+     */
+    'Metadata'?: boolean;
+    /**
+     * Gets or sets a value indicating whether the archive contains the Trickplay contents.
+     * @type {boolean}
+     * @memberof BackupOptionsDto
+     */
+    'Trickplay'?: boolean;
+    /**
+     * Gets or sets a value indicating whether the archive contains the Subtitle contents.
+     * @type {boolean}
+     * @memberof BackupOptionsDto
+     */
+    'Subtitles'?: boolean;
+    /**
+     * Gets or sets a value indicating whether the archive contains the Database contents.
+     * @type {boolean}
+     * @memberof BackupOptionsDto
+     */
+    'Database'?: boolean;
+}

package/lib/generated-client/models/backup-restore-request-dto.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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/.
+ */
+/**
+ * Defines properties used to start a restore process.
+ * @export
+ * @interface BackupRestoreRequestDto
+ */
+export interface BackupRestoreRequestDto {
+    /**
+     * Gets or Sets the name of the backup archive to restore from. Must be present in MediaBrowser.Common.Configuration.IApplicationPaths.BackupPath.
+     * @type {string}
+     * @memberof BackupRestoreRequestDto
+     */
+    'ArchiveFileName'?: string;
+}

package/lib/generated-client/models/base-item-dto-query-result.d.ts

@@ -8,9 +8,9 @@
  * 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 { BaseItemDto } from './base-item-dto';
+import type { BaseItemDto } from './base-item-dto';
 /**
- *
+ * Query result container.
  * @export
  * @interface BaseItemDtoQueryResult
  */
@@ -20,7 +20,7 @@ export interface BaseItemDtoQueryResult {
      * @type {Array<BaseItemDto>}
      * @memberof BaseItemDtoQueryResult
      */
-    'Items'?: Array<BaseItemDto> | null;
+    'Items'?: Array<BaseItemDto>;
     /**
      * Gets or sets the total number of records available.
      * @type {number}

package/lib/generated-client/models/base-item-dto.d.ts

@@ -8,30 +8,30 @@
  * 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 { BaseItemDtoImageBlurHashes } from './base-item-dto-image-blur-hashes';
-import { BaseItemKind } from './base-item-kind';
-import { BaseItemPerson } from './base-item-person';
-import { ChannelType } from './channel-type';
-import { ChapterInfo } from './chapter-info';
-import { CollectionType } from './collection-type';
-import { DayOfWeek } from './day-of-week';
-import { ExternalUrl } from './external-url';
-import { ExtraType } from './extra-type';
-import { ImageOrientation } from './image-orientation';
-import { IsoType } from './iso-type';
-import { LocationType } from './location-type';
-import { MediaSourceInfo } from './media-source-info';
-import { MediaStream } from './media-stream';
-import { MediaType } from './media-type';
-import { MediaUrl } from './media-url';
-import { MetadataField } from './metadata-field';
-import { NameGuidPair } from './name-guid-pair';
-import { PlayAccess } from './play-access';
-import { ProgramAudio } from './program-audio';
-import { TrickplayInfo } from './trickplay-info';
-import { UserItemDataDto } from './user-item-data-dto';
-import { Video3DFormat } from './video3-dformat';
-import { VideoType } from './video-type';
+import type { BaseItemDtoImageBlurHashes } from './base-item-dto-image-blur-hashes';
+import type { BaseItemKind } from './base-item-kind';
+import type { BaseItemPerson } from './base-item-person';
+import type { ChannelType } from './channel-type';
+import type { ChapterInfo } from './chapter-info';
+import type { CollectionType } from './collection-type';
+import type { DayOfWeek } from './day-of-week';
+import type { ExternalUrl } from './external-url';
+import type { ExtraType } from './extra-type';
+import type { ImageOrientation } from './image-orientation';
+import type { IsoType } from './iso-type';
+import type { LocationType } from './location-type';
+import type { MediaSourceInfo } from './media-source-info';
+import type { MediaStream } from './media-stream';
+import type { MediaType } from './media-type';
+import type { MediaUrl } from './media-url';
+import type { MetadataField } from './metadata-field';
+import type { NameGuidPair } from './name-guid-pair';
+import type { PlayAccess } from './play-access';
+import type { ProgramAudio } from './program-audio';
+import type { TrickplayInfoDto } from './trickplay-info-dto';
+import type { UserItemDataDto } from './user-item-data-dto';
+import type { Video3DFormat } from './video3-dformat';
+import type { VideoType } from './video-type';
 /**
  * This is strictly used as a data transfer object from the api layer.  This holds information about a BaseItem in a format that is convenient for the client.
  * @export
@@ -340,11 +340,11 @@ export interface BaseItemDto {
     'RemoteTrailers'?: Array<MediaUrl> | null;
     /**
      * Gets or sets the provider ids.
-     * @type {{ [key: string]: string; }}
+     * @type {{ [key: string]: string | null; }}
      * @memberof BaseItemDto
      */
     'ProviderIds'?: {
-        [key: string]: string;
+        [key: string]: string | null;
     } | null;
     /**
      * Gets or sets a value indicating whether this instance is HD.
@@ -668,12 +668,12 @@ export interface BaseItemDto {
     'Chapters'?: Array<ChapterInfo> | null;
     /**
      * Gets or sets the trickplay manifest.
-     * @type {{ [key: string]: { [key: string]: TrickplayInfo; }; }}
+     * @type {{ [key: string]: { [key: string]: TrickplayInfoDto; }; }}
      * @memberof BaseItemDto
      */
     'Trickplay'?: {
         [key: string]: {
-            [key: string]: TrickplayInfo;
+            [key: string]: TrickplayInfoDto;
         };
     } | null;
     /**

package/lib/generated-client/models/base-item-person.d.ts

@@ -8,8 +8,8 @@
  * 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 { BaseItemPersonImageBlurHashes } from './base-item-person-image-blur-hashes';
-import { PersonKind } from './person-kind';
+import type { BaseItemPersonImageBlurHashes } from './base-item-person-image-blur-hashes';
+import type { PersonKind } from './person-kind';
 /**
  * This is used by the api to get information about a Person within a BaseItem.
  * @export

package/lib/generated-client/models/book-info-remote-search-query.d.ts

@@ -8,7 +8,7 @@
  * 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 { BookInfo } from './book-info';
+import type { BookInfo } from './book-info';
 /**
  *
  * @export

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

@@ -46,11 +46,11 @@ export interface BookInfo {
     'MetadataCountryCode'?: string | null;
     /**
      * Gets or sets the provider ids.
-     * @type {{ [key: string]: string; }}
+     * @type {{ [key: string]: string | null; }}
      * @memberof BookInfo
      */
     'ProviderIds'?: {
-        [key: string]: string;
+        [key: string]: string | null;
     } | null;
     /**
      * Gets or sets the year.

package/lib/generated-client/models/box-set-info-remote-search-query.d.ts

@@ -8,7 +8,7 @@
  * 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 { BoxSetInfo } from './box-set-info';
+import type { BoxSetInfo } from './box-set-info';
 /**
  *
  * @export

package/lib/generated-client/models/box-set-info.d.ts

@@ -46,11 +46,11 @@ export interface BoxSetInfo {
     'MetadataCountryCode'?: string | null;
     /**
      * Gets or sets the provider ids.
-     * @type {{ [key: string]: string; }}
+     * @type {{ [key: string]: string | null; }}
      * @memberof BoxSetInfo
      */
     'ProviderIds'?: {
-        [key: string]: string;
+        [key: string]: string | null;
     } | null;
     /**
      * Gets or sets the year.

package/lib/generated-client/models/branding-options-dto.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/.
+ */
+/**
+ * The branding options DTO for API use.  This DTO excludes SplashscreenLocation to prevent it from being updated via API.
+ * @export
+ * @interface BrandingOptionsDto
+ */
+export interface BrandingOptionsDto {
+    /**
+     * Gets or sets the login disclaimer.
+     * @type {string}
+     * @memberof BrandingOptionsDto
+     */
+    'LoginDisclaimer'?: string | null;
+    /**
+     * Gets or sets the custom CSS.
+     * @type {string}
+     * @memberof BrandingOptionsDto
+     */
+    'CustomCss'?: string | null;
+    /**
+     * Gets or sets a value indicating whether to enable the splashscreen.
+     * @type {boolean}
+     * @memberof BrandingOptionsDto
+     */
+    'SplashscreenEnabled'?: boolean;
+}

package/lib/generated-client/models/channel-features.d.ts

@@ -8,9 +8,9 @@
  * 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 { ChannelItemSortField } from './channel-item-sort-field';
-import { ChannelMediaContentType } from './channel-media-content-type';
-import { ChannelMediaType } from './channel-media-type';
+import type { ChannelItemSortField } from './channel-item-sort-field';
+import type { ChannelMediaContentType } from './channel-media-content-type';
+import type { ChannelMediaType } from './channel-media-type';
 /**
  *
  * @export

package/lib/generated-client/models/channel-mapping-options-dto.d.ts

@@ -8,9 +8,9 @@
  * 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 { NameIdPair } from './name-id-pair';
-import { NameValuePair } from './name-value-pair';
-import { TunerChannelMapping } from './tuner-channel-mapping';
+import type { NameIdPair } from './name-id-pair';
+import type { NameValuePair } from './name-value-pair';
+import type { TunerChannelMapping } from './tuner-channel-mapping';
 /**
  * Channel mapping options dto.
  * @export

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

@@ -8,9 +8,9 @@
  * 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 { DeviceProfile } from './device-profile';
-import { GeneralCommandType } from './general-command-type';
-import { MediaType } from './media-type';
+import type { DeviceProfile } from './device-profile';
+import type { GeneralCommandType } from './general-command-type';
+import type { MediaType } from './media-type';
 /**
  * Client capabilities dto.
  * @export
@@ -59,18 +59,4 @@ export interface ClientCapabilitiesDto {
      * @memberof ClientCapabilitiesDto
      */
     'IconUrl'?: string | null;
-    /**
-     *
-     * @type {boolean}
-     * @memberof ClientCapabilitiesDto
-     * @deprecated
-     */
-    'SupportsContentUploading'?: boolean | null;
-    /**
-     *
-     * @type {boolean}
-     * @memberof ClientCapabilitiesDto
-     * @deprecated
-     */
-    'SupportsSync'?: boolean | null;
 }

package/lib/generated-client/models/client-capabilities.d.ts

@@ -8,9 +8,9 @@
  * 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 { DeviceProfile } from './device-profile';
-import { GeneralCommandType } from './general-command-type';
-import { MediaType } from './media-type';
+import type { DeviceProfile } from './device-profile';
+import type { GeneralCommandType } from './general-command-type';
+import type { MediaType } from './media-type';
 /**
  *
  * @export

package/lib/generated-client/models/codec-profile.d.ts

@@ -8,10 +8,10 @@
  * 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 { CodecType } from './codec-type';
-import { ProfileCondition } from './profile-condition';
+import type { CodecType } from './codec-type';
+import type { ProfileCondition } from './profile-condition';
 /**
- *
+ * Defines the MediaBrowser.Model.Dlna.CodecProfile.
  * @export
  * @interface CodecProfile
  */
@@ -23,27 +23,33 @@ export interface CodecProfile {
      */
     'Type'?: CodecType;
     /**
-     *
+     * Gets or sets the list of MediaBrowser.Model.Dlna.ProfileCondition which this profile must meet.
      * @type {Array<ProfileCondition>}
      * @memberof CodecProfile
      */
-    'Conditions'?: Array<ProfileCondition> | null;
+    'Conditions'?: Array<ProfileCondition>;
     /**
-     *
+     * Gets or sets the list of MediaBrowser.Model.Dlna.ProfileCondition to apply if this profile is met.
      * @type {Array<ProfileCondition>}
      * @memberof CodecProfile
      */
-    'ApplyConditions'?: Array<ProfileCondition> | null;
+    'ApplyConditions'?: Array<ProfileCondition>;
     /**
-     *
+     * Gets or sets the codec(s) that this profile applies to.
      * @type {string}
      * @memberof CodecProfile
      */
     'Codec'?: string | null;
     /**
-     *
+     * Gets or sets the container(s) which this profile will be applied to.
      * @type {string}
      * @memberof CodecProfile
      */
     'Container'?: string | null;
+    /**
+     * Gets or sets the sub-container(s) which this profile will be applied to.
+     * @type {string}
+     * @memberof CodecProfile
+     */
+    'SubContainer'?: string | null;
 }

package/lib/generated-client/models/container-profile.d.ts

@@ -8,10 +8,10 @@
  * 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 { DlnaProfileType } from './dlna-profile-type';
-import { ProfileCondition } from './profile-condition';
+import type { DlnaProfileType } from './dlna-profile-type';
+import type { ProfileCondition } from './profile-condition';
 /**
- *
+ * Defines the MediaBrowser.Model.Dlna.ContainerProfile.
  * @export
  * @interface ContainerProfile
  */
@@ -23,15 +23,21 @@ export interface ContainerProfile {
      */
     'Type'?: DlnaProfileType;
     /**
-     *
+     * Gets or sets the list of MediaBrowser.Model.Dlna.ProfileCondition which this container will be applied to.
      * @type {Array<ProfileCondition>}
      * @memberof ContainerProfile
      */
     'Conditions'?: Array<ProfileCondition>;
     /**
-     *
+     * Gets or sets the container(s) which this container must meet.
+     * @type {string}
+     * @memberof ContainerProfile
+     */
+    'Container'?: string | null;
+    /**
+     * Gets or sets the sub container(s) which this container must meet.
      * @type {string}
      * @memberof ContainerProfile
      */
-    'Container'?: string;
+    'SubContainer'?: string | null;
 }

package/lib/generated-client/models/create-playlist-dto.d.ts

@@ -8,8 +8,8 @@
  * 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 { MediaType } from './media-type';
-import { PlaylistUserPermissions } from './playlist-user-permissions';
+import type { MediaType } from './media-type';
+import type { PlaylistUserPermissions } from './playlist-user-permissions';
 /**
  * Create new playlist dto.
  * @export

package/lib/generated-client/models/custom-database-option.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/.
+ */
+/**
+ * The custom value option for custom database providers.
+ * @export
+ * @interface CustomDatabaseOption
+ */
+export interface CustomDatabaseOption {
+    /**
+     * Gets or sets the key of the value.
+     * @type {string}
+     * @memberof CustomDatabaseOption
+     */
+    'Key'?: string;
+    /**
+     * Gets or sets the value.
+     * @type {string}
+     * @memberof CustomDatabaseOption
+     */
+    'Value'?: string;
+}

package/lib/generated-client/models/custom-database-options.d.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 type { CustomDatabaseOption } from './custom-database-option';
+/**
+ * Defines the options for a custom database connector.
+ * @export
+ * @interface CustomDatabaseOptions
+ */
+export interface CustomDatabaseOptions {
+    /**
+     * Gets or sets the Plugin name to search for database providers.
+     * @type {string}
+     * @memberof CustomDatabaseOptions
+     */
+    'PluginName'?: string;
+    /**
+     * Gets or sets the plugin assembly to search for providers.
+     * @type {string}
+     * @memberof CustomDatabaseOptions
+     */
+    'PluginAssembly'?: string;
+    /**
+     * Gets or sets the connection string for the custom database provider.
+     * @type {string}
+     * @memberof CustomDatabaseOptions
+     */
+    'ConnectionString'?: string;
+    /**
+     * Gets or sets the list of extra options for the custom provider.
+     * @type {Array<CustomDatabaseOption>}
+     * @memberof CustomDatabaseOptions
+     */
+    'Options'?: Array<CustomDatabaseOption>;
+}