SuggestionApiClient

Contains all the endpoints needed to manage suggestions.

Constructors

new SuggestionApiClient()

new SuggestionApiClient(): SuggestionApiClient

Returns

SuggestionApiClient

Methods

getCategorySuggestion()

static getCategorySuggestion(params?, config?): Promise <SCPaginatedResponse<SCCategoryType>>

This endpoint retrieves a list of categories suggested to the current user.

Parameters

Parameter	Type	Description
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCCategoryType>>

Source

services/suggestion/index.ts:25

---

getIncubatorSuggestion()

static getIncubatorSuggestion(params?, config?): Promise <SCPaginatedResponse<SCIncubatorType>>

This endpoint retrieves a list of suggested incubators.

Parameters

Parameter	Type	Description
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCIncubatorType>>

Source

services/suggestion/index.ts:34

---

getPollSuggestion()

static getPollSuggestion(params?, config?): Promise <SCPaginatedResponse<SCFeedObjectType>>

This endpoint retrieves a list of contributes(discussions, posts, statuses) with a related poll.

Parameters

Parameter	Type	Description
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCFeedObjectType>>

Source

services/suggestion/index.ts:43

---

getSearchSuggestion()

static getSearchSuggestion(search, params?, config?): Promise <SCPaginatedResponse<SCSuggestionType>>

This endpoint retrieves a list of users suggested to the current user.

Parameters

Parameter	Type	Description
search	string
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCSuggestionType>>

Source

services/suggestion/index.ts:61

---

getUserSuggestion()

static getUserSuggestion(params?, config?): Promise <SCPaginatedResponse<SCUserType>>

This endpoint retrieves a list of users suggested to the current user.

Parameters

Parameter	Type	Description
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/suggestion/index.ts:52