symbols:
# region models
'RestapiActionApiRequest@py.reporting.mod':
id: 'RestapiActionApiRequest@py.reporting.mod'
name: 'RestapiActionApiRequest'
type: 'model'
fields:
'action_id':
type: 'str'
required: true
description: |-
Auto mod action ID
'action_name':
type: 'str'
required: true
description: |-
Auto mod action display name
'event_name':
type: 'str'
required: true
description: |-
Kafka publish event name
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_action_api_request.py'
example: |-
restapi_action_api_request = reporting_models.RestapiActionApiRequest.create(...)
'RestapiActionApiResponse@py.reporting.mod':
id: 'RestapiActionApiResponse@py.reporting.mod'
name: 'RestapiActionApiResponse'
type: 'model'
fields:
'action_id':
type: 'str'
required: true
'action_name':
type: 'str'
required: true
'event_name':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_action_api_response.py'
example: |-
restapi_action_api_response = reporting_models.RestapiActionApiResponse.create(...)
'RestapiActionListApiResponse@py.reporting.mod':
id: 'RestapiActionListApiResponse@py.reporting.mod'
name: 'RestapiActionListApiResponse'
type: 'model'
fields:
'data':
type: 'List[RestapiActionApiResponse]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_action_list_api_response.py'
example: |-
restapi_action_list_api_response = reporting_models.RestapiActionListApiResponse.create(...)
'RestapiAdminAllReasonsResponse@py.reporting.mod':
id: 'RestapiAdminAllReasonsResponse@py.reporting.mod'
name: 'RestapiAdminAllReasonsResponse'
type: 'model'
fields:
'data':
type: 'List[RestapiPublicReasonResponse]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_admin_all_reasons_response.py'
example: |-
restapi_admin_all_reasons_response = reporting_models.RestapiAdminAllReasonsResponse.create(...)
'RestapiAdminReasonListResponse@py.reporting.mod':
id: 'RestapiAdminReasonListResponse@py.reporting.mod'
name: 'RestapiAdminReasonListResponse'
type: 'model'
fields:
'data':
type: 'List[RestapiAdminReasonResponse]'
required: true
'paging':
type: 'RestapiPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_admin_reason_list_response.py'
example: |-
restapi_admin_reason_list_response = reporting_models.RestapiAdminReasonListResponse.create(...)
'RestapiAdminReasonResponse@py.reporting.mod':
id: 'RestapiAdminReasonResponse@py.reporting.mod'
name: 'RestapiAdminReasonResponse'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'description':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'title':
type: 'str'
required: true
'updated_at':
type: 'str'
required: true
'groups':
type: 'List[RestapiPublicReasonGroupResponse]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_admin_reason_response.py'
example: |-
restapi_admin_reason_response = reporting_models.RestapiAdminReasonResponse.create(...)
'RestapiBanAccountActionRequest@py.reporting.mod':
id: 'RestapiBanAccountActionRequest@py.reporting.mod'
name: 'RestapiBanAccountActionRequest'
type: 'model'
fields:
'duration':
type: 'int'
required: true
description: |-
Ban duration in minutes, -1 means unlimited duration
'reason':
type: 'str'
required: true
description: |-
Ban reason
'skip_notif':
type: 'bool'
required: true
description: |-
Skip notification for banned user (e.g. email notification)
'type_':
type: 'str'
required: true
description: |-
Ban type
'comment':
type: 'str'
required: false
description: |-
Ban comment
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_ban_account_action_request.py'
example: |-
restapi_ban_account_action_request = reporting_models.RestapiBanAccountActionRequest.create(...)
'RestapiBanAccountActionResponse@py.reporting.mod':
id: 'RestapiBanAccountActionResponse@py.reporting.mod'
name: 'RestapiBanAccountActionResponse'
type: 'model'
fields:
'duration':
type: 'int'
required: true
description: |-
Ban duration in minutes, -1 means unlimited duration
'reason':
type: 'str'
required: true
description: |-
Ban reason
'skip_notif':
type: 'bool'
required: true
description: |-
Skip notification for banned user (e.g. email notification)
'type_':
type: 'str'
required: true
description: |-
Ban type
'comment':
type: 'str'
required: false
description: |-
Ban comment
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_ban_account_action_response.py'
example: |-
restapi_ban_account_action_response = reporting_models.RestapiBanAccountActionResponse.create(...)
'RestapiCategoryLimit@py.reporting.mod':
id: 'RestapiCategoryLimit@py.reporting.mod'
name: 'RestapiCategoryLimit'
type: 'model'
fields:
'max_report_per_ticket':
type: 'int'
required: true
description: |-
must between 1 to 2147483647
'name':
type: 'str'
required: true
'extension_category':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_category_limit.py'
example: |-
restapi_category_limit = reporting_models.RestapiCategoryLimit.create(...)
'RestapiConfigResponse@py.reporting.mod':
id: 'RestapiConfigResponse@py.reporting.mod'
name: 'RestapiConfigResponse'
type: 'model'
fields:
'namespace':
type: 'str'
required: true
'reporting_limit':
type: 'RestapiReportingLimit'
required: true
'updated_at':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_config_response.py'
example: |-
restapi_config_response = reporting_models.RestapiConfigResponse.create(...)
'RestapiCreateReasonGroupRequest@py.reporting.mod':
id: 'RestapiCreateReasonGroupRequest@py.reporting.mod'
name: 'RestapiCreateReasonGroupRequest'
type: 'model'
fields:
'title':
type: 'str'
required: true
description: |-
max 256 chars
'reason_ids':
type: 'List[str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_create_reason_group_request.py'
example: |-
restapi_create_reason_group_request = reporting_models.RestapiCreateReasonGroupRequest.create(...)
'RestapiCreateReasonRequest@py.reporting.mod':
id: 'RestapiCreateReasonRequest@py.reporting.mod'
name: 'RestapiCreateReasonRequest'
type: 'model'
fields:
'description':
type: 'str'
required: true
description: |-
max 280 chars
'group_ids':
type: 'List[str]'
required: true
'title':
type: 'str'
required: true
description: |-
max 256 chars
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_create_reason_request.py'
example: |-
restapi_create_reason_request = reporting_models.RestapiCreateReasonRequest.create(...)
'RestapiErrorResponse@py.reporting.mod':
id: 'RestapiErrorResponse@py.reporting.mod'
name: 'RestapiErrorResponse'
type: 'model'
fields:
'error_code':
type: 'int'
required: true
'error_message':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_error_response.py'
example: |-
restapi_error_response = reporting_models.RestapiErrorResponse.create(...)
'RestapiExtensionCategoryApiRequest@py.reporting.mod':
id: 'RestapiExtensionCategoryApiRequest@py.reporting.mod'
name: 'RestapiExtensionCategoryApiRequest'
type: 'model'
fields:
'extension_category':
type: 'str'
required: true
description: |-
Report extension category, consist of custom services sub-category (eg. salesItem,challenge,etc)
'extension_category_name':
type: 'str'
required: true
description: |-
Report extension category display name)
'service_source':
type: 'str'
required: true
description: |-
Extension category service source (eg. service source 'marketplace' for extension category 'salesItem')
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_extension_category_api_request.py'
example: |-
restapi_extension_category_api_request = reporting_models.RestapiExtensionCategoryApiRequest.create(...)
'RestapiExtensionCategoryApiResponse@py.reporting.mod':
id: 'RestapiExtensionCategoryApiResponse@py.reporting.mod'
name: 'RestapiExtensionCategoryApiResponse'
type: 'model'
fields:
'extension_category':
type: 'str'
required: true
'extension_category_name':
type: 'str'
required: true
'service_source':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_extension_category_api_response.py'
example: |-
restapi_extension_category_api_response = reporting_models.RestapiExtensionCategoryApiResponse.create(...)
'RestapiExtensionCategoryListApiResponse@py.reporting.mod':
id: 'RestapiExtensionCategoryListApiResponse@py.reporting.mod'
name: 'RestapiExtensionCategoryListApiResponse'
type: 'model'
fields:
'data':
type: 'List[RestapiExtensionCategoryApiResponse]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_extension_category_list_api_response.py'
example: |-
restapi_extension_category_list_api_response = reporting_models.RestapiExtensionCategoryListApiResponse.create(...)
'RestapiModerationRuleActionsRequest@py.reporting.mod':
id: 'RestapiModerationRuleActionsRequest@py.reporting.mod'
name: 'RestapiModerationRuleActionsRequest'
type: 'model'
fields:
'ban_account':
type: 'RestapiBanAccountActionRequest'
required: false
description: |-
Ban account action configuration
'delete_chat':
type: 'bool'
required: false
description: |-
Enable delete chat action
'extension_action_ids':
type: 'List[str]'
required: false
description: |-
Custom services moderation actions
'hide_content':
type: 'bool'
required: false
description: |-
Enable hide content action
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_moderation_rule_actions_request.py'
example: |-
restapi_moderation_rule_actions_request = reporting_models.RestapiModerationRuleActionsRequest.create(...)
'RestapiModerationRuleActionsResponse@py.reporting.mod':
id: 'RestapiModerationRuleActionsResponse@py.reporting.mod'
name: 'RestapiModerationRuleActionsResponse'
type: 'model'
fields:
'ban_account':
type: 'RestapiBanAccountActionResponse'
required: false
description: |-
Ban account action configuration
'delete_chat':
type: 'bool'
required: false
description: |-
Enable delete chat action
'extension_action_ids':
type: 'List[str]'
required: false
description: |-
custom service mod actions
'hide_content':
type: 'bool'
required: false
description: |-
Enable hide content action
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_moderation_rule_actions_response.py'
example: |-
restapi_moderation_rule_actions_response = reporting_models.RestapiModerationRuleActionsResponse.create(...)
'RestapiModerationRuleActiveRequest@py.reporting.mod':
id: 'RestapiModerationRuleActiveRequest@py.reporting.mod'
name: 'RestapiModerationRuleActiveRequest'
type: 'model'
fields:
'active':
type: 'bool'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_moderation_rule_active_request.py'
example: |-
restapi_moderation_rule_active_request = reporting_models.RestapiModerationRuleActiveRequest.create(...)
'RestapiModerationRuleRequest@py.reporting.mod':
id: 'RestapiModerationRuleRequest@py.reporting.mod'
name: 'RestapiModerationRuleRequest'
type: 'model'
fields:
'active':
type: 'bool'
required: true
description: |-
status of this rule
'category':
type: 'Union[str, CategoryEnum]'
required: true
description: |-
Report category, must select from pre defined list
'reason':
type: 'str'
required: true
description: |-
Reason of report, can select from pre defined list, max 128 chars
'threshold':
type: 'int'
required: true
description: |-
the threshold to trigger auto moderation
'action':
type: 'Union[str, ActionEnum]'
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
'extension_category':
type: 'str'
required: false
description: |-
Report extension category, consist of custom services sub-category (eg. salesItem,challenge,etc)
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_moderation_rule_request.py'
example: |-
restapi_moderation_rule_request = reporting_models.RestapiModerationRuleRequest.create(...)
'RestapiModerationRuleResponse@py.reporting.mod':
id: 'RestapiModerationRuleResponse@py.reporting.mod'
name: 'RestapiModerationRuleResponse'
type: 'model'
fields:
'actions':
type: 'RestapiModerationRuleActionsResponse'
required: true
description: |-
Action configurations for moderation rule
'active':
type: 'bool'
required: true
'category':
type: 'str'
required: true
'created_at':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'reason':
type: 'str'
required: true
'threshold':
type: 'int'
required: true
'action':
type: 'str'
required: false
description: |-
GOING TO DEPRECATE, PLEASE DO NOT USE, for replacement use the "actions" field
'extension_category':
type: 'str'
required: false
'updated_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_moderation_rule_response.py'
example: |-
restapi_moderation_rule_response = reporting_models.RestapiModerationRuleResponse.create(...)
'RestapiModerationRulesList@py.reporting.mod':
id: 'RestapiModerationRulesList@py.reporting.mod'
name: 'RestapiModerationRulesList'
type: 'model'
fields:
'data':
type: 'List[RestapiModerationRuleResponse]'
required: true
'paging':
type: 'RestapiPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_moderation_rules_list.py'
example: |-
restapi_moderation_rules_list = reporting_models.RestapiModerationRulesList.create(...)
'RestapiPagination@py.reporting.mod':
id: 'RestapiPagination@py.reporting.mod'
name: 'RestapiPagination'
type: 'model'
fields:
'first':
type: 'str'
required: true
'last':
type: 'str'
required: true
'next_':
type: 'str'
required: true
'previous':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_pagination.py'
example: |-
restapi_pagination = reporting_models.RestapiPagination.create(...)
'RestapiPublicReasonGroupResponse@py.reporting.mod':
id: 'RestapiPublicReasonGroupResponse@py.reporting.mod'
name: 'RestapiPublicReasonGroupResponse'
type: 'model'
fields:
'id_':
type: 'str'
required: true
'title':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_public_reason_group_response.py'
example: |-
restapi_public_reason_group_response = reporting_models.RestapiPublicReasonGroupResponse.create(...)
'RestapiPublicReasonListResponse@py.reporting.mod':
id: 'RestapiPublicReasonListResponse@py.reporting.mod'
name: 'RestapiPublicReasonListResponse'
type: 'model'
fields:
'data':
type: 'List[RestapiPublicReasonResponse]'
required: true
'paging':
type: 'RestapiPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_public_reason_list_response.py'
example: |-
restapi_public_reason_list_response = reporting_models.RestapiPublicReasonListResponse.create(...)
'RestapiPublicReasonResponse@py.reporting.mod':
id: 'RestapiPublicReasonResponse@py.reporting.mod'
name: 'RestapiPublicReasonResponse'
type: 'model'
fields:
'description':
type: 'str'
required: true
'title':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_public_reason_response.py'
example: |-
restapi_public_reason_response = reporting_models.RestapiPublicReasonResponse.create(...)
'RestapiReasonGroupListResponse@py.reporting.mod':
id: 'RestapiReasonGroupListResponse@py.reporting.mod'
name: 'RestapiReasonGroupListResponse'
type: 'model'
fields:
'data':
type: 'List[RestapiPublicReasonGroupResponse]'
required: true
'paging':
type: 'RestapiPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_reason_group_list_response.py'
example: |-
restapi_reason_group_list_response = reporting_models.RestapiReasonGroupListResponse.create(...)
'RestapiReasonGroupResponse@py.reporting.mod':
id: 'RestapiReasonGroupResponse@py.reporting.mod'
name: 'RestapiReasonGroupResponse'
type: 'model'
fields:
'id_':
type: 'str'
required: true
'title':
type: 'str'
required: true
'reasons':
type: 'List[RestapiAdminReasonResponse]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_reason_group_response.py'
example: |-
restapi_reason_group_response = reporting_models.RestapiReasonGroupResponse.create(...)
'RestapiReportingLimit@py.reporting.mod':
id: 'RestapiReportingLimit@py.reporting.mod'
name: 'RestapiReportingLimit'
type: 'model'
fields:
'category_limits':
type: 'List[RestapiCategoryLimit]'
required: true
'time_interval':
type: 'int'
required: true
description: |-
the unit is nanoseconds, must between 1 to 6000000 seconds
'user_max_report_per_time_interval':
type: 'int'
required: true
description: |-
must between 1 to 2147483647
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_reporting_limit.py'
example: |-
restapi_reporting_limit = reporting_models.RestapiReportingLimit.create(...)
'RestapiReportListResponse@py.reporting.mod':
id: 'RestapiReportListResponse@py.reporting.mod'
name: 'RestapiReportListResponse'
type: 'model'
fields:
'data':
type: 'List[RestapiReportResponse]'
required: true
'paging':
type: 'RestapiPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_report_list_response.py'
example: |-
restapi_report_list_response = reporting_models.RestapiReportListResponse.create(...)
'RestapiReportResponse@py.reporting.mod':
id: 'RestapiReportResponse@py.reporting.mod'
name: 'RestapiReportResponse'
type: 'model'
fields:
'additional_info':
type: 'Dict[str, Any]'
required: true
'category':
type: 'Union[str, CategoryEnum]'
required: true
'comment':
type: 'str'
required: true
'created_at':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'object_id':
type: 'str'
required: true
'object_type':
type: 'str'
required: true
'reason':
type: 'str'
required: true
'reporter_id':
type: 'str'
required: true
'ticket_id':
type: 'str'
required: true
'updated_at':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
'extension_category':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_report_response.py'
example: |-
restapi_report_response = reporting_models.RestapiReportResponse.create(...)
'RestapiSubmitReportRequest@py.reporting.mod':
id: 'RestapiSubmitReportRequest@py.reporting.mod'
name: 'RestapiSubmitReportRequest'
type: 'model'
fields:
'category':
type: 'Union[str, CategoryEnum]'
required: true
description: |-
Report category, must select from pre defined list
'reason':
type: 'str'
required: true
description: |-
Reason of report, can select from pre defined list, max 128 chars
'user_id':
type: 'str'
required: true
description: |-
User ID being reported, in UUID4 format
'additional_info':
type: 'Dict[str, Any]'
required: false
description: |-
Additional info regarding reported user / content, JSON formatted
'comment':
type: 'str'
required: false
description: |-
Additional comment if any, max 280 chars
'extension_category':
type: 'str'
required: false
description: |-
Report extension category, must select from pre defined list
'object_id':
type: 'str'
required: false
description: |-
ID of content being reported, uuid4WithoutHyphens. Required for UGC category
'object_type':
type: 'str'
required: false
description: |-
Type of content being reported, max 64 chars. Required for UGC category
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_submit_report_request.py'
example: |-
restapi_submit_report_request = reporting_models.RestapiSubmitReportRequest.create(...)
'RestapiSubmitReportResponse@py.reporting.mod':
id: 'RestapiSubmitReportResponse@py.reporting.mod'
name: 'RestapiSubmitReportResponse'
type: 'model'
fields:
'category':
type: 'Union[str, CategoryEnum]'
required: true
'created_at':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'object_id':
type: 'str'
required: true
'object_type':
type: 'str'
required: true
'status':
type: 'Union[str, StatusEnum]'
required: true
'ticket_id':
type: 'str'
required: true
'updated_at':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
'extension_category':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_submit_report_response.py'
example: |-
restapi_submit_report_response = reporting_models.RestapiSubmitReportResponse.create(...)
'RestapiTicketListResponse@py.reporting.mod':
id: 'RestapiTicketListResponse@py.reporting.mod'
name: 'RestapiTicketListResponse'
type: 'model'
fields:
'data':
type: 'List[RestapiTicketResponse]'
required: true
'paging':
type: 'RestapiPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_ticket_list_response.py'
example: |-
restapi_ticket_list_response = reporting_models.RestapiTicketListResponse.create(...)
'RestapiTicketResponse@py.reporting.mod':
id: 'RestapiTicketResponse@py.reporting.mod'
name: 'RestapiTicketResponse'
type: 'model'
fields:
'category':
type: 'Union[str, CategoryEnum]'
required: true
'created_at':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'notes':
type: 'str'
required: true
'object_id':
type: 'str'
required: true
'object_type':
type: 'str'
required: true
'reports_count':
type: 'int'
required: true
'status':
type: 'Union[str, StatusEnum]'
required: true
'updated_at':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
'extension_category':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_ticket_response.py'
example: |-
restapi_ticket_response = reporting_models.RestapiTicketResponse.create(...)
'RestapiTicketStatisticResponse@py.reporting.mod':
id: 'RestapiTicketStatisticResponse@py.reporting.mod'
name: 'RestapiTicketStatisticResponse'
type: 'model'
fields:
'moderated_count':
type: 'int'
required: true
'open_count':
type: 'int'
required: true
'total_count':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_ticket_statistic_response.py'
example: |-
restapi_ticket_statistic_response = reporting_models.RestapiTicketStatisticResponse.create(...)
'RestapiUnusedReasonListResponse@py.reporting.mod':
id: 'RestapiUnusedReasonListResponse@py.reporting.mod'
name: 'RestapiUnusedReasonListResponse'
type: 'model'
fields:
'reasons':
type: 'List[RestapiPublicReasonResponse]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_unused_reason_list_response.py'
example: |-
restapi_unused_reason_list_response = reporting_models.RestapiUnusedReasonListResponse.create(...)
'RestapiUpdateReasonGroupRequest@py.reporting.mod':
id: 'RestapiUpdateReasonGroupRequest@py.reporting.mod'
name: 'RestapiUpdateReasonGroupRequest'
type: 'model'
fields:
'title':
type: 'str'
required: true
description: |-
max 256 chars
'reason_ids':
type: 'List[str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_update_reason_group_request.py'
example: |-
restapi_update_reason_group_request = reporting_models.RestapiUpdateReasonGroupRequest.create(...)
'RestapiUpdateTicketResolutionsRequest@py.reporting.mod':
id: 'RestapiUpdateTicketResolutionsRequest@py.reporting.mod'
name: 'RestapiUpdateTicketResolutionsRequest'
type: 'model'
fields:
'notes':
type: 'str'
required: true
description: |-
Info regarding the resolution status, max 280 chars
'status':
type: 'Union[str, StatusEnum]'
required: true
description: |-
Ticket status is open, closed, auto moderated
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/models/restapi_update_ticket_resolutions_request.py'
example: |-
restapi_update_ticket_resolutions_request = reporting_models.RestapiUpdateTicketResolutionsRequest.create(...)
# endregion models
# region functions
'admin_create_extension_category@py.reporting.fun':
id: 'admin_create_extension_category@py.reporting.fun'
name: 'admin_create_extension_category'
type: 'function'
description: |-
Create extension category data
arguments:
'body':
type: 'RestapiExtensionCategoryApiRequest'
required: true
return_type: 'Tuple[Union[None, RestapiExtensionCategoryApiResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_extension_categories_and_auto_moderation_actions/admin_create_extension__954f3a.py'
example: |-
result, error = reporting.admin_create_extension_category(...)
if error:
# handle_error(error)
tags:
- 'actions'
- 'admin'
- 'and'
- 'auto'
- 'categories'
- 'category'
- 'create'
- 'extension'
- 'moderation'
permissions:
- 'ADMIN:REPORTINGCONFIG [CREATE]'
'admin_create_mod_action@py.reporting.fun':
id: 'admin_create_mod_action@py.reporting.fun'
name: 'admin_create_mod_action'
type: 'function'
description: |-
Create auto moderation action
arguments:
'body':
type: 'RestapiActionApiRequest'
required: true
return_type: 'Tuple[Union[None, RestapiActionApiResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_extension_categories_and_auto_moderation_actions/admin_create_mod_action.py'
example: |-
result, error = reporting.admin_create_mod_action(...)
if error:
# handle_error(error)
tags:
- 'action'
- 'actions'
- 'admin'
- 'and'
- 'auto'
- 'categories'
- 'create'
- 'extension'
- 'mod'
- 'moderation'
permissions:
- 'ADMIN:REPORTINGCONFIG [CREATE]'
'admin_find_action_list@py.reporting.fun':
id: 'admin_find_action_list@py.reporting.fun'
name: 'admin_find_action_list'
type: 'function'
description: |-
Get a list of auto moderation actions
return_type: 'Tuple[Union[None, RestapiActionListApiResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_extension_categories_and_auto_moderation_actions/admin_find_action_list.py'
example: |-
result, error = reporting.admin_find_action_list(...)
if error:
# handle_error(error)
tags:
- 'action'
- 'actions'
- 'admin'
- 'and'
- 'auto'
- 'categories'
- 'extension'
- 'find'
- 'list'
- 'moderation'
permissions:
- 'ADMIN:REPORTINGCONFIG [READ]'
'admin_find_extension_category_list@py.reporting.fun':
id: 'admin_find_extension_category_list@py.reporting.fun'
name: 'admin_find_extension_category_list'
type: 'function'
description: |-
Get a list of extension category data with the specified name
arguments:
'order':
type: 'Optional[Union[str, AdminFindExtensionCategoryListOrderEnum]]'
required: false
description: |-
data order, asc or desc (default: asc)
'sort_by':
type: 'Optional[Union[str, AdminFindExtensionCategoryListSortByEnum]]'
required: false
description: |-
data order key, valid key : 'extensionCategory', and 'extensionCategoryName'
return_type: 'Tuple[Union[None, RestapiExtensionCategoryListApiResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_extension_categories_and_auto_moderation_actions/admin_find_extension_ca_6e8210.py'
example: |-
result, error = reporting.admin_find_extension_category_list(...)
if error:
# handle_error(error)
tags:
- 'actions'
- 'admin'
- 'and'
- 'auto'
- 'categories'
- 'category'
- 'extension'
- 'find'
- 'list'
- 'moderation'
permissions:
- 'ADMIN:REPORTINGCONFIG [READ]'
'admin_get_all_reasons@py.reporting.fun':
id: 'admin_get_all_reasons@py.reporting.fun'
name: 'admin_get_all_reasons'
type: 'function'
description: |-
This endpoint get all reasons without pagination.
arguments:
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiAdminAllReasonsResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_reasons/admin_get_all_reasons.py'
example: |-
result, error = reporting.admin_get_all_reasons(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'all'
- 'get'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'admin_get_reason@py.reporting.fun':
id: 'admin_get_reason@py.reporting.fun'
name: 'admin_get_reason'
type: 'function'
description: |-
This endpoint get a single reason.
arguments:
'namespace':
type: 'str'
required: true
'reason_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiAdminReasonResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_reasons/admin_get_reason.py'
example: |-
result, error = reporting.admin_get_reason(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'get'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'admin_get_reasons@py.reporting.fun':
id: 'admin_get_reasons@py.reporting.fun'
name: 'admin_get_reasons'
type: 'function'
description: |-
This endpoint get reasons with pagination
arguments:
'group':
type: 'Optional[str]'
required: false
description: |-
query reasons under specified reason group
'limit':
type: 'Optional[int]'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'str'
required: true
'offset':
type: 'Optional[int]'
required: false
description: |-
number of data offset (default 0)
'title':
type: 'Optional[str]'
required: false
description: |-
query reason(s) by title
return_type: 'Tuple[Union[None, RestapiAdminReasonListResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_reasons/admin_get_reasons.py'
example: |-
result, error = reporting.admin_get_reasons(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'get'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'admin_get_unused_reasons@py.reporting.fun':
id: 'admin_get_unused_reasons@py.reporting.fun'
name: 'admin_get_unused_reasons'
type: 'function'
description: |-
This endpoint get reasons not used by moderation rules.
arguments:
'category':
type: 'str'
required: true
'extension_category':
type: 'Optional[str]'
required: false
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiUnusedReasonListResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_reasons/admin_get_unused_reasons.py'
example: |-
result, error = reporting.admin_get_unused_reasons(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'get'
- 'reasons'
- 'unused'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'admin_list_reason_groups@py.reporting.fun':
id: 'admin_list_reason_groups@py.reporting.fun'
name: 'admin_list_reason_groups'
type: 'function'
description: |-
Return list of reason groups ID and title under given namespace.
To fetch the reasons inside a group, use get reason group endpoint.
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'str'
required: true
'offset':
type: 'Optional[int]'
required: false
description: |-
number of data offset (default 0)
return_type: 'Tuple[Union[None, RestapiReasonGroupListResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_reasons/admin_list_reason_groups.py'
example: |-
result, error = reporting.admin_list_reason_groups(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'groups'
- 'list'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'admin_submit_report@py.reporting.fun':
id: 'admin_submit_report@py.reporting.fun'
name: 'admin_submit_report'
type: 'function'
description: |-
Submit a report and will return ticket for reported object.
New ticket will be created if no OPEN ticket present for reported object (based by objectId and objectType) in a namespace.
Admin can only submit report once for each different user / object reported in the same OPEN ticket.
Reporting the same user / object in the same OPEN ticket will return HTTP code 409 (conflict).
Fill the 'reason' field with a 'reason title'
Supported category: - UGC - USER - CHAT - EXTENSION
arguments:
'body':
type: 'RestapiSubmitReportRequest'
required: true
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiSubmitReportResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_reports/admin_submit_report.py'
example: |-
result, error = reporting.admin_submit_report(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'report'
- 'reports'
- 'submit'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [CREATE]'
'create_moderation_rule@py.reporting.fun':
id: 'create_moderation_rule@py.reporting.fun'
name: 'create_moderation_rule'
type: 'function'
description: |-
This endpoint create moderation rule.
Supported Category: - UGC - USER - CHAT - EXTENSION
Supported Action (GOING TO DEPRECATE, for replacement please use "actions"):
* HideContent
Supported Actions:
* **hideContent**: Hide the content
* **banAccount**: Ban the user account
* **deleteChat**: Delete chat
arguments:
'body':
type: 'RestapiModerationRuleRequest'
required: true
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, Optional[str]], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_moderation_rule/create_moderation_rule.py'
example: |-
result, error = reporting.create_moderation_rule(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'create'
- 'moderation'
- 'rule'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [CREATE]'
'create_reason@py.reporting.fun':
id: 'create_reason@py.reporting.fun'
name: 'create_reason'
type: 'function'
description: |-
This endpoint create a reason for a namespace.
arguments:
'body':
type: 'RestapiCreateReasonRequest'
required: true
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiAdminReasonResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_reasons/create_reason.py'
example: |-
result, error = reporting.create_reason(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'create'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [CREATE]'
'create_reason_group@py.reporting.fun':
id: 'create_reason_group@py.reporting.fun'
name: 'create_reason_group'
type: 'function'
description: |-
Create a reason group for easier query. You can query reasons by specifying
the group title in the list reasons query. Reason group title is case insensitive,
meaning you can't have **reason** if you already create a reason titled **Reason**
arguments:
'body':
type: 'RestapiCreateReasonGroupRequest'
required: true
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiReasonGroupResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_reasons/create_reason_group.py'
example: |-
result, error = reporting.create_reason_group(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'create'
- 'group'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [CREATE]'
'delete_moderation_rule@py.reporting.fun':
id: 'delete_moderation_rule@py.reporting.fun'
name: 'delete_moderation_rule'
type: 'function'
description: |-
This endpoint delete moderation rule.
arguments:
'namespace':
type: 'str'
required: true
'rule_id':
type: 'str'
required: true
return_type: 'Tuple[None, Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_moderation_rule/delete_moderation_rule.py'
example: |-
result, error = reporting.delete_moderation_rule(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'delete'
- 'moderation'
- 'rule'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [DELETE]'
'delete_reason@py.reporting.fun':
id: 'delete_reason@py.reporting.fun'
name: 'delete_reason'
type: 'function'
description: |-
This endpoint delete a reason for a namespace with ID.
arguments:
'namespace':
type: 'str'
required: true
'reason_id':
type: 'str'
required: true
return_type: 'Tuple[None, Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_reasons/delete_reason.py'
example: |-
result, error = reporting.delete_reason(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'delete'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [DELETE]'
'delete_reason_group@py.reporting.fun':
id: 'delete_reason_group@py.reporting.fun'
name: 'delete_reason_group'
type: 'function'
description: |-
This endpoint delete a reason group for a namespace with ID.
arguments:
'group_id':
type: 'str'
required: true
description: |-
Reason group ID
'namespace':
type: 'str'
required: true
return_type: 'Tuple[None, Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_reasons/delete_reason_group.py'
example: |-
result, error = reporting.delete_reason_group(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'delete'
- 'group'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [DELETE]'
'delete_ticket@py.reporting.fun':
id: 'delete_ticket@py.reporting.fun'
name: 'delete_ticket'
type: 'function'
description: |-
This endpoint will delete ticket and all its reports.
arguments:
'namespace':
type: 'str'
required: true
'ticket_id':
type: 'str'
required: true
return_type: 'Tuple[None, Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_tickets/delete_ticket.py'
example: |-
result, error = reporting.delete_ticket(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'delete'
- 'ticket'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [DELETE]'
'get@py.reporting.fun':
id: 'get@py.reporting.fun'
name: 'get'
type: 'function'
description: |-
TimeInterval is in nanoseconds.
When there's no configuration set, the response is the default value (configurable through envar).
arguments:
'category':
type: 'Optional[Union[str, GetCategoryEnum]]'
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: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiConfigResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_configurations/get.py'
example: |-
result, error = reporting.get(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configurations'
- 'get'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REPORTINGCONFIG [READ]'
'get_moderation_rule_details@py.reporting.fun':
id: 'get_moderation_rule_details@py.reporting.fun'
name: 'get_moderation_rule_details'
type: 'function'
description: |-
This endpoint get moderation rule.
arguments:
'namespace':
type: 'str'
required: true
'rule_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiModerationRuleResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_moderation_rule/get_moderation_rule_details.py'
example: |-
result, error = reporting.get_moderation_rule_details(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'details'
- 'get'
- 'moderation'
- 'rule'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [READ]'
'get_moderation_rules@py.reporting.fun':
id: 'get_moderation_rules@py.reporting.fun'
name: 'get_moderation_rules'
type: 'function'
description: |-
This endpoint get moderation rules.
arguments:
'category':
type: 'Optional[str]'
required: false
description: |-
filter rules by category
'extension_category':
type: 'Optional[str]'
required: false
description: |-
filter rules by extension category
'limit':
type: 'Optional[int]'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'str'
required: true
'offset':
type: 'Optional[int]'
required: false
description: |-
number of data offset (default 0)
return_type: 'Tuple[Union[None, RestapiModerationRulesList], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_moderation_rule/get_moderation_rules.py'
example: |-
result, error = reporting.get_moderation_rules(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'get'
- 'moderation'
- 'rule'
- 'rules'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [READ]'
'get_reason_group@py.reporting.fun':
id: 'get_reason_group@py.reporting.fun'
name: 'get_reason_group'
type: 'function'
arguments:
'group_id':
type: 'str'
required: true
description: |-
Reason group ID
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiReasonGroupResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_reasons/get_reason_group.py'
example: |-
result, error = reporting.get_reason_group(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'get'
- 'group'
- 'reason'
- 'reasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [READ]'
'get_reports_by_ticket@py.reporting.fun':
id: 'get_reports_by_ticket@py.reporting.fun'
name: 'get_reports_by_ticket'
type: 'function'
description: |-
List reports ordered by createdAt in descending order.
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'str'
required: true
'offset':
type: 'Optional[int]'
required: false
description: |-
number of data offset (default 0)
'ticket_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiReportListResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_tickets/get_reports_by_ticket.py'
example: |-
result, error = reporting.get_reports_by_ticket(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'by'
- 'get'
- 'reports'
- 'ticket'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'get_ticket_detail@py.reporting.fun':
id: 'get_ticket_detail@py.reporting.fun'
name: 'get_ticket_detail'
type: 'function'
description: |-
This endpoint will return ticket detail with ticket id.
arguments:
'namespace':
type: 'str'
required: true
'ticket_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiTicketResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_tickets/get_ticket_detail.py'
example: |-
result, error = reporting.get_ticket_detail(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'detail'
- 'get'
- 'ticket'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'list_reports@py.reporting.fun':
id: 'list_reports@py.reporting.fun'
name: 'list_reports'
type: 'function'
description: |-
Required permission: ADMIN:NAMESPACE:{namespace}:TICKET [READ]
Reports list can be ordered by:
- createdAt
- updatedAt
arguments:
'category':
type: 'Optional[str]'
required: false
description: |-
filter reports by category
'limit':
type: 'Optional[int]'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'str'
required: true
'offset':
type: 'Optional[int]'
required: false
description: |-
number of data offset (default 0)
'reported_user_id':
type: 'Optional[str]'
required: false
description: |-
filter reports by reportedUserId
'sort_by':
type: 'Optional[str]'
required: false
description: |-
Only support one level of sortBy; default createdAt:desc
return_type: 'Tuple[Union[None, RestapiReportListResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_reports/list_reports.py'
example: |-
result, error = reporting.list_reports(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'list'
- 'reports'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'list_tickets@py.reporting.fun':
id: 'list_tickets@py.reporting.fun'
name: 'list_tickets'
type: 'function'
description: |-
Tickets list can be ordered by:
- createdAt
- reportsCount
- status (currently there are OPEN, AUTO_MODERATED and CLOSED statuses, desc order will put ticket with CLOSED status at the top)
arguments:
'category':
type: 'Optional[str]'
required: false
description: |-
filter tickets by category
'extension_category':
type: 'Optional[str]'
required: false
description: |-
filter tickets by extension category
'limit':
type: 'Optional[int]'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'str'
required: true
'offset':
type: 'Optional[int]'
required: false
description: |-
number of data offset (default 0)
'order':
type: 'Optional[str]'
required: false
description: |-
data order, asc or desc (default: desc)
'reported_user_id':
type: 'Optional[str]'
required: false
description: |-
filter reports by reportedUserId
'sort_by':
type: 'Optional[str]'
required: false
description: |-
data order key, valid keys are createdAt, reportsCount, and status (default: createdAt)
'status':
type: 'Optional[str]'
required: false
description: |-
filter tickets by status (OPEN, AUTO_MODERATED or CLOSED)
return_type: 'Tuple[Union[None, RestapiTicketListResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_tickets/list_tickets.py'
example: |-
result, error = reporting.list_tickets(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'list'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'public_get_reasons@py.reporting.fun':
id: 'public_get_reasons@py.reporting.fun'
name: 'public_get_reasons'
type: 'function'
arguments:
'group':
type: 'Optional[str]'
required: false
description: |-
query reasons under specified reason group
'limit':
type: 'Optional[int]'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'str'
required: true
'offset':
type: 'Optional[int]'
required: false
description: |-
number of data offset (default 0)
'title':
type: 'Optional[str]'
required: false
description: |-
query reason(s) by title
return_type: 'Tuple[Union[None, RestapiPublicReasonListResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/public_reasons/public_get_reasons.py'
example: |-
result, error = reporting.public_get_reasons(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'public'
- 'reasons'
'public_list_reason_groups@py.reporting.fun':
id: 'public_list_reason_groups@py.reporting.fun'
name: 'public_list_reason_groups'
type: 'function'
description: |-
Return list of reason groups ID and title under given namespace.
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
number of data requested (default 25)
'namespace':
type: 'str'
required: true
'offset':
type: 'Optional[int]'
required: false
description: |-
number of data offset (default 0)
return_type: 'Tuple[Union[None, RestapiReasonGroupListResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/public_reasons/public_list_reason_groups.py'
example: |-
result, error = reporting.public_list_reason_groups(...)
if error:
# handle_error(error)
tags:
- 'groups'
- 'list'
- 'public'
- 'reason'
- 'reasons'
'submit_report@py.reporting.fun':
id: 'submit_report@py.reporting.fun'
name: 'submit_report'
type: 'function'
description: |-
User need to be authenticated to access this endpoint.
Submit a report and will return ticket for reported object.
New ticket will be created if no OPEN ticket present for reported object (based by objectId and objectType) in a namespace.
User can only submit report once for each different user / object reported in the same OPEN ticket.
Reporting the same user / object in the same OPEN ticket will return HTTP code 409 (conflict).
Fill the 'reason' field with a 'reason title'
Supported category: - UGC - USER - CHAT - EXTENSION
arguments:
'body':
type: 'RestapiSubmitReportRequest'
required: true
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiSubmitReportResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/public_reports/submit_report.py'
example: |-
result, error = reporting.submit_report(...)
if error:
# handle_error(error)
tags:
- 'public'
- 'report'
- 'reports'
- 'submit'
'ticket_statistic@py.reporting.fun':
id: 'ticket_statistic@py.reporting.fun'
name: 'ticket_statistic'
type: 'function'
description: |-
Ticket statistic can be filtered by:
- category
- extension category
arguments:
'category':
type: 'str'
required: true
description: |-
filter statistic by category
'extension_category':
type: 'Optional[str]'
required: false
description: |-
filter statistic by extension category
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiTicketStatisticResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_tickets/ticket_statistic.py'
example: |-
result, error = reporting.ticket_statistic(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'statistic'
- 'ticket'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [READ]'
'update_moderation_rule@py.reporting.fun':
id: 'update_moderation_rule@py.reporting.fun'
name: 'update_moderation_rule'
type: 'function'
description: |-
This endpoint update moderation rule.
Supported Category:- UGC - USER - CHAT - EXTENSION
Supported Action (GOING TO DEPRECATE, for replacement please use "actions"):
* HideContent
Supported Actions:
* **hideContent**: Hide the content
* **banAccount**: Ban the user account
* **deleteChat**: Delete chat
arguments:
'body':
type: 'RestapiModerationRuleRequest'
required: true
'namespace':
type: 'str'
required: true
'rule_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiModerationRuleResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_moderation_rule/update_moderation_rule.py'
example: |-
result, error = reporting.update_moderation_rule(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'moderation'
- 'rule'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [UPDATE]'
'update_moderation_rule_status@py.reporting.fun':
id: 'update_moderation_rule_status@py.reporting.fun'
name: 'update_moderation_rule_status'
type: 'function'
description: |-
This endpoint enable/disable moderation rule status.
arguments:
'body':
type: 'RestapiModerationRuleActiveRequest'
required: true
'namespace':
type: 'str'
required: true
'rule_id':
type: 'str'
required: true
return_type: 'Tuple[None, Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_moderation_rule/update_moderation_rule_status.py'
example: |-
result, error = reporting.update_moderation_rule_status(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'moderation'
- 'rule'
- 'status'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:RULE [UPDATE]'
'update_reason@py.reporting.fun':
id: 'update_reason@py.reporting.fun'
name: 'update_reason'
type: 'function'
description: |-
This endpoint update a reason for a namespace with ID.
arguments:
'body':
type: 'RestapiCreateReasonRequest'
required: true
'namespace':
type: 'str'
required: true
'reason_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiAdminReasonResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_reasons/update_reason.py'
example: |-
result, error = reporting.update_reason(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'reason'
- 'reasons'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [UPDATE]'
'update_reason_group@py.reporting.fun':
id: 'update_reason_group@py.reporting.fun'
name: 'update_reason_group'
type: 'function'
description: |-
Reason group title is case insensitive, meaning you can't have **reason** if you already create a reason titled **Reason**
If no reasonIds passed when updating, the current reasons under the reason group will be kept (reasons will not be removed from the group).
arguments:
'body':
type: 'RestapiUpdateReasonGroupRequest'
required: true
'group_id':
type: 'str'
required: true
description: |-
Reason group ID
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiReasonGroupResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_reasons/update_reason_group.py'
example: |-
result, error = reporting.update_reason_group(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'group'
- 'reason'
- 'reasons'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REASON [UPDATE]'
'update_ticket_resolutions@py.reporting.fun':
id: 'update_ticket_resolutions@py.reporting.fun'
name: 'update_ticket_resolutions'
type: 'function'
description: |-
Update ticket resolution status to either OPEN or CLOSED. It is mandatory to provide notes
arguments:
'body':
type: 'RestapiUpdateTicketResolutionsRequest'
required: true
'namespace':
type: 'str'
required: true
'ticket_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiTicketResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_tickets/update_ticket_resolutions.py'
example: |-
result, error = reporting.update_ticket_resolutions(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'resolutions'
- 'ticket'
- 'tickets'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:TICKET [UPDATE]'
'upsert@py.reporting.fun':
id: 'upsert@py.reporting.fun'
name: 'upsert'
type: 'function'
description: |-
The behaviour of this endpoint is upsert based on the namespace.
So, you can use this for both creating & updating the configuration.
TimeInterval is in nanoseconds.
arguments:
'body':
type: 'RestapiReportingLimit'
required: true
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RestapiConfigResponse], Union[None, HttpResponse, RestapiErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.reporting as reporting'
- 'import accelbyte_py_sdk.api.reporting.models as reporting_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/reporting/operations/admin_configurations/upsert.py'
example: |-
result, error = reporting.upsert(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configurations'
- 'upsert'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:REPORTINGCONFIG [CREATE]'
# endregion functions
