Class: ModerationApiClient
services/moderation.ModerationApiClient
Contains all the endpoints needed to manage moderation.
Constructors
constructor
• new ModerationApiClient(): ModerationApiClient
Returns
Methods
getAllFlaggedContributions
▸ getAllFlaggedContributions(params?, config?): Promise<SCPaginatedResponse<SCFlaggedContributionType>>
This endpoint retrieves all flagged contributions.
Parameters
| Name | Type |
|---|---|
params? | FlaggedContributionParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCFlaggedContributionType>>
Defined in
services/moderation/index.ts:73
getAllFlagsForSpecificContribution
▸ getAllFlagsForSpecificContribution(id, contribution_type, flag_type?, config?): Promise<SCPaginatedResponse<SCFlagType>>
This endpoint retrieves all flags for a specific contribution.
Parameters
| Name | Type |
|---|---|
id | string | number |
contribution_type | SCContributionType |
flag_type? | SCFlagTypeEnum |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCFlagType>>
Defined in
services/moderation/index.ts:88
getContributionModerationStatus
▸ getContributionModerationStatus(id, contribution_type, config?): Promise<SCContributionStatus>
This endpoint retrieves moderation status for a specific contribution.
Parameters
| Name | Type |
|---|---|
id | string | number |
contribution_type | SCContributionType |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCContributionStatus>
Defined in
services/moderation/index.ts:120
getUsersForModeration
▸ getUsersForModeration(params?, config?): Promise<SCPaginatedResponse<SCUserModerationType>>
This endpoint retrieves all users for moderation purpose.
Parameters
| Name | Type |
|---|---|
params? | ModerationParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCUserModerationType>>
Defined in
services/moderation/index.ts:39
moderateAContribution
▸ moderateAContribution(id, data, config?): Promise<any>
This endpoint provides actions for flagged contributions moderation.
Parameters
| Name | Type |
|---|---|
id | string | number |
data | ModerateContributionParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>
Defined in
services/moderation/index.ts:110
moderateASpecificUser
▸ moderateASpecificUser(id, status, days_blocked?, hard?, config?): Promise<any>
This endpoint performs users moderation.
Parameters
| Name | Type |
|---|---|
id | string | number |
status | SCUserStatus |
days_blocked? | string |
hard? | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<any>