UserApiClientInterface

Methods

addUserAvatar()

addUserAvatar(data, config?): Promise<SCAvatarType>

Parameters

Parameter	Type
data	FormData
config?	AxiosRequestConfig<any>

Returns

Promise<SCAvatarType>

Source

services/user/index.ts:92

---

changeUserMail()

changeUserMail(id, new_email, confirm?, send_email?, config?): Promise<any>

Parameters

Parameter	Type
id	string | number
new_email	string
confirm?	boolean
send_email?	boolean
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/user/index.ts:42

---

changeUserPassword()

changeUserPassword(id, password, new_password, config?): Promise<any>

Parameters

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

Returns

Promise<any>

Source

services/user/index.ts:50

---

checkUserConnections()

checkUserConnections(id, config?): Promise<SCUserConnectionStatusType>

Parameters

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

Returns

Promise<SCUserConnectionStatusType>

Source

services/user/index.ts:75

---

checkUserEmailToken()

checkUserEmailToken(id, email_token, config?): Promise<SCUserEmailTokenType>

Parameters

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

Returns

Promise<SCUserEmailTokenType>

Source

services/user/index.ts:91

---

checkUserFollowed()

checkUserFollowed(id, config?): Promise<SCUserFollowedStatusType>

Parameters

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

Returns

Promise<SCUserFollowedStatusType>

Source

services/user/index.ts:72

---

checkUserFollower()

checkUserFollower(id, config?): Promise<SCUserFollowerStatusType>

Parameters

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

Returns

Promise<SCUserFollowerStatusType>

Source

services/user/index.ts:73

---

checkUserHidden()

checkUserHidden(id, config?): Promise<SCUserHiddenStatusType>

Parameters

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

Returns

Promise<SCUserHiddenStatusType>

Source

services/user/index.ts:86

---

checkUserHiddenBy()

checkUserHiddenBy(id, config?): Promise<SCUserHiddenByStatusType>

Parameters

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

Returns

Promise<SCUserHiddenByStatusType>

Source

services/user/index.ts:87

---

confirmChangeUserMail()

confirmChangeUserMail(id, new_email, validation_code?, config?): Promise<any>

Parameters

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

Returns

Promise<any>

Source

services/user/index.ts:49

---

createProviderAssociation()

createProviderAssociation(data, config?): Promise<SCUserProviderAssociationType>

Parameters

Parameter	Type
data	SCUserProviderAssociationType
config?	AxiosRequestConfig<any>

Returns

Promise<SCUserProviderAssociationType>

Source

services/user/index.ts:97

---

deleteProviderAssociation()

deleteProviderAssociation(data, config?): Promise<any>

Parameters

Parameter	Type
data	DeleteProviderAssociation
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/user/index.ts:98

---

followUser()

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

Parameters

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

Returns

Promise<any>

Source

services/user/index.ts:71

---

getAllUsers()

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

Parameters

Parameter	Type
params?	any
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/user/index.ts:32

---

getCurrentUser()

getCurrentUser(config?): Promise<SCUserType>

Parameters

Parameter	Type
config?	AxiosRequestConfig<any>

Returns

Promise<SCUserType>

Source

services/user/index.ts:53

---

getCurrentUserAvatar()

getCurrentUserAvatar(config?): Promise<SCUserAvatarType>

Parameters

Parameter	Type
config?	AxiosRequestConfig<any>

Returns

Promise<SCUserAvatarType>

Source

services/user/index.ts:54

---

getCurrentUserPermission()

getCurrentUserPermission(config?): Promise<SCUserPermissionType>

Parameters

Parameter	Type
config?	AxiosRequestConfig<any>

Returns

Promise<SCUserPermissionType>

Source

services/user/index.ts:55

---

getCurrentUserPlatform()

getCurrentUserPlatform(next?, config?): Promise<SCPlatformType>

Parameters

Parameter	Type
next?	string
config?	AxiosRequestConfig<any>

Returns

Promise<SCPlatformType>

Source

services/user/index.ts:56

---

getHiddenUsers()

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

Parameters

Parameter	Type
params?	any
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/user/index.ts:33

---

getHiddenUsersId()

getHiddenUsersId(params?, config?): Promise<number[]>

Parameters

Parameter	Type
params?	any
config?	AxiosRequestConfig<any>

Returns

Promise<number[]>

Source

services/user/index.ts:34

---

getProviderAssociations()

getProviderAssociations(userId, config?): Promise<SCUserProviderAssociationType[]>

Parameters

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

Returns

Promise<SCUserProviderAssociationType[]>

Source

services/user/index.ts:96

---

getSpecificUser()

getSpecificUser(id, config?): Promise<SCUserType>

Parameters

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

Returns

Promise<SCUserType>

Source

services/user/index.ts:37

---

getUserAvatars()

getUserAvatars(config?): Promise <SCPaginatedResponse<SCAvatarType>>

Parameters

Parameter	Type
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCAvatarType>>

Source

services/user/index.ts:93

---

getUserConnectionRequests()

getUserConnectionRequests(params?, config?): Promise <SCPaginatedResponse<SCUserConnectionRequestType>>

Parameters

Parameter	Type
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserConnectionRequestType>>

Source

services/user/index.ts:76

---

getUserConnectionStatuses()

getUserConnectionStatuses(users, config?): Promise<any>

Parameters

Parameter	Type
users	number[]
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/user/index.ts:89

---

getUserConnections()

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

Parameters

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

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/user/index.ts:74

---

getUserCounters()

getUserCounters(id, config?): Promise<SCUserCounterType>

Parameters

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

Returns

Promise<SCUserCounterType>

Source

services/user/index.ts:38

---

getUserFeed()

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

Parameters

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

Returns

Promise <SCPaginatedResponse<SCFeedUnitType>>

Source

services/user/index.ts:58

---

getUserFollowedCategories()

getUserFollowedCategories(id, mutual?, config?): Promise<SCCategoryType[]>

Parameters

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

Returns

Promise<SCCategoryType[]>

Source

services/user/index.ts:57

---

getUserFollowers()

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

Parameters

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

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/user/index.ts:59

---

getUserFollowings()

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

Parameters

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

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/user/index.ts:65

---

getUserLoyaltyPoints()

getUserLoyaltyPoints(id, config?): Promise<SCUserLoyaltyPointsType>

Parameters

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

Returns

Promise<SCUserLoyaltyPointsType>

Source

services/user/index.ts:88

---

getUserRequestConnectionsSent()

getUserRequestConnectionsSent(params?, config?): Promise <SCPaginatedResponse<SCUserConnectionRequestType>>

Parameters

Parameter	Type
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserConnectionRequestType>>

Source

services/user/index.ts:77

---

removeUserAvatar()

removeUserAvatar(avatar_id, config?): Promise<any>

Parameters

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

Returns

Promise<any>

Source

services/user/index.ts:94

---

setUserPrimaryAvatar()

setUserPrimaryAvatar(avatar_id, config?): Promise<any>

Parameters

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

Returns

Promise<any>

Source

services/user/index.ts:95

---

showHideUser()

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

Parameters

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

Returns

Promise<any>

Source

services/user/index.ts:85

---

userAcceptRequestConnection()

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

Parameters

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

Returns

Promise<any>

Source

services/user/index.ts:78

---

userAutocomplete()

userAutocomplete(params, config?): Promise <SCPaginatedResponse<SCUserAutocompleteType>>

Parameters

Parameter	Type
params	UserAutocompleteParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserAutocompleteType>>

Source

services/user/index.ts:35

---

userCancelRejectConnectionRequest()

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

Parameters

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

Returns

Promise<any>

Source

services/user/index.ts:81

---

userCancelRequestConnection()

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

Parameters

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

Returns

Promise<any>

Source

services/user/index.ts:82

---

userDelete()

userDelete(id, hard?, config?): Promise<any>

Parameters

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

Returns

Promise<any>

Source

services/user/index.ts:41

---

userMarkSeenConnectionRequest()

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

Parameters

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

Returns

Promise<any>

Source

services/user/index.ts:84

---

userPatch()

userPatch(id, data?, config?): Promise<SCUserType>

Parameters

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

Returns

Promise<SCUserType>

Source

services/user/index.ts:40

---

userRejectConnectionRequest()

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

Parameters

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

Returns

Promise<any>

Source

services/user/index.ts:83

---

userRemoveConnection()

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

Parameters

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

Returns

Promise<any>

Source

services/user/index.ts:80

---

userRequestConnection()

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

Parameters

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

Returns

Promise<any>

Source

services/user/index.ts:79

---

userSearch()

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

Parameters

Parameter	Type
params	UserSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/user/index.ts:36

---

userSettings()

userSettings(id, config?): Promise<SCUserSettingsType>

Parameters

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

Returns

Promise<SCUserSettingsType>

Source

services/user/index.ts:51

---

userSettingsPatch()

userSettingsPatch(id, data?, config?): Promise<SCUserSettingsType>

Parameters

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

Returns

Promise<SCUserSettingsType>

Source

services/user/index.ts:52

---

userTagToAddressContribution()

userTagToAddressContribution(config?): Promise<SCTagType>

Parameters

Parameter	Type
config?	AxiosRequestConfig<any>

Returns

Promise<SCTagType>

Source

services/user/index.ts:90

---

userUpdate()

userUpdate(id, data?, config?): Promise<SCUserType>

Parameters

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

Returns

Promise<SCUserType>

Source

services/user/index.ts:39