Function InstantMixApiFp

InstantMixApi - functional programming interface

Export

  • InstantMixApiFp(
        configuration?: Configuration,
    ): {
        getInstantMixFromAlbum(
            itemId: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getInstantMixFromArtists(
            itemId: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getInstantMixFromArtists2(
            id: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getInstantMixFromItem(
            itemId: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getInstantMixFromMusicGenreById(
            id: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getInstantMixFromMusicGenreByName(
            name: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getInstantMixFromPlaylist(
            itemId: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getInstantMixFromSong(
            itemId: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
    }

  • Parameters

    Returns {
        getInstantMixFromAlbum(
            itemId: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getInstantMixFromArtists(
            itemId: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getInstantMixFromArtists2(
            id: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getInstantMixFromItem(
            itemId: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getInstantMixFromMusicGenreById(
            id: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getInstantMixFromMusicGenreByName(
            name: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getInstantMixFromPlaylist(
            itemId: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
        getInstantMixFromSong(
            itemId: string,
            userId?: string,
            limit?: number,
            fields?: ItemFields[],
            enableImages?: boolean,
            enableUserData?: boolean,
            imageTypeLimit?: number,
            enableImageTypes?: ImageType[],
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<BaseItemDtoQueryResult>,
        >;
    }

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

      • Parameters

        • itemId: string

          The item id.

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

        • 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

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

      • Parameters

        • itemId: string

          The item id.

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

        • 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

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

      • Parameters

        • id: string

          The item id.

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

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

        Deprecated

        Throws

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

      • Parameters

        • itemId: string

          The item id.

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

        • 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

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

      • Parameters

        • id: string

          The item id.

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

        • 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

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

      • Parameters

        • name: string

          The genre name.

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

        • 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

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

      • Parameters

        • itemId: string

          The item id.

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

        • 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

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

      • Parameters

        • itemId: string

          The item id.

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

        • 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

Settings

Member Visibility