Class: SuggestionApiClient
services/suggestion.SuggestionApiClient
Contains all the endpoints needed to manage suggestions.
Constructors
constructor
• new SuggestionApiClient(): SuggestionApiClient
Returns
Methods
getCategorySuggestion
▸ getCategorySuggestion(params?, config?): Promise<SCPaginatedResponse<SCCategoryType>>
This endpoint retrieves a list of categories suggested to the current user.
Parameters
| Name | Type |
|---|---|
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCCategoryType>>
Defined in
services/suggestion/index.ts:25
getIncubatorSuggestion
▸ getIncubatorSuggestion(params?, config?): Promise<SCPaginatedResponse<SCIncubatorType>>
This endpoint retrieves a list of suggested incubators.
Parameters
| Name | Type |
|---|---|
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCIncubatorType>>
Defined in
services/suggestion/index.ts:34
getPollSuggestion
▸ getPollSuggestion(params?, config?): Promise<SCPaginatedResponse<SCFeedObjectType>>
This endpoint retrieves a list of contributes(discussions, posts, statuses) with a related poll.
Parameters
| Name | Type |
|---|---|
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCFeedObjectType>>
Defined in
services/suggestion/index.ts:43
getSearchSuggestion
▸ getSearchSuggestion(search, params?, config?): Promise<SCPaginatedResponse<SCSuggestionType>>
This endpoint retrieves a list of users suggested to the current user.
Parameters
| Name | Type |
|---|---|
search | string |
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCSuggestionType>>
Defined in
services/suggestion/index.ts:61
getUserSuggestion
▸ getUserSuggestion(params?, config?): Promise<SCPaginatedResponse<SCUserType>>
This endpoint retrieves a list of users suggested to the current user.
Parameters
| Name | Type |
|---|---|
params? | BaseGetParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCUserType>>