SuggestionApiClient

Contains all the endpoints needed to manage suggestions.

Constructors

Constructor

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

Returns

Promise<SCPaginatedResponse<SCCategoryType>>

---

getCourseSuggestion()

static getCourseSuggestion(params?, config?): Promise<SCPaginatedResponse<SCCourseType>>

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

Parameters

Parameter	Type	Description
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCCourseType>>

---

getEventSuggestion()

static getEventSuggestion(params?, config?): Promise<SCPaginatedResponse<SCEventType>>

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

Parameters

Parameter	Type	Description
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEventType>>

---

getIncubatorSuggestion()

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

This endpoint retrieves a list of suggested incubators.

Parameters

Parameter	Type	Description
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCIncubatorType>>

---

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

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>

---

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

Returns

Promise<SCPaginatedResponse<SCSuggestionType>>

---

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

Returns

Promise<SCPaginatedResponse<SCUserType>>