symbols:
# region models
'RestapiActionApiRequest@jv.reporting.mod':
id: 'RestapiActionApiRequest@jv.reporting.mod'
name: 'RestapiActionApiRequest'
type: 'model'
fields:
'actionId':
type: 'String'
required: true
description: |-
Auto mod action ID
'actionName':
type: 'String'
required: true
description: |-
Auto mod action display name
'eventName':
type: 'String'
required: true
description: |-
Kafka publish event name
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiActionApiRequest.java'
'RestapiActionApiResponse@jv.reporting.mod':
id: 'RestapiActionApiResponse@jv.reporting.mod'
name: 'RestapiActionApiResponse'
type: 'model'
fields:
'actionId':
type: 'String'
required: true
'actionName':
type: 'String'
required: true
'eventName':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiActionApiResponse.java'
'RestapiActionListApiResponse@jv.reporting.mod':
id: 'RestapiActionListApiResponse@jv.reporting.mod'
name: 'RestapiActionListApiResponse'
type: 'model'
fields:
'data':
type: 'List<RestapiActionApiResponse>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiActionListApiResponse.java'
'RestapiAdminAllReasonsResponse@jv.reporting.mod':
id: 'RestapiAdminAllReasonsResponse@jv.reporting.mod'
name: 'RestapiAdminAllReasonsResponse'
type: 'model'
fields:
'data':
type: 'List<RestapiPublicReasonResponse>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiAdminAllReasonsResponse.java'
'RestapiAdminReasonListResponse@jv.reporting.mod':
id: 'RestapiAdminReasonListResponse@jv.reporting.mod'
name: 'RestapiAdminReasonListResponse'
type: 'model'
fields:
'data':
type: 'List<RestapiAdminReasonResponse>'
required: true
'paging':
type: 'RestapiPagination'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiAdminReasonListResponse.java'
'RestapiAdminReasonResponse@jv.reporting.mod':
id: 'RestapiAdminReasonResponse@jv.reporting.mod'
name: 'RestapiAdminReasonResponse'
type: 'model'
fields:
'createdAt':
type: 'String'
required: true
'description':
type: 'String'
required: true
'id':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
'title':
type: 'String'
required: true
'updatedAt':
type: 'String'
required: true
'groups':
type: 'List<RestapiPublicReasonGroupResponse>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiAdminReasonResponse.java'
'RestapiBanAccountActionRequest@jv.reporting.mod':
id: 'RestapiBanAccountActionRequest@jv.reporting.mod'
name: 'RestapiBanAccountActionRequest'
type: 'model'
fields:
'duration':
type: 'Integer'
required: true
description: |-
Ban duration in minutes, -1 means unlimited duration
'reason':
type: 'String'
required: true
description: |-
Ban reason
'skipNotif':
type: 'Boolean'
required: true
description: |-
Skip notification for banned user (e.g. email notification)
'type':
type: 'String'
required: true
description: |-
Ban type
'comment':
type: 'String'
required: false
description: |-
Ban comment
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiBanAccountActionRequest.java'
'RestapiBanAccountActionResponse@jv.reporting.mod':
id: 'RestapiBanAccountActionResponse@jv.reporting.mod'
name: 'RestapiBanAccountActionResponse'
type: 'model'
fields:
'duration':
type: 'Integer'
required: true
description: |-
Ban duration in minutes, -1 means unlimited duration
'reason':
type: 'String'
required: true
description: |-
Ban reason
'skipNotif':
type: 'Boolean'
required: true
description: |-
Skip notification for banned user (e.g. email notification)
'type':
type: 'String'
required: true
description: |-
Ban type
'comment':
type: 'String'
required: false
description: |-
Ban comment
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiBanAccountActionResponse.java'
'RestapiCategoryLimit@jv.reporting.mod':
id: 'RestapiCategoryLimit@jv.reporting.mod'
name: 'RestapiCategoryLimit'
type: 'model'
fields:
'maxReportPerTicket':
type: 'Integer'
required: true
description: |-
must between 1 to 2147483647
'name':
type: 'String'
required: true
'extensionCategory':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiCategoryLimit.java'
'RestapiConfigResponse@jv.reporting.mod':
id: 'RestapiConfigResponse@jv.reporting.mod'
name: 'RestapiConfigResponse'
type: 'model'
fields:
'namespace':
type: 'String'
required: true
'reportingLimit':
type: 'RestapiReportingLimit'
required: true
'updatedAt':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiConfigResponse.java'
'RestapiCreateReasonGroupRequest@jv.reporting.mod':
id: 'RestapiCreateReasonGroupRequest@jv.reporting.mod'
name: 'RestapiCreateReasonGroupRequest'
type: 'model'
fields:
'title':
type: 'String'
required: true
description: |-
max 256 chars
'reasonIds':
type: 'List<String>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiCreateReasonGroupRequest.java'
'RestapiCreateReasonRequest@jv.reporting.mod':
id: 'RestapiCreateReasonRequest@jv.reporting.mod'
name: 'RestapiCreateReasonRequest'
type: 'model'
fields:
'description':
type: 'String'
required: true
description: |-
max 280 chars
'groupIds':
type: 'List<String>'
required: true
'title':
type: 'String'
required: true
description: |-
max 256 chars
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiCreateReasonRequest.java'
'RestapiErrorResponse@jv.reporting.mod':
id: 'RestapiErrorResponse@jv.reporting.mod'
name: 'RestapiErrorResponse'
type: 'model'
fields:
'errorCode':
type: 'Integer'
required: true
'errorMessage':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiErrorResponse.java'
'RestapiExtensionCategoryApiRequest@jv.reporting.mod':
id: 'RestapiExtensionCategoryApiRequest@jv.reporting.mod'
name: 'RestapiExtensionCategoryApiRequest'
type: 'model'
fields:
'extensionCategory':
type: 'String'
required: true
description: |-
Report extension category, consist of custom services sub-category (eg. salesItem,challenge,etc)
'extensionCategoryName':
type: 'String'
required: true
description: |-
Report extension category display name)
'serviceSource':
type: 'String'
required: true
description: |-
Extension category service source (eg. service source 'marketplace' for extension category 'salesItem')
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiExtensionCategoryApiRequest.java'
'RestapiExtensionCategoryApiResponse@jv.reporting.mod':
id: 'RestapiExtensionCategoryApiResponse@jv.reporting.mod'
name: 'RestapiExtensionCategoryApiResponse'
type: 'model'
fields:
'extensionCategory':
type: 'String'
required: true
'extensionCategoryName':
type: 'String'
required: true
'serviceSource':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiExtensionCategoryApiResponse.java'
'RestapiExtensionCategoryListApiResponse@jv.reporting.mod':
id: 'RestapiExtensionCategoryListApiResponse@jv.reporting.mod'
name: 'RestapiExtensionCategoryListApiResponse'
type: 'model'
fields:
'data':
type: 'List<RestapiExtensionCategoryApiResponse>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiExtensionCategoryListApiResponse.java'
'RestapiModerationRuleActionsRequest@jv.reporting.mod':
id: 'RestapiModerationRuleActionsRequest@jv.reporting.mod'
name: 'RestapiModerationRuleActionsRequest'
type: 'model'
fields:
'banAccount':
type: 'RestapiBanAccountActionRequest'
required: false
description: |-
Ban account action configuration
'deleteChat':
type: 'Boolean'
required: false
description: |-
Enable delete chat action
'extensionActionIds':
type: 'List<String>'
required: false
description: |-
Custom services moderation actions
'hideContent':
type: 'Boolean'
required: false
description: |-
Enable hide content action
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiModerationRuleActionsRequest.java'
'RestapiModerationRuleActionsResponse@jv.reporting.mod':
id: 'RestapiModerationRuleActionsResponse@jv.reporting.mod'
name: 'RestapiModerationRuleActionsResponse'
type: 'model'
fields:
'banAccount':
type: 'RestapiBanAccountActionResponse'
required: false
description: |-
Ban account action configuration
'deleteChat':
type: 'Boolean'
required: false
description: |-
Enable delete chat action
'extensionActionIds':
type: 'List<String>'
required: false
description: |-
custom service mod actions
'hideContent':
type: 'Boolean'
required: false
description: |-
Enable hide content action
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiModerationRuleActionsResponse.java'
'RestapiModerationRuleActiveRequest@jv.reporting.mod':
id: 'RestapiModerationRuleActiveRequest@jv.reporting.mod'
name: 'RestapiModerationRuleActiveRequest'
type: 'model'
fields:
'active':
type: 'Boolean'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiModerationRuleActiveRequest.java'
'RestapiModerationRuleRequest@jv.reporting.mod':
id: 'RestapiModerationRuleRequest@jv.reporting.mod'
name: 'RestapiModerationRuleRequest'
type: 'model'
fields:
'active':
type: 'Boolean'
required: true
description: |-
status of this rule
'category':
type: 'String'
required: true
description: |-
Report category, must select from pre defined list
'reason':
type: 'String'
required: true
description: |-
Reason of report, can select from pre defined list, max 128 chars
'threshold':
type: 'Integer'
required: true
description: |-
the threshold to trigger auto moderation
'action':
type: 'String'
required: false
description: |-
GOING TO DEPRECATE, PLEASE DO NOT USE, for replacement use the "actions" field
'actions':
type: 'RestapiModerationRuleActionsRequest'
required: false
description: |-
Action configurations for moderation rule
'extensionCategory':
type: 'String'
required: false
description: |-
Report extension category, consist of custom services sub-category (eg. salesItem,challenge,etc)
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiModerationRuleRequest.java'
'RestapiModerationRuleResponse@jv.reporting.mod':
id: 'RestapiModerationRuleResponse@jv.reporting.mod'
name: 'RestapiModerationRuleResponse'
type: 'model'
fields:
'actions':
type: 'RestapiModerationRuleActionsResponse'
required: true
description: |-
Action configurations for moderation rule
'active':
type: 'Boolean'
required: true
'category':
type: 'String'
required: true
'createdAt':
type: 'String'
required: true
'id':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
'reason':
type: 'String'
required: true
'threshold':
type: 'Integer'
required: true
'action':
type: 'String'
required: false
description: |-
GOING TO DEPRECATE, PLEASE DO NOT USE, for replacement use the "actions" field
'extensionCategory':
type: 'String'
required: false
'updatedAt':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiModerationRuleResponse.java'
'RestapiModerationRulesList@jv.reporting.mod':
id: 'RestapiModerationRulesList@jv.reporting.mod'
name: 'RestapiModerationRulesList'
type: 'model'
fields:
'data':
type: 'List<RestapiModerationRuleResponse>'
required: true
'paging':
type: 'RestapiPagination'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiModerationRulesList.java'
'RestapiPagination@jv.reporting.mod':
id: 'RestapiPagination@jv.reporting.mod'
name: 'RestapiPagination'
type: 'model'
fields:
'first':
type: 'String'
required: true
'last':
type: 'String'
required: true
'next':
type: 'String'
required: true
'previous':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiPagination.java'
'RestapiPublicReasonGroupResponse@jv.reporting.mod':
id: 'RestapiPublicReasonGroupResponse@jv.reporting.mod'
name: 'RestapiPublicReasonGroupResponse'
type: 'model'
fields:
'id':
type: 'String'
required: true
'title':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiPublicReasonGroupResponse.java'
'RestapiPublicReasonListResponse@jv.reporting.mod':
id: 'RestapiPublicReasonListResponse@jv.reporting.mod'
name: 'RestapiPublicReasonListResponse'
type: 'model'
fields:
'data':
type: 'List<RestapiPublicReasonResponse>'
required: true
'paging':
type: 'RestapiPagination'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiPublicReasonListResponse.java'
'RestapiPublicReasonResponse@jv.reporting.mod':
id: 'RestapiPublicReasonResponse@jv.reporting.mod'
name: 'RestapiPublicReasonResponse'
type: 'model'
fields:
'description':
type: 'String'
required: true
'title':
type: 'String'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiPublicReasonResponse.java'
'RestapiReasonGroupListResponse@jv.reporting.mod':
id: 'RestapiReasonGroupListResponse@jv.reporting.mod'
name: 'RestapiReasonGroupListResponse'
type: 'model'
fields:
'data':
type: 'List<RestapiPublicReasonGroupResponse>'
required: true
'paging':
type: 'RestapiPagination'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiReasonGroupListResponse.java'
'RestapiReasonGroupResponse@jv.reporting.mod':
id: 'RestapiReasonGroupResponse@jv.reporting.mod'
name: 'RestapiReasonGroupResponse'
type: 'model'
fields:
'id':
type: 'String'
required: true
'title':
type: 'String'
required: true
'reasons':
type: 'List<RestapiAdminReasonResponse>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiReasonGroupResponse.java'
'RestapiReportingLimit@jv.reporting.mod':
id: 'RestapiReportingLimit@jv.reporting.mod'
name: 'RestapiReportingLimit'
type: 'model'
fields:
'categoryLimits':
type: 'List<RestapiCategoryLimit>'
required: true
'timeInterval':
type: 'Long'
required: true
description: |-
the unit is nanoseconds, must between 1 to 6000000 seconds
'userMaxReportPerTimeInterval':
type: 'Integer'
required: true
description: |-
must between 1 to 2147483647
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiReportingLimit.java'
'RestapiReportListResponse@jv.reporting.mod':
id: 'RestapiReportListResponse@jv.reporting.mod'
name: 'RestapiReportListResponse'
type: 'model'
fields:
'data':
type: 'List<RestapiReportResponse>'
required: true
'paging':
type: 'RestapiPagination'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiReportListResponse.java'
'RestapiReportResponse@jv.reporting.mod':
id: 'RestapiReportResponse@jv.reporting.mod'
name: 'RestapiReportResponse'
type: 'model'
fields:
'additionalInfo':
type: 'Map<String, ?>'
required: true
'category':
type: 'String'
required: true
'comment':
type: 'String'
required: true
'createdAt':
type: 'String'
required: true
'id':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
'objectId':
type: 'String'
required: true
'objectType':
type: 'String'
required: true
'reason':
type: 'String'
required: true
'reporterId':
type: 'String'
required: true
'ticketId':
type: 'String'
required: true
'updatedAt':
type: 'String'
required: true
'userId':
type: 'String'
required: true
'extensionCategory':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiReportResponse.java'
'RestapiSubmitReportRequest@jv.reporting.mod':
id: 'RestapiSubmitReportRequest@jv.reporting.mod'
name: 'RestapiSubmitReportRequest'
type: 'model'
fields:
'category':
type: 'String'
required: true
description: |-
Report category, must select from pre defined list
'reason':
type: 'String'
required: true
description: |-
Reason of report, can select from pre defined list, max 128 chars
'userId':
type: 'String'
required: true
description: |-
User ID being reported, in UUID4 format
'additionalInfo':
type: 'Map<String, ?>'
required: false
description: |-
Additional info regarding reported user / content, JSON formatted
'comment':
type: 'String'
required: false
description: |-
Additional comment if any, max 280 chars
'extensionCategory':
type: 'String'
required: false
description: |-
Report extension category, must select from pre defined list
'objectId':
type: 'String'
required: false
description: |-
ID of content being reported, uuid4WithoutHyphens. Required for UGC category
'objectType':
type: 'String'
required: false
description: |-
Type of content being reported, max 64 chars. Required for UGC category
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiSubmitReportRequest.java'
'RestapiSubmitReportResponse@jv.reporting.mod':
id: 'RestapiSubmitReportResponse@jv.reporting.mod'
name: 'RestapiSubmitReportResponse'
type: 'model'
fields:
'category':
type: 'String'
required: true
'createdAt':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
'objectId':
type: 'String'
required: true
'objectType':
type: 'String'
required: true
'status':
type: 'String'
required: true
'ticketId':
type: 'String'
required: true
'updatedAt':
type: 'String'
required: true
'userId':
type: 'String'
required: true
'extensionCategory':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiSubmitReportResponse.java'
'RestapiTicketListResponse@jv.reporting.mod':
id: 'RestapiTicketListResponse@jv.reporting.mod'
name: 'RestapiTicketListResponse'
type: 'model'
fields:
'data':
type: 'List<RestapiTicketResponse>'
required: true
'paging':
type: 'RestapiPagination'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiTicketListResponse.java'
'RestapiTicketResponse@jv.reporting.mod':
id: 'RestapiTicketResponse@jv.reporting.mod'
name: 'RestapiTicketResponse'
type: 'model'
fields:
'category':
type: 'String'
required: true
'createdAt':
type: 'String'
required: true
'id':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
'notes':
type: 'String'
required: true
'objectId':
type: 'String'
required: true
'objectType':
type: 'String'
required: true
'reportsCount':
type: 'Integer'
required: true
'status':
type: 'String'
required: true
'updatedAt':
type: 'String'
required: true
'userId':
type: 'String'
required: true
'extensionCategory':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiTicketResponse.java'
'RestapiTicketStatisticResponse@jv.reporting.mod':
id: 'RestapiTicketStatisticResponse@jv.reporting.mod'
name: 'RestapiTicketStatisticResponse'
type: 'model'
fields:
'moderatedCount':
type: 'Long'
required: true
'openCount':
type: 'Long'
required: true
'totalCount':
type: 'Long'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiTicketStatisticResponse.java'
'RestapiUnusedReasonListResponse@jv.reporting.mod':
id: 'RestapiUnusedReasonListResponse@jv.reporting.mod'
name: 'RestapiUnusedReasonListResponse'
type: 'model'
fields:
'reasons':
type: 'List<RestapiPublicReasonResponse>'
required: true
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiUnusedReasonListResponse.java'
'RestapiUpdateReasonGroupRequest@jv.reporting.mod':
id: 'RestapiUpdateReasonGroupRequest@jv.reporting.mod'
name: 'RestapiUpdateReasonGroupRequest'
type: 'model'
fields:
'title':
type: 'String'
required: true
description: |-
max 256 chars
'reasonIds':
type: 'List<String>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiUpdateReasonGroupRequest.java'
'RestapiUpdateTicketResolutionsRequest@jv.reporting.mod':
id: 'RestapiUpdateTicketResolutionsRequest@jv.reporting.mod'
name: 'RestapiUpdateTicketResolutionsRequest'
type: 'model'
fields:
'notes':
type: 'String'
required: true
description: |-
Info regarding the resolution status, max 280 chars
'status':
type: 'String'
required: true
description: |-
Ticket status is open, closed, auto moderated
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/models/RestapiUpdateTicketResolutionsRequest.java'
# endregion models
# region functions
'AdminCreateExtensionCategory@jv.reporting.fun':
id: 'AdminCreateExtensionCategory@jv.reporting.fun'
name: 'AdminCreateExtensionCategory'
type: 'function'
description: |-
Create extension category data
arguments:
'body':
type: 'RestapiExtensionCategoryApiRequest'
required: true
return_type: 'RestapiExtensionCategoryApiResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_extension_categories_and_auto_moderation_actions.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminExtensionCategoriesAndAutoModerationActions.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_extension_categories_and_auto_moderation_actions/AdminCreateExtensionCategory.java'
example: |-
try {
final AdminCreateExtensionCategory operation = AdminCreateExtensionCategory.builder()
.build(
body,
);
final AdminExtensionCategoriesAndAutoModerationActions wrapper = new AdminExtensionCategoriesAndAutoModerationActions(sdk);
final RestapiExtensionCategoryApiResponse response = wrapper.adminCreateExtensionCategory(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'actions'
- 'admin'
- 'and'
- 'auto'
- 'categories'
- 'category'
- 'create'
- 'extension'
- 'moderation'
permissions:
- 'ADMIN:REPORTINGCONFIG [CREATE]'
'AdminCreateModAction@jv.reporting.fun':
id: 'AdminCreateModAction@jv.reporting.fun'
name: 'AdminCreateModAction'
type: 'function'
description: |-
Create auto moderation action
arguments:
'body':
type: 'RestapiActionApiRequest'
required: true
return_type: 'RestapiActionApiResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_extension_categories_and_auto_moderation_actions.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminExtensionCategoriesAndAutoModerationActions.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_extension_categories_and_auto_moderation_actions/AdminCreateModAction.java'
example: |-
try {
final AdminCreateModAction operation = AdminCreateModAction.builder()
.build(
body,
);
final AdminExtensionCategoriesAndAutoModerationActions wrapper = new AdminExtensionCategoriesAndAutoModerationActions(sdk);
final RestapiActionApiResponse response = wrapper.adminCreateModAction(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'action'
- 'actions'
- 'admin'
- 'and'
- 'auto'
- 'categories'
- 'create'
- 'extension'
- 'mod'
- 'moderation'
permissions:
- 'ADMIN:REPORTINGCONFIG [CREATE]'
'AdminFindActionList@jv.reporting.fun':
id: 'AdminFindActionList@jv.reporting.fun'
name: 'AdminFindActionList'
type: 'function'
description: |-
Get a list of auto moderation actions
return_type: 'RestapiActionListApiResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_extension_categories_and_auto_moderation_actions.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminExtensionCategoriesAndAutoModerationActions.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_extension_categories_and_auto_moderation_actions/AdminFindActionList.java'
example: |-
try {
final AdminFindActionList operation = AdminFindActionList.builder()
.build();
final AdminExtensionCategoriesAndAutoModerationActions wrapper = new AdminExtensionCategoriesAndAutoModerationActions(sdk);
final RestapiActionListApiResponse response = wrapper.adminFindActionList(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'action'
- 'actions'
- 'admin'
- 'and'
- 'auto'
- 'categories'
- 'extension'
- 'find'
- 'list'
- 'moderation'
permissions:
- 'ADMIN:REPORTINGCONFIG [READ]'
'AdminFindExtensionCategoryList@jv.reporting.fun':
id: 'AdminFindExtensionCategoryList@jv.reporting.fun'
name: 'AdminFindExtensionCategoryList'
type: 'function'
description: |-
Get a list of extension category data with the specified name
arguments:
'order':
type: 'String'
required: false
description: |-
data order, asc or desc (default: asc)
'sortBy':
type: 'String'
required: false
description: |-
data order key, valid key : 'extensionCategory', and 'extensionCategoryName'
return_type: 'RestapiExtensionCategoryListApiResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_extension_categories_and_auto_moderation_actions.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminExtensionCategoriesAndAutoModerationActions.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_extension_categories_and_auto_moderation_actions/AdminFindExtensionCategoryList.java'
example: |-
try {
final AdminFindExtensionCategoryList operation = AdminFindExtensionCategoryList.builder()
.order(...)
.sortBy(...)
.build();
final AdminExtensionCategoriesAndAutoModerationActions wrapper = new AdminExtensionCategoriesAndAutoModerationActions(sdk);
final RestapiExtensionCategoryListApiResponse response = wrapper.adminFindExtensionCategoryList(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'actions'
- 'admin'
- 'and'
- 'auto'
- 'categories'
- 'category'
- 'extension'
- 'find'
- 'list'
- 'moderation'
permissions:
- 'ADMIN:REPORTINGCONFIG [READ]'
'AdminGetAllReasons@jv.reporting.fun':
id: 'AdminGetAllReasons@jv.reporting.fun'
name: 'AdminGetAllReasons'
type: 'function'
description: |-
This endpoint get all reasons without pagination.
arguments:
'namespace':
type: 'String'
required: true
return_type: 'RestapiAdminAllReasonsResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_reasons.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminReasons.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_reasons/AdminGetAllReasons.java'
example: |-
try {
final AdminGetAllReasons operation = AdminGetAllReasons.builder()
.build(
namespace,
);
final AdminReasons wrapper = new AdminReasons(sdk);
final RestapiAdminAllReasonsResponse response = wrapper.adminGetAllReasons(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'all'
- 'get'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'AdminGetReason@jv.reporting.fun':
id: 'AdminGetReason@jv.reporting.fun'
name: 'AdminGetReason'
type: 'function'
description: |-
This endpoint get a single reason.
arguments:
'namespace':
type: 'String'
required: true
'reasonId':
type: 'String'
required: true
return_type: 'RestapiAdminReasonResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_reasons.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminReasons.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_reasons/AdminGetReason.java'
example: |-
try {
final AdminGetReason operation = AdminGetReason.builder()
.build(
namespace,
reasonId,
);
final AdminReasons wrapper = new AdminReasons(sdk);
final RestapiAdminReasonResponse response = wrapper.adminGetReason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'AdminGetReasons@jv.reporting.fun':
id: 'AdminGetReasons@jv.reporting.fun'
name: 'AdminGetReasons'
type: 'function'
description: |-
This endpoint get reasons with pagination
arguments:
'group':
type: 'String'
required: false
description: |-
query reasons under specified reason group
'limit':
type: 'Integer'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'String'
required: true
'offset':
type: 'Integer'
required: false
description: |-
number of data offset (default 0)
'title':
type: 'String'
required: false
description: |-
query reason(s) by title
return_type: 'RestapiAdminReasonListResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_reasons.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminReasons.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_reasons/AdminGetReasons.java'
example: |-
try {
final AdminGetReasons operation = AdminGetReasons.builder()
.group(...)
.limit(...)
.offset(...)
.title(...)
.build(
namespace,
);
final AdminReasons wrapper = new AdminReasons(sdk);
final RestapiAdminReasonListResponse response = wrapper.adminGetReasons(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'AdminGetUnusedReasons@jv.reporting.fun':
id: 'AdminGetUnusedReasons@jv.reporting.fun'
name: 'AdminGetUnusedReasons'
type: 'function'
description: |-
This endpoint get reasons not used by moderation rules.
arguments:
'category':
type: 'String'
required: true
'extensionCategory':
type: 'String'
required: false
'namespace':
type: 'String'
required: true
return_type: 'RestapiUnusedReasonListResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_reasons.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminReasons.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_reasons/AdminGetUnusedReasons.java'
example: |-
try {
final AdminGetUnusedReasons operation = AdminGetUnusedReasons.builder()
.extensionCategory(...)
.build(
category,
namespace,
);
final AdminReasons wrapper = new AdminReasons(sdk);
final RestapiUnusedReasonListResponse response = wrapper.adminGetUnusedReasons(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'reasons'
- 'unused'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'AdminListReasonGroups@jv.reporting.fun':
id: 'AdminListReasonGroups@jv.reporting.fun'
name: 'AdminListReasonGroups'
type: 'function'
description: |-
Return list of reason groups ID and title under given namespace.
To fetch the reasons inside a group, use get reason group endpoint.
arguments:
'limit':
type: 'Integer'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'String'
required: true
'offset':
type: 'Integer'
required: false
description: |-
number of data offset (default 0)
return_type: 'RestapiReasonGroupListResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_reasons.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminReasons.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_reasons/AdminListReasonGroups.java'
example: |-
try {
final AdminListReasonGroups operation = AdminListReasonGroups.builder()
.limit(...)
.offset(...)
.build(
namespace,
);
final AdminReasons wrapper = new AdminReasons(sdk);
final RestapiReasonGroupListResponse response = wrapper.adminListReasonGroups(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'groups'
- 'list'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'AdminSubmitReport@jv.reporting.fun':
id: 'AdminSubmitReport@jv.reporting.fun'
name: 'AdminSubmitReport'
type: 'function'
description: |-
Submit a report and will return ticket for reported object.
New ticket will be created if no OPEN ticket present for reported object (based by objectId and objectType) in a namespace.
Admin can only submit report once for each different user / object reported in the same OPEN ticket.
Reporting the same user / object in the same OPEN ticket will return HTTP code 409 (conflict).
Fill the 'reason' field with a 'reason title'
Supported category: - UGC - USER - CHAT - EXTENSION
arguments:
'body':
type: 'RestapiSubmitReportRequest'
required: true
'namespace':
type: 'String'
required: true
return_type: 'RestapiSubmitReportResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_reports.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminReports.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_reports/AdminSubmitReport.java'
example: |-
try {
final AdminSubmitReport operation = AdminSubmitReport.builder()
.build(
body,
namespace,
);
final AdminReports wrapper = new AdminReports(sdk);
final RestapiSubmitReportResponse response = wrapper.adminSubmitReport(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'report'
- 'reports'
- 'submit'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [CREATE]'
'CreateModerationRule@jv.reporting.fun':
id: 'CreateModerationRule@jv.reporting.fun'
name: 'CreateModerationRule'
type: 'function'
description: |-
This endpoint create moderation rule.
Supported Category: - UGC - USER - CHAT - EXTENSION
Supported Action (GOING TO DEPRECATE, for replacement please use "actions"):
* HideContent
Supported Actions:
* **hideContent**: Hide the content
* **banAccount**: Ban the user account
* **deleteChat**: Delete chat
arguments:
'body':
type: 'RestapiModerationRuleRequest'
required: true
'namespace':
type: 'String'
required: true
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_moderation_rule.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminModerationRule.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_moderation_rule/CreateModerationRule.java'
example: |-
try {
final CreateModerationRule operation = CreateModerationRule.builder()
.build(
body,
namespace,
);
final AdminModerationRule wrapper = new AdminModerationRule(sdk);
wrapper.createModerationRule(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'create'
- 'moderation'
- 'rule'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [CREATE]'
'CreateReason@jv.reporting.fun':
id: 'CreateReason@jv.reporting.fun'
name: 'CreateReason'
type: 'function'
description: |-
This endpoint create a reason for a namespace.
arguments:
'body':
type: 'RestapiCreateReasonRequest'
required: true
'namespace':
type: 'String'
required: true
return_type: 'RestapiAdminReasonResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_reasons.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminReasons.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_reasons/CreateReason.java'
example: |-
try {
final CreateReason operation = CreateReason.builder()
.build(
body,
namespace,
);
final AdminReasons wrapper = new AdminReasons(sdk);
final RestapiAdminReasonResponse response = wrapper.createReason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'create'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [CREATE]'
'CreateReasonGroup@jv.reporting.fun':
id: 'CreateReasonGroup@jv.reporting.fun'
name: 'CreateReasonGroup'
type: 'function'
description: |-
Create a reason group for easier query. You can query reasons by specifying
the group title in the list reasons query. Reason group title is case insensitive,
meaning you can't have **reason** if you already create a reason titled **Reason**
arguments:
'body':
type: 'RestapiCreateReasonGroupRequest'
required: true
'namespace':
type: 'String'
required: true
return_type: 'RestapiReasonGroupResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_reasons.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminReasons.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_reasons/CreateReasonGroup.java'
example: |-
try {
final CreateReasonGroup operation = CreateReasonGroup.builder()
.build(
body,
namespace,
);
final AdminReasons wrapper = new AdminReasons(sdk);
final RestapiReasonGroupResponse response = wrapper.createReasonGroup(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'create'
- 'group'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [CREATE]'
'DeleteModerationRule@jv.reporting.fun':
id: 'DeleteModerationRule@jv.reporting.fun'
name: 'DeleteModerationRule'
type: 'function'
description: |-
This endpoint delete moderation rule.
arguments:
'namespace':
type: 'String'
required: true
'ruleId':
type: 'String'
required: true
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_moderation_rule.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminModerationRule.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_moderation_rule/DeleteModerationRule.java'
example: |-
try {
final DeleteModerationRule operation = DeleteModerationRule.builder()
.build(
namespace,
ruleId,
);
final AdminModerationRule wrapper = new AdminModerationRule(sdk);
wrapper.deleteModerationRule(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'delete'
- 'moderation'
- 'rule'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [DELETE]'
'DeleteReason@jv.reporting.fun':
id: 'DeleteReason@jv.reporting.fun'
name: 'DeleteReason'
type: 'function'
description: |-
This endpoint delete a reason for a namespace with ID.
arguments:
'namespace':
type: 'String'
required: true
'reasonId':
type: 'String'
required: true
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_reasons.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminReasons.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_reasons/DeleteReason.java'
example: |-
try {
final DeleteReason operation = DeleteReason.builder()
.build(
namespace,
reasonId,
);
final AdminReasons wrapper = new AdminReasons(sdk);
wrapper.deleteReason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'delete'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [DELETE]'
'DeleteReasonGroup@jv.reporting.fun':
id: 'DeleteReasonGroup@jv.reporting.fun'
name: 'DeleteReasonGroup'
type: 'function'
description: |-
This endpoint delete a reason group for a namespace with ID.
arguments:
'groupId':
type: 'String'
required: true
description: |-
Reason group ID
'namespace':
type: 'String'
required: true
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_reasons.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminReasons.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_reasons/DeleteReasonGroup.java'
example: |-
try {
final DeleteReasonGroup operation = DeleteReasonGroup.builder()
.build(
groupId,
namespace,
);
final AdminReasons wrapper = new AdminReasons(sdk);
wrapper.deleteReasonGroup(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'delete'
- 'group'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [DELETE]'
'DeleteTicket@jv.reporting.fun':
id: 'DeleteTicket@jv.reporting.fun'
name: 'DeleteTicket'
type: 'function'
description: |-
This endpoint will delete ticket and all its reports.
arguments:
'namespace':
type: 'String'
required: true
'ticketId':
type: 'String'
required: true
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_tickets.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminTickets.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_tickets/DeleteTicket.java'
example: |-
try {
final DeleteTicket operation = DeleteTicket.builder()
.build(
namespace,
ticketId,
);
final AdminTickets wrapper = new AdminTickets(sdk);
wrapper.deleteTicket(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'delete'
- 'ticket'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [DELETE]'
'Get@jv.reporting.fun':
id: 'Get@jv.reporting.fun'
name: 'Get'
type: 'function'
description: |-
TimeInterval is in nanoseconds.
When there's no configuration set, the response is the default value (configurable through envar).
arguments:
'category':
type: 'String'
required: false
description: |-
configuration category flag.
set this to 'all' to retrieve all category configurations
set this to 'extension' to retrieve [EXTENSION] category configurations
leave it blank to retrieve core categories [UGC,USER,CHAT] configurations
'namespace':
type: 'String'
required: true
return_type: 'RestapiConfigResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_configurations.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminConfigurations.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_configurations/Get.java'
example: |-
try {
final Get operation = Get.builder()
.category(...)
.build(
namespace,
);
final AdminConfigurations wrapper = new AdminConfigurations(sdk);
final RestapiConfigResponse response = wrapper.get(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configurations'
- 'get'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REPORTINGCONFIG [READ]'
'GetModerationRuleDetails@jv.reporting.fun':
id: 'GetModerationRuleDetails@jv.reporting.fun'
name: 'GetModerationRuleDetails'
type: 'function'
description: |-
This endpoint get moderation rule.
arguments:
'namespace':
type: 'String'
required: true
'ruleId':
type: 'String'
required: true
return_type: 'RestapiModerationRuleResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_moderation_rule.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminModerationRule.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_moderation_rule/GetModerationRuleDetails.java'
example: |-
try {
final GetModerationRuleDetails operation = GetModerationRuleDetails.builder()
.build(
namespace,
ruleId,
);
final AdminModerationRule wrapper = new AdminModerationRule(sdk);
final RestapiModerationRuleResponse response = wrapper.getModerationRuleDetails(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'details'
- 'get'
- 'moderation'
- 'rule'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [READ]'
'GetModerationRules@jv.reporting.fun':
id: 'GetModerationRules@jv.reporting.fun'
name: 'GetModerationRules'
type: 'function'
description: |-
This endpoint get moderation rules.
arguments:
'category':
type: 'String'
required: false
description: |-
filter rules by category
'extensionCategory':
type: 'String'
required: false
description: |-
filter rules by extension category
'limit':
type: 'Integer'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'String'
required: true
'offset':
type: 'Integer'
required: false
description: |-
number of data offset (default 0)
return_type: 'RestapiModerationRulesList'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_moderation_rule.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminModerationRule.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_moderation_rule/GetModerationRules.java'
example: |-
try {
final GetModerationRules operation = GetModerationRules.builder()
.category(...)
.extensionCategory(...)
.limit(...)
.offset(...)
.build(
namespace,
);
final AdminModerationRule wrapper = new AdminModerationRule(sdk);
final RestapiModerationRulesList response = wrapper.getModerationRules(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'moderation'
- 'rule'
- 'rules'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [READ]'
'GetReasonGroup@jv.reporting.fun':
id: 'GetReasonGroup@jv.reporting.fun'
name: 'GetReasonGroup'
type: 'function'
arguments:
'groupId':
type: 'String'
required: true
description: |-
Reason group ID
'namespace':
type: 'String'
required: true
return_type: 'RestapiReasonGroupResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_reasons.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminReasons.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_reasons/GetReasonGroup.java'
example: |-
try {
final GetReasonGroup operation = GetReasonGroup.builder()
.build(
groupId,
namespace,
);
final AdminReasons wrapper = new AdminReasons(sdk);
final RestapiReasonGroupResponse response = wrapper.getReasonGroup(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'group'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'GetReportsByTicket@jv.reporting.fun':
id: 'GetReportsByTicket@jv.reporting.fun'
name: 'GetReportsByTicket'
type: 'function'
description: |-
List reports ordered by createdAt in descending order.
arguments:
'limit':
type: 'Integer'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'String'
required: true
'offset':
type: 'Integer'
required: false
description: |-
number of data offset (default 0)
'ticketId':
type: 'String'
required: true
return_type: 'RestapiReportListResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_tickets.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminTickets.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_tickets/GetReportsByTicket.java'
example: |-
try {
final GetReportsByTicket operation = GetReportsByTicket.builder()
.limit(...)
.offset(...)
.build(
namespace,
ticketId,
);
final AdminTickets wrapper = new AdminTickets(sdk);
final RestapiReportListResponse response = wrapper.getReportsByTicket(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'by'
- 'get'
- 'reports'
- 'ticket'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'GetTicketDetail@jv.reporting.fun':
id: 'GetTicketDetail@jv.reporting.fun'
name: 'GetTicketDetail'
type: 'function'
description: |-
This endpoint will return ticket detail with ticket id.
arguments:
'namespace':
type: 'String'
required: true
'ticketId':
type: 'String'
required: true
return_type: 'RestapiTicketResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_tickets.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminTickets.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_tickets/GetTicketDetail.java'
example: |-
try {
final GetTicketDetail operation = GetTicketDetail.builder()
.build(
namespace,
ticketId,
);
final AdminTickets wrapper = new AdminTickets(sdk);
final RestapiTicketResponse response = wrapper.getTicketDetail(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'detail'
- 'get'
- 'ticket'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'ListReports@jv.reporting.fun':
id: 'ListReports@jv.reporting.fun'
name: 'ListReports'
type: 'function'
description: |-
Required permission: ADMIN:NAMESPACE:{namespace}:TICKET [READ]
Reports list can be ordered by:
- createdAt
- updatedAt
arguments:
'category':
type: 'String'
required: false
description: |-
filter reports by category
'limit':
type: 'Integer'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'String'
required: true
'offset':
type: 'Integer'
required: false
description: |-
number of data offset (default 0)
'reportedUserId':
type: 'String'
required: false
description: |-
filter reports by reportedUserId
'sortBy':
type: 'String'
required: false
description: |-
Only support one level of sortBy; default createdAt:desc
return_type: 'RestapiReportListResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_reports.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminReports.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_reports/ListReports.java'
example: |-
try {
final ListReports operation = ListReports.builder()
.category(...)
.limit(...)
.offset(...)
.reportedUserId(...)
.sortBy(...)
.build(
namespace,
);
final AdminReports wrapper = new AdminReports(sdk);
final RestapiReportListResponse response = wrapper.listReports(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'list'
- 'reports'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'ListTickets@jv.reporting.fun':
id: 'ListTickets@jv.reporting.fun'
name: 'ListTickets'
type: 'function'
description: |-
Tickets list can be ordered by:
- createdAt
- reportsCount
- status (currently there are OPEN, AUTO_MODERATED and CLOSED statuses, desc order will put ticket with CLOSED status at the top)
arguments:
'category':
type: 'String'
required: false
description: |-
filter tickets by category
'extensionCategory':
type: 'String'
required: false
description: |-
filter tickets by extension category
'limit':
type: 'Integer'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'String'
required: true
'offset':
type: 'Integer'
required: false
description: |-
number of data offset (default 0)
'order':
type: 'String'
required: false
description: |-
data order, asc or desc (default: desc)
'reportedUserId':
type: 'String'
required: false
description: |-
filter reports by reportedUserId
'sortBy':
type: 'String'
required: false
description: |-
data order key, valid keys are createdAt, reportsCount, and status (default: createdAt)
'status':
type: 'String'
required: false
description: |-
filter tickets by status (OPEN, AUTO_MODERATED or CLOSED)
return_type: 'RestapiTicketListResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_tickets.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminTickets.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_tickets/ListTickets.java'
example: |-
try {
final ListTickets operation = ListTickets.builder()
.category(...)
.extensionCategory(...)
.limit(...)
.offset(...)
.order(...)
.reportedUserId(...)
.sortBy(...)
.status(...)
.build(
namespace,
);
final AdminTickets wrapper = new AdminTickets(sdk);
final RestapiTicketListResponse response = wrapper.listTickets(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'list'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'PublicGetReasons@jv.reporting.fun':
id: 'PublicGetReasons@jv.reporting.fun'
name: 'PublicGetReasons'
type: 'function'
arguments:
'group':
type: 'String'
required: false
description: |-
query reasons under specified reason group
'limit':
type: 'Integer'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'String'
required: true
'offset':
type: 'Integer'
required: false
description: |-
number of data offset (default 0)
'title':
type: 'String'
required: false
description: |-
query reason(s) by title
return_type: 'RestapiPublicReasonListResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.public_reasons.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/PublicReasons.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/public_reasons/PublicGetReasons.java'
example: |-
try {
final PublicGetReasons operation = PublicGetReasons.builder()
.group(...)
.limit(...)
.offset(...)
.title(...)
.build(
namespace,
);
final PublicReasons wrapper = new PublicReasons(sdk);
final RestapiPublicReasonListResponse response = wrapper.publicGetReasons(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'public'
- 'reasons'
'PublicListReasonGroups@jv.reporting.fun':
id: 'PublicListReasonGroups@jv.reporting.fun'
name: 'PublicListReasonGroups'
type: 'function'
description: |-
Return list of reason groups ID and title under given namespace.
arguments:
'limit':
type: 'Integer'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'String'
required: true
'offset':
type: 'Integer'
required: false
description: |-
number of data offset (default 0)
return_type: 'RestapiReasonGroupListResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.public_reasons.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/PublicReasons.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/public_reasons/PublicListReasonGroups.java'
example: |-
try {
final PublicListReasonGroups operation = PublicListReasonGroups.builder()
.limit(...)
.offset(...)
.build(
namespace,
);
final PublicReasons wrapper = new PublicReasons(sdk);
final RestapiReasonGroupListResponse response = wrapper.publicListReasonGroups(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'groups'
- 'list'
- 'public'
- 'reason'
- 'reasons'
'SubmitReport@jv.reporting.fun':
id: 'SubmitReport@jv.reporting.fun'
name: 'SubmitReport'
type: 'function'
description: |-
User need to be authenticated to access this endpoint.
Submit a report and will return ticket for reported object.
New ticket will be created if no OPEN ticket present for reported object (based by objectId and objectType) in a namespace.
User can only submit report once for each different user / object reported in the same OPEN ticket.
Reporting the same user / object in the same OPEN ticket will return HTTP code 409 (conflict).
Fill the 'reason' field with a 'reason title'
Supported category: - UGC - USER - CHAT - EXTENSION
arguments:
'body':
type: 'RestapiSubmitReportRequest'
required: true
'namespace':
type: 'String'
required: true
return_type: 'RestapiSubmitReportResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.public_reports.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/PublicReports.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/public_reports/SubmitReport.java'
example: |-
try {
final SubmitReport operation = SubmitReport.builder()
.build(
body,
namespace,
);
final PublicReports wrapper = new PublicReports(sdk);
final RestapiSubmitReportResponse response = wrapper.submitReport(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'public'
- 'report'
- 'reports'
- 'submit'
'TicketStatistic@jv.reporting.fun':
id: 'TicketStatistic@jv.reporting.fun'
name: 'TicketStatistic'
type: 'function'
description: |-
Ticket statistic can be filtered by:
- category
- extension category
arguments:
'category':
type: 'String'
required: true
description: |-
filter statistic by category
'extensionCategory':
type: 'String'
required: false
description: |-
filter statistic by extension category
'namespace':
type: 'String'
required: true
return_type: 'RestapiTicketStatisticResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_tickets.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminTickets.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_tickets/TicketStatistic.java'
example: |-
try {
final TicketStatistic operation = TicketStatistic.builder()
.extensionCategory(...)
.build(
category,
namespace,
);
final AdminTickets wrapper = new AdminTickets(sdk);
final RestapiTicketStatisticResponse response = wrapper.ticketStatistic(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'statistic'
- 'ticket'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'UpdateModerationRule@jv.reporting.fun':
id: 'UpdateModerationRule@jv.reporting.fun'
name: 'UpdateModerationRule'
type: 'function'
description: |-
This endpoint update moderation rule.
Supported Category:- UGC - USER - CHAT - EXTENSION
Supported Action (GOING TO DEPRECATE, for replacement please use "actions"):
* HideContent
Supported Actions:
* **hideContent**: Hide the content
* **banAccount**: Ban the user account
* **deleteChat**: Delete chat
arguments:
'body':
type: 'RestapiModerationRuleRequest'
required: true
'namespace':
type: 'String'
required: true
'ruleId':
type: 'String'
required: true
return_type: 'RestapiModerationRuleResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_moderation_rule.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminModerationRule.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_moderation_rule/UpdateModerationRule.java'
example: |-
try {
final UpdateModerationRule operation = UpdateModerationRule.builder()
.build(
body,
namespace,
ruleId,
);
final AdminModerationRule wrapper = new AdminModerationRule(sdk);
final RestapiModerationRuleResponse response = wrapper.updateModerationRule(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'moderation'
- 'rule'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [UPDATE]'
'UpdateModerationRuleStatus@jv.reporting.fun':
id: 'UpdateModerationRuleStatus@jv.reporting.fun'
name: 'UpdateModerationRuleStatus'
type: 'function'
description: |-
This endpoint enable/disable moderation rule status.
arguments:
'body':
type: 'RestapiModerationRuleActiveRequest'
required: true
'namespace':
type: 'String'
required: true
'ruleId':
type: 'String'
required: true
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_moderation_rule.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminModerationRule.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_moderation_rule/UpdateModerationRuleStatus.java'
example: |-
try {
final UpdateModerationRuleStatus operation = UpdateModerationRuleStatus.builder()
.build(
body,
namespace,
ruleId,
);
final AdminModerationRule wrapper = new AdminModerationRule(sdk);
wrapper.updateModerationRuleStatus(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'moderation'
- 'rule'
- 'status'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [UPDATE]'
'UpdateReason@jv.reporting.fun':
id: 'UpdateReason@jv.reporting.fun'
name: 'UpdateReason'
type: 'function'
description: |-
This endpoint update a reason for a namespace with ID.
arguments:
'body':
type: 'RestapiCreateReasonRequest'
required: true
'namespace':
type: 'String'
required: true
'reasonId':
type: 'String'
required: true
return_type: 'RestapiAdminReasonResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_reasons.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminReasons.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_reasons/UpdateReason.java'
example: |-
try {
final UpdateReason operation = UpdateReason.builder()
.build(
body,
namespace,
reasonId,
);
final AdminReasons wrapper = new AdminReasons(sdk);
final RestapiAdminReasonResponse response = wrapper.updateReason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'reason'
- 'reasons'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [UPDATE]'
'UpdateReasonGroup@jv.reporting.fun':
id: 'UpdateReasonGroup@jv.reporting.fun'
name: 'UpdateReasonGroup'
type: 'function'
description: |-
Reason group title is case insensitive, meaning you can't have **reason** if you already create a reason titled **Reason**
If no reasonIds passed when updating, the current reasons under the reason group will be kept (reasons will not be removed from the group).
arguments:
'body':
type: 'RestapiUpdateReasonGroupRequest'
required: true
'groupId':
type: 'String'
required: true
description: |-
Reason group ID
'namespace':
type: 'String'
required: true
return_type: 'RestapiReasonGroupResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_reasons.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminReasons.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_reasons/UpdateReasonGroup.java'
example: |-
try {
final UpdateReasonGroup operation = UpdateReasonGroup.builder()
.build(
body,
groupId,
namespace,
);
final AdminReasons wrapper = new AdminReasons(sdk);
final RestapiReasonGroupResponse response = wrapper.updateReasonGroup(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'group'
- 'reason'
- 'reasons'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [UPDATE]'
'UpdateTicketResolutions@jv.reporting.fun':
id: 'UpdateTicketResolutions@jv.reporting.fun'
name: 'UpdateTicketResolutions'
type: 'function'
description: |-
Update ticket resolution status to either OPEN or CLOSED. It is mandatory to provide notes
arguments:
'body':
type: 'RestapiUpdateTicketResolutionsRequest'
required: true
'namespace':
type: 'String'
required: true
'ticketId':
type: 'String'
required: true
return_type: 'RestapiTicketResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_tickets.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminTickets.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_tickets/UpdateTicketResolutions.java'
example: |-
try {
final UpdateTicketResolutions operation = UpdateTicketResolutions.builder()
.build(
body,
namespace,
ticketId,
);
final AdminTickets wrapper = new AdminTickets(sdk);
final RestapiTicketResponse response = wrapper.updateTicketResolutions(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'resolutions'
- 'ticket'
- 'tickets'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [UPDATE]'
'Upsert@jv.reporting.fun':
id: 'Upsert@jv.reporting.fun'
name: 'Upsert'
type: 'function'
description: |-
The behaviour of this endpoint is upsert based on the namespace.
So, you can use this for both creating & updating the configuration.
TimeInterval is in nanoseconds.
arguments:
'body':
type: 'RestapiReportingLimit'
required: true
'namespace':
type: 'String'
required: true
return_type: 'RestapiConfigResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.reporting.models.*;'
- 'import net.accelbyte.sdk.api.reporting.operations.admin_configurations.*;'
- 'import net.accelbyte.sdk.api.reporting.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/wrappers/AdminConfigurations.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/reporting/operations/admin_configurations/Upsert.java'
example: |-
try {
final Upsert operation = Upsert.builder()
.build(
body,
namespace,
);
final AdminConfigurations wrapper = new AdminConfigurations(sdk);
final RestapiConfigResponse response = wrapper.upsert(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configurations'
- 'upsert'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REPORTINGCONFIG [CREATE]'
# endregion functions
