Function HighlightApiFactory

Returns {
    getAllHighlights(
        page?: number,
        perpage?: number,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetAllHighlightsResponse>;
    getHighlightsInCollection(
        collectionId: number,
        page?: number,
        perpage?: number,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetHighlightsInCollectionResponse>;
    getRaindrop(
        id: number,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetRaindropResponse>;
    updateRaindrop(
        id: number,
        body?: object,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UpdateRaindropResponse>;
}

• getAllHighlights: function

  • getAllHighlights(
        page?: number,
        perpage?: number,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetAllHighlightsResponse>

    Parameters

    • Optionalpage: number
    • Optionalperpage: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetAllHighlightsResponse>

    Throws

• getHighlightsInCollection: function

  • getHighlightsInCollection(
        collectionId: number,
        page?: number,
        perpage?: number,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetHighlightsInCollectionResponse>

    Parameters

    • collectionId: number
    • Optionalpage: number
    • Optionalperpage: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetHighlightsInCollectionResponse>

    Throws

• getRaindrop: function

  • getRaindrop(
        id: number,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<GetRaindropResponse>

    Parameters

    • id: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<GetRaindropResponse>

    Throws

• updateRaindrop: function

  • updateRaindrop(
        id: number,
        body?: object,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<UpdateRaindropResponse>

    Parameters

    • id: number
    • Optionalbody: object
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UpdateRaindropResponse>

    Throws