Class RaindropApi

RaindropApi - object-oriented interface

Hierarchy (View Summary)

generated.RaindropApi
- RaindropApi

Constructors

constructor

new RaindropApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): RaindropApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns RaindropApi
Inherited from RaindropApi.constructor
- Defined in src/generated/base.ts:39

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

createRaindrop

createRaindrop(
createRaindropRequest?: CreateRaindropRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CreateRaindropResponse, any, {}>>
Parameters
- OptionalcreateRaindropRequest: CreateRaindropRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CreateRaindropResponse, any, {}>>

Throws
Inherited from RaindropApi.createRaindrop
- Defined in src/generated/api.ts:3973

createRaindrops

createRaindrops(
body?: object,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<CreateRaindropsResponse, any, {}>>
Parameters
- Optionalbody: object
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CreateRaindropsResponse, any, {}>>

Throws
Inherited from RaindropApi.createRaindrops
- Defined in src/generated/api.ts:3983

getAllRaindrops

getAllRaindrops(
    collectionId?: number,
    params?: GetAllRaindropsParams,
    options?: AxiosRequestConfig<any>,
): Promise<GetRaindropResponseItem[]>
Fetch all raindrops of a collection.
Parameters
- OptionalcollectionId: number
  ID of collection.
- Optionalparams: GetAllRaindropsParams
  Request parameters.
- Optionaloptions: AxiosRequestConfig<any>
  Axios request config.
Returns Promise<GetRaindropResponseItem[]>
Array of raindrops.

Deprecated
This function is deprecated and will be removed in a future release.
- Defined in src/client/raindrop.ts:29

getPermanentCopy

getPermanentCopy(
id: number,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- id: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
Inherited from RaindropApi.getPermanentCopy
- Defined in src/generated/api.ts:3993

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
Inherited from RaindropApi.getRaindrop
- Defined in src/generated/api.ts:4003

getRaindrops

getRaindrops(
    collectionId: number,
    sort?: string,
    perpage?: number,
    page?: number,
    search?: string,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GetRaindropsResponse, any, {}>>
Parameters
- collectionId: number
- Optionalsort: string
- Optionalperpage: number
- Optionalpage: number
- Optionalsearch: string
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GetRaindropsResponse, any, {}>>

Throws
Inherited from RaindropApi.getRaindrops
- Defined in src/generated/api.ts:4017

removeRaindrop

removeRaindrop(
id: number,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RemoveRaindropResponse, any, {}>>
Parameters
- id: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoveRaindropResponse, any, {}>>

Throws
Inherited from RaindropApi.removeRaindrop
- Defined in src/generated/api.ts:4027

removeRaindrops

removeRaindrops(
    collectionId: number,
    search?: string,
    removeRaindropsRequest?: RemoveRaindropsRequest,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<RemoveRaindropsResponse, any, {}>>
Parameters
- collectionId: number
- Optionalsearch: string
- OptionalremoveRaindropsRequest: RemoveRaindropsRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoveRaindropsResponse, any, {}>>

Throws
Inherited from RaindropApi.removeRaindrops
- Defined in src/generated/api.ts:4039

suggestForExistingBookmark

suggestForExistingBookmark(
id: number,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SuggestForExistingBookmarkResponse, any, {}>>
Parameters
- id: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SuggestForExistingBookmarkResponse, any, {}>>

Throws
Inherited from RaindropApi.suggestForExistingBookmark
- Defined in src/generated/api.ts:4049

suggestForNewBookmark

suggestForNewBookmark(
suggestForNewBookmarkRequest?: SuggestForNewBookmarkRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<SuggestForNewBookmarkResponse, any, {}>>
Parameters
- OptionalsuggestForNewBookmarkRequest: SuggestForNewBookmarkRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SuggestForNewBookmarkResponse, any, {}>>

Throws
Inherited from RaindropApi.suggestForNewBookmark
- Defined in src/generated/api.ts:4059

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
Inherited from RaindropApi.updateRaindrop
- Defined in src/generated/api.ts:4070

updateRaindrops

updateRaindrops(
    collectionId: number,
    updateRaindropsRequest?: UpdateRaindropsRequest,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UpdateRaindropsResponse, any, {}>>
Parameters
- collectionId: number
- OptionalupdateRaindropsRequest: UpdateRaindropsRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UpdateRaindropsResponse, any, {}>>

Throws
Inherited from RaindropApi.updateRaindrops
- Defined in src/generated/api.ts:4081

uploadFile

uploadFile(
    file?: File,
    collectionId?: number,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UploadFileResponse, any, {}>>
Parameters
- Optionalfile: File
- OptionalcollectionId: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UploadFileResponse, any, {}>>

Throws
Inherited from RaindropApi.uploadFile
- Defined in src/generated/api.ts:4092

uploadRaindropCover

uploadRaindropCover(
    id: number,
    cover?: File,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<UploadRaindropCoverResponse, any, {}>>
Parameters
- id: number
- Optionalcover: File
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UploadRaindropCoverResponse, any, {}>>

Throws
Inherited from RaindropApi.uploadRaindropCover
- Defined in src/generated/api.ts:4103

Class RaindropApi

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RaindropApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

createRaindrop

Parameters

Returns Promise<AxiosResponse<CreateRaindropResponse, any, {}>>

Throws

createRaindrops

Parameters

Returns Promise<AxiosResponse<CreateRaindropsResponse, any, {}>>

Throws

getAllRaindrops

Parameters

Returns Promise<GetRaindropResponseItem[]>

Deprecated

getPermanentCopy

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

getRaindrop

Parameters

Returns Promise<AxiosResponse<GetRaindropResponse, any, {}>>

Throws

getRaindrops

Parameters

Returns Promise<AxiosResponse<GetRaindropsResponse, any, {}>>

Throws

removeRaindrop

Parameters

Returns Promise<AxiosResponse<RemoveRaindropResponse, any, {}>>

Throws

removeRaindrops

Parameters

Returns Promise<AxiosResponse<RemoveRaindropsResponse, any, {}>>

Throws

suggestForExistingBookmark

Parameters

Returns Promise<AxiosResponse<SuggestForExistingBookmarkResponse, any, {}>>

Throws

suggestForNewBookmark

Parameters

Returns Promise<AxiosResponse<SuggestForNewBookmarkResponse, any, {}>>

Throws

updateRaindrop

Parameters

Returns Promise<AxiosResponse<UpdateRaindropResponse, any, {}>>

Throws

updateRaindrops

Parameters

Returns Promise<AxiosResponse<UpdateRaindropsResponse, any, {}>>

Throws

uploadFile

Parameters

Returns Promise<AxiosResponse<UploadFileResponse, any, {}>>

Throws

uploadRaindropCover

Parameters

Returns Promise<AxiosResponse<UploadRaindropCoverResponse, any, {}>>

Throws

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration