Function PlaylistsApiAxiosParamCreator

PlaylistsApi - axios parameter creator

Export

  • PlaylistsApiAxiosParamCreator(
        configuration?: Configuration,
    ): {
        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>;
    }

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

      Throws

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

      Throws

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

      Throws

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

      Throws

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

      Throws

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

      Throws

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

      Throws

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

      Throws

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

      Throws

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

      Throws

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

      Throws

Settings

Member Visibility