symbols:
# region models
'RestapiActionApiRequest@cs.reporting.mod':
id: 'RestapiActionApiRequest@cs.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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiActionApiRequest.cs'
'RestapiActionApiResponse@cs.reporting.mod':
id: 'RestapiActionApiResponse@cs.reporting.mod'
name: 'RestapiActionApiResponse'
type: 'model'
fields:
'ActionId':
type: 'string'
required: true
'ActionName':
type: 'string'
required: true
'EventName':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiActionApiResponse.cs'
'RestapiActionListApiResponse@cs.reporting.mod':
id: 'RestapiActionListApiResponse@cs.reporting.mod'
name: 'RestapiActionListApiResponse'
type: 'model'
fields:
'Data':
type: 'List<RestapiActionApiResponse>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiActionListApiResponse.cs'
'RestapiAdminAllReasonsResponse@cs.reporting.mod':
id: 'RestapiAdminAllReasonsResponse@cs.reporting.mod'
name: 'RestapiAdminAllReasonsResponse'
type: 'model'
fields:
'Data':
type: 'List<RestapiPublicReasonResponse>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiAdminAllReasonsResponse.cs'
'RestapiAdminReasonListResponse@cs.reporting.mod':
id: 'RestapiAdminReasonListResponse@cs.reporting.mod'
name: 'RestapiAdminReasonListResponse'
type: 'model'
fields:
'Data':
type: 'List<RestapiAdminReasonResponse>'
required: true
'Paging':
type: 'RestapiPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiAdminReasonListResponse.cs'
'RestapiAdminReasonResponse@cs.reporting.mod':
id: 'RestapiAdminReasonResponse@cs.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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiAdminReasonResponse.cs'
'RestapiBanAccountActionRequest@cs.reporting.mod':
id: 'RestapiBanAccountActionRequest@cs.reporting.mod'
name: 'RestapiBanAccountActionRequest'
type: 'model'
fields:
'Duration':
type: 'int'
required: true
description: |-
Ban duration in minutes, -1 means unlimited duration
'Reason':
type: 'string'
required: true
description: |-
Ban reason
'SkipNotif':
type: 'bool'
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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiBanAccountActionRequest.cs'
'RestapiBanAccountActionResponse@cs.reporting.mod':
id: 'RestapiBanAccountActionResponse@cs.reporting.mod'
name: 'RestapiBanAccountActionResponse'
type: 'model'
fields:
'Duration':
type: 'int'
required: true
description: |-
Ban duration in minutes, -1 means unlimited duration
'Reason':
type: 'string'
required: true
description: |-
Ban reason
'SkipNotif':
type: 'bool'
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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiBanAccountActionResponse.cs'
'RestapiCategoryLimit@cs.reporting.mod':
id: 'RestapiCategoryLimit@cs.reporting.mod'
name: 'RestapiCategoryLimit'
type: 'model'
fields:
'MaxReportPerTicket':
type: 'int'
required: true
description: |-
must between 1 to 2147483647
'Name':
type: 'string'
required: true
'ExtensionCategory':
type: 'string'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiCategoryLimit.cs'
'RestapiConfigResponse@cs.reporting.mod':
id: 'RestapiConfigResponse@cs.reporting.mod'
name: 'RestapiConfigResponse'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
'ReportingLimit':
type: 'RestapiReportingLimit'
required: true
'UpdatedAt':
type: 'DateTime'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiConfigResponse.cs'
'RestapiCreateReasonGroupRequest@cs.reporting.mod':
id: 'RestapiCreateReasonGroupRequest@cs.reporting.mod'
name: 'RestapiCreateReasonGroupRequest'
type: 'model'
fields:
'Title':
type: 'string'
required: true
description: |-
max 256 chars
'ReasonIds':
type: 'List<string>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiCreateReasonGroupRequest.cs'
'RestapiCreateReasonRequest@cs.reporting.mod':
id: 'RestapiCreateReasonRequest@cs.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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiCreateReasonRequest.cs'
'RestapiErrorResponse@cs.reporting.mod':
id: 'RestapiErrorResponse@cs.reporting.mod'
name: 'RestapiErrorResponse'
type: 'model'
fields:
'ErrorCode':
type: 'int'
required: true
'ErrorMessage':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiErrorResponse.cs'
'RestapiExtensionCategoryApiRequest@cs.reporting.mod':
id: 'RestapiExtensionCategoryApiRequest@cs.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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiExtensionCategoryApiRequest.cs'
'RestapiExtensionCategoryApiResponse@cs.reporting.mod':
id: 'RestapiExtensionCategoryApiResponse@cs.reporting.mod'
name: 'RestapiExtensionCategoryApiResponse'
type: 'model'
fields:
'ExtensionCategory':
type: 'string'
required: true
'ExtensionCategoryName':
type: 'string'
required: true
'ServiceSource':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiExtensionCategoryApiResponse.cs'
'RestapiExtensionCategoryListApiResponse@cs.reporting.mod':
id: 'RestapiExtensionCategoryListApiResponse@cs.reporting.mod'
name: 'RestapiExtensionCategoryListApiResponse'
type: 'model'
fields:
'Data':
type: 'List<RestapiExtensionCategoryApiResponse>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiExtensionCategoryListApiResponse.cs'
'RestapiModerationRuleActionsRequest@cs.reporting.mod':
id: 'RestapiModerationRuleActionsRequest@cs.reporting.mod'
name: 'RestapiModerationRuleActionsRequest'
type: 'model'
fields:
'BanAccount':
type: 'RestapiBanAccountActionRequest'
required: false
description: |-
Ban account action configuration
'DeleteChat':
type: 'bool'
required: false
description: |-
Enable delete chat action
'ExtensionActionIds':
type: 'List<string>'
required: false
description: |-
Custom services moderation actions
'HideContent':
type: 'bool'
required: false
description: |-
Enable hide content action
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiModerationRuleActionsRequest.cs'
'RestapiModerationRuleActionsResponse@cs.reporting.mod':
id: 'RestapiModerationRuleActionsResponse@cs.reporting.mod'
name: 'RestapiModerationRuleActionsResponse'
type: 'model'
fields:
'BanAccount':
type: 'RestapiBanAccountActionResponse'
required: false
description: |-
Ban account action configuration
'DeleteChat':
type: 'bool'
required: false
description: |-
Enable delete chat action
'ExtensionActionIds':
type: 'List<string>'
required: false
description: |-
custom service mod actions
'HideContent':
type: 'bool'
required: false
description: |-
Enable hide content action
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiModerationRuleActionsResponse.cs'
'RestapiModerationRuleActiveRequest@cs.reporting.mod':
id: 'RestapiModerationRuleActiveRequest@cs.reporting.mod'
name: 'RestapiModerationRuleActiveRequest'
type: 'model'
fields:
'Active':
type: 'bool'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiModerationRuleActiveRequest.cs'
'RestapiModerationRuleRequest@cs.reporting.mod':
id: 'RestapiModerationRuleRequest@cs.reporting.mod'
name: 'RestapiModerationRuleRequest'
type: 'model'
fields:
'Active':
type: 'bool'
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: 'int'
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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiModerationRuleRequest.cs'
'RestapiModerationRuleResponse@cs.reporting.mod':
id: 'RestapiModerationRuleResponse@cs.reporting.mod'
name: 'RestapiModerationRuleResponse'
type: 'model'
fields:
'Actions':
type: 'RestapiModerationRuleActionsResponse'
required: true
description: |-
Action configurations for moderation rule
'Active':
type: 'bool'
required: true
'Category':
type: 'string'
required: true
'CreatedAt':
type: 'DateTime'
required: true
'Id':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'Reason':
type: 'string'
required: true
'Threshold':
type: 'int'
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: 'DateTime'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiModerationRuleResponse.cs'
'RestapiModerationRulesList@cs.reporting.mod':
id: 'RestapiModerationRulesList@cs.reporting.mod'
name: 'RestapiModerationRulesList'
type: 'model'
fields:
'Data':
type: 'List<RestapiModerationRuleResponse>'
required: true
'Paging':
type: 'RestapiPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiModerationRulesList.cs'
'RestapiPagination@cs.reporting.mod':
id: 'RestapiPagination@cs.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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiPagination.cs'
'RestapiPublicReasonGroupResponse@cs.reporting.mod':
id: 'RestapiPublicReasonGroupResponse@cs.reporting.mod'
name: 'RestapiPublicReasonGroupResponse'
type: 'model'
fields:
'Id':
type: 'string'
required: true
'Title':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiPublicReasonGroupResponse.cs'
'RestapiPublicReasonListResponse@cs.reporting.mod':
id: 'RestapiPublicReasonListResponse@cs.reporting.mod'
name: 'RestapiPublicReasonListResponse'
type: 'model'
fields:
'Data':
type: 'List<RestapiPublicReasonResponse>'
required: true
'Paging':
type: 'RestapiPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiPublicReasonListResponse.cs'
'RestapiPublicReasonResponse@cs.reporting.mod':
id: 'RestapiPublicReasonResponse@cs.reporting.mod'
name: 'RestapiPublicReasonResponse'
type: 'model'
fields:
'Description':
type: 'string'
required: true
'Title':
type: 'string'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiPublicReasonResponse.cs'
'RestapiReasonGroupListResponse@cs.reporting.mod':
id: 'RestapiReasonGroupListResponse@cs.reporting.mod'
name: 'RestapiReasonGroupListResponse'
type: 'model'
fields:
'Data':
type: 'List<RestapiPublicReasonGroupResponse>'
required: true
'Paging':
type: 'RestapiPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiReasonGroupListResponse.cs'
'RestapiReasonGroupResponse@cs.reporting.mod':
id: 'RestapiReasonGroupResponse@cs.reporting.mod'
name: 'RestapiReasonGroupResponse'
type: 'model'
fields:
'Id':
type: 'string'
required: true
'Title':
type: 'string'
required: true
'Reasons':
type: 'List<RestapiAdminReasonResponse>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiReasonGroupResponse.cs'
'RestapiReportingLimit@cs.reporting.mod':
id: 'RestapiReportingLimit@cs.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: 'int'
required: true
description: |-
must between 1 to 2147483647
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiReportingLimit.cs'
'RestapiReportListResponse@cs.reporting.mod':
id: 'RestapiReportListResponse@cs.reporting.mod'
name: 'RestapiReportListResponse'
type: 'model'
fields:
'Data':
type: 'List<RestapiReportResponse>'
required: true
'Paging':
type: 'RestapiPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiReportListResponse.cs'
'RestapiReportResponse@cs.reporting.mod':
id: 'RestapiReportResponse@cs.reporting.mod'
name: 'RestapiReportResponse'
type: 'model'
fields:
'AdditionalInfo':
type: 'Dictionary<string, object>'
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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiReportResponse.cs'
'RestapiSubmitReportRequest@cs.reporting.mod':
id: 'RestapiSubmitReportRequest@cs.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: 'Dictionary<string, object>'
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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiSubmitReportRequest.cs'
'RestapiSubmitReportResponse@cs.reporting.mod':
id: 'RestapiSubmitReportResponse@cs.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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiSubmitReportResponse.cs'
'RestapiTicketListResponse@cs.reporting.mod':
id: 'RestapiTicketListResponse@cs.reporting.mod'
name: 'RestapiTicketListResponse'
type: 'model'
fields:
'Data':
type: 'List<RestapiTicketResponse>'
required: true
'Paging':
type: 'RestapiPagination'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiTicketListResponse.cs'
'RestapiTicketResponse@cs.reporting.mod':
id: 'RestapiTicketResponse@cs.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: 'int'
required: true
'Status':
type: 'string'
required: true
'UpdatedAt':
type: 'string'
required: true
'UserId':
type: 'string'
required: true
'ExtensionCategory':
type: 'string'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiTicketResponse.cs'
'RestapiTicketStatisticResponse@cs.reporting.mod':
id: 'RestapiTicketStatisticResponse@cs.reporting.mod'
name: 'RestapiTicketStatisticResponse'
type: 'model'
fields:
'ModeratedCount':
type: 'long'
required: true
'OpenCount':
type: 'long'
required: true
'TotalCount':
type: 'long'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiTicketStatisticResponse.cs'
'RestapiUnusedReasonListResponse@cs.reporting.mod':
id: 'RestapiUnusedReasonListResponse@cs.reporting.mod'
name: 'RestapiUnusedReasonListResponse'
type: 'model'
fields:
'Reasons':
type: 'List<RestapiPublicReasonResponse>'
required: true
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiUnusedReasonListResponse.cs'
'RestapiUpdateReasonGroupRequest@cs.reporting.mod':
id: 'RestapiUpdateReasonGroupRequest@cs.reporting.mod'
name: 'RestapiUpdateReasonGroupRequest'
type: 'model'
fields:
'Title':
type: 'string'
required: true
description: |-
max 256 chars
'ReasonIds':
type: 'List<string>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiUpdateReasonGroupRequest.cs'
'RestapiUpdateTicketResolutionsRequest@cs.reporting.mod':
id: 'RestapiUpdateTicketResolutionsRequest@cs.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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Model/RestapiUpdateTicketResolutionsRequest.cs'
# endregion models
# region functions
'AdminCreateExtensionCategory@cs.reporting.fun':
id: 'AdminCreateExtensionCategory@cs.reporting.fun'
name: 'AdminCreateExtensionCategory'
type: 'function'
description: |-
Create extension category data
arguments:
'Body':
type: 'RestapiExtensionCategoryApiRequest'
required: true
return_type: 'RestapiExtensionCategoryApiResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminExtensionCategoriesAndAutoModerationActions.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminExtensionCategoriesAndAutoModerationActions/AdminCreateExtensionCategory.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminExtensionCategoriesAndAutoModerationActions.AdminCreateExtensionCategoryOp
.Build();
var response = sdk.Reporting.AdminExtensionCategoriesAndAutoModerationActions.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@cs.reporting.fun':
id: 'AdminCreateModAction@cs.reporting.fun'
name: 'AdminCreateModAction'
type: 'function'
description: |-
Create auto moderation action
arguments:
'Body':
type: 'RestapiActionApiRequest'
required: true
return_type: 'RestapiActionApiResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminExtensionCategoriesAndAutoModerationActions.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminExtensionCategoriesAndAutoModerationActions/AdminCreateModAction.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminExtensionCategoriesAndAutoModerationActions.AdminCreateModActionOp
.Build();
var response = sdk.Reporting.AdminExtensionCategoriesAndAutoModerationActions.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@cs.reporting.fun':
id: 'AdminFindActionList@cs.reporting.fun'
name: 'AdminFindActionList'
type: 'function'
description: |-
Get a list of auto moderation actions
return_type: 'RestapiActionListApiResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminExtensionCategoriesAndAutoModerationActions.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminExtensionCategoriesAndAutoModerationActions/AdminFindActionList.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminExtensionCategoriesAndAutoModerationActions.AdminFindActionListOp
.Build();
var response = sdk.Reporting.AdminExtensionCategoriesAndAutoModerationActions.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@cs.reporting.fun':
id: 'AdminFindExtensionCategoryList@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminExtensionCategoriesAndAutoModerationActions.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminExtensionCategoriesAndAutoModerationActions/AdminFindExtensionCategoryList.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminExtensionCategoriesAndAutoModerationActions.AdminFindExtensionCategoryListOp
.SetOrder(...)
.SetSortBy(...)
.Build(
);
var response = sdk.Reporting.AdminExtensionCategoriesAndAutoModerationActions.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@cs.reporting.fun':
id: 'AdminGetAllReasons@cs.reporting.fun'
name: 'AdminGetAllReasons'
type: 'function'
description: |-
This endpoint get all reasons without pagination.
arguments:
'Namespace':
type: 'string'
required: true
return_type: 'RestapiAdminAllReasonsResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminReasons.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminReasons/AdminGetAllReasons.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminReasons.AdminGetAllReasonsOp
.Build();
var response = sdk.Reporting.AdminReasons.AdminGetAllReasons(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'all'
- 'get'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'AdminGetReason@cs.reporting.fun':
id: 'AdminGetReason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminReasons.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminReasons/AdminGetReason.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminReasons.AdminGetReasonOp
.Build();
var response = sdk.Reporting.AdminReasons.AdminGetReason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'AdminGetReasons@cs.reporting.fun':
id: 'AdminGetReasons@cs.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: 'long'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'long'
required: false
description: |-
number of data offset (default 0)
'Title':
type: 'string'
required: false
description: |-
query reason(s) by title
return_type: 'RestapiAdminReasonListResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminReasons.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminReasons/AdminGetReasons.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminReasons.AdminGetReasonsOp
.SetGroup(...)
.SetLimit(...)
.SetOffset(...)
.SetTitle(...)
.Build(
namespace_,
);
var response = sdk.Reporting.AdminReasons.AdminGetReasons(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'AdminGetUnusedReasons@cs.reporting.fun':
id: 'AdminGetUnusedReasons@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminReasons.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminReasons/AdminGetUnusedReasons.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminReasons.AdminGetUnusedReasonsOp
.SetExtensionCategory(...)
.Build(
category,
namespace_,
);
var response = sdk.Reporting.AdminReasons.AdminGetUnusedReasons(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'get'
- 'reasons'
- 'unused'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'AdminListReasonGroups@cs.reporting.fun':
id: 'AdminListReasonGroups@cs.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: 'long'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'long'
required: false
description: |-
number of data offset (default 0)
return_type: 'RestapiReasonGroupListResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminReasons.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminReasons/AdminListReasonGroups.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminReasons.AdminListReasonGroupsOp
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
);
var response = sdk.Reporting.AdminReasons.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@cs.reporting.fun':
id: 'AdminSubmitReport@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminReports.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminReports/AdminSubmitReport.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminReports.AdminSubmitReportOp
.Build();
var response = sdk.Reporting.AdminReports.AdminSubmitReport(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'report'
- 'reports'
- 'submit'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [CREATE]'
'CreateModerationRule@cs.reporting.fun':
id: 'CreateModerationRule@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminModerationRule.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminModerationRule/CreateModerationRule.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminModerationRule.CreateModerationRuleOp
.Build();
sdk.Reporting.AdminModerationRule.CreateModerationRule(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'create'
- 'moderation'
- 'rule'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [CREATE]'
'CreateReason@cs.reporting.fun':
id: 'CreateReason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminReasons.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminReasons/CreateReason.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminReasons.CreateReasonOp
.Build();
var response = sdk.Reporting.AdminReasons.CreateReason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'create'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [CREATE]'
'CreateReasonGroup@cs.reporting.fun':
id: 'CreateReasonGroup@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminReasons.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminReasons/CreateReasonGroup.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminReasons.CreateReasonGroupOp
.Build();
var response = sdk.Reporting.AdminReasons.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@cs.reporting.fun':
id: 'DeleteModerationRule@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminModerationRule.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminModerationRule/DeleteModerationRule.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminModerationRule.DeleteModerationRuleOp
.Build();
sdk.Reporting.AdminModerationRule.DeleteModerationRule(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'delete'
- 'moderation'
- 'rule'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [DELETE]'
'DeleteReason@cs.reporting.fun':
id: 'DeleteReason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminReasons.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminReasons/DeleteReason.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminReasons.DeleteReasonOp
.Build();
sdk.Reporting.AdminReasons.DeleteReason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'delete'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [DELETE]'
'DeleteReasonGroup@cs.reporting.fun':
id: 'DeleteReasonGroup@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminReasons.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminReasons/DeleteReasonGroup.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminReasons.DeleteReasonGroupOp
.Build();
sdk.Reporting.AdminReasons.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@cs.reporting.fun':
id: 'DeleteTicket@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminTickets.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminTickets/DeleteTicket.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminTickets.DeleteTicketOp
.Build();
sdk.Reporting.AdminTickets.DeleteTicket(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'delete'
- 'ticket'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [DELETE]'
'Get@cs.reporting.fun':
id: 'Get@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminConfigurations.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminConfigurations/Get.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminConfigurations.GetOp
.SetCategory(...)
.Build(
namespace_,
);
var response = sdk.Reporting.AdminConfigurations.Get(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configurations'
- 'get'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REPORTINGCONFIG [READ]'
'GetModerationRuleDetails@cs.reporting.fun':
id: 'GetModerationRuleDetails@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminModerationRule.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminModerationRule/GetModerationRuleDetails.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminModerationRule.GetModerationRuleDetailsOp
.Build();
var response = sdk.Reporting.AdminModerationRule.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@cs.reporting.fun':
id: 'GetModerationRules@cs.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: 'long'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'long'
required: false
description: |-
number of data offset (default 0)
return_type: 'RestapiModerationRulesList'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminModerationRule.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminModerationRule/GetModerationRules.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminModerationRule.GetModerationRulesOp
.SetCategory(...)
.SetExtensionCategory(...)
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
);
var response = sdk.Reporting.AdminModerationRule.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@cs.reporting.fun':
id: 'GetReasonGroup@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminReasons.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminReasons/GetReasonGroup.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminReasons.GetReasonGroupOp
.Build();
var response = sdk.Reporting.AdminReasons.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@cs.reporting.fun':
id: 'GetReportsByTicket@cs.reporting.fun'
name: 'GetReportsByTicket'
type: 'function'
description: |-
List reports ordered by createdAt in descending order.
arguments:
'Limit':
type: 'long'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'long'
required: false
description: |-
number of data offset (default 0)
'TicketId':
type: 'string'
required: true
return_type: 'RestapiReportListResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminTickets.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminTickets/GetReportsByTicket.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminTickets.GetReportsByTicketOp
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
ticketId,
);
var response = sdk.Reporting.AdminTickets.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@cs.reporting.fun':
id: 'GetTicketDetail@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminTickets.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminTickets/GetTicketDetail.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminTickets.GetTicketDetailOp
.Build();
var response = sdk.Reporting.AdminTickets.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@cs.reporting.fun':
id: 'ListReports@cs.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: 'long'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'long'
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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminReports.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminReports/ListReports.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminReports.ListReportsOp
.SetCategory(...)
.SetLimit(...)
.SetOffset(...)
.SetReportedUserId(...)
.SetSortBy(...)
.Build(
namespace_,
);
var response = sdk.Reporting.AdminReports.ListReports(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'list'
- 'reports'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'ListTickets@cs.reporting.fun':
id: 'ListTickets@cs.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: 'long'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'long'
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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminTickets.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminTickets/ListTickets.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminTickets.ListTicketsOp
.SetCategory(...)
.SetExtensionCategory(...)
.SetLimit(...)
.SetOffset(...)
.SetOrder(...)
.SetReportedUserId(...)
.SetSortBy(...)
.SetStatus(...)
.Build(
namespace_,
);
var response = sdk.Reporting.AdminTickets.ListTickets(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'list'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'PublicGetReasons@cs.reporting.fun':
id: 'PublicGetReasons@cs.reporting.fun'
name: 'PublicGetReasons'
type: 'function'
arguments:
'Group':
type: 'string'
required: false
description: |-
query reasons under specified reason group
'Limit':
type: 'long'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'long'
required: false
description: |-
number of data offset (default 0)
'Title':
type: 'string'
required: false
description: |-
query reason(s) by title
return_type: 'RestapiPublicReasonListResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/PublicReasons.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/PublicReasons/PublicGetReasons.cs'
example: |-
try
{
var operation = sdk.Reporting.PublicReasons.PublicGetReasonsOp
.SetGroup(...)
.SetLimit(...)
.SetOffset(...)
.SetTitle(...)
.Build(
namespace_,
);
var response = sdk.Reporting.PublicReasons.PublicGetReasons(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'public'
- 'reasons'
'PublicListReasonGroups@cs.reporting.fun':
id: 'PublicListReasonGroups@cs.reporting.fun'
name: 'PublicListReasonGroups'
type: 'function'
description: |-
Return list of reason groups ID and title under given namespace.
arguments:
'Limit':
type: 'long'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'long'
required: false
description: |-
number of data offset (default 0)
return_type: 'RestapiReasonGroupListResponse'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/PublicReasons.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/PublicReasons/PublicListReasonGroups.cs'
example: |-
try
{
var operation = sdk.Reporting.PublicReasons.PublicListReasonGroupsOp
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
);
var response = sdk.Reporting.PublicReasons.PublicListReasonGroups(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'groups'
- 'list'
- 'public'
- 'reason'
- 'reasons'
'SubmitReport@cs.reporting.fun':
id: 'SubmitReport@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/PublicReports.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/PublicReports/SubmitReport.cs'
example: |-
try
{
var operation = sdk.Reporting.PublicReports.SubmitReportOp
.Build();
var response = sdk.Reporting.PublicReports.SubmitReport(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'public'
- 'report'
- 'reports'
- 'submit'
'TicketStatistic@cs.reporting.fun':
id: 'TicketStatistic@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminTickets.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminTickets/TicketStatistic.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminTickets.TicketStatisticOp
.SetExtensionCategory(...)
.Build(
category,
namespace_,
);
var response = sdk.Reporting.AdminTickets.TicketStatistic(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'statistic'
- 'ticket'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'UpdateModerationRule@cs.reporting.fun':
id: 'UpdateModerationRule@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminModerationRule.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminModerationRule/UpdateModerationRule.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminModerationRule.UpdateModerationRuleOp
.Build();
var response = sdk.Reporting.AdminModerationRule.UpdateModerationRule(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'moderation'
- 'rule'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [UPDATE]'
'UpdateModerationRuleStatus@cs.reporting.fun':
id: 'UpdateModerationRuleStatus@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminModerationRule.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminModerationRule/UpdateModerationRuleStatus.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminModerationRule.UpdateModerationRuleStatusOp
.Build();
sdk.Reporting.AdminModerationRule.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@cs.reporting.fun':
id: 'UpdateReason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminReasons.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminReasons/UpdateReason.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminReasons.UpdateReasonOp
.Build();
var response = sdk.Reporting.AdminReasons.UpdateReason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'reason'
- 'reasons'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [UPDATE]'
'UpdateReasonGroup@cs.reporting.fun':
id: 'UpdateReasonGroup@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminReasons.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminReasons/UpdateReasonGroup.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminReasons.UpdateReasonGroupOp
.Build();
var response = sdk.Reporting.AdminReasons.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@cs.reporting.fun':
id: 'UpdateTicketResolutions@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminTickets.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminTickets/UpdateTicketResolutions.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminTickets.UpdateTicketResolutionsOp
.Build();
var response = sdk.Reporting.AdminTickets.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@cs.reporting.fun':
id: 'Upsert@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Reporting.Model;'
- 'using AccelByte.Sdk.Api.Reporting.Operation;'
- 'using AccelByte.Sdk.Api.Reporting.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Wrapper/AdminConfigurations.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Reporting/Operation/AdminConfigurations/Upsert.cs'
example: |-
try
{
var operation = sdk.Reporting.AdminConfigurations.UpsertOp
.Build();
var response = sdk.Reporting.AdminConfigurations.Upsert(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'configurations'
- 'upsert'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REPORTINGCONFIG [CREATE]'
# endregion functions
