Class AssetsApi

AssetsApi - object-oriented interface

Export

Hierarchy

BaseAPI
- AssetsApi

Index

Constructors

Properties

axios basePath configuration

Methods

assetsCreate assetsDestroy assetsRetrieve assetsRetrievePublic

Constructors

constructor

new AssetsApi(configuration?, basePath?, axios?): AssetsApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns AssetsApi
Inherited from BaseAPI.constructor
- Defined in base.ts:53

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

assetsCreate

assetsCreate(requestParameters?, options?): Promise<AxiosResponse<AssetRead, any>>
Parameters
- requestParameters: AssetsApiAssetsCreateRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<AssetRead, any>>

Summary
Method saves new asset on the server and attaches it to a corresponding guide

Throws

Memberof
AssetsApi
- Defined in api-client/assets-api.ts:407

assetsDestroy

assetsDestroy(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: AssetsApiAssetsDestroyRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method deletes a specific asset from the server

Throws

Memberof
AssetsApi
- Defined in api-client/assets-api.ts:419

assetsRetrieve

assetsRetrieve(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: AssetsApiAssetsRetrieveRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<void, any>>

Summary
Method returns an asset file

Throws

Memberof
AssetsApi
- Defined in api-client/assets-api.ts:431

assetsRetrievePublic

assetsRetrievePublic(requestParameters, options?): Promise<AxiosResponse<AssetRead, any>>
Parameters
- requestParameters: AssetsApiAssetsRetrievePublicRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
  
  Override http request option.
Returns Promise<AxiosResponse<AssetRead, any>>

Throws

Memberof
AssetsApi
- Defined in api-client/assets-api.ts:442

Generated using TypeDoc