@jellyfin/sdk

    Function PlaylistsApiAxiosParamCreator

    • PlaylistsApi - axios parameter creator

      Parameters

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

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