Class CollectionApi

CollectionApi - object-oriented interface

Export

CollectionApi

Hierarchy (view full)

BaseAPI
- CollectionApi
  - CollectionApi

Constructors

constructor

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

acceptInvitation

acceptInvitation(id, options?): Promise<AxiosResponse<AcceptInvitation200Response, any>>
Parameters
- id: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<AcceptInvitation200Response, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5286

changeCollaboratorAccessLevel

changeCollaboratorAccessLevel(userId, id, changeCollaboratorAccessLevelRequest?, options?): Promise<AxiosResponse<void, any>>
Parameters
- userId: number
- id: number
- OptionalchangeCollaboratorAccessLevelRequest: ChangeCollaboratorAccessLevelRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5299

createCollection

createCollection(createCollectionRequest?, options?): Promise<AxiosResponse<CreateCollectionResponse, any>>
Parameters
- OptionalcreateCollectionRequest: CreateCollectionRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CreateCollectionResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5310

deleteCollaborator

deleteCollaborator(userId, id, options?): Promise<AxiosResponse<SimpleResponse, any>>
Parameters
- userId: number
- id: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SimpleResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5322

emptyTrash

emptyTrash(options?): Promise<AxiosResponse<SimpleResponse, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SimpleResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5332

getChildCollections

getChildCollections(options?): Promise<AxiosResponse<GetChildCollectionsResponse, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetChildCollectionsResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5342

getCollaborators

getCollaborators(id, options?): Promise<AxiosResponse<void, any>>
Parameters
- id: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5353

getCollection

getCollection(id, options?): Promise<AxiosResponse<GetCollectionResponse, any>>
Parameters
- id: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetCollectionResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5364

getFeaturedCovers

getFeaturedCovers(options?): Promise<AxiosResponse<GetFeaturedCoversResponse, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetFeaturedCoversResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5374

getRootCollections

getRootCollections(options?): Promise<AxiosResponse<GetRootCollectionsResponse, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetRootCollectionsResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5384

getSystemCollectionStats

getSystemCollectionStats(options?): Promise<AxiosResponse<GetSystemCollectionStatsResponse, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetSystemCollectionStatsResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5394

mergeCollections

mergeCollections(mergeCollectionsRequest?, options?): Promise<AxiosResponse<MergeCollectionsResponse, any>>
Parameters
- OptionalmergeCollectionsRequest: MergeCollectionsRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<MergeCollectionsResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5405

removeAllEmptyCollections

removeAllEmptyCollections(options?): Promise<AxiosResponse<RemoveAllEmptyCollectionsResponse, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoveAllEmptyCollectionsResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5415

removeCollection

removeCollection(id, options?): Promise<AxiosResponse<SimpleResponse, any>>
Parameters
- id: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SimpleResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5426

removeCollections

removeCollections(removeCollectionsRequest?, options?): Promise<AxiosResponse<RemoveCollectionsResponse, any>>
Parameters
- OptionalremoveCollectionsRequest: RemoveCollectionsRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoveCollectionsResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5437

reorderAllCollections

reorderAllCollections(reorderAllCollectionsRequest?, options?): Promise<AxiosResponse<SimpleResponse, any>>
Parameters
- OptionalreorderAllCollectionsRequest: ReorderAllCollectionsRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SimpleResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5448

searchCovers

searchCovers(text, options?): Promise<AxiosResponse<SearchCoversResponse, any>>
Parameters
- text: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SearchCoversResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5459

shareCollection

shareCollection(id, shareCollectionRequest?, options?): Promise<AxiosResponse<ShareCollectionResponse, any>>
Parameters
- id: number
- OptionalshareCollectionRequest: ShareCollectionRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ShareCollectionResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5471

unshareOrLeaveCollection

unshareOrLeaveCollection(id, options?): Promise<AxiosResponse<SimpleResponse, any>>
Parameters
- id: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SimpleResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5482

updateCollection

updateCollection(id, updateCollectionRequest?, options?): Promise<AxiosResponse<UpdateCollectionResponse, any>>
Parameters
- id: number
- OptionalupdateCollectionRequest: UpdateCollectionRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UpdateCollectionResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5494

uploadCollectionCover

uploadCollectionCover(id, cover?, options?): Promise<AxiosResponse<UploadCollectionCoverResponse, any>>
Parameters
- id: number
- Optionalcover: File
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UploadCollectionCoverResponse, any>>
Throws
Memberof
CollectionApi
- Defined in src/generated/api.ts:5506