Class: SuggestionService

services/suggestion.SuggestionService

Suggestion service can be used in the following way:

1. Import the service from our library:

import {SuggestionService} from "@selfcommunity/api-services";

2. Create a function and put the service inside it!
The async function `getCategorySuggestion` will return the paginated list of categories.

async getCategorySuggestion() {
         return await SuggestionService.getCategorySuggestion();
      }

If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).

1. Declare it(or declare them, it is possible to add multiple params)

const headers = headers: {Authorization: `Bearer ${yourToken}`}

2. Add it inside the brackets and pass it to the function, as shown in the previous example!

Constructors

constructor

• new SuggestionService(): SuggestionService

Returns

SuggestionService

Methods

getCategorySuggestion

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

Parameters

Name	Type
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCCategoryType>>

Defined in

services/suggestion/index.ts:96

---

getIncubatorSuggestion

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

Parameters

Name	Type
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCIncubatorType>>

Defined in

services/suggestion/index.ts:100

---

getPollSuggestion

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

Parameters

Name	Type
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCFeedObjectType>>

Defined in

services/suggestion/index.ts:104

---

getSearchSuggestion

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

Parameters

Name	Type
search	string
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCSuggestionType>>

Defined in

services/suggestion/index.ts:111

---

getUserSuggestion

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

Parameters

Name	Type
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCUserType>>

Defined in

services/suggestion/index.ts:108