Function LibraryApiAxiosParamCreator

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>)

  Summary

  Deletes an item from the library and filesystem.

  Throws

  • • (itemId, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        The item id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• deleteItems: ((ids?: string[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Deletes items from the library and filesystem.

  Throws

  • • (ids?, options?): Promise<RequestArgs>

    • Parameters

      • Optionalids: string[]

        The item ids.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getAncestors: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets all parents of an item.

  Throws

  • • (itemId, userId?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getCriticReviews: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets critic review for an item.

  Deprecated

  Throws

  • • (itemId, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getDownload: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Downloads item media.

  Throws

  • • (itemId, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        The item id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getFile: ((itemId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get the original file of an item.

  Throws

  • • (itemId, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        The item id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getItemCounts: ((userId?: string, isFavorite?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get item counts.

  Throws

  • • (userId?, isFavorite?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getLibraryOptionsInfo: ((libraryContentType?: CollectionType, isNewLibrary?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets the library options info.

  Throws

  • • (libraryContentType?, isNewLibrary?, options?): Promise<RequestArgs>

    • Parameters

      • OptionallibraryContentType: CollectionType

        Library content type.
      • OptionalisNewLibrary: boolean

        Whether this is a new library.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getMediaFolders: ((isHidden?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets all user media folders.

  Throws

  • • (isHidden?, options?): Promise<RequestArgs>

    • Parameters

      • OptionalisHidden: boolean

        Optional. Filter by folders that are marked hidden, or not.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getPhysicalPaths: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets a list of physical paths from virtual folders.

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getSimilarAlbums: ((itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets similar items.

  Throws

  • • (itemId, excludeArtistIds?, userId?, limit?, fields?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getSimilarArtists: ((itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets similar items.

  Throws

  • • (itemId, excludeArtistIds?, userId?, limit?, fields?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getSimilarItems: ((itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets similar items.

  Throws

  • • (itemId, excludeArtistIds?, userId?, limit?, fields?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getSimilarMovies: ((itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets similar items.

  Throws

  • • (itemId, excludeArtistIds?, userId?, limit?, fields?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getSimilarShows: ((itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets similar items.

  Throws

  • • (itemId, excludeArtistIds?, userId?, limit?, fields?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getSimilarTrailers: ((itemId: string, excludeArtistIds?: string[], userId?: string, limit?: number, fields?: ItemFields[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets similar items.

  Throws

  • • (itemId, excludeArtistIds?, userId?, limit?, fields?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getThemeMedia: ((itemId: string, userId?: string, inheritFromParent?: boolean, sortBy?: ItemSortBy[], sortOrder?: SortOrder[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get theme songs and videos for an item.

  Throws

  • • (itemId, userId?, inheritFromParent?, sortBy?, sortOrder?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getThemeSongs: ((itemId: string, userId?: string, inheritFromParent?: boolean, sortBy?: ItemSortBy[], sortOrder?: SortOrder[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get theme songs for an item.

  Throws

  • • (itemId, userId?, inheritFromParent?, sortBy?, sortOrder?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• getThemeVideos: ((itemId: string, userId?: string, inheritFromParent?: boolean, sortBy?: ItemSortBy[], sortOrder?: SortOrder[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get theme videos for an item.

  Throws

  • • (itemId, userId?, inheritFromParent?, sortBy?, sortOrder?, options?): Promise<RequestArgs>

    • 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<RequestArgs>

• postAddedMovies: ((tmdbId?: string, imdbId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Reports that new movies have been added by an external source.

  Throws

  • • (tmdbId?, imdbId?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaltmdbId: string

        The tmdbId.
      • OptionalimdbId: string

        The imdbId.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• postAddedSeries: ((tvdbId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Reports that new episodes of a series have been added by an external source.

  Throws

  • • (tvdbId?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaltvdbId: string

        The tvdbId.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• postUpdatedMedia: ((mediaUpdateInfoDto: MediaUpdateInfoDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Reports that new movies have been added by an external source.

  Throws

  • • (mediaUpdateInfoDto, options?): Promise<RequestArgs>

    • Parameters

      • mediaUpdateInfoDto: MediaUpdateInfoDto

        The update paths.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• postUpdatedMovies: ((tmdbId?: string, imdbId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Reports that new movies have been added by an external source.

  Throws

  • • (tmdbId?, imdbId?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaltmdbId: string

        The tmdbId.
      • OptionalimdbId: string

        The imdbId.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• postUpdatedSeries: ((tvdbId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Reports that new episodes of a series have been added by an external source.

  Throws

  • • (tvdbId?, options?): Promise<RequestArgs>

    • Parameters

      • OptionaltvdbId: string

        The tvdbId.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• refreshLibrary: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Starts a library scan.

  Throws

  • • (options?): Promise<RequestArgs>

    • Parameters

      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>