ModerationApiClient

Contains all the endpoints needed to manage moderation.

Constructors

Constructor

new ModerationApiClient(): ModerationApiClient

Returns

ModerationApiClient

Methods

getAllFlaggedContributions()

static getAllFlaggedContributions(params?, config?): Promise<SCPaginatedResponse<SCFlaggedContributionType>>

This endpoint retrieves all flagged contributions.

Parameters

Parameter	Type	Description
params?	FlaggedContributionParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFlaggedContributionType>>

---

getAllFlagsForSpecificContribution()

static getAllFlagsForSpecificContribution(id, contribution_type, flag_type?, config?): Promise<SCPaginatedResponse<SCFlagType>>

This endpoint retrieves all flags for a specific contribution.

Parameters

Parameter	Type	Description
id	string | number
contribution_type	SCContributionType
flag_type?	SCFlagTypeEnum
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCFlagType>>

---

getContributionModerationStatus()

static getContributionModerationStatus(id, contribution_type, config?): Promise<SCContributionStatus>

This endpoint retrieves moderation status for a specific contribution.

Parameters

Parameter	Type	Description
id	string | number
contribution_type	SCContributionType
config?	AxiosRequestConfig

Returns

Promise<SCContributionStatus>

---

getUsersForModeration()

static getUsersForModeration(params?, config?): Promise<SCPaginatedResponse<SCUserModerationType>>

This endpoint retrieves all users for moderation purpose.

Parameters

Parameter	Type	Description
params?	ModerationParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserModerationType>>

---

moderateAContribution()

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

This endpoint provides actions for flagged contributions moderation.

Parameters

Parameter	Type	Description
id	string | number
data	ModerateContributionParams
config?	AxiosRequestConfig

Returns

Promise<any>

---

moderateASpecificUser()

static moderateASpecificUser(id, status, days_blocked?, hard?, config?): Promise<any>

This endpoint performs users moderation.

Parameters

Parameter	Type	Description
id	string | number
status	SCUserStatus
days_blocked?	string
hard?	number
config?	AxiosRequestConfig

Returns

Promise<any>