Class RaindropApi

RaindropApi - object-oriented interface

Export

RaindropApi

Hierarchy (view full)

generated.RaindropApi
- RaindropApi

Index

Constructors

constructor

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

createRaindrop

createRaindrop(createRaindropRequest?, options?): Promise<AxiosResponse<CreateRaindropResponse, any>>
Parameters
- OptionalcreateRaindropRequest: CreateRaindropRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CreateRaindropResponse, any>>
Throws
Memberof
RaindropApi
Inherited from RaindropApi.createRaindrop
- Defined in src/generated/api.ts:7093

createRaindrops

createRaindrops(body?, options?): Promise<AxiosResponse<CreateRaindropsResponse, any>>
Parameters
- Optionalbody: object
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<CreateRaindropsResponse, any>>
Throws
Memberof
RaindropApi
Inherited from RaindropApi.createRaindrops
- Defined in src/generated/api.ts:7104

getAllRaindrops

getAllRaindrops(collectionId?, params?, options?): 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.
- Defined in src/client/raindrop.ts:28

getPermanentCopy

getPermanentCopy(id, options?): Promise<AxiosResponse<void, any>>
Parameters
- id: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
RaindropApi
Inherited from RaindropApi.getPermanentCopy
- Defined in src/generated/api.ts:7115

getRaindrop

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

getRaindrops

getRaindrops(collectionId, sort?, perpage?, page?, search?, options?): 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
Memberof
RaindropApi
Inherited from RaindropApi.getRaindrops
- Defined in src/generated/api.ts:7141

removeRaindrop

removeRaindrop(id, options?): Promise<AxiosResponse<RemoveRaindropResponse, any>>
Parameters
- id: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoveRaindropResponse, any>>
Throws
Memberof
RaindropApi
Inherited from RaindropApi.removeRaindrop
- Defined in src/generated/api.ts:7152

removeRaindrops

removeRaindrops(collectionId, search?, removeRaindropsRequest?, options?): Promise<AxiosResponse<RemoveRaindropsResponse, any>>
Parameters
- collectionId: number
- Optionalsearch: string
- OptionalremoveRaindropsRequest: RemoveRaindropsRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RemoveRaindropsResponse, any>>
Throws
Memberof
RaindropApi
Inherited from RaindropApi.removeRaindrops
- Defined in src/generated/api.ts:7165

suggestForExistingBookmark

suggestForExistingBookmark(id, options?): Promise<AxiosResponse<SuggestForExistingBookmarkResponse, any>>
Parameters
- id: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SuggestForExistingBookmarkResponse, any>>
Throws
Memberof
RaindropApi
Inherited from RaindropApi.suggestForExistingBookmark
- Defined in src/generated/api.ts:7176

suggestForNewBookmark

suggestForNewBookmark(suggestForNewBookmarkRequest?, options?): Promise<AxiosResponse<SuggestForNewBookmarkResponse, any>>
Parameters
- OptionalsuggestForNewBookmarkRequest: SuggestForNewBookmarkRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SuggestForNewBookmarkResponse, any>>
Throws
Memberof
RaindropApi
Inherited from RaindropApi.suggestForNewBookmark
- Defined in src/generated/api.ts:7187

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

updateRaindrops

updateRaindrops(collectionId, updateRaindropsRequest?, options?): Promise<AxiosResponse<UpdateRaindropsResponse, any>>
Parameters
- collectionId: number
- OptionalupdateRaindropsRequest: UpdateRaindropsRequest
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UpdateRaindropsResponse, any>>
Throws
Memberof
RaindropApi
Inherited from RaindropApi.updateRaindrops
- Defined in src/generated/api.ts:7211

uploadFile

uploadFile(file?, collectionId?, options?): Promise<AxiosResponse<UploadFileResponse, any>>
Parameters
- Optionalfile: File
- OptionalcollectionId: number
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UploadFileResponse, any>>
Throws
Memberof
RaindropApi
Inherited from RaindropApi.uploadFile
- Defined in src/generated/api.ts:7223

uploadRaindropCover

uploadRaindropCover(id, cover?, options?): Promise<AxiosResponse<UploadRaindropCoverResponse, any>>
Parameters
- id: number
- Optionalcover: File
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<UploadRaindropCoverResponse, any>>
Throws
Memberof
RaindropApi
Inherited from RaindropApi.uploadRaindropCover
- Defined in src/generated/api.ts:7235

Class RaindropApi

Export

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RaindropApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

createRaindrop

Parameters

Returns Promise<AxiosResponse<CreateRaindropResponse, any>>

Throws

Memberof

createRaindrops

Parameters

Returns Promise<AxiosResponse<CreateRaindropsResponse, any>>

Throws

Memberof

getAllRaindrops

Parameters

Returns Promise<GetRaindropResponseItem[]>

getPermanentCopy

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

getRaindrop

Parameters

Returns Promise<AxiosResponse<GetRaindropResponse, any>>

Throws

Memberof

getRaindrops

Parameters

Returns Promise<AxiosResponse<GetRaindropsResponse, any>>

Throws

Memberof

removeRaindrop

Parameters

Returns Promise<AxiosResponse<RemoveRaindropResponse, any>>

Throws

Memberof

removeRaindrops

Parameters

Returns Promise<AxiosResponse<RemoveRaindropsResponse, any>>

Throws

Memberof

suggestForExistingBookmark

Parameters

Returns Promise<AxiosResponse<SuggestForExistingBookmarkResponse, any>>

Throws

Memberof

suggestForNewBookmark

Parameters

Returns Promise<AxiosResponse<SuggestForNewBookmarkResponse, any>>

Throws

Memberof

updateRaindrop

Parameters

Returns Promise<AxiosResponse<UpdateRaindropResponse, any>>

Throws

Memberof

updateRaindrops

Parameters

Returns Promise<AxiosResponse<UpdateRaindropsResponse, any>>

Throws

Memberof

uploadFile

Parameters

Returns Promise<AxiosResponse<UploadFileResponse, any>>

Throws

Memberof

uploadRaindropCover

`Protected`axios

`Protected`basePath

`Protected`configuration