GroupApiClientInterface

Methods

changeGroupAvatarOrCover()

changeGroupAvatarOrCover(id, data, config?): Promise<SCGroupType>

Parameters

Parameter	Type
id	string | number
data	FormData
config?	AxiosRequestConfig

Returns

Promise<SCGroupType>

---

createGroup()

createGroup(data, config?): Promise<SCGroupType>

Parameters

Parameter	Type
data	GroupCreateParams | FormData
config?	AxiosRequestConfig

Returns

Promise<SCGroupType>

---

deleteGroup()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

getGroupFeed()

getGroupFeed(id, params?, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
params?	GroupFeedParams
config?	AxiosRequestConfig

Returns

Promise<any>

---

getGroupInvitedUsers()

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

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getGroupMembers()

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

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getGroupsSuggestedUsers()

getGroupsSuggestedUsers(search, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

Parameter	Type
search	string
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getGroupSubscriptionStatus()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

getGroupSuggestedUsers()

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

Parameters

Parameter	Type
id	string | number
search	string
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getGroupWaitingApprovalSubscribers()

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

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getSpecificGroupInfo()

getSpecificGroupInfo(id, config?): Promise<SCGroupType>

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCGroupType>

---

getUserGroups()

getUserGroups(params?, config?): Promise<SCPaginatedResponse<SCGroupType>>

Parameters

Parameter	Type
params?	BaseSearchParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCGroupType>>

---

getUserSubscribedGroups()

getUserSubscribedGroups(id, params?, config?): Promise<SCPaginatedResponse<SCGroupType>>

Parameters

Parameter	Type
id	string | number
params?	BaseSearchParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCGroupType>>

---

inviteOrAcceptGroupRequest()

inviteOrAcceptGroupRequest(id, data, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
data	{ users: number[]; }
data.users	number[]
config?	AxiosRequestConfig

Returns

Promise<any>

---

patchGroup()

patchGroup(id, data, config?): Promise<SCGroupType>

Parameters

Parameter	Type
id	string | number
data	SCGroupType
config?	AxiosRequestConfig

Returns

Promise<SCGroupType>

---

removeUserFromGroup()

removeUserFromGroup(id, user, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
user	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

searchGroups()

searchGroups(params?, config?): Promise<SCPaginatedResponse<SCGroupType>>

Parameters

Parameter	Type
params?	BaseSearchParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCGroupType>>

---

subscribeToGroup()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

unsubscribeFromGroup()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

updateGroup()

updateGroup(id, data, config?): Promise<SCGroupType>

Parameters

Parameter	Type
id	string | number
data	SCGroupType
config?	AxiosRequestConfig

Returns

Promise<SCGroupType>