CategoryApiClientInterface

Methods

checkCategoryIsFollowed()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCCategoryFollowedStatusType>

Source

services/category/index.ts:21

---

createCategory()

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

Parameters

Parameter	Type
data	SCCategoryType
config?	AxiosRequestConfig<any>

Returns

Promise<SCCategoryType>

Source

services/category/index.ts:10

---

deleteASpecificCategory()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/category/index.ts:14

---

followCategory()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/category/index.ts:20

---

getAllCategories()

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

Parameters

Parameter	Type
params?	CategoryParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCCategoryType>>

Source

services/category/index.ts:8

---

getCategoryAudience()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCCategoryAudienceType>

Source

services/category/index.ts:15

---

getCategoryFeed()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCFeedUnitType>>

Source

services/category/index.ts:17

---

getCategoryFollowers()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/category/index.ts:16

---

getCategoryTrendingFeed()

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

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCFeedUnitType>>

Source

services/category/index.ts:18

---

getCategoryTrendingFollowers()

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

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/category/index.ts:19

---

getFollowedCategories()

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

Parameters

Parameter	Type
params?	CategoryParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCCategoryType>>

Source

services/category/index.ts:22

---

getPopularCategories()

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

Parameters

Parameter	Type
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCCategoryType>>

Source

services/category/index.ts:23

---

getSpecificCategory()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCCategoryType>

Source

services/category/index.ts:11

---

patchASpecificCategory()

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

Parameters

Parameter	Type
id	string | number
data	SCCategoryType
config?	AxiosRequestConfig<any>

Returns

Promise<SCCategoryType>

Source

services/category/index.ts:13

---

searchCategory()

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

Parameters

Parameter	Type
params?	CategoryParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCCategoryType>>

Source

services/category/index.ts:9

---

updateASpecificCategory()

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

Parameters

Parameter	Type
id	string | number
data	SCCategoryType
config?	AxiosRequestConfig<any>

Returns

Promise<SCCategoryType>

Source

services/category/index.ts:12