Class HighlightApi

HighlightApi - object-oriented interface

Export

HighlightApi

Hierarchy (view full)

BaseAPI
- HighlightApi

Index

Constructors

Properties

axios basePath configuration

Methods

getAllHighlights getHighlightsInCollection getRaindrop updateRaindrop

Constructors

constructor

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

getAllHighlights

getAllHighlights(page?, perpage?, options?): Promise<AxiosResponse<GetAllHighlightsResponse, any>>
Parameters
- Optionalpage: number
- Optionalperpage: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetAllHighlightsResponse, any>>
Throws
Memberof
HighlightApi
- Defined in src/generated/api.ts:5949

getHighlightsInCollection

getHighlightsInCollection(collectionId, page?, perpage?, options?): Promise<AxiosResponse<GetHighlightsInCollectionResponse, any>>
Parameters
- collectionId: number
- Optionalpage: number
- Optionalperpage: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetHighlightsInCollectionResponse, any>>
Throws
Memberof
HighlightApi
- Defined in src/generated/api.ts:5962

getRaindrop

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

updateRaindrop

updateRaindrop(id, body?, options?): Promise<AxiosResponse<UpdateRaindropResponse, any>>
Parameters
- id: number
- Optionalbody: object
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UpdateRaindropResponse, any>>
Throws
Memberof
HighlightApi
- Defined in src/generated/api.ts:5985