Class ImageApi

ImageApi - object-oriented interface

Export

ImageApi

Hierarchy

BaseAPI
- ImageApi

Constructors

constructor

new ImageApi(configuration?, basePath?, axios?): ImageApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ImageApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

deleteCustomSplashscreen

deleteCustomSplashscreen(options?): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Delete a custom splashscreen.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8351

deleteItemImage

deleteItemImage(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ImageApiDeleteItemImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Delete an item's image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8363

deleteItemImageByIndex

deleteItemImageByIndex(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ImageApiDeleteItemImageByIndexRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Delete an item's image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8375

deleteUserImage

deleteUserImage(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ImageApiDeleteUserImageRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Delete the user's image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8387

getArtistImage

getArtistImage(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiGetArtistImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get artist image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8399

getGenreImage

getGenreImage(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiGetGenreImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get genre image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8411

getGenreImageByIndex

getGenreImageByIndex(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiGetGenreImageByIndexRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get genre image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8423

getItemImage

getItemImage(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiGetItemImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets the item's image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8435

getItemImage2

getItemImage2(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiGetItemImage2Request
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets the item's image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8447

getItemImageByIndex

getItemImageByIndex(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiGetItemImageByIndexRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets the item's image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8459

getItemImageInfos

getItemImageInfos(requestParameters, options?): Promise<AxiosResponse<ImageInfo[], any>>
Parameters
- requestParameters: ImageApiGetItemImageInfosRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ImageInfo[], any>>
Summary
Get item image infos.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8471

getMusicGenreImage

getMusicGenreImage(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiGetMusicGenreImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get music genre image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8483

getMusicGenreImageByIndex

getMusicGenreImageByIndex(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiGetMusicGenreImageByIndexRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get music genre image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8495

getPersonImage

getPersonImage(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiGetPersonImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get person image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8507

getPersonImageByIndex

getPersonImageByIndex(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiGetPersonImageByIndexRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get person image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8519

getSplashscreen

getSplashscreen(requestParameters?, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiGetSplashscreenRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Generates or gets the splashscreen.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8531

getStudioImage

getStudioImage(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiGetStudioImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get studio image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8543

getStudioImageByIndex

getStudioImageByIndex(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiGetStudioImageByIndexRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get studio image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8555

getUserImage

getUserImage(requestParameters?, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiGetUserImageRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get user profile image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8567

headArtistImage

headArtistImage(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiHeadArtistImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get artist image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8579

headGenreImage

headGenreImage(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiHeadGenreImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get genre image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8591

headGenreImageByIndex

headGenreImageByIndex(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiHeadGenreImageByIndexRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get genre image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8603

headItemImage

headItemImage(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiHeadItemImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets the item's image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8615

headItemImage2

headItemImage2(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiHeadItemImage2Request
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets the item's image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8627

headItemImageByIndex

headItemImageByIndex(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiHeadItemImageByIndexRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets the item's image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8639

headMusicGenreImage

headMusicGenreImage(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiHeadMusicGenreImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get music genre image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8651

headMusicGenreImageByIndex

headMusicGenreImageByIndex(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiHeadMusicGenreImageByIndexRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get music genre image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8663

headPersonImage

headPersonImage(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiHeadPersonImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get person image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8675

headPersonImageByIndex

headPersonImageByIndex(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiHeadPersonImageByIndexRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get person image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8687

headStudioImage

headStudioImage(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiHeadStudioImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get studio image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8699

headStudioImageByIndex

headStudioImageByIndex(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiHeadStudioImageByIndexRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get studio image by name.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8711

headUserImage

headUserImage(requestParameters?, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: ImageApiHeadUserImageRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Get user profile image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8723

postUserImage

postUserImage(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ImageApiPostUserImageRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Sets the user image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8735

setItemImage

setItemImage(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ImageApiSetItemImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Set item image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8747

setItemImageByIndex

setItemImageByIndex(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ImageApiSetItemImageByIndexRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Set item image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8759

updateItemImageIndex

updateItemImageIndex(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ImageApiUpdateItemImageIndexRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Updates the index for an item image.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8771

uploadCustomSplashscreen

uploadCustomSplashscreen(requestParameters?, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ImageApiUploadCustomSplashscreenRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Uploads a custom splashscreen. The body is expected to the image contents base64 encoded.

Throws
Memberof
ImageApi
- Defined in generated-client/api/image-api.ts:8783

Class ImageApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ImageApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

deleteCustomSplashscreen

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

deleteItemImage

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

deleteItemImageByIndex

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

deleteUserImage

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

getArtistImage

Parameters

Returns Promise<AxiosResponse<File, any>>

Summary

Throws

Memberof

getGenreImage

Parameters

Returns Promise<AxiosResponse<File, any>>

Summary

Throws

Memberof

getGenreImageByIndex

Parameters

Returns Promise<AxiosResponse<File, any>>

Summary

Throws

Memberof

getItemImage

Parameters

Returns Promise<AxiosResponse<File, any>>

Summary

Throws

Memberof

getItemImage2

Parameters

Returns Promise<AxiosResponse<File, any>>

Summary

Throws

Memberof

getItemImageByIndex

Parameters

Returns Promise<AxiosResponse<File, any>>

Summary

Throws

Memberof

getItemImageInfos

Parameters

Returns Promise<AxiosResponse<ImageInfo[], any>>

Summary

`Protected`axios

`Protected`basePath

`Protected`configuration