Class HighlightApi

HighlightApi - object-oriented interface

Export

HighlightApi

Hierarchy (View Summary, Expand)

BaseAPI
- HighlightApi

Index

Constructors

Methods

getAllHighlights getHighlightsInCollection getRaindrop updateRaindrop

Constructors

constructor

new HighlightApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): 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?: number,
    perpage?: number,
    options?: RawAxiosRequestConfig,
): 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: number,
    page?: number,
    perpage?: number,
    options?: RawAxiosRequestConfig,
): 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: number,
options?: RawAxiosRequestConfig,
): 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: number,
    body?: object,
    options?: RawAxiosRequestConfig,
): 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