Class CollectionApi

CollectionApi - object-oriented interface

Export

CollectionApi

Hierarchy

BaseAPI
- CollectionApi

Index

Constructors

Properties

axios basePath configuration

Methods

addToCollection createCollection removeFromCollection

Constructors

constructor

new CollectionApi(configuration?, basePath?, axios?): CollectionApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns CollectionApi
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

addToCollection

addToCollection(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: CollectionApiAddToCollectionRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Adds items to a collection.

Throws
Memberof
CollectionApi
- Defined in generated-client/api/collection-api.ts:361

createCollection

createCollection(requestParameters?, options?): Promise<AxiosResponse<CollectionCreationResult, any>>
Parameters
- requestParameters: CollectionApiCreateCollectionRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CollectionCreationResult, any>>
Summary
Creates a new collection.

Throws
Memberof
CollectionApi
- Defined in generated-client/api/collection-api.ts:373

removeFromCollection

removeFromCollection(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: CollectionApiRemoveFromCollectionRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Removes items from a collection.

Throws
Memberof
CollectionApi
- Defined in generated-client/api/collection-api.ts:385