UserService

User service can be used in the following way:

1. Import the service from our library:

import {UserService} from "@selfcommunity/api-services";

2. Create a function and put the service inside it!
The async function `getAllUsers` will return the paginated list of users.

async getAllUsers() {
       return await UserService.getAllUsers();
     }

In case of required `params`, just add them inside the brackets.

async getSpecificUser(userId) {
      return await UserService.getSpecificUser(userId);
     }

If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).

Ex: If the async function `userUpdate`  is willing to update the avatar or the cover the 'Content-Type' request header must be set as 'multipart/form-data'.

async getSpecificUser(userId, data, config) {
const headers = {headers: {'Content-Type': 'multipart/form-data'}}
      return await UserService.getSpecificUser(userId, {avatar: avatar}, headers);
     }

Constructors

Constructor

new UserService(): UserService

Returns

UserService

Methods

addUserAvatar()

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

Parameters

Parameter	Type
data	FormData
config?	AxiosRequestConfig

Returns

Promise<SCAvatarType>

---

changeUserMail()

static 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()

static 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()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCUserConnectionStatusType>

---

checkUserEmailToken()

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

Parameters

Parameter	Type
id	string | number
email_token	any
config?	AxiosRequestConfig

Returns

Promise<SCUserEmailTokenType>

---

checkUserFollowed()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCUserFollowedStatusType>

---

checkUserFollower()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCUserFollowerStatusType>

---

checkUserHidden()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCUserHiddenStatusType>

---

checkUserHiddenBy()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCUserHiddenByStatusType>

---

confirmChangeUserMail()

static 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()

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

Parameters

Parameter	Type
data	SCUserProviderAssociationType
config?	AxiosRequestConfig

Returns

Promise<SCUserProviderAssociationType>

---

deleteProviderAssociation()

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

Parameters

Parameter	Type
data	DeleteProviderAssociation
config?	AxiosRequestConfig

Returns

Promise<any>

---

followUser()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

getAllUsers()

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

Parameters

Parameter	Type
params?	any
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getCurrentUser()

static getCurrentUser(config?): Promise<SCUserType>

Parameters

Parameter	Type
config?	AxiosRequestConfig

Returns

Promise<SCUserType>

---

getCurrentUserAvatar()

static getCurrentUserAvatar(config?): Promise<SCUserAvatarType>

Parameters

Parameter	Type
config?	AxiosRequestConfig

Returns

Promise<SCUserAvatarType>

---

getCurrentUserPermission()

static getCurrentUserPermission(config?): Promise<SCUserPermissionType>

Parameters

Parameter	Type
config?	AxiosRequestConfig

Returns

Promise<SCUserPermissionType>

---

getCurrentUserPlatform()

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

Parameters

Parameter	Type
next?	string
config?	AxiosRequestConfig

Returns

Promise<SCPlatformType>

---

getHiddenUsers()

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

Parameters

Parameter	Type
params?	any
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getHiddenUsersId()

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

Parameters

Parameter	Type
params?	any
config?	AxiosRequestConfig

Returns

Promise<number[]>

---

getProviderAssociations()

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

Parameters

Parameter	Type
userId	string | number
config?	AxiosRequestConfig

Returns

Promise<SCUserProviderAssociationType[]>

---

getSpecificUser()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCUserType>

---

getUserAvatars()

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

Parameters

Parameter	Type
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCAvatarType>>

---

getUserConnectionRequests()

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

Parameters

Parameter	Type
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserConnectionRequestType>>

---

getUserConnections()

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

Parameters

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

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getUserConnectionStatuses()

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

Parameters

Parameter	Type
users	number[]
config?	AxiosRequestConfig

Returns

Promise<any>

---

getUserCounters()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCUserCounterType>

---

getUserFeed()

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

Parameters

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

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>

---

getUserFollowedCategories()

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

Parameters

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

Returns

Promise<SCCategoryType[]>

---

getUserFollowers()

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

Parameters

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

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getUserFollowings()

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

Parameters

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

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getUserLiveStream()

static getUserLiveStream(id, params?, config?): Promise<SCPaginatedResponse<SCLiveStreamType>>

Parameters

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

Returns

Promise<SCPaginatedResponse<SCLiveStreamType>>

---

getUserLoyaltyPoints()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCUserLoyaltyPointsType>

---

getUserRequestConnectionsSent()

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

Parameters

Parameter	Type
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserConnectionRequestType>>

---

removeUserAvatar()

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

Parameters

Parameter	Type
avatar_id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

setUserPrimaryAvatar()

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

Parameters

Parameter	Type
avatar_id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

showHideUser()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

userAcceptRequestConnection()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

userAutocomplete()

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

Parameters

Parameter	Type
params	UserAutocompleteParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserAutocompleteType>>

---

userCancelRejectConnectionRequest()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

userCancelRequestConnection()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

userDelete()

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

Parameters

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

Returns

Promise<any>

---

userMarkSeenConnectionRequest()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

userPatch()

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

Parameters

Parameter	Type
id	string | number
data?	SCUserType
config?	AxiosRequestConfig

Returns

Promise<SCUserType>

---

userRejectConnectionRequest()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

userRemoveConnection()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

userRequestConnection()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

userSearch()

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

Parameters

Parameter	Type
params	UserSearchParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

userSettings()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCUserSettingsType>

---

userSettingsPatch()

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

Parameters

Parameter	Type
id	string | number
data?	SCUserSettingsType
config?	AxiosRequestConfig

Returns

Promise<SCUserSettingsType>

---

userTagToAddressContribution()

static userTagToAddressContribution(config?): Promise<SCTagType>

Parameters

Parameter	Type
config?	AxiosRequestConfig

Returns

Promise<SCTagType>

---

userUpdate()

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

Parameters

Parameter	Type
id	string | number
data?	SCUserType
config?	AxiosRequestConfig

Returns

Promise<SCUserType>