@jellyfin/sdk
    Preparing search index...

    Function LibraryApiAxiosParamCreator

    • LibraryApi - axios parameter creator

      Parameters

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

      • deleteItem: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>
      • deleteItems: (ids?: string[], options?: RawAxiosRequestConfig) => Promise<RequestArgs>
      • getAncestors: (
            itemId: string,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • getCriticReviews: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>
      • getDownload: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>
      • getFile: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>
      • getItemCounts: (
            userId?: string,
            isFavorite?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • getLibraryOptionsInfo: (
            libraryContentType?: CollectionType,
            isNewLibrary?: boolean,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • getMediaFolders: (isHidden?: boolean, options?: RawAxiosRequestConfig) => Promise<RequestArgs>
      • getPhysicalPaths: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>
      • getSimilarAlbums: (
            itemId: string,
            excludeArtistIds?: string[],
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • getSimilarArtists: (
            itemId: string,
            excludeArtistIds?: string[],
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • getSimilarItems: (
            itemId: string,
            excludeArtistIds?: string[],
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • getSimilarMovies: (
            itemId: string,
            excludeArtistIds?: string[],
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • getSimilarShows: (
            itemId: string,
            excludeArtistIds?: string[],
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • getSimilarTrailers: (
            itemId: string,
            excludeArtistIds?: string[],
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • getThemeMedia: (
            itemId: string,
            userId?: string,
            inheritFromParent?: boolean,
            sortBy?: ItemSortBy[],
            sortOrder?: SortOrder[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • getThemeSongs: (
            itemId: string,
            userId?: string,
            inheritFromParent?: boolean,
            sortBy?: ItemSortBy[],
            sortOrder?: SortOrder[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • getThemeVideos: (
            itemId: string,
            userId?: string,
            inheritFromParent?: boolean,
            sortBy?: ItemSortBy[],
            sortOrder?: SortOrder[],
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • postAddedMovies: (
            tmdbId?: string,
            imdbId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • postAddedSeries: (tvdbId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>
      • postUpdatedMedia: (
            mediaUpdateInfoDto: MediaUpdateInfoDto,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • postUpdatedMovies: (
            tmdbId?: string,
            imdbId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>
      • postUpdatedSeries: (tvdbId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>
      • refreshLibrary: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>