Interface: CategoryApiClientInterface

services/category.CategoryApiClientInterface

Methods

checkCategoryIsFollowed

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

Parameters

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

Returns

Promise<SCCategoryFollowedStatusType>

Defined in

services/category/index.ts:22

---

createCategory

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

Parameters

Name	Type
data	SCCategoryType
config?	AxiosRequestConfig<any>

Returns

Promise<SCCategoryType>

Defined in

services/category/index.ts:11

---

deleteASpecificCategory

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

Parameters

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

Returns

Promise<any>

Defined in

services/category/index.ts:15

---

followCategory

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

Parameters

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

Returns

Promise<any>

Defined in

services/category/index.ts:21

---

getAllCategories

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

Parameters

Name	Type
params?	CategoryParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCCategoryType>>

Defined in

services/category/index.ts:9

---

getCategoryAudience

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

Parameters

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

Returns

Promise<SCCategoryAudienceType>

Defined in

services/category/index.ts:16

---

getCategoryFeed

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

Parameters

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

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>

Defined in

services/category/index.ts:18

---

getCategoryFollowers

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

Parameters

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

Returns

Promise<SCPaginatedResponse<SCUserType>>

Defined in

services/category/index.ts:17

---

getCategoryTrendingFeed

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

Parameters

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

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>

Defined in

services/category/index.ts:19

---

getCategoryTrendingFollowers

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

Parameters

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

Returns

Promise<SCPaginatedResponse<SCUserType>>

Defined in

services/category/index.ts:20

---

getFollowedCategories

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

Parameters

Name	Type
params?	CategoryParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCCategoryType>>

Defined in

services/category/index.ts:23

---

getPopularCategories

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

Parameters

Name	Type
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCCategoryType>>

Defined in

services/category/index.ts:24

---

getSpecificCategory

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

Parameters

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

Returns

Promise<SCCategoryType>

Defined in

services/category/index.ts:12

---

patchASpecificCategory

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

Parameters

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

Returns

Promise<SCCategoryType>

Defined in

services/category/index.ts:14

---

searchCategory

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

Parameters

Name	Type
params?	CategoryParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCCategoryType>>

Defined in

services/category/index.ts:10

---

updateASpecificCategory

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

Parameters

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

Returns

Promise<SCCategoryType>

Defined in

services/category/index.ts:13