Function PlaylistsApiAxiosParamCreator

Returns {
    addItemToPlaylist: ((playlistId: string, ids?: string[], userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    createPlaylist: ((name?: string, ids?: string[], userId?: string, mediaType?: MediaType, createPlaylistDto?: CreatePlaylistDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getPlaylist: ((playlistId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getPlaylistItems: ((playlistId: string, userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getPlaylistUser: ((playlistId: string, userId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    getPlaylistUsers: ((playlistId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    moveItem: ((playlistId: string, itemId: string, newIndex: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    removeItemFromPlaylist: ((playlistId: string, entryIds?: string[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    removeUserFromPlaylist: ((playlistId: string, userId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    updatePlaylist: ((playlistId: string, updatePlaylistDto: UpdatePlaylistDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    updatePlaylistUser: ((playlistId: string, userId: string, updatePlaylistUserDto: UpdatePlaylistUserDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}

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

  Summary

  Adds items to a playlist.

  Throws

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

    • Parameters

      • playlistId: string

        The playlist id.
      • Optionalids: string[]

        Item id, comma delimited.
      • OptionaluserId: string

        The userId.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• createPlaylist: ((name?: string, ids?: string[], userId?: string, mediaType?: MediaType, createPlaylistDto?: CreatePlaylistDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.

  Summary

  Creates a new playlist.

  Throws

  • • (name?, ids?, userId?, mediaType?, createPlaylistDto?, options?): Promise<RequestArgs>

    • Parameters

      • Optionalname: string

        The playlist name.
      • Optionalids: string[]

        The item ids.
      • OptionaluserId: string

        The user id.
      • OptionalmediaType: MediaType

        The media type.
      • OptionalcreatePlaylistDto: CreatePlaylistDto

        The create playlist payload.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getPlaylist: ((playlistId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get a playlist.

  Throws

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

    • Parameters

      • playlistId: string

        The playlist id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getPlaylistItems: ((playlistId: string, userId?: string, startIndex?: number, limit?: number, fields?: ItemFields[], enableImages?: boolean, enableUserData?: boolean, imageTypeLimit?: number, enableImageTypes?: ImageType[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Gets the original items of a playlist.

  Throws

  • • (playlistId, userId?, startIndex?, limit?, fields?, enableImages?, enableUserData?, imageTypeLimit?, enableImageTypes?, options?): Promise<RequestArgs>

    • Parameters

      • playlistId: string

        The playlist id.
      • OptionaluserId: string

        User id.
      • OptionalstartIndex: number

        Optional. The record index to start at. All items with a lower index will be dropped from the results.
      • Optionallimit: number

        Optional. The maximum number of records to return.
      • Optionalfields: ItemFields[]

        Optional. Specify additional fields of information to return in the output.
      • OptionalenableImages: boolean

        Optional. Include image information in output.
      • OptionalenableUserData: boolean

        Optional. Include user data.
      • OptionalimageTypeLimit: number

        Optional. The max number of images to return, per image type.
      • OptionalenableImageTypes: ImageType[]

        Optional. The image types to include in the output.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getPlaylistUser: ((playlistId: string, userId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get a playlist user.

  Throws

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

    • Parameters

      • playlistId: string

        The playlist id.
      • userId: string

        The user id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• getPlaylistUsers: ((playlistId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Get a playlist's users.

  Throws

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

    • Parameters

      • playlistId: string

        The playlist id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• moveItem: ((playlistId: string, itemId: string, newIndex: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Moves a playlist item.

  Throws

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

    • Parameters

      • playlistId: string

        The playlist id.
      • itemId: string

        The item id.
      • newIndex: number

        The new index.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• removeItemFromPlaylist: ((playlistId: string, entryIds?: string[], options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Removes items from a playlist.

  Throws

  • • (playlistId, entryIds?, options?): Promise<RequestArgs>

    • Parameters

      • playlistId: string

        The playlist id.
      • OptionalentryIds: string[]

        The item ids, comma delimited.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• removeUserFromPlaylist: ((playlistId: string, userId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Remove a user from a playlist's users.

  Throws

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

    • Parameters

      • playlistId: string

        The playlist id.
      • userId: string

        The user id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updatePlaylist: ((playlistId: string, updatePlaylistDto: UpdatePlaylistDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Updates a playlist.

  Throws

  • • (playlistId, updatePlaylistDto, options?): Promise<RequestArgs>

    • Parameters

      • playlistId: string

        The playlist id.
      • updatePlaylistDto: UpdatePlaylistDto

        The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• updatePlaylistUser: ((playlistId: string, userId: string, updatePlaylistUserDto: UpdatePlaylistUserDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Modify a user of a playlist's users.

  Throws

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

    • Parameters

      • playlistId: string

        The playlist id.
      • userId: string

        The user id.
      • updatePlaylistUserDto: UpdatePlaylistUserDto

        The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistUserDto.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>