Class TagApi

TagApi - object-oriented interface

Export

TagApi

Hierarchy (view full)

BaseAPI
- TagApi

Index

Constructors

Properties

axios basePath configuration

Methods

getTagsInCollection removeTagsFromCollection renameOrMergeTags

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

getTagsInCollection

getTagsInCollection(collectionId?, options?): Promise<AxiosResponse<GetTagsInCollectionResponse, any>>
Parameters
- OptionalcollectionId: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetTagsInCollectionResponse, any>>
Throws
Memberof
TagApi
- Defined in src/generated/api.ts:7489

removeTagsFromCollection

removeTagsFromCollection(collectionId?, removeTagsFromCollectionRequest?, options?): Promise<AxiosResponse<SimpleResponse, any>>
Parameters
- OptionalcollectionId: number
- OptionalremoveTagsFromCollectionRequest: RemoveTagsFromCollectionRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SimpleResponse, any>>
Throws
Memberof
TagApi
- Defined in src/generated/api.ts:7501

renameOrMergeTags

renameOrMergeTags(collectionId?, renameOrMergeTagsRequest?, options?): Promise<AxiosResponse<SimpleResponse, any>>
Parameters
- OptionalcollectionId: number
- OptionalrenameOrMergeTagsRequest: RenameOrMergeTagsRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SimpleResponse, any>>
Throws
Memberof
TagApi
- Defined in src/generated/api.ts:7513