@jellyfin/sdk/lib/generated-client/api/image-api.d.ts

A TypeScript SDK for Jellyfin.

/**
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * Do not edit the class manually.
 *
 * Jellyfin API
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { ImageFormat } from '../models';
import type { ImageInfo } from '../models';
import type { ImageType } from '../models';
/**
 * ImageApi - axios parameter creator
 * @export
 */
export declare const ImageApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @summary Delete a custom splashscreen.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteCustomSplashscreen: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Delete an item\'s image.
     * @param {string} itemId Item id.
     * @param {ImageType} imageType Image type.
     * @param {number} [imageIndex] The image index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteItemImage: (itemId: string, imageType: ImageType, imageIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Delete an item\'s image.
     * @param {string} itemId Item id.
     * @param {ImageType} imageType Image type.
     * @param {number} imageIndex The image index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Delete the user\'s image.
     * @param {string} [userId] User Id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteUserImage: (userId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get artist image by name.
     * @param {string} name Artist name.
     * @param {ImageType} imageType Image type.
     * @param {number} imageIndex Image index.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get genre image by name.
     * @param {string} name Genre name.
     * @param {ImageType} imageType Image type.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {number} [imageIndex] Image index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get genre image by name.
     * @param {string} name Genre name.
     * @param {ImageType} imageType Image type.
     * @param {number} imageIndex Image index.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets the item\'s image.
     * @param {string} itemId Item id.
     * @param {ImageType} imageType Image type.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {number} [imageIndex] Image index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets the item\'s image.
     * @param {string} itemId Item id.
     * @param {ImageType} imageType Image type.
     * @param {number} maxWidth The maximum image width to return.
     * @param {number} maxHeight The maximum image height to return.
     * @param {string} tag Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} format Determines the output format of the image - original,gif,jpg,png.
     * @param {number} percentPlayed Optional. Percent to render for the percent played overlay.
     * @param {number} unplayedCount Optional. Unplayed count overlay to render.
     * @param {number} imageIndex Image index.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets the item\'s image.
     * @param {string} itemId Item id.
     * @param {ImageType} imageType Image type.
     * @param {number} imageIndex Image index.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get item image infos.
     * @param {string} itemId Item id.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getItemImageInfos: (itemId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get music genre image by name.
     * @param {string} name Music genre name.
     * @param {ImageType} imageType Image type.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {number} [imageIndex] Image index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get music genre image by name.
     * @param {string} name Music genre name.
     * @param {ImageType} imageType Image type.
     * @param {number} imageIndex Image index.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get person image by name.
     * @param {string} name Person name.
     * @param {ImageType} imageType Image type.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {number} [imageIndex] Image index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get person image by name.
     * @param {string} name Person name.
     * @param {ImageType} imageType Image type.
     * @param {number} imageIndex Image index.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Generates or gets the splashscreen.
     * @param {string} [tag] Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Blur image.
     * @param {string} [backgroundColor] Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Apply a foreground layer on top of the image.
     * @param {number} [quality] Quality setting, from 0-100.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSplashscreen: (tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, width?: number, height?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, quality?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get studio image by name.
     * @param {string} name Studio name.
     * @param {ImageType} imageType Image type.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {number} [imageIndex] Image index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get studio image by name.
     * @param {string} name Studio name.
     * @param {ImageType} imageType Image type.
     * @param {number} imageIndex Image index.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getStudioImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get user profile image.
     * @param {string} [userId] User id.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {number} [imageIndex] Image index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getUserImage: (userId?: string, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get artist image by name.
     * @param {string} name Artist name.
     * @param {ImageType} imageType Image type.
     * @param {number} imageIndex Image index.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    headArtistImage: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get genre image by name.
     * @param {string} name Genre name.
     * @param {ImageType} imageType Image type.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {number} [imageIndex] Image index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    headGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get genre image by name.
     * @param {string} name Genre name.
     * @param {ImageType} imageType Image type.
     * @param {number} imageIndex Image index.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    headGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets the item\'s image.
     * @param {string} itemId Item id.
     * @param {ImageType} imageType Image type.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {number} [imageIndex] Image index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    headItemImage: (itemId: string, imageType: ImageType, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets the item\'s image.
     * @param {string} itemId Item id.
     * @param {ImageType} imageType Image type.
     * @param {number} maxWidth The maximum image width to return.
     * @param {number} maxHeight The maximum image height to return.
     * @param {string} tag Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} format Determines the output format of the image - original,gif,jpg,png.
     * @param {number} percentPlayed Optional. Percent to render for the percent played overlay.
     * @param {number} unplayedCount Optional. Unplayed count overlay to render.
     * @param {number} imageIndex Image index.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    headItemImage2: (itemId: string, imageType: ImageType, maxWidth: number, maxHeight: number, tag: string, format: ImageFormat, percentPlayed: number, unplayedCount: number, imageIndex: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Gets the item\'s image.
     * @param {string} itemId Item id.
     * @param {ImageType} imageType Image type.
     * @param {number} imageIndex Image index.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Optional. The MediaBrowser.Model.Drawing.ImageFormat of the returned image.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    headItemImageByIndex: (itemId: string, imageType: ImageType, imageIndex: number, maxWidth?: number, maxHeight?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, tag?: string, format?: ImageFormat, percentPlayed?: number, unplayedCount?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get music genre image by name.
     * @param {string} name Music genre name.
     * @param {ImageType} imageType Image type.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {number} [imageIndex] Image index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    headMusicGenreImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get music genre image by name.
     * @param {string} name Music genre name.
     * @param {ImageType} imageType Image type.
     * @param {number} imageIndex Image index.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    headMusicGenreImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get person image by name.
     * @param {string} name Person name.
     * @param {ImageType} imageType Image type.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {number} [imageIndex] Image index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    headPersonImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get person image by name.
     * @param {string} name Person name.
     * @param {ImageType} imageType Image type.
     * @param {number} imageIndex Image index.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    headPersonImageByIndex: (name: string, imageType: ImageType, imageIndex: number, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get studio image by name.
     * @param {string} name Studio name.
     * @param {ImageType} imageType Image type.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer on top of the image.
     * @param {number} [imageIndex] Image index.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    headStudioImage: (name: string, imageType: ImageType, tag?: string, format?: ImageFormat, maxWidth?: number, maxHeight?: number, percentPlayed?: number, unplayedCount?: number, width?: number, height?: number, quality?: number, fillWidth?: number, fillHeight?: number, blur?: number, backgroundColor?: string, foregroundLayer?: string, imageIndex?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @summary Get studio image by name.
     * @param {string} name Studio name.
     * @param {ImageType} imageType Image type.
     * @param {number} imageIndex Image index.
     * @param {string} [tag] Optional. Supply the cache tag from the item object to receive strong caching headers.
     * @param {ImageFormat} [format] Determines the output format of the image - original,gif,jpg,png.
     * @param {number} [maxWidth] The maximum image width to return.
     * @param {number} [maxHeight] The maximum image height to return.
     * @param {number} [percentPlayed] Optional. Percent to render for the percent played overlay.
     * @param {number} [unplayedCount] Optional. Unplayed count overlay to render.
     * @param {number} [width] The fixed image width to return.
     * @param {number} [height] The fixed image height to return.
     * @param {number} [quality] Optional. Quality setting, from 0-100. Defaults to 90 and should suffice in most cases.
     * @param {number} [fillWidth] Width of box to fill.
     * @param {number} [fillHeight] Height of box to fill.
     * @param {number} [blur] Optional. Blur image.
     * @param {string} [backgroundColor] Optional. Apply a background color for transparent images.
     * @param {string} [foregroundLayer] Optional. Apply a foreground layer