UserApiClientInterface
Methods
addUserAvatar()
addUserAvatar(
data,config?):Promise<SCAvatarType>
Parameters
| Parameter | Type |
|---|---|
data | FormData |
config? | AxiosRequestConfig |
Returns
Promise<SCAvatarType>
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 |
Returns
Promise<any>
changeUserPassword()
changeUserPassword(
id,password,new_password,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
password | string |
new_password | string |
config? | AxiosRequestConfig |
Returns
Promise<any>
checkUserConnections()
checkUserConnections(
id,config?):Promise<SCUserConnectionStatusType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<SCUserConnectionStatusType>
checkUserEmailToken()
checkUserEmailToken(
id,email_token,config?):Promise<SCUserEmailTokenType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
email_token | string |
config? | AxiosRequestConfig |
Returns
Promise<SCUserEmailTokenType>
checkUserFollowed()
checkUserFollowed(
id,config?):Promise<SCUserFollowedStatusType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<SCUserFollowedStatusType>
checkUserFollower()
checkUserFollower(
id,config?):Promise<SCUserFollowerStatusType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<SCUserFollowerStatusType>
checkUserHidden()
checkUserHidden(
id,config?):Promise<SCUserHiddenStatusType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<SCUserHiddenStatusType>
checkUserHiddenBy()
checkUserHiddenBy(
id,config?):Promise<SCUserHiddenByStatusType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<SCUserHiddenByStatusType>
confirmChangeUserMail()
confirmChangeUserMail(
id,new_email,validation_code?,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
new_email | string |
validation_code? | string |
config? | AxiosRequestConfig |
Returns
Promise<any>
createProviderAssociation()
createProviderAssociation(
data,config?):Promise<SCUserProviderAssociationType>
Parameters
| Parameter | Type |
|---|---|
data | SCUserProviderAssociationType |
config? | AxiosRequestConfig |
Returns
Promise<SCUserProviderAssociationType>
deleteProviderAssociation()
deleteProviderAssociation(
data,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
data | DeleteProviderAssociation |
config? | AxiosRequestConfig |
Returns
Promise<any>
followUser()
followUser(
id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<any>
getAllUsers()
getAllUsers(
params?,config?):Promise<SCPaginatedResponse<SCUserType>>
Parameters
| Parameter | Type |
|---|---|
params? | any |
config? | AxiosRequestConfig |
Returns
Promise<SCPaginatedResponse<SCUserType>>
getCurrentUser()
getCurrentUser(
config?):Promise<SCUserType>
Parameters
| Parameter | Type |
|---|---|
config? | AxiosRequestConfig |
Returns
Promise<SCUserType>
getCurrentUserAvatar()
getCurrentUserAvatar(
config?):Promise<SCUserAvatarType>
Parameters
| Parameter | Type |
|---|---|
config? | AxiosRequestConfig |
Returns
Promise<SCUserAvatarType>
getCurrentUserPermission()
getCurrentUserPermission(
config?):Promise<SCUserPermissionType>
Parameters
| Parameter | Type |
|---|---|
config? | AxiosRequestConfig |
Returns
Promise<SCUserPermissionType>
getCurrentUserPlatform()
getCurrentUserPlatform(
next?,config?):Promise<SCPlatformType>
Parameters
| Parameter | Type |
|---|---|
next? | string |
config? | AxiosRequestConfig |
Returns
Promise<SCPlatformType>
getHiddenUsers()
getHiddenUsers(
params?,config?):Promise<SCPaginatedResponse<SCUserType>>
Parameters
| Parameter | Type |
|---|---|
params? | any |
config? | AxiosRequestConfig |
Returns
Promise<SCPaginatedResponse<SCUserType>>
getHiddenUsersId()
getHiddenUsersId(
params?,config?):Promise<number[]>
Parameters
| Parameter | Type |
|---|---|
params? | any |
config? | AxiosRequestConfig |
Returns
Promise<number[]>
getProviderAssociations()
getProviderAssociations(
userId,config?):Promise<SCUserProviderAssociationType[]>
Parameters
| Parameter | Type |
|---|---|
userId | string | number |
config? | AxiosRequestConfig |
Returns
Promise<SCUserProviderAssociationType[]>
getSpecificUser()
getSpecificUser(
id,config?):Promise<SCUserType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<SCUserType>
getUserAvatars()
getUserAvatars(
config?):Promise<SCPaginatedResponse<SCAvatarType>>
Parameters
| Parameter | Type |
|---|---|
config? | AxiosRequestConfig |
Returns
Promise<SCPaginatedResponse<SCAvatarType>>
getUserConnectionRequests()
getUserConnectionRequests(
params?,config?):Promise<SCPaginatedResponse<SCUserConnectionRequestType>>
Parameters
| Parameter | Type |
|---|---|
params? | BaseGetParams |
config? | AxiosRequestConfig |
Returns
Promise<SCPaginatedResponse<SCUserConnectionRequestType>>
getUserConnections()
getUserConnections(
id,params?,config?):Promise<SCPaginatedResponse<SCUserType>>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
params? | UserGetParams |
config? | AxiosRequestConfig |
Returns
Promise<SCPaginatedResponse<SCUserType>>
getUserConnectionStatuses()
getUserConnectionStatuses(
users,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
users | number[] |
config? | AxiosRequestConfig |
Returns
Promise<any>
getUserCounters()
getUserCounters(
id,config?):Promise<SCUserCounterType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<SCUserCounterType>
getUserFeed()
getUserFeed(
id,params?,config?):Promise<SCPaginatedResponse<SCFeedUnitType>>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
params? | BaseGetParams |
config? | AxiosRequestConfig |
Returns
Promise<SCPaginatedResponse<SCFeedUnitType>>
getUserFollowedCategories()
getUserFollowedCategories(
id,mutual?,config?):Promise<SCCategoryType[]>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
mutual? | number |
config? | AxiosRequestConfig |
Returns
Promise<SCCategoryType[]>
getUserFollowers()
getUserFollowers(
id,mutual?,params?,config?):Promise<SCPaginatedResponse<SCUserType>>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
mutual? | number |
params? | BaseGetParams |
config? | AxiosRequestConfig |
Returns
Promise<SCPaginatedResponse<SCUserType>>
getUserFollowings()
getUserFollowings(
id,mutual?,params?,config?):Promise<SCPaginatedResponse<SCUserType>>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
mutual? | number |
params? | BaseGetParams |
config? | AxiosRequestConfig |
Returns
Promise<SCPaginatedResponse<SCUserType>>
getUserLiveStream()
getUserLiveStream(
id,params?,config?):Promise<SCPaginatedResponse<SCLiveStreamType>>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
params? | BaseGetParams |
config? | AxiosRequestConfig |
Returns
Promise<SCPaginatedResponse<SCLiveStreamType>>
getUserLoyaltyPoints()
getUserLoyaltyPoints(
id,config?):Promise<SCUserLoyaltyPointsType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<SCUserLoyaltyPointsType>
getUserRequestConnectionsSent()
getUserRequestConnectionsSent(
params?,config?):Promise<SCPaginatedResponse<SCUserConnectionRequestType>>
Parameters
| Parameter | Type |
|---|---|
params? | BaseGetParams |
config? | AxiosRequestConfig |
Returns
Promise<SCPaginatedResponse<SCUserConnectionRequestType>>
removeUserAvatar()
removeUserAvatar(
avatar_id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
avatar_id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<any>
setUserPrimaryAvatar()
setUserPrimaryAvatar(
avatar_id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
avatar_id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<any>
showHideUser()
showHideUser(
id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<any>
userAcceptRequestConnection()
userAcceptRequestConnection(
id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<any>
userAutocomplete()
userAutocomplete(
params,config?):Promise<SCPaginatedResponse<SCUserAutocompleteType>>
Parameters
| Parameter | Type |
|---|---|
params | UserAutocompleteParams |
config? | AxiosRequestConfig |
Returns
Promise<SCPaginatedResponse<SCUserAutocompleteType>>
userCancelRejectConnectionRequest()
userCancelRejectConnectionRequest(
id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<any>
userCancelRequestConnection()
userCancelRequestConnection(
id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<any>
userDelete()
userDelete(
id,hard?,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
hard? | number |
config? | AxiosRequestConfig |
Returns
Promise<any>
userMarkSeenConnectionRequest()
userMarkSeenConnectionRequest(
id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<any>
userPatch()
userPatch(
id,data?,config?):Promise<SCUserType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
data? | SCUserType |
config? | AxiosRequestConfig |
Returns
Promise<SCUserType>
userRejectConnectionRequest()
userRejectConnectionRequest(
id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<any>
userRemoveConnection()
userRemoveConnection(
id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<any>
userRequestConnection()
userRequestConnection(
id,config?):Promise<any>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<any>
userSearch()
userSearch(
params,config?):Promise<SCPaginatedResponse<SCUserType>>
Parameters
| Parameter | Type |
|---|---|
params | UserSearchParams |
config? | AxiosRequestConfig |
Returns
Promise<SCPaginatedResponse<SCUserType>>
userSettings()
userSettings(
id,config?):Promise<SCUserSettingsType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig |
Returns
Promise<SCUserSettingsType>
userSettingsPatch()
userSettingsPatch(
id,data?,config?):Promise<SCUserSettingsType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
data? | SCUserSettingsType |
config? | AxiosRequestConfig |
Returns
Promise<SCUserSettingsType>
userTagToAddressContribution()
userTagToAddressContribution(
config?):Promise<SCTagType>
Parameters
| Parameter | Type |
|---|---|
config? | AxiosRequestConfig |
Returns
Promise<SCTagType>
userUpdate()
userUpdate(
id,data?,config?):Promise<SCUserType>
Parameters
| Parameter | Type |
|---|---|
id | string | number |
data? | SCUserType |
config? | AxiosRequestConfig |
Returns
Promise<SCUserType>