@jellyfin/sdk
    Preparing search index...

    Function LibraryApiFp

    • LibraryApi - functional programming interface

      Parameters

      Returns {
          deleteItem(
              itemId: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
          >;
          deleteItems(
              ids?: string[],
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
          >;
          getAncestors(
              itemId: string,
              userId?: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDto[]>,
          >;
          getCriticReviews(
              itemId: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >;
          getDownload(
              itemId: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
          >;
          getFile(
              itemId: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
          >;
          getItemCounts(
              userId?: string,
              isFavorite?: boolean,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemCounts>,
          >;
          getLibraryOptionsInfo(
              libraryContentType?: CollectionType,
              isNewLibrary?: boolean,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<LibraryOptionsResultDto>,
          >;
          getMediaFolders(
              isHidden?: boolean,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >;
          getPhysicalPaths(
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>,
          >;
          getSimilarAlbums(
              itemId: string,
              excludeArtistIds?: string[],
              userId?: string,
              limit?: number,
              fields?: ItemFields[],
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >;
          getSimilarArtists(
              itemId: string,
              excludeArtistIds?: string[],
              userId?: string,
              limit?: number,
              fields?: ItemFields[],
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >;
          getSimilarItems(
              itemId: string,
              excludeArtistIds?: string[],
              userId?: string,
              limit?: number,
              fields?: ItemFields[],
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >;
          getSimilarMovies(
              itemId: string,
              excludeArtistIds?: string[],
              userId?: string,
              limit?: number,
              fields?: ItemFields[],
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >;
          getSimilarShows(
              itemId: string,
              excludeArtistIds?: string[],
              userId?: string,
              limit?: number,
              fields?: ItemFields[],
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >;
          getSimilarTrailers(
              itemId: string,
              excludeArtistIds?: string[],
              userId?: string,
              limit?: number,
              fields?: ItemFields[],
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >;
          getThemeMedia(
              itemId: string,
              userId?: string,
              inheritFromParent?: boolean,
              sortBy?: ItemSortBy[],
              sortOrder?: SortOrder[],
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<AllThemeMediaResult>,
          >;
          getThemeSongs(
              itemId: string,
              userId?: string,
              inheritFromParent?: boolean,
              sortBy?: ItemSortBy[],
              sortOrder?: SortOrder[],
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ThemeMediaResult>,
          >;
          getThemeVideos(
              itemId: string,
              userId?: string,
              inheritFromParent?: boolean,
              sortBy?: ItemSortBy[],
              sortOrder?: SortOrder[],
              options?: RawAxiosRequestConfig,
          ): Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ThemeMediaResult>,
          >;
          postAddedMovies(
              tmdbId?: string,
              imdbId?: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
          >;
          postAddedSeries(
              tvdbId?: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
          >;
          postUpdatedMedia(
              mediaUpdateInfoDto: MediaUpdateInfoDto,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
          >;
          postUpdatedMovies(
              tmdbId?: string,
              imdbId?: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
          >;
          postUpdatedSeries(
              tvdbId?: string,
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
          >;
          refreshLibrary(
              options?: RawAxiosRequestConfig,
          ): Promise<
              (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
          >;
      }

      • deleteItem: function
        • Parameters

          • itemId: string

            The item id.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • deleteItems: function
        • Parameters

          • Optionalids: string[]

            The item ids.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • getAncestors: function
        • Parameters

          • itemId: string

            The item id.

          • OptionaluserId: string

            Optional. Filter by user id, and attach user data.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDto[]>,
          >

      • getCriticReviews: function
        • Parameters

          • itemId: string
          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >

      • getDownload: function
        • Parameters

          • itemId: string

            The item id.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

      • getFile: function
        • Parameters

          • itemId: string

            The item id.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

      • getItemCounts: function
        • Parameters

          • OptionaluserId: string

            Optional. Get counts from a specific user&#39;s library.

          • OptionalisFavorite: boolean

            Optional. Get counts of favorite items.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ItemCounts>>

      • getLibraryOptionsInfo: function
        • Parameters

          • OptionallibraryContentType: CollectionType

            Library content type.

          • OptionalisNewLibrary: boolean

            Whether this is a new library.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<LibraryOptionsResultDto>,
          >

      • getMediaFolders: function
        • Parameters

          • OptionalisHidden: boolean

            Optional. Filter by folders that are marked hidden, or not.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >

      • getPhysicalPaths: function
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string[]>>

      • getSimilarAlbums: function
        • Parameters

          • itemId: string

            The item id.

          • OptionalexcludeArtistIds: string[]

            Exclude artist ids.

          • OptionaluserId: string

            Optional. Filter by user id, and attach user data.

          • Optionallimit: number

            Optional. The maximum number of records to return.

          • Optionalfields: ItemFields[]

            Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >

      • getSimilarArtists: function
        • Parameters

          • itemId: string

            The item id.

          • OptionalexcludeArtistIds: string[]

            Exclude artist ids.

          • OptionaluserId: string

            Optional. Filter by user id, and attach user data.

          • Optionallimit: number

            Optional. The maximum number of records to return.

          • Optionalfields: ItemFields[]

            Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >

      • getSimilarItems: function
        • Parameters

          • itemId: string

            The item id.

          • OptionalexcludeArtistIds: string[]

            Exclude artist ids.

          • OptionaluserId: string

            Optional. Filter by user id, and attach user data.

          • Optionallimit: number

            Optional. The maximum number of records to return.

          • Optionalfields: ItemFields[]

            Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >

      • getSimilarMovies: function
        • Parameters

          • itemId: string

            The item id.

          • OptionalexcludeArtistIds: string[]

            Exclude artist ids.

          • OptionaluserId: string

            Optional. Filter by user id, and attach user data.

          • Optionallimit: number

            Optional. The maximum number of records to return.

          • Optionalfields: ItemFields[]

            Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >

      • getSimilarShows: function
        • Parameters

          • itemId: string

            The item id.

          • OptionalexcludeArtistIds: string[]

            Exclude artist ids.

          • OptionaluserId: string

            Optional. Filter by user id, and attach user data.

          • Optionallimit: number

            Optional. The maximum number of records to return.

          • Optionalfields: ItemFields[]

            Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >

      • getSimilarTrailers: function
        • Parameters

          • itemId: string

            The item id.

          • OptionalexcludeArtistIds: string[]

            Exclude artist ids.

          • OptionaluserId: string

            Optional. Filter by user id, and attach user data.

          • Optionallimit: number

            Optional. The maximum number of records to return.

          • Optionalfields: ItemFields[]

            Optional. Specify additional fields of information to return in the output. This allows multiple, comma delimited. Options: Budget, Chapters, DateCreated, Genres, HomePageUrl, IndexOptions, MediaStreams, Overview, ParentId, Path, People, ProviderIds, PrimaryImageAspectRatio, Revenue, SortName, Studios, Taglines, TrailerUrls.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<BaseItemDtoQueryResult>,
          >

      • getThemeMedia: function
        • Parameters

          • itemId: string

            The item id.

          • OptionaluserId: string

            Optional. Filter by user id, and attach user data.

          • OptionalinheritFromParent: boolean

            Optional. Determines whether or not parent items should be searched for theme media.

          • OptionalsortBy: ItemSortBy[]

            Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

          • OptionalsortOrder: SortOrder[]

            Optional. Sort Order - Ascending, Descending.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<AllThemeMediaResult>,
          >

      • getThemeSongs: function
        • Parameters

          • itemId: string

            The item id.

          • OptionaluserId: string

            Optional. Filter by user id, and attach user data.

          • OptionalinheritFromParent: boolean

            Optional. Determines whether or not parent items should be searched for theme media.

          • OptionalsortBy: ItemSortBy[]

            Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

          • OptionalsortOrder: SortOrder[]

            Optional. Sort Order - Ascending, Descending.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ThemeMediaResult>,
          >

      • getThemeVideos: function
        • Parameters

          • itemId: string

            The item id.

          • OptionaluserId: string

            Optional. Filter by user id, and attach user data.

          • OptionalinheritFromParent: boolean

            Optional. Determines whether or not parent items should be searched for theme media.

          • OptionalsortBy: ItemSortBy[]

            Optional. Specify one or more sort orders, comma delimited. Options: Album, AlbumArtist, Artist, Budget, CommunityRating, CriticRating, DateCreated, DatePlayed, PlayCount, PremiereDate, ProductionYear, SortName, Random, Revenue, Runtime.

          • OptionalsortOrder: SortOrder[]

            Optional. Sort Order - Ascending, Descending.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<
              (
                  axios?: AxiosInstance,
                  basePath?: string,
              ) => AxiosPromise<ThemeMediaResult>,
          >

      • postAddedMovies: function
        • Parameters

          • OptionaltmdbId: string

            The tmdbId.

          • OptionalimdbId: string

            The imdbId.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • postAddedSeries: function
        • Parameters

          • OptionaltvdbId: string

            The tvdbId.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • postUpdatedMedia: function
        • Parameters

          • mediaUpdateInfoDto: MediaUpdateInfoDto

            The update paths.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • postUpdatedMovies: function
        • Parameters

          • OptionaltmdbId: string

            The tmdbId.

          • OptionalimdbId: string

            The imdbId.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • postUpdatedSeries: function
        • Parameters

          • OptionaltvdbId: string

            The tvdbId.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • refreshLibrary: function
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

          Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>