symbols:
'NewReportingClient@go.reporting.fun':
id: 'NewReportingClient@go.reporting.fun'
name: 'NewReportingClient'
type: 'function'
arguments:
configRepository:
type: 'repository.ConfigRepository'
return_type: '*reportingclient.JusticeReportingService'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-modular-sdk/reporting-sdk/pkg/reportingclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/justice_reporting_service_client.go'
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/factory/reportingclientfactory.go'
example: |-
reportingClient := factory.NewReportingClient(configRepo)
# region wrappers
'AdminConfigurationsService@go.reporting.mod':
id: 'AdminConfigurationsService@go.reporting.mod'
name: 'AdminConfigurationsService'
type: 'model'
fields:
Client:
type: '*reportingclient.JusticeReportingService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminConfigurations.go'
example: |-
reportingClient := factory.NewReportingClient(configRepo) // re-use if it exists already
adminConfigurationsService := AdminConfigurationsService{
Client: reportingClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'AdminExtensionCategoriesAndAutoModerationActionsService@go.reporting.mod':
id: 'AdminExtensionCategoriesAndAutoModerationActionsService@go.reporting.mod'
name: 'AdminExtensionCategoriesAndAutoModerationActionsService'
type: 'model'
fields:
Client:
type: '*reportingclient.JusticeReportingService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminExtensionCategoriesAndAutoModerationActions.go'
example: |-
reportingClient := factory.NewReportingClient(configRepo) // re-use if it exists already
adminExtensionCategoriesAndAutoModerationActionsService := AdminExtensionCategoriesAndAutoModerationActionsService{
Client: reportingClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'AdminModerationRuleService@go.reporting.mod':
id: 'AdminModerationRuleService@go.reporting.mod'
name: 'AdminModerationRuleService'
type: 'model'
fields:
Client:
type: '*reportingclient.JusticeReportingService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminModerationRule.go'
example: |-
reportingClient := factory.NewReportingClient(configRepo) // re-use if it exists already
adminModerationRuleService := AdminModerationRuleService{
Client: reportingClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'AdminReasonsService@go.reporting.mod':
id: 'AdminReasonsService@go.reporting.mod'
name: 'AdminReasonsService'
type: 'model'
fields:
Client:
type: '*reportingclient.JusticeReportingService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReasons.go'
example: |-
reportingClient := factory.NewReportingClient(configRepo) // re-use if it exists already
adminReasonsService := AdminReasonsService{
Client: reportingClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'AdminReportsService@go.reporting.mod':
id: 'AdminReportsService@go.reporting.mod'
name: 'AdminReportsService'
type: 'model'
fields:
Client:
type: '*reportingclient.JusticeReportingService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReports.go'
example: |-
reportingClient := factory.NewReportingClient(configRepo) // re-use if it exists already
adminReportsService := AdminReportsService{
Client: reportingClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'AdminTicketsService@go.reporting.mod':
id: 'AdminTicketsService@go.reporting.mod'
name: 'AdminTicketsService'
type: 'model'
fields:
Client:
type: '*reportingclient.JusticeReportingService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminTickets.go'
example: |-
reportingClient := factory.NewReportingClient(configRepo) // re-use if it exists already
adminTicketsService := AdminTicketsService{
Client: reportingClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'PublicReasonsService@go.reporting.mod':
id: 'PublicReasonsService@go.reporting.mod'
name: 'PublicReasonsService'
type: 'model'
fields:
Client:
type: '*reportingclient.JusticeReportingService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/publicReasons.go'
example: |-
reportingClient := factory.NewReportingClient(configRepo) // re-use if it exists already
publicReasonsService := PublicReasonsService{
Client: reportingClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
'PublicReportsService@go.reporting.mod':
id: 'PublicReportsService@go.reporting.mod'
name: 'PublicReportsService'
type: 'model'
fields:
Client:
type: '*reportingclient.JusticeReportingService'
ConfigRepository:
type: 'repository.ConfigRepository'
TokenRepository:
type: 'repository.TokenRepository'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/publicReports.go'
example: |-
reportingClient := factory.NewReportingClient(configRepo) // re-use if it exists already
publicReportsService := PublicReportsService{
Client: reportingClient,
ConfigRepository: configRepo,
TokenRepository: tokenRepo,
}
# endregion wrappers
# region params
'AdminCreateExtensionCategoryParams@go.reporting.mod':
id: 'AdminCreateExtensionCategoryParams@go.reporting.mod'
name: 'AdminCreateExtensionCategoryParams'
type: 'model'
fields:
'Body':
type: '*RestapiExtensionCategoryAPIRequest'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_extension_categories_and_auto_moderation_actions'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_extension_categories_and_auto_moderation_actions/admin_create_extension_category_parameters.go'
'AdminCreateModActionParams@go.reporting.mod':
id: 'AdminCreateModActionParams@go.reporting.mod'
name: 'AdminCreateModActionParams'
type: 'model'
fields:
'Body':
type: '*RestapiActionAPIRequest'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_extension_categories_and_auto_moderation_actions'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_extension_categories_and_auto_moderation_actions/admin_create_mod_action_parameters.go'
'AdminFindActionListParams@go.reporting.mod':
id: 'AdminFindActionListParams@go.reporting.mod'
name: 'AdminFindActionListParams'
type: 'model'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_extension_categories_and_auto_moderation_actions'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_extension_categories_and_auto_moderation_actions/admin_find_action_list_parameters.go'
'AdminFindExtensionCategoryListParams@go.reporting.mod':
id: 'AdminFindExtensionCategoryListParams@go.reporting.mod'
name: 'AdminFindExtensionCategoryListParams'
type: 'model'
fields:
'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'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_extension_categories_and_auto_moderation_actions'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_extension_categories_and_auto_moderation_actions/admin_find_extension_category_list_parameters.go'
'AdminGetAllReasonsParams@go.reporting.mod':
id: 'AdminGetAllReasonsParams@go.reporting.mod'
name: 'AdminGetAllReasonsParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_reasons/admin_get_all_reasons_parameters.go'
'AdminGetReasonParams@go.reporting.mod':
id: 'AdminGetReasonParams@go.reporting.mod'
name: 'AdminGetReasonParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
'ReasonID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_reasons/admin_get_reason_parameters.go'
'AdminGetReasonsParams@go.reporting.mod':
id: 'AdminGetReasonsParams@go.reporting.mod'
name: 'AdminGetReasonsParams'
type: 'model'
fields:
'Group':
type: 'string'
required: false
description: |-
query reasons under specified reason group
'Limit':
type: 'int64'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'int64'
required: false
description: |-
number of data offset (default 0)
'Title':
type: 'string'
required: false
description: |-
query reason(s) by title
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_reasons/admin_get_reasons_parameters.go'
'AdminGetUnusedReasonsParams@go.reporting.mod':
id: 'AdminGetUnusedReasonsParams@go.reporting.mod'
name: 'AdminGetUnusedReasonsParams'
type: 'model'
fields:
'Category':
type: 'string'
required: true
'ExtensionCategory':
type: 'string'
required: false
'Namespace':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_reasons/admin_get_unused_reasons_parameters.go'
'AdminListReasonGroupsParams@go.reporting.mod':
id: 'AdminListReasonGroupsParams@go.reporting.mod'
name: 'AdminListReasonGroupsParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'int64'
required: false
description: |-
number of data offset (default 0)
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_reasons/admin_list_reason_groups_parameters.go'
'AdminSubmitReportParams@go.reporting.mod':
id: 'AdminSubmitReportParams@go.reporting.mod'
name: 'AdminSubmitReportParams'
type: 'model'
fields:
'Body':
type: '*RestapiSubmitReportRequest'
required: true
'Namespace':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reports'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_reports/admin_submit_report_parameters.go'
'CreateModerationRuleParams@go.reporting.mod':
id: 'CreateModerationRuleParams@go.reporting.mod'
name: 'CreateModerationRuleParams'
type: 'model'
fields:
'Body':
type: '*RestapiModerationRuleRequest'
required: true
'Namespace':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_moderation_rule'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_moderation_rule/create_moderation_rule_parameters.go'
'CreateReasonParams@go.reporting.mod':
id: 'CreateReasonParams@go.reporting.mod'
name: 'CreateReasonParams'
type: 'model'
fields:
'Body':
type: '*RestapiCreateReasonRequest'
required: true
'Namespace':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_reasons/create_reason_parameters.go'
'CreateReasonGroupParams@go.reporting.mod':
id: 'CreateReasonGroupParams@go.reporting.mod'
name: 'CreateReasonGroupParams'
type: 'model'
fields:
'Body':
type: '*RestapiCreateReasonGroupRequest'
required: true
'Namespace':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_reasons/create_reason_group_parameters.go'
'DeleteModerationRuleParams@go.reporting.mod':
id: 'DeleteModerationRuleParams@go.reporting.mod'
name: 'DeleteModerationRuleParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
'RuleID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_moderation_rule'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_moderation_rule/delete_moderation_rule_parameters.go'
'DeleteReasonParams@go.reporting.mod':
id: 'DeleteReasonParams@go.reporting.mod'
name: 'DeleteReasonParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
'ReasonID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_reasons/delete_reason_parameters.go'
'DeleteReasonGroupParams@go.reporting.mod':
id: 'DeleteReasonGroupParams@go.reporting.mod'
name: 'DeleteReasonGroupParams'
type: 'model'
fields:
'GroupID':
type: 'string'
required: true
description: |-
Reason group ID
'Namespace':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_reasons/delete_reason_group_parameters.go'
'DeleteTicketParams@go.reporting.mod':
id: 'DeleteTicketParams@go.reporting.mod'
name: 'DeleteTicketParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
'TicketID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_tickets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_tickets/delete_ticket_parameters.go'
'GetParams@go.reporting.mod':
id: 'GetParams@go.reporting.mod'
name: 'GetParams'
type: 'model'
fields:
'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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_configurations'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_configurations/get_parameters.go'
'GetModerationRuleDetailsParams@go.reporting.mod':
id: 'GetModerationRuleDetailsParams@go.reporting.mod'
name: 'GetModerationRuleDetailsParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
'RuleID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_moderation_rule'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_moderation_rule/get_moderation_rule_details_parameters.go'
'GetModerationRulesParams@go.reporting.mod':
id: 'GetModerationRulesParams@go.reporting.mod'
name: 'GetModerationRulesParams'
type: 'model'
fields:
'Category':
type: 'string'
required: false
description: |-
filter rules by category
'ExtensionCategory':
type: 'string'
required: false
description: |-
filter rules by extension category
'Limit':
type: 'int64'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'int64'
required: false
description: |-
number of data offset (default 0)
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_moderation_rule'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_moderation_rule/get_moderation_rules_parameters.go'
'GetReasonGroupParams@go.reporting.mod':
id: 'GetReasonGroupParams@go.reporting.mod'
name: 'GetReasonGroupParams'
type: 'model'
fields:
'GroupID':
type: 'string'
required: true
description: |-
Reason group ID
'Namespace':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_reasons/get_reason_group_parameters.go'
'GetReportsByTicketParams@go.reporting.mod':
id: 'GetReportsByTicketParams@go.reporting.mod'
name: 'GetReportsByTicketParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'int64'
required: false
description: |-
number of data offset (default 0)
'TicketID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_tickets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_tickets/get_reports_by_ticket_parameters.go'
'GetTicketDetailParams@go.reporting.mod':
id: 'GetTicketDetailParams@go.reporting.mod'
name: 'GetTicketDetailParams'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
'TicketID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_tickets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_tickets/get_ticket_detail_parameters.go'
'ListReportsParams@go.reporting.mod':
id: 'ListReportsParams@go.reporting.mod'
name: 'ListReportsParams'
type: 'model'
fields:
'Category':
type: 'string'
required: false
description: |-
filter reports by category
'Limit':
type: 'int64'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'int64'
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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reports'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_reports/list_reports_parameters.go'
'ListTicketsParams@go.reporting.mod':
id: 'ListTicketsParams@go.reporting.mod'
name: 'ListTicketsParams'
type: 'model'
fields:
'Category':
type: 'string'
required: false
description: |-
filter tickets by category
'ExtensionCategory':
type: 'string'
required: false
description: |-
filter tickets by extension category
'Limit':
type: 'int64'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'int64'
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)
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_tickets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_tickets/list_tickets_parameters.go'
'PublicGetReasonsParams@go.reporting.mod':
id: 'PublicGetReasonsParams@go.reporting.mod'
name: 'PublicGetReasonsParams'
type: 'model'
fields:
'Group':
type: 'string'
required: false
description: |-
query reasons under specified reason group
'Limit':
type: 'int64'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'int64'
required: false
description: |-
number of data offset (default 0)
'Title':
type: 'string'
required: false
description: |-
query reason(s) by title
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/public_reasons'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/public_reasons/public_get_reasons_parameters.go'
'PublicListReasonGroupsParams@go.reporting.mod':
id: 'PublicListReasonGroupsParams@go.reporting.mod'
name: 'PublicListReasonGroupsParams'
type: 'model'
fields:
'Limit':
type: 'int64'
required: false
description: |-
number of data requested (default 25)
'Namespace':
type: 'string'
required: true
'Offset':
type: 'int64'
required: false
description: |-
number of data offset (default 0)
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/public_reasons'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/public_reasons/public_list_reason_groups_parameters.go'
'SubmitReportParams@go.reporting.mod':
id: 'SubmitReportParams@go.reporting.mod'
name: 'SubmitReportParams'
type: 'model'
fields:
'Body':
type: '*RestapiSubmitReportRequest'
required: true
'Namespace':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/public_reports'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/public_reports/submit_report_parameters.go'
'TicketStatisticParams@go.reporting.mod':
id: 'TicketStatisticParams@go.reporting.mod'
name: 'TicketStatisticParams'
type: 'model'
fields:
'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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_tickets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_tickets/ticket_statistic_parameters.go'
'UpdateModerationRuleParams@go.reporting.mod':
id: 'UpdateModerationRuleParams@go.reporting.mod'
name: 'UpdateModerationRuleParams'
type: 'model'
fields:
'Body':
type: '*RestapiModerationRuleRequest'
required: true
'Namespace':
type: 'string'
required: true
'RuleID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_moderation_rule'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_moderation_rule/update_moderation_rule_parameters.go'
'UpdateModerationRuleStatusParams@go.reporting.mod':
id: 'UpdateModerationRuleStatusParams@go.reporting.mod'
name: 'UpdateModerationRuleStatusParams'
type: 'model'
fields:
'Body':
type: '*RestapiModerationRuleActiveRequest'
required: true
'Namespace':
type: 'string'
required: true
'RuleID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_moderation_rule'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_moderation_rule/update_moderation_rule_status_parameters.go'
'UpdateReasonParams@go.reporting.mod':
id: 'UpdateReasonParams@go.reporting.mod'
name: 'UpdateReasonParams'
type: 'model'
fields:
'Body':
type: '*RestapiCreateReasonRequest'
required: true
'Namespace':
type: 'string'
required: true
'ReasonID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_reasons/update_reason_parameters.go'
'UpdateReasonGroupParams@go.reporting.mod':
id: 'UpdateReasonGroupParams@go.reporting.mod'
name: 'UpdateReasonGroupParams'
type: 'model'
fields:
'Body':
type: '*RestapiUpdateReasonGroupRequest'
required: true
'GroupID':
type: 'string'
required: true
description: |-
Reason group ID
'Namespace':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_reasons/update_reason_group_parameters.go'
'UpdateTicketResolutionsParams@go.reporting.mod':
id: 'UpdateTicketResolutionsParams@go.reporting.mod'
name: 'UpdateTicketResolutionsParams'
type: 'model'
fields:
'Body':
type: '*RestapiUpdateTicketResolutionsRequest'
required: true
'Namespace':
type: 'string'
required: true
'TicketID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_tickets'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_tickets/update_ticket_resolutions_parameters.go'
'UpsertParams@go.reporting.mod':
id: 'UpsertParams@go.reporting.mod'
name: 'UpsertParams'
type: 'model'
fields:
'Body':
type: '*RestapiReportingLimit'
required: true
'Namespace':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_configurations'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclient/admin_configurations/upsert_parameters.go'
# endregion params
# region models
'RestapiActionAPIRequest@go.reporting.mod':
id: 'RestapiActionAPIRequest@go.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:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_action_api_request.go'
'RestapiActionAPIResponse@go.reporting.mod':
id: 'RestapiActionAPIResponse@go.reporting.mod'
name: 'RestapiActionAPIResponse'
type: 'model'
fields:
'ActionID':
type: 'string'
required: true
'ActionName':
type: 'string'
required: true
'EventName':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_action_api_response.go'
'RestapiActionListAPIResponse@go.reporting.mod':
id: 'RestapiActionListAPIResponse@go.reporting.mod'
name: 'RestapiActionListAPIResponse'
type: 'model'
fields:
'Data':
type: '[]*RestapiActionAPIResponse'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_action_list_api_response.go'
'RestapiAdminAllReasonsResponse@go.reporting.mod':
id: 'RestapiAdminAllReasonsResponse@go.reporting.mod'
name: 'RestapiAdminAllReasonsResponse'
type: 'model'
fields:
'Data':
type: '[]*RestapiPublicReasonResponse'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_admin_all_reasons_response.go'
'RestapiAdminReasonListResponse@go.reporting.mod':
id: 'RestapiAdminReasonListResponse@go.reporting.mod'
name: 'RestapiAdminReasonListResponse'
type: 'model'
fields:
'Data':
type: '[]*RestapiAdminReasonResponse'
required: true
'Paging':
type: '*RestapiPagination'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_admin_reason_list_response.go'
'RestapiAdminReasonResponse@go.reporting.mod':
id: 'RestapiAdminReasonResponse@go.reporting.mod'
name: 'RestapiAdminReasonResponse'
type: 'model'
fields:
'CreatedAt':
type: 'string'
required: true
'Description':
type: 'string'
required: true
'Groups':
type: '[]*RestapiPublicReasonGroupResponse'
required: false
'ID':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'Title':
type: 'string'
required: true
'UpdatedAt':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_admin_reason_response.go'
'RestapiBanAccountActionRequest@go.reporting.mod':
id: 'RestapiBanAccountActionRequest@go.reporting.mod'
name: 'RestapiBanAccountActionRequest'
type: 'model'
fields:
'Comment':
type: 'string'
required: false
description: |-
Ban comment
'Duration':
type: 'int32'
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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_ban_account_action_request.go'
'RestapiBanAccountActionResponse@go.reporting.mod':
id: 'RestapiBanAccountActionResponse@go.reporting.mod'
name: 'RestapiBanAccountActionResponse'
type: 'model'
fields:
'Comment':
type: 'string'
required: false
description: |-
Ban comment
'Duration':
type: 'int32'
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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_ban_account_action_response.go'
'RestapiCategoryLimit@go.reporting.mod':
id: 'RestapiCategoryLimit@go.reporting.mod'
name: 'RestapiCategoryLimit'
type: 'model'
fields:
'ExtensionCategory':
type: 'string'
required: false
'MaxReportPerTicket':
type: 'int32'
required: true
description: |-
must between 1 to 2147483647
'Name':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_category_limit.go'
'RestapiConfigResponse@go.reporting.mod':
id: 'RestapiConfigResponse@go.reporting.mod'
name: 'RestapiConfigResponse'
type: 'model'
fields:
'Namespace':
type: 'string'
required: true
'ReportingLimit':
type: '*RestapiReportingLimit'
required: true
'UpdatedAt':
type: 'strfmt.DateTime'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_config_response.go'
'RestapiCreateReasonGroupRequest@go.reporting.mod':
id: 'RestapiCreateReasonGroupRequest@go.reporting.mod'
name: 'RestapiCreateReasonGroupRequest'
type: 'model'
fields:
'ReasonIds':
type: '[]string'
required: false
'Title':
type: 'string'
required: true
description: |-
max 256 chars
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_create_reason_group_request.go'
'RestapiCreateReasonRequest@go.reporting.mod':
id: 'RestapiCreateReasonRequest@go.reporting.mod'
name: 'RestapiCreateReasonRequest'
type: 'model'
fields:
'Description':
type: 'string'
required: true
description: |-
max 280 chars
'GroupIds':
type: '[]string'
required: true
'Title':
type: 'string'
required: true
description: |-
max 256 chars
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_create_reason_request.go'
'RestapiErrorResponse@go.reporting.mod':
id: 'RestapiErrorResponse@go.reporting.mod'
name: 'RestapiErrorResponse'
type: 'model'
fields:
'ErrorCode':
type: 'int32'
required: true
'ErrorMessage':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_error_response.go'
'RestapiExtensionCategoryAPIRequest@go.reporting.mod':
id: 'RestapiExtensionCategoryAPIRequest@go.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:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_extension_category_api_request.go'
'RestapiExtensionCategoryAPIResponse@go.reporting.mod':
id: 'RestapiExtensionCategoryAPIResponse@go.reporting.mod'
name: 'RestapiExtensionCategoryAPIResponse'
type: 'model'
fields:
'ExtensionCategory':
type: 'string'
required: true
'ExtensionCategoryName':
type: 'string'
required: true
'ServiceSource':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_extension_category_api_response.go'
'RestapiExtensionCategoryListAPIResponse@go.reporting.mod':
id: 'RestapiExtensionCategoryListAPIResponse@go.reporting.mod'
name: 'RestapiExtensionCategoryListAPIResponse'
type: 'model'
fields:
'Data':
type: '[]*RestapiExtensionCategoryAPIResponse'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_extension_category_list_api_response.go'
'RestapiModerationRuleActionsRequest@go.reporting.mod':
id: 'RestapiModerationRuleActionsRequest@go.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: '[]string'
required: false
description: |-
Custom services moderation actions
'HideContent':
type: 'bool'
required: false
description: |-
Enable hide content action
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_moderation_rule_actions_request.go'
'RestapiModerationRuleActionsResponse@go.reporting.mod':
id: 'RestapiModerationRuleActionsResponse@go.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: '[]string'
required: false
description: |-
custom service mod actions
'HideContent':
type: 'bool'
required: false
description: |-
Enable hide content action
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_moderation_rule_actions_response.go'
'RestapiModerationRuleActiveRequest@go.reporting.mod':
id: 'RestapiModerationRuleActiveRequest@go.reporting.mod'
name: 'RestapiModerationRuleActiveRequest'
type: 'model'
fields:
'Active':
type: 'bool'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_moderation_rule_active_request.go'
'RestapiModerationRuleRequest@go.reporting.mod':
id: 'RestapiModerationRuleRequest@go.reporting.mod'
name: 'RestapiModerationRuleRequest'
type: 'model'
fields:
'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
'Active':
type: 'bool'
required: true
description: |-
status of this rule
'Category':
type: 'string'
required: true
description: |-
Report category, must select from pre defined list
'ExtensionCategory':
type: 'string'
required: false
description: |-
Report extension category, consist of custom services sub-category (eg. salesItem,challenge,etc)
'Reason':
type: 'string'
required: true
description: |-
Reason of report, can select from pre defined list, max 128 chars
'Threshold':
type: 'int32'
required: true
description: |-
the threshold to trigger auto moderation
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_moderation_rule_request.go'
'RestapiModerationRuleResponse@go.reporting.mod':
id: 'RestapiModerationRuleResponse@go.reporting.mod'
name: 'RestapiModerationRuleResponse'
type: 'model'
fields:
'Action':
type: 'string'
required: false
description: |-
GOING TO DEPRECATE, PLEASE DO NOT USE, for replacement use the "actions" field
'Actions':
type: '*RestapiModerationRuleActionsResponse'
required: true
description: |-
Action configurations for moderation rule
'Active':
type: 'bool'
required: true
'Category':
type: 'string'
required: true
'CreatedAt':
type: 'strfmt.DateTime'
required: true
'ExtensionCategory':
type: 'string'
required: false
'ID':
type: 'string'
required: true
'Namespace':
type: 'string'
required: true
'Reason':
type: 'string'
required: true
'Threshold':
type: 'int32'
required: true
'UpdatedAt':
type: '*strfmt.DateTime'
required: false
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_moderation_rule_response.go'
'RestapiModerationRulesList@go.reporting.mod':
id: 'RestapiModerationRulesList@go.reporting.mod'
name: 'RestapiModerationRulesList'
type: 'model'
fields:
'Data':
type: '[]*RestapiModerationRuleResponse'
required: true
'Paging':
type: '*RestapiPagination'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_moderation_rules_list.go'
'RestapiPagination@go.reporting.mod':
id: 'RestapiPagination@go.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:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_pagination.go'
'RestapiPublicReasonGroupResponse@go.reporting.mod':
id: 'RestapiPublicReasonGroupResponse@go.reporting.mod'
name: 'RestapiPublicReasonGroupResponse'
type: 'model'
fields:
'ID':
type: 'string'
required: true
'Title':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_public_reason_group_response.go'
'RestapiPublicReasonListResponse@go.reporting.mod':
id: 'RestapiPublicReasonListResponse@go.reporting.mod'
name: 'RestapiPublicReasonListResponse'
type: 'model'
fields:
'Data':
type: '[]*RestapiPublicReasonResponse'
required: true
'Paging':
type: '*RestapiPagination'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_public_reason_list_response.go'
'RestapiPublicReasonResponse@go.reporting.mod':
id: 'RestapiPublicReasonResponse@go.reporting.mod'
name: 'RestapiPublicReasonResponse'
type: 'model'
fields:
'Description':
type: 'string'
required: true
'Title':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_public_reason_response.go'
'RestapiReasonGroupListResponse@go.reporting.mod':
id: 'RestapiReasonGroupListResponse@go.reporting.mod'
name: 'RestapiReasonGroupListResponse'
type: 'model'
fields:
'Data':
type: '[]*RestapiPublicReasonGroupResponse'
required: true
'Paging':
type: '*RestapiPagination'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_reason_group_list_response.go'
'RestapiReasonGroupResponse@go.reporting.mod':
id: 'RestapiReasonGroupResponse@go.reporting.mod'
name: 'RestapiReasonGroupResponse'
type: 'model'
fields:
'ID':
type: 'string'
required: true
'Reasons':
type: '[]*RestapiAdminReasonResponse'
required: false
'Title':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_reason_group_response.go'
'RestapiReportingLimit@go.reporting.mod':
id: 'RestapiReportingLimit@go.reporting.mod'
name: 'RestapiReportingLimit'
type: 'model'
fields:
'CategoryLimits':
type: '[]*RestapiCategoryLimit'
required: true
'TimeInterval':
type: 'int64'
required: true
description: |-
the unit is nanoseconds, must between 1 to 6000000 seconds
'UserMaxReportPerTimeInterval':
type: 'int32'
required: true
description: |-
must between 1 to 2147483647
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_reporting_limit.go'
'RestapiReportListResponse@go.reporting.mod':
id: 'RestapiReportListResponse@go.reporting.mod'
name: 'RestapiReportListResponse'
type: 'model'
fields:
'Data':
type: '[]*RestapiReportResponse'
required: true
'Paging':
type: '*RestapiPagination'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_report_list_response.go'
'RestapiReportResponse@go.reporting.mod':
id: 'RestapiReportResponse@go.reporting.mod'
name: 'RestapiReportResponse'
type: 'model'
fields:
'AdditionalInfo':
type: 'interface{}'
required: true
'Category':
type: 'string'
required: true
'Comment':
type: 'string'
required: true
'CreatedAt':
type: 'string'
required: true
'ExtensionCategory':
type: 'string'
required: false
'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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_report_response.go'
'RestapiSubmitReportRequest@go.reporting.mod':
id: 'RestapiSubmitReportRequest@go.reporting.mod'
name: 'RestapiSubmitReportRequest'
type: 'model'
fields:
'AdditionalInfo':
type: 'interface{}'
required: false
description: |-
Additional info regarding reported user / content, JSON formatted
'Category':
type: 'string'
required: true
description: |-
Report category, must select from pre defined list
'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
'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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_submit_report_request.go'
'RestapiSubmitReportResponse@go.reporting.mod':
id: 'RestapiSubmitReportResponse@go.reporting.mod'
name: 'RestapiSubmitReportResponse'
type: 'model'
fields:
'Category':
type: 'string'
required: true
'CreatedAt':
type: 'string'
required: true
'ExtensionCategory':
type: 'string'
required: false
'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
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_submit_report_response.go'
'RestapiTicketListResponse@go.reporting.mod':
id: 'RestapiTicketListResponse@go.reporting.mod'
name: 'RestapiTicketListResponse'
type: 'model'
fields:
'Data':
type: '[]*RestapiTicketResponse'
required: true
'Paging':
type: '*RestapiPagination'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_ticket_list_response.go'
'RestapiTicketResponse@go.reporting.mod':
id: 'RestapiTicketResponse@go.reporting.mod'
name: 'RestapiTicketResponse'
type: 'model'
fields:
'Category':
type: 'string'
required: true
'CreatedAt':
type: 'string'
required: true
'ExtensionCategory':
type: 'string'
required: false
'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: 'int32'
required: true
'Status':
type: 'string'
required: true
'UpdatedAt':
type: 'string'
required: true
'UserID':
type: 'string'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_ticket_response.go'
'RestapiTicketStatisticResponse@go.reporting.mod':
id: 'RestapiTicketStatisticResponse@go.reporting.mod'
name: 'RestapiTicketStatisticResponse'
type: 'model'
fields:
'ModeratedCount':
type: 'int64'
required: true
'OpenCount':
type: 'int64'
required: true
'TotalCount':
type: 'int64'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_ticket_statistic_response.go'
'RestapiUnusedReasonListResponse@go.reporting.mod':
id: 'RestapiUnusedReasonListResponse@go.reporting.mod'
name: 'RestapiUnusedReasonListResponse'
type: 'model'
fields:
'Reasons':
type: '[]*RestapiPublicReasonResponse'
required: true
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_unused_reason_list_response.go'
'RestapiUpdateReasonGroupRequest@go.reporting.mod':
id: 'RestapiUpdateReasonGroupRequest@go.reporting.mod'
name: 'RestapiUpdateReasonGroupRequest'
type: 'model'
fields:
'ReasonIds':
type: '[]string'
required: false
'Title':
type: 'string'
required: true
description: |-
max 256 chars
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_update_reason_group_request.go'
'RestapiUpdateTicketResolutionsRequest@go.reporting.mod':
id: 'RestapiUpdateTicketResolutionsRequest@go.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:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/reporting-sdk/pkg/reportingclientmodels/restapi_update_ticket_resolutions_request.go'
# endregion models
# region functions
'AdminCreateExtensionCategoryShort@go.reporting.fun':
id: 'AdminCreateExtensionCategoryShort@go.reporting.fun'
name: 'AdminCreateExtensionCategoryShort'
type: 'function'
description: |-
Create extension category data
struct: 'AdminExtensionCategoriesAndAutoModerationActionsService'
arguments:
params:
type: '*admin_extension_categories_and_auto_moderation_actions.AdminCreateExtensionCategoryParams'
required: true
return_type: '(*admin_extension_categories_and_auto_moderation_actions.AdminCreateExtensionCategoryResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_extension_categories_and_auto_moderation_actions'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminExtensionCategoriesAndAutoModerationActions.go'
example: |-
adminExtensionCategoriesAndAutoModerationActionsService := reporting.AdminExtensionCategoriesAndAutoModerationActionsService{ ... }
params := admin_extension_categories_and_auto_moderation_actions.AdminCreateExtensionCategoryParams{ ... }
res, err := adminExtensionCategoriesAndAutoModerationActionsService.AdminCreateExtensionCategoryShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'actions'
- 'admin'
- 'and'
- 'auto'
- 'categories'
- 'category'
- 'create'
- 'extension'
- 'moderation'
permissions:
- 'ADMIN:REPORTINGCONFIG [CREATE]'
'AdminCreateModActionShort@go.reporting.fun':
id: 'AdminCreateModActionShort@go.reporting.fun'
name: 'AdminCreateModActionShort'
type: 'function'
description: |-
Create auto moderation action
struct: 'AdminExtensionCategoriesAndAutoModerationActionsService'
arguments:
params:
type: '*admin_extension_categories_and_auto_moderation_actions.AdminCreateModActionParams'
required: true
return_type: '(*admin_extension_categories_and_auto_moderation_actions.AdminCreateModActionResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_extension_categories_and_auto_moderation_actions'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminExtensionCategoriesAndAutoModerationActions.go'
example: |-
adminExtensionCategoriesAndAutoModerationActionsService := reporting.AdminExtensionCategoriesAndAutoModerationActionsService{ ... }
params := admin_extension_categories_and_auto_moderation_actions.AdminCreateModActionParams{ ... }
res, err := adminExtensionCategoriesAndAutoModerationActionsService.AdminCreateModActionShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'action'
- 'actions'
- 'admin'
- 'and'
- 'auto'
- 'categories'
- 'create'
- 'extension'
- 'mod'
- 'moderation'
permissions:
- 'ADMIN:REPORTINGCONFIG [CREATE]'
'AdminFindActionListShort@go.reporting.fun':
id: 'AdminFindActionListShort@go.reporting.fun'
name: 'AdminFindActionListShort'
type: 'function'
description: |-
Get a list of auto moderation actions
struct: 'AdminExtensionCategoriesAndAutoModerationActionsService'
arguments:
params:
type: '*admin_extension_categories_and_auto_moderation_actions.AdminFindActionListParams'
required: true
return_type: '(*admin_extension_categories_and_auto_moderation_actions.AdminFindActionListResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_extension_categories_and_auto_moderation_actions'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminExtensionCategoriesAndAutoModerationActions.go'
example: |-
adminExtensionCategoriesAndAutoModerationActionsService := reporting.AdminExtensionCategoriesAndAutoModerationActionsService{ ... }
params := admin_extension_categories_and_auto_moderation_actions.AdminFindActionListParams{ ... }
res, err := adminExtensionCategoriesAndAutoModerationActionsService.AdminFindActionListShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'action'
- 'actions'
- 'admin'
- 'and'
- 'auto'
- 'categories'
- 'extension'
- 'find'
- 'list'
- 'moderation'
permissions:
- 'ADMIN:REPORTINGCONFIG [READ]'
'AdminFindExtensionCategoryListShort@go.reporting.fun':
id: 'AdminFindExtensionCategoryListShort@go.reporting.fun'
name: 'AdminFindExtensionCategoryListShort'
type: 'function'
description: |-
Get a list of extension category data with the specified name
struct: 'AdminExtensionCategoriesAndAutoModerationActionsService'
arguments:
params:
type: '*admin_extension_categories_and_auto_moderation_actions.AdminFindExtensionCategoryListParams'
required: true
return_type: '(*admin_extension_categories_and_auto_moderation_actions.AdminFindExtensionCategoryListResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_extension_categories_and_auto_moderation_actions'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminExtensionCategoriesAndAutoModerationActions.go'
example: |-
adminExtensionCategoriesAndAutoModerationActionsService := reporting.AdminExtensionCategoriesAndAutoModerationActionsService{ ... }
params := admin_extension_categories_and_auto_moderation_actions.AdminFindExtensionCategoryListParams{ ... }
res, err := adminExtensionCategoriesAndAutoModerationActionsService.AdminFindExtensionCategoryListShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'actions'
- 'admin'
- 'and'
- 'auto'
- 'categories'
- 'category'
- 'extension'
- 'find'
- 'list'
- 'moderation'
permissions:
- 'ADMIN:REPORTINGCONFIG [READ]'
'AdminGetAllReasonsShort@go.reporting.fun':
id: 'AdminGetAllReasonsShort@go.reporting.fun'
name: 'AdminGetAllReasonsShort'
type: 'function'
description: |-
This endpoint get all reasons without pagination.
struct: 'AdminReasonsService'
arguments:
params:
type: '*admin_reasons.AdminGetAllReasonsParams'
required: true
return_type: '(*admin_reasons.AdminGetAllReasonsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReasons.go'
example: |-
adminReasonsService := reporting.AdminReasonsService{ ... }
params := admin_reasons.AdminGetAllReasonsParams{ ... }
res, err := adminReasonsService.AdminGetAllReasonsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'all'
- 'get'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'AdminGetReasonShort@go.reporting.fun':
id: 'AdminGetReasonShort@go.reporting.fun'
name: 'AdminGetReasonShort'
type: 'function'
description: |-
This endpoint get a single reason.
struct: 'AdminReasonsService'
arguments:
params:
type: '*admin_reasons.AdminGetReasonParams'
required: true
return_type: '(*admin_reasons.AdminGetReasonResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReasons.go'
example: |-
adminReasonsService := reporting.AdminReasonsService{ ... }
params := admin_reasons.AdminGetReasonParams{ ... }
res, err := adminReasonsService.AdminGetReasonShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'get'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'AdminGetReasonsShort@go.reporting.fun':
id: 'AdminGetReasonsShort@go.reporting.fun'
name: 'AdminGetReasonsShort'
type: 'function'
description: |-
This endpoint get reasons with pagination
struct: 'AdminReasonsService'
arguments:
params:
type: '*admin_reasons.AdminGetReasonsParams'
required: true
return_type: '(*admin_reasons.AdminGetReasonsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReasons.go'
example: |-
adminReasonsService := reporting.AdminReasonsService{ ... }
params := admin_reasons.AdminGetReasonsParams{ ... }
res, err := adminReasonsService.AdminGetReasonsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'get'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'AdminGetUnusedReasonsShort@go.reporting.fun':
id: 'AdminGetUnusedReasonsShort@go.reporting.fun'
name: 'AdminGetUnusedReasonsShort'
type: 'function'
description: |-
This endpoint get reasons not used by moderation rules.
struct: 'AdminReasonsService'
arguments:
params:
type: '*admin_reasons.AdminGetUnusedReasonsParams'
required: true
return_type: '(*admin_reasons.AdminGetUnusedReasonsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReasons.go'
example: |-
adminReasonsService := reporting.AdminReasonsService{ ... }
params := admin_reasons.AdminGetUnusedReasonsParams{ ... }
res, err := adminReasonsService.AdminGetUnusedReasonsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'get'
- 'reasons'
- 'unused'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'AdminListReasonGroupsShort@go.reporting.fun':
id: 'AdminListReasonGroupsShort@go.reporting.fun'
name: 'AdminListReasonGroupsShort'
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.
struct: 'AdminReasonsService'
arguments:
params:
type: '*admin_reasons.AdminListReasonGroupsParams'
required: true
return_type: '(*admin_reasons.AdminListReasonGroupsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReasons.go'
example: |-
adminReasonsService := reporting.AdminReasonsService{ ... }
params := admin_reasons.AdminListReasonGroupsParams{ ... }
res, err := adminReasonsService.AdminListReasonGroupsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'groups'
- 'list'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'AdminSubmitReportShort@go.reporting.fun':
id: 'AdminSubmitReportShort@go.reporting.fun'
name: 'AdminSubmitReportShort'
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
struct: 'AdminReportsService'
arguments:
params:
type: '*admin_reports.AdminSubmitReportParams'
required: true
return_type: '(*admin_reports.AdminSubmitReportResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reports'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReports.go'
example: |-
adminReportsService := reporting.AdminReportsService{ ... }
params := admin_reports.AdminSubmitReportParams{ ... }
res, err := adminReportsService.AdminSubmitReportShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'report'
- 'reports'
- 'submit'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [CREATE]'
'CreateModerationRuleShort@go.reporting.fun':
id: 'CreateModerationRuleShort@go.reporting.fun'
name: 'CreateModerationRuleShort'
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
struct: 'AdminModerationRuleService'
arguments:
params:
type: '*admin_moderation_rule.CreateModerationRuleParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_moderation_rule'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminModerationRule.go'
example: |-
adminModerationRuleService := reporting.AdminModerationRuleService{ ... }
params := admin_moderation_rule.CreateModerationRuleParams{ ... }
res, err := adminModerationRuleService.CreateModerationRuleShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'create'
- 'moderation'
- 'rule'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [CREATE]'
'CreateReasonShort@go.reporting.fun':
id: 'CreateReasonShort@go.reporting.fun'
name: 'CreateReasonShort'
type: 'function'
description: |-
This endpoint create a reason for a namespace.
struct: 'AdminReasonsService'
arguments:
params:
type: '*admin_reasons.CreateReasonParams'
required: true
return_type: '(*admin_reasons.CreateReasonResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReasons.go'
example: |-
adminReasonsService := reporting.AdminReasonsService{ ... }
params := admin_reasons.CreateReasonParams{ ... }
res, err := adminReasonsService.CreateReasonShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'create'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [CREATE]'
'CreateReasonGroupShort@go.reporting.fun':
id: 'CreateReasonGroupShort@go.reporting.fun'
name: 'CreateReasonGroupShort'
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**
struct: 'AdminReasonsService'
arguments:
params:
type: '*admin_reasons.CreateReasonGroupParams'
required: true
return_type: '(*admin_reasons.CreateReasonGroupResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReasons.go'
example: |-
adminReasonsService := reporting.AdminReasonsService{ ... }
params := admin_reasons.CreateReasonGroupParams{ ... }
res, err := adminReasonsService.CreateReasonGroupShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'create'
- 'group'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [CREATE]'
'DeleteModerationRuleShort@go.reporting.fun':
id: 'DeleteModerationRuleShort@go.reporting.fun'
name: 'DeleteModerationRuleShort'
type: 'function'
description: |-
This endpoint delete moderation rule.
struct: 'AdminModerationRuleService'
arguments:
params:
type: '*admin_moderation_rule.DeleteModerationRuleParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_moderation_rule'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminModerationRule.go'
example: |-
adminModerationRuleService := reporting.AdminModerationRuleService{ ... }
params := admin_moderation_rule.DeleteModerationRuleParams{ ... }
res, err := adminModerationRuleService.DeleteModerationRuleShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'delete'
- 'moderation'
- 'rule'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [DELETE]'
'DeleteReasonShort@go.reporting.fun':
id: 'DeleteReasonShort@go.reporting.fun'
name: 'DeleteReasonShort'
type: 'function'
description: |-
This endpoint delete a reason for a namespace with ID.
struct: 'AdminReasonsService'
arguments:
params:
type: '*admin_reasons.DeleteReasonParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReasons.go'
example: |-
adminReasonsService := reporting.AdminReasonsService{ ... }
params := admin_reasons.DeleteReasonParams{ ... }
res, err := adminReasonsService.DeleteReasonShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'delete'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [DELETE]'
'DeleteReasonGroupShort@go.reporting.fun':
id: 'DeleteReasonGroupShort@go.reporting.fun'
name: 'DeleteReasonGroupShort'
type: 'function'
description: |-
This endpoint delete a reason group for a namespace with ID.
struct: 'AdminReasonsService'
arguments:
params:
type: '*admin_reasons.DeleteReasonGroupParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReasons.go'
example: |-
adminReasonsService := reporting.AdminReasonsService{ ... }
params := admin_reasons.DeleteReasonGroupParams{ ... }
res, err := adminReasonsService.DeleteReasonGroupShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'delete'
- 'group'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [DELETE]'
'DeleteTicketShort@go.reporting.fun':
id: 'DeleteTicketShort@go.reporting.fun'
name: 'DeleteTicketShort'
type: 'function'
description: |-
This endpoint will delete ticket and all its reports.
struct: 'AdminTicketsService'
arguments:
params:
type: '*admin_tickets.DeleteTicketParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_tickets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminTickets.go'
example: |-
adminTicketsService := reporting.AdminTicketsService{ ... }
params := admin_tickets.DeleteTicketParams{ ... }
res, err := adminTicketsService.DeleteTicketShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'delete'
- 'ticket'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [DELETE]'
'GetShort@go.reporting.fun':
id: 'GetShort@go.reporting.fun'
name: 'GetShort'
type: 'function'
description: |-
TimeInterval is in nanoseconds.
When there's no configuration set, the response is the default value (configurable through envar).
struct: 'AdminConfigurationsService'
arguments:
params:
type: '*admin_configurations.GetParams'
required: true
return_type: '(*admin_configurations.GetResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_configurations'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminConfigurations.go'
example: |-
adminConfigurationsService := reporting.AdminConfigurationsService{ ... }
params := admin_configurations.GetParams{ ... }
res, err := adminConfigurationsService.GetShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'configurations'
- 'get'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REPORTINGCONFIG [READ]'
'GetModerationRuleDetailsShort@go.reporting.fun':
id: 'GetModerationRuleDetailsShort@go.reporting.fun'
name: 'GetModerationRuleDetailsShort'
type: 'function'
description: |-
This endpoint get moderation rule.
struct: 'AdminModerationRuleService'
arguments:
params:
type: '*admin_moderation_rule.GetModerationRuleDetailsParams'
required: true
return_type: '(*admin_moderation_rule.GetModerationRuleDetailsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_moderation_rule'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminModerationRule.go'
example: |-
adminModerationRuleService := reporting.AdminModerationRuleService{ ... }
params := admin_moderation_rule.GetModerationRuleDetailsParams{ ... }
res, err := adminModerationRuleService.GetModerationRuleDetailsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'details'
- 'get'
- 'moderation'
- 'rule'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [READ]'
'GetModerationRulesShort@go.reporting.fun':
id: 'GetModerationRulesShort@go.reporting.fun'
name: 'GetModerationRulesShort'
type: 'function'
description: |-
This endpoint get moderation rules.
struct: 'AdminModerationRuleService'
arguments:
params:
type: '*admin_moderation_rule.GetModerationRulesParams'
required: true
return_type: '(*admin_moderation_rule.GetModerationRulesResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_moderation_rule'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminModerationRule.go'
example: |-
adminModerationRuleService := reporting.AdminModerationRuleService{ ... }
params := admin_moderation_rule.GetModerationRulesParams{ ... }
res, err := adminModerationRuleService.GetModerationRulesShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'get'
- 'moderation'
- 'rule'
- 'rules'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [READ]'
'GetReasonGroupShort@go.reporting.fun':
id: 'GetReasonGroupShort@go.reporting.fun'
name: 'GetReasonGroupShort'
type: 'function'
struct: 'AdminReasonsService'
arguments:
params:
type: '*admin_reasons.GetReasonGroupParams'
required: true
return_type: '(*admin_reasons.GetReasonGroupResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReasons.go'
example: |-
adminReasonsService := reporting.AdminReasonsService{ ... }
params := admin_reasons.GetReasonGroupParams{ ... }
res, err := adminReasonsService.GetReasonGroupShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'get'
- 'group'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'GetReportsByTicketShort@go.reporting.fun':
id: 'GetReportsByTicketShort@go.reporting.fun'
name: 'GetReportsByTicketShort'
type: 'function'
description: |-
List reports ordered by createdAt in descending order.
struct: 'AdminTicketsService'
arguments:
params:
type: '*admin_tickets.GetReportsByTicketParams'
required: true
return_type: '(*admin_tickets.GetReportsByTicketResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_tickets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminTickets.go'
example: |-
adminTicketsService := reporting.AdminTicketsService{ ... }
params := admin_tickets.GetReportsByTicketParams{ ... }
res, err := adminTicketsService.GetReportsByTicketShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'by'
- 'get'
- 'reports'
- 'ticket'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'GetTicketDetailShort@go.reporting.fun':
id: 'GetTicketDetailShort@go.reporting.fun'
name: 'GetTicketDetailShort'
type: 'function'
description: |-
This endpoint will return ticket detail with ticket id.
struct: 'AdminTicketsService'
arguments:
params:
type: '*admin_tickets.GetTicketDetailParams'
required: true
return_type: '(*admin_tickets.GetTicketDetailResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_tickets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminTickets.go'
example: |-
adminTicketsService := reporting.AdminTicketsService{ ... }
params := admin_tickets.GetTicketDetailParams{ ... }
res, err := adminTicketsService.GetTicketDetailShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'detail'
- 'get'
- 'ticket'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'ListReportsShort@go.reporting.fun':
id: 'ListReportsShort@go.reporting.fun'
name: 'ListReportsShort'
type: 'function'
description: |-
Required permission: ADMIN:NAMESPACE:{namespace}:TICKET [READ]
Reports list can be ordered by:
- createdAt
- updatedAt
struct: 'AdminReportsService'
arguments:
params:
type: '*admin_reports.ListReportsParams'
required: true
return_type: '(*admin_reports.ListReportsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reports'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReports.go'
example: |-
adminReportsService := reporting.AdminReportsService{ ... }
params := admin_reports.ListReportsParams{ ... }
res, err := adminReportsService.ListReportsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'list'
- 'reports'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'ListTicketsShort@go.reporting.fun':
id: 'ListTicketsShort@go.reporting.fun'
name: 'ListTicketsShort'
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)
struct: 'AdminTicketsService'
arguments:
params:
type: '*admin_tickets.ListTicketsParams'
required: true
return_type: '(*admin_tickets.ListTicketsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_tickets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminTickets.go'
example: |-
adminTicketsService := reporting.AdminTicketsService{ ... }
params := admin_tickets.ListTicketsParams{ ... }
res, err := adminTicketsService.ListTicketsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'list'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'PublicGetReasonsShort@go.reporting.fun':
id: 'PublicGetReasonsShort@go.reporting.fun'
name: 'PublicGetReasonsShort'
type: 'function'
struct: 'PublicReasonsService'
arguments:
params:
type: '*public_reasons.PublicGetReasonsParams'
required: true
return_type: '(*public_reasons.PublicGetReasonsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/public_reasons'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/publicReasons.go'
example: |-
publicReasonsService := reporting.PublicReasonsService{ ... }
params := public_reasons.PublicGetReasonsParams{ ... }
res, err := publicReasonsService.PublicGetReasonsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'get'
- 'public'
- 'reasons'
'PublicListReasonGroupsShort@go.reporting.fun':
id: 'PublicListReasonGroupsShort@go.reporting.fun'
name: 'PublicListReasonGroupsShort'
type: 'function'
description: |-
Return list of reason groups ID and title under given namespace.
struct: 'PublicReasonsService'
arguments:
params:
type: '*public_reasons.PublicListReasonGroupsParams'
required: true
return_type: '(*public_reasons.PublicListReasonGroupsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/public_reasons'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/publicReasons.go'
example: |-
publicReasonsService := reporting.PublicReasonsService{ ... }
params := public_reasons.PublicListReasonGroupsParams{ ... }
res, err := publicReasonsService.PublicListReasonGroupsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'groups'
- 'list'
- 'public'
- 'reason'
- 'reasons'
'SubmitReportShort@go.reporting.fun':
id: 'SubmitReportShort@go.reporting.fun'
name: 'SubmitReportShort'
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
struct: 'PublicReportsService'
arguments:
params:
type: '*public_reports.SubmitReportParams'
required: true
return_type: '(*public_reports.SubmitReportResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/public_reports'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/publicReports.go'
example: |-
publicReportsService := reporting.PublicReportsService{ ... }
params := public_reports.SubmitReportParams{ ... }
res, err := publicReportsService.SubmitReportShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'public'
- 'report'
- 'reports'
- 'submit'
'TicketStatisticShort@go.reporting.fun':
id: 'TicketStatisticShort@go.reporting.fun'
name: 'TicketStatisticShort'
type: 'function'
description: |-
Ticket statistic can be filtered by:
- category
- extension category
struct: 'AdminTicketsService'
arguments:
params:
type: '*admin_tickets.TicketStatisticParams'
required: true
return_type: '(*admin_tickets.TicketStatisticResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_tickets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminTickets.go'
example: |-
adminTicketsService := reporting.AdminTicketsService{ ... }
params := admin_tickets.TicketStatisticParams{ ... }
res, err := adminTicketsService.TicketStatisticShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'statistic'
- 'ticket'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'UpdateModerationRuleShort@go.reporting.fun':
id: 'UpdateModerationRuleShort@go.reporting.fun'
name: 'UpdateModerationRuleShort'
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
struct: 'AdminModerationRuleService'
arguments:
params:
type: '*admin_moderation_rule.UpdateModerationRuleParams'
required: true
return_type: '(*admin_moderation_rule.UpdateModerationRuleResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_moderation_rule'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminModerationRule.go'
example: |-
adminModerationRuleService := reporting.AdminModerationRuleService{ ... }
params := admin_moderation_rule.UpdateModerationRuleParams{ ... }
res, err := adminModerationRuleService.UpdateModerationRuleShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'moderation'
- 'rule'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [UPDATE]'
'UpdateModerationRuleStatusShort@go.reporting.fun':
id: 'UpdateModerationRuleStatusShort@go.reporting.fun'
name: 'UpdateModerationRuleStatusShort'
type: 'function'
description: |-
This endpoint enable/disable moderation rule status.
struct: 'AdminModerationRuleService'
arguments:
params:
type: '*admin_moderation_rule.UpdateModerationRuleStatusParams'
required: true
return_type: 'error'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_moderation_rule'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminModerationRule.go'
example: |-
adminModerationRuleService := reporting.AdminModerationRuleService{ ... }
params := admin_moderation_rule.UpdateModerationRuleStatusParams{ ... }
res, err := adminModerationRuleService.UpdateModerationRuleStatusShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'moderation'
- 'rule'
- 'status'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [UPDATE]'
'UpdateReasonShort@go.reporting.fun':
id: 'UpdateReasonShort@go.reporting.fun'
name: 'UpdateReasonShort'
type: 'function'
description: |-
This endpoint update a reason for a namespace with ID.
struct: 'AdminReasonsService'
arguments:
params:
type: '*admin_reasons.UpdateReasonParams'
required: true
return_type: '(*admin_reasons.UpdateReasonResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReasons.go'
example: |-
adminReasonsService := reporting.AdminReasonsService{ ... }
params := admin_reasons.UpdateReasonParams{ ... }
res, err := adminReasonsService.UpdateReasonShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'reason'
- 'reasons'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [UPDATE]'
'UpdateReasonGroupShort@go.reporting.fun':
id: 'UpdateReasonGroupShort@go.reporting.fun'
name: 'UpdateReasonGroupShort'
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).
struct: 'AdminReasonsService'
arguments:
params:
type: '*admin_reasons.UpdateReasonGroupParams'
required: true
return_type: '(*admin_reasons.UpdateReasonGroupResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_reasons'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminReasons.go'
example: |-
adminReasonsService := reporting.AdminReasonsService{ ... }
params := admin_reasons.UpdateReasonGroupParams{ ... }
res, err := adminReasonsService.UpdateReasonGroupShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'group'
- 'reason'
- 'reasons'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [UPDATE]'
'UpdateTicketResolutionsShort@go.reporting.fun':
id: 'UpdateTicketResolutionsShort@go.reporting.fun'
name: 'UpdateTicketResolutionsShort'
type: 'function'
description: |-
Update ticket resolution status to either OPEN or CLOSED. It is mandatory to provide notes
struct: 'AdminTicketsService'
arguments:
params:
type: '*admin_tickets.UpdateTicketResolutionsParams'
required: true
return_type: '(*admin_tickets.UpdateTicketResolutionsResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_tickets'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminTickets.go'
example: |-
adminTicketsService := reporting.AdminTicketsService{ ... }
params := admin_tickets.UpdateTicketResolutionsParams{ ... }
res, err := adminTicketsService.UpdateTicketResolutionsShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'resolutions'
- 'ticket'
- 'tickets'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [UPDATE]'
'UpsertShort@go.reporting.fun':
id: 'UpsertShort@go.reporting.fun'
name: 'UpsertShort'
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.
struct: 'AdminConfigurationsService'
arguments:
params:
type: '*admin_configurations.UpsertParams'
required: true
return_type: '(*admin_configurations.UpsertResponse, error)'
imports:
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclientmodels'
- 'github.com/AccelByte/accelbyte-go-sdk/reporting-sdk/pkg/reportingclient/admin_configurations'
- 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/reporting'
files:
- 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/reporting/adminConfigurations.go'
example: |-
adminConfigurationsService := reporting.AdminConfigurationsService{ ... }
params := admin_configurations.UpsertParams{ ... }
res, err := adminConfigurationsService.UpsertShort(params)
if err != nil {
// handleError(err)
}
tags:
- 'admin'
- 'configurations'
- 'upsert'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REPORTINGCONFIG [CREATE]'
# endregion functions