Class: UserService

services/user.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

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

Parameters

Name	Type
data	FormData
config?	AxiosRequestConfig<any>

Returns

Promise<SCAvatarType>

Defined in

services/user/index.ts:832

---

changeUserMail

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:714

---

changeUserPassword

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:726

---

checkUserConnections

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

Parameters

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

Returns

Promise<SCUserConnectionStatusType>

Defined in

services/user/index.ts:775

---

checkUserEmailToken

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

Parameters

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

Returns

Promise<SCUserEmailTokenType>

Defined in

services/user/index.ts:829

---

checkUserFollowed

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

Parameters

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

Returns

Promise<SCUserFollowedStatusType>

Defined in

services/user/index.ts:762

---

checkUserFollower

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

Parameters

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

Returns

Promise<SCUserFollowerStatusType>

Defined in

services/user/index.ts:765

---

checkUserHidden

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

Parameters

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

Returns

Promise<SCUserHiddenStatusType>

Defined in

services/user/index.ts:814

---

checkUserHiddenBy

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

Parameters

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

Returns

Promise<SCUserHiddenByStatusType>

Defined in

services/user/index.ts:817

---

confirmChangeUserMail

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:723

---

createProviderAssociation

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

Parameters

Name	Type
data	SCUserProviderAssociationType
config?	AxiosRequestConfig<any>

Returns

Promise<SCUserProviderAssociationType>

Defined in

services/user/index.ts:847

---

deleteProviderAssociation

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

Parameters

Name	Type
data	DeleteProviderAssociation
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Defined in

services/user/index.ts:850

---

followUser

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:759

---

getAllUsers

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

Parameters

Name	Type
params?	any
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCUserType>>

Defined in

services/user/index.ts:684

---

getCurrentUser

▸ getCurrentUser(config?): Promise<SCUserType>

Parameters

Name	Type
config?	AxiosRequestConfig<any>

Returns

Promise<SCUserType>

Defined in

services/user/index.ts:735

---

getCurrentUserAvatar

▸ getCurrentUserAvatar(config?): Promise<SCUserAvatarType>

Parameters

Name	Type
config?	AxiosRequestConfig<any>

Returns

Promise<SCUserAvatarType>

Defined in

services/user/index.ts:738

---

getCurrentUserPermission

▸ getCurrentUserPermission(config?): Promise<SCUserPermissionType>

Parameters

Name	Type
config?	AxiosRequestConfig<any>

Returns

Promise<SCUserPermissionType>

Defined in

services/user/index.ts:741

---

getCurrentUserPlatform

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

Parameters

Name	Type
next?	string
config?	AxiosRequestConfig<any>

Returns

Promise<SCPlatformType>

Defined in

services/user/index.ts:744

---

getHiddenUsers

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

Parameters

Name	Type
params?	any
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCUserType>>

Defined in

services/user/index.ts:687

---

getHiddenUsersId

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

Parameters

Name	Type
params?	any
config?	AxiosRequestConfig<any>

Returns

Promise<number[]>

Defined in

services/user/index.ts:690

---

getProviderAssociations

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

Parameters

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

Returns

Promise<SCUserProviderAssociationType[]>

Defined in

services/user/index.ts:844

---

getSpecificUser

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

Parameters

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

Returns

Promise<SCUserType>

Defined in

services/user/index.ts:699

---

getUserAvatars

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

Parameters

Name	Type
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCAvatarType>>

Defined in

services/user/index.ts:835

---

getUserConnectionRequests

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

Parameters

Name	Type
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCUserConnectionRequestType>>

Defined in

services/user/index.ts:778

---

getUserConnectionStatuses

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:823

---

getUserConnections

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

Parameters

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

Returns

Promise<SCPaginatedResponse<SCUserType>>

Defined in

services/user/index.ts:768

---

getUserCounters

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

Parameters

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

Returns

Promise<SCUserCounterType>

Defined in

services/user/index.ts:702

---

getUserFeed

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

Parameters

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

Returns

Promise<SCPaginatedResponse<SCFeedUnitType>>

Defined in

services/user/index.ts:750

---

getUserFollowedCategories

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

Parameters

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

Returns

Promise<SCCategoryType[]>

Defined in

services/user/index.ts:747

---

getUserFollowers

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

Parameters

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

Returns

Promise<SCPaginatedResponse<SCUserType>>

Defined in

services/user/index.ts:753

---

getUserFollowings

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

Parameters

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

Returns

Promise<SCPaginatedResponse<SCUserType>>

Defined in

services/user/index.ts:756

---

getUserLoyaltyPoints

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

Parameters

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

Returns

Promise<SCUserLoyaltyPointsType>

Defined in

services/user/index.ts:820

---

getUserRequestConnectionsSent

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

Parameters

Name	Type
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCUserConnectionRequestType>>

Defined in

services/user/index.ts:784

---

removeUserAvatar

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:838

---

setUserPrimaryAvatar

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:841

---

showHideUser

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:811

---

userAcceptRequestConnection

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:790

---

userAutocomplete

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

Parameters

Name	Type
params	UserAutocompleteParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCUserAutocompleteType>>

Defined in

services/user/index.ts:693

---

userCancelRejectConnectionRequest

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:799

---

userCancelRequestConnection

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:802

---

userDelete

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:711

---

userMarkSeenConnectionRequest

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:808

---

userPatch

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

Parameters

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

Returns

Promise<SCUserType>

Defined in

services/user/index.ts:708

---

userRejectConnectionRequest

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:805

---

userRemoveConnection

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:796

---

userRequestConnection

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

Parameters

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

Returns

Promise<any>

Defined in

services/user/index.ts:793

---

userSearch

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

Parameters

Name	Type
params	UserSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise<SCPaginatedResponse<SCUserType>>

Defined in

services/user/index.ts:696

---

userSettings

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

Parameters

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

Returns

Promise<SCUserSettingsType>

Defined in

services/user/index.ts:729

---

userSettingsPatch

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

Parameters

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

Returns

Promise<SCUserSettingsType>

Defined in

services/user/index.ts:732

---

userTagToAddressContribution

▸ userTagToAddressContribution(config?): Promise<SCTagType>

Parameters

Name	Type
config?	AxiosRequestConfig<any>

Returns

Promise<SCTagType>

Defined in

services/user/index.ts:826

---

userUpdate

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

Parameters

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

Returns

Promise<SCUserType>

Defined in

services/user/index.ts:705