Function PlaylistsApiFp

PlaylistsApi - functional programming interface

Export

  • PlaylistsApiFp(
        configuration?: Configuration,
    ): {
        addItemToPlaylist(
            playlistId: string,
            ids?: string[],
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        createPlaylist(
            name?: string,
            ids?: string[],
            userId?: string,
            mediaType?: MediaType,
            createPlaylistDto?: CreatePlaylistDto,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PlaylistCreationResult>,
        >;
        getPlaylist(
            playlistId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaylistDto>,
        >;
        getPlaylistItems(
            playlistId: string,
            userId?: string,
            startIndex?: number,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getPlaylistUser(
            playlistId: string,
            userId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PlaylistUserPermissions>,
        >;
        getPlaylistUsers(
            playlistId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PlaylistUserPermissions[]>,
        >;
        moveItem(
            playlistId: string,
            itemId: string,
            newIndex: number,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        removeItemFromPlaylist(
            playlistId: string,
            entryIds?: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        removeUserFromPlaylist(
            playlistId: string,
            userId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        updatePlaylist(
            playlistId: string,
            updatePlaylistDto: UpdatePlaylistDto,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
        updatePlaylistUser(
            playlistId: string,
            userId: string,
            updatePlaylistUserDto: UpdatePlaylistUserDto,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
        >;
    }

  • Parameters

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

    • addItemToPlaylist:function
      • addItemToPlaylist(
            playlistId: string,
            ids?: string[],
            userId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • playlistId: string

          The playlist id.

        • Optionalids: string[]

          Item id, comma delimited.

        • OptionaluserId: string

          The userId.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • createPlaylist:function
      • createPlaylist(
            name?: string,
            ids?: string[],
            userId?: string,
            mediaType?: MediaType,
            createPlaylistDto?: CreatePlaylistDto,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PlaylistCreationResult>,
        >

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

        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<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PlaylistCreationResult>,
        >

        Throws

    • getPlaylist:function
      • getPlaylist(
            playlistId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<PlaylistDto>,
        >

      • Parameters

        • playlistId: string

          The playlist id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

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

      • 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<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >

        Throws

    • getPlaylistUser:function
      • getPlaylistUser(
            playlistId: string,
            userId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PlaylistUserPermissions>,
        >

      • Parameters

        • playlistId: string

          The playlist id.

        • userId: string

          The user id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getPlaylistUsers:function
      • getPlaylistUsers(
            playlistId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<PlaylistUserPermissions[]>,
        >

      • Parameters

        • playlistId: string

          The playlist id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • moveItem:function
      • moveItem(
            playlistId: string,
            itemId: string,
            newIndex: number,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • playlistId: string

          The playlist id.

        • itemId: string

          The item id.

        • newIndex: number

          The new index.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • removeItemFromPlaylist:function
      • removeItemFromPlaylist(
            playlistId: string,
            entryIds?: string[],
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • playlistId: string

          The playlist id.

        • OptionalentryIds: string[]

          The item ids, comma delimited.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • removeUserFromPlaylist:function
      • removeUserFromPlaylist(
            playlistId: string,
            userId: string,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • playlistId: string

          The playlist id.

        • userId: string

          The user id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • updatePlaylist:function
      • updatePlaylist(
            playlistId: string,
            updatePlaylistDto: UpdatePlaylistDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • playlistId: string

          The playlist id.

        • updatePlaylistDto: UpdatePlaylistDto

          The Jellyfin.Api.Models.PlaylistDtos.UpdatePlaylistDto id.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • updatePlaylistUser:function
      • updatePlaylistUser(
            playlistId: string,
            userId: string,
            updatePlaylistUserDto: UpdatePlaylistUserDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • 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<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

        Throws

Settings

Member Visibility