Function HighlightApiFp

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

• getAllHighlights: function

  • getAllHighlights(
        page?: number,
        perpage?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetAllHighlightsResponse>,
    >

    Parameters

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

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetAllHighlightsResponse>,
    >

    Throws

• getHighlightsInCollection: function

  • getHighlightsInCollection(
        collectionId: number,
        page?: number,
        perpage?: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetHighlightsInCollectionResponse>,
    >

    Parameters

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

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetHighlightsInCollectionResponse>,
    >

    Throws

• getRaindrop: function

  • getRaindrop(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetRaindropResponse>,
    >

    Parameters

    • id: number
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<GetRaindropResponse>,
    >

    Throws

• updateRaindrop: function

  • updateRaindrop(
        id: number,
        body?: object,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateRaindropResponse>,
    >

    Parameters

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

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<UpdateRaindropResponse>,
    >

    Throws