Skip to main content

CategoryApiClientInterface

Methods​

checkCategoryIsFollowed()​

checkCategoryIsFollowed(id, config?): Promise<SCCategoryFollowedStatusType>

Parameters​

ParameterType
idstring | number
config?AxiosRequestConfig

Returns​

Promise<SCCategoryFollowedStatusType>

createCategory()​

createCategory(data, config?): Promise<SCCategoryType>

Parameters​

ParameterType
dataSCCategoryType
config?AxiosRequestConfig

Returns​

Promise<SCCategoryType>

deleteASpecificCategory()​

deleteASpecificCategory(id, config?): Promise<any>

Parameters​

ParameterType
idstring | number
config?AxiosRequestConfig

Returns​

Promise<any>

followCategory()​

followCategory(id, config?): Promise<any>

Parameters​

ParameterType
idstring | number
config?AxiosRequestConfig

Returns​

Promise<any>

getAllCategories()​

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

Parameters​

ParameterType
params?CategoryParams
config?AxiosRequestConfig

Returns​

Promise<SCPaginatedResponse<SCCategoryType>>

getCategoryAudience()​

getCategoryAudience(id, config?): Promise<SCCategoryAudienceType>

Parameters​

ParameterType
idstring | number
config?AxiosRequestConfig

Returns​

Promise<SCCategoryAudienceType>

getCategoryFeed()​

getCategoryFeed(id, config?): Promise<SCPaginatedResponse<SCFeedUnitType>>

Parameters​

ParameterType
idstring | number
config?AxiosRequestConfig

Returns​

Promise<SCPaginatedResponse<SCFeedUnitType>>

getCategoryFollowers()​

getCategoryFollowers(id, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters​

ParameterType
idstring | number
config?AxiosRequestConfig

Returns​

Promise<SCPaginatedResponse<SCUserType>>

getCategoryTrendingFeed()​

getCategoryTrendingFeed(id, params?, config?): Promise<SCPaginatedResponse<SCFeedUnitType>>

Parameters​

ParameterType
idstring | number
params?BaseGetParams
config?AxiosRequestConfig

Returns​

Promise<SCPaginatedResponse<SCFeedUnitType>>

getCategoryTrendingFollowers()​

getCategoryTrendingFollowers(id, params?, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters​

ParameterType
idstring | number
params?BaseGetParams
config?AxiosRequestConfig

Returns​

Promise<SCPaginatedResponse<SCUserType>>

getFollowedCategories()​

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

Parameters​

ParameterType
params?CategoryParams
config?AxiosRequestConfig

Returns​

Promise<SCPaginatedResponse<SCCategoryType>>

getPopularCategories()​

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

Parameters​

ParameterType
params?BaseGetParams
config?AxiosRequestConfig

Returns​

Promise<SCPaginatedResponse<SCCategoryType>>

getSpecificCategory()​

getSpecificCategory(id, config?): Promise<SCCategoryType>

Parameters​

ParameterType
idstring | number
config?AxiosRequestConfig

Returns​

Promise<SCCategoryType>

patchASpecificCategory()​

patchASpecificCategory(id, data, config?): Promise<SCCategoryType>

Parameters​

ParameterType
idstring | number
dataSCCategoryType
config?AxiosRequestConfig

Returns​

Promise<SCCategoryType>

searchCategory()​

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

Parameters​

ParameterType
params?CategoryParams
config?AxiosRequestConfig

Returns​

Promise<SCPaginatedResponse<SCCategoryType>>

updateASpecificCategory()​

updateASpecificCategory(id, data, config?): Promise<SCCategoryType>

Parameters​

ParameterType
idstring | number
dataSCCategoryType
config?AxiosRequestConfig

Returns​

Promise<SCCategoryType>