MediaApi

MediaApi - object-oriented interface

Export

MediaApi

Extends

  • BaseAPI

Constructors

Constructor

new MediaApi(configuration?, basePath?, axios?): MediaApi

Parameters

configuration?

basePath?

string = BASE_PATH

axios?

AxiosInstance = globalAxios

Returns

MediaApi

Inherited from

BaseAPI.constructor

Properties

axios

protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios


basePath

protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath


configuration

protected configuration: Configuration | undefined

Inherited from

BaseAPI.configuration

Methods

apiV1MediaGet()

apiV1MediaGet(page?, pageSize?, options?): Promise<AxiosResponse<MediaFileResponseDTO[], any, { }>>

Parameters

page?

number

pageSize?

number

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<MediaFileResponseDTO[], any, { }>>

Throws

Memberof

MediaApi


apiV1MediaIdDelete()

apiV1MediaIdDelete(id, options?): Promise<AxiosResponse<void, any, { }>>

Parameters

id

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<void, any, { }>>

Throws

Memberof

MediaApi


apiV1MediaIdDownloadGet()

apiV1MediaIdDownloadGet(id, options?): Promise<AxiosResponse<File, any, { }>>

Parameters

id

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<File, any, { }>>

Throws

Memberof

MediaApi


apiV1MediaIdGet()

apiV1MediaIdGet(id, options?): Promise<AxiosResponse<MediaFileResponseDTO, any, { }>>

Parameters

id

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<MediaFileResponseDTO, any, { }>>

Throws

Memberof

MediaApi


apiV1MediaIdPatch()

apiV1MediaIdPatch(id, mediaFilePatchDTO, options?): Promise<AxiosResponse<MediaFileResponseDTO, any, { }>>

Parameters

id

string

mediaFilePatchDTO

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<MediaFileResponseDTO, any, { }>>

Throws

Memberof

MediaApi


apiV1MediaPost()

apiV1MediaPost(file, description?, options?): Promise<AxiosResponse<MediaFileResponseDTO, any, { }>>

Parameters

file

File

description?

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<MediaFileResponseDTO, any, { }>>

Throws

Memberof

MediaApi

Found a mistake? Let us know.

Enroll in beta

Request invite to our private Beta program for developers to join the waitlist. No spam, we promise.