AGS Extend SDK MCP Server

symbols: # region models 'ApiAddMemberParams@py.chat.mod': id: 'ApiAddMemberParams@py.chat.mod' name: 'ApiAddMemberParams' type: 'model' fields: 'is_admin': type: 'bool' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/api_add_member_params.py' example: |- api_add_member_params = chat_models.ApiAddMemberParams.create(...) 'ApiCreateNamespaceTopicParams@py.chat.mod': id: 'ApiCreateNamespaceTopicParams@py.chat.mod' name: 'ApiCreateNamespaceTopicParams' type: 'model' fields: 'description': type: 'str' required: true 'name': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/api_create_namespace_topic_params.py' example: |- api_create_namespace_topic_params = chat_models.ApiCreateNamespaceTopicParams.create(...) 'ApiCreateTopicParams@py.chat.mod': id: 'ApiCreateTopicParams@py.chat.mod' name: 'ApiCreateTopicParams' type: 'model' fields: 'admins': type: 'List[str]' required: true 'description': type: 'str' required: true 'is_channel': type: 'bool' required: true 'is_joinable': type: 'bool' required: true 'members': type: 'List[str]' required: true 'name': type: 'str' required: true 'type_': type: 'str' required: true 'shard_limit': type: 'int' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/api_create_topic_params.py' example: |- api_create_topic_params = chat_models.ApiCreateTopicParams.create(...) 'ApiCreateTopicResponse@py.chat.mod': id: 'ApiCreateTopicResponse@py.chat.mod' name: 'ApiCreateTopicResponse' type: 'model' fields: 'created_at': type: 'int' required: true 'created_by': type: 'str' required: true 'description': type: 'str' required: true 'is_channel': type: 'bool' required: true 'is_joinable': type: 'bool' required: true 'name': type: 'str' required: true 'namespace': type: 'str' required: true 'topic_id': type: 'str' required: true 'type_': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/api_create_topic_response.py' example: |- api_create_topic_response = chat_models.ApiCreateTopicResponse.create(...) 'ApiMutedTopicResponse@py.chat.mod': id: 'ApiMutedTopicResponse@py.chat.mod' name: 'ApiMutedTopicResponse' type: 'model' fields: 'expiration_time': type: 'int' required: true 'remaining_time': type: 'int' required: true 'topic_id': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/api_muted_topic_response.py' example: |- api_muted_topic_response = chat_models.ApiMutedTopicResponse.create(...) 'ApiMuteUserRequest@py.chat.mod': id: 'ApiMuteUserRequest@py.chat.mod' name: 'ApiMuteUserRequest' type: 'model' fields: 'duration': type: 'int' required: true 'user_id': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/api_mute_user_request.py' example: |- api_mute_user_request = chat_models.ApiMuteUserRequest.create(...) 'ApiSendChatParams@py.chat.mod': id: 'ApiSendChatParams@py.chat.mod' name: 'ApiSendChatParams' type: 'model' fields: 'message': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/api_send_chat_params.py' example: |- api_send_chat_params = chat_models.ApiSendChatParams.create(...) 'ApiUnmuteUserRequest@py.chat.mod': id: 'ApiUnmuteUserRequest@py.chat.mod' name: 'ApiUnmuteUserRequest' type: 'model' fields: 'user_id': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/api_unmute_user_request.py' example: |- api_unmute_user_request = chat_models.ApiUnmuteUserRequest.create(...) 'ApiUpdateTopicParams@py.chat.mod': id: 'ApiUpdateTopicParams@py.chat.mod' name: 'ApiUpdateTopicParams' type: 'model' fields: 'description': type: 'str' required: true 'is_joinable': type: 'bool' required: true 'name': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/api_update_topic_params.py' example: |- api_update_topic_params = chat_models.ApiUpdateTopicParams.create(...) 'LogAppMessageDeclaration@py.chat.mod': id: 'LogAppMessageDeclaration@py.chat.mod' name: 'LogAppMessageDeclaration' type: 'model' fields: 'attributes': type: 'List[str]' required: true 'code': type: 'str' required: true 'code_name': type: 'str' required: true 'section': type: 'str' required: true 'service': type: 'str' required: true 'text': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/log_app_message_declaration.py' example: |- log_app_message_declaration = chat_models.LogAppMessageDeclaration.create(...) 'LogconfigConfiguration@py.chat.mod': id: 'LogconfigConfiguration@py.chat.mod' name: 'LogconfigConfiguration' type: 'model' fields: 'internal_access_log_enabled': type: 'bool' required: false 'log_level': type: 'Union[str, LogLevelEnum]' required: false 'log_level_db': type: 'Union[str, LogLevelDBEnum]' required: false 'slow_query_threshold': type: 'int' required: false 'socket_log_enabled': type: 'bool' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/logconfig_configuration.py' example: |- logconfig_configuration = chat_models.LogconfigConfiguration.create(...) 'MessageActionAddUserToTopicResult@py.chat.mod': id: 'MessageActionAddUserToTopicResult@py.chat.mod' name: 'MessageActionAddUserToTopicResult' type: 'model' fields: 'processed': type: 'int' required: true 'topic_id': type: 'str' required: true 'user_id': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/message_action_add_user_to_topic_result.py' example: |- message_action_add_user_to_topic_result = chat_models.MessageActionAddUserToTopicResult.create(...) 'MessageActionDeleteTopicResult@py.chat.mod': id: 'MessageActionDeleteTopicResult@py.chat.mod' name: 'MessageActionDeleteTopicResult' type: 'model' fields: 'processed': type: 'int' required: true 'topic_id': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/message_action_delete_topic_result.py' example: |- message_action_delete_topic_result = chat_models.MessageActionDeleteTopicResult.create(...) 'ModelsAddInboxCategoryRequest@py.chat.mod': id: 'ModelsAddInboxCategoryRequest@py.chat.mod' name: 'ModelsAddInboxCategoryRequest' type: 'model' fields: 'enabled': type: 'bool' required: true 'expires_in': type: 'int' required: true 'name': type: 'str' required: true 'save_inbox': type: 'bool' required: true 'send_notification': type: 'bool' required: true 'hook': type: 'ModelsCategoryHook' required: false 'json_schema': type: 'Dict[str, Any]' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_add_inbox_category_request.py' example: |- models_add_inbox_category_request = chat_models.ModelsAddInboxCategoryRequest.create(...) 'ModelsAddInboxCategoryResponse@py.chat.mod': id: 'ModelsAddInboxCategoryResponse@py.chat.mod' name: 'ModelsAddInboxCategoryResponse' type: 'model' fields: 'enabled': type: 'bool' required: true 'expires_in': type: 'int' required: true 'name': type: 'str' required: true 'save_inbox': type: 'bool' required: true 'send_notification': type: 'bool' required: true 'hook': type: 'ModelsCategoryHook' required: false 'json_schema': type: 'Dict[str, Any]' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_add_inbox_category_response.py' example: |- models_add_inbox_category_response = chat_models.ModelsAddInboxCategoryResponse.create(...) 'ModelsBanTopicMemberParam@py.chat.mod': id: 'ModelsBanTopicMemberParam@py.chat.mod' name: 'ModelsBanTopicMemberParam' type: 'model' fields: 'user_ids': type: 'List[str]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_ban_topic_member_param.py' example: |- models_ban_topic_member_param = chat_models.ModelsBanTopicMemberParam.create(...) 'ModelsBanTopicMemberResult@py.chat.mod': id: 'ModelsBanTopicMemberResult@py.chat.mod' name: 'ModelsBanTopicMemberResult' type: 'model' fields: 'user_ids': type: 'List[str]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_ban_topic_member_result.py' example: |- models_ban_topic_member_result = chat_models.ModelsBanTopicMemberResult.create(...) 'ModelsCategoryHook@py.chat.mod': id: 'ModelsCategoryHook@py.chat.mod' name: 'ModelsCategoryHook' type: 'model' fields: 'driver': type: 'str' required: false 'params': type: 'Dict[str, Any]' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_category_hook.py' example: |- models_category_hook = chat_models.ModelsCategoryHook.create(...) 'ModelsChannelTopicResponse@py.chat.mod': id: 'ModelsChannelTopicResponse@py.chat.mod' name: 'ModelsChannelTopicResponse' type: 'model' fields: 'created_at': type: 'int' required: true 'created_by': type: 'str' required: true 'description': type: 'str' required: true 'is_joinable': type: 'bool' required: true 'message_per_minutes': type: 'float' required: true 'name': type: 'str' required: true 'namespace': type: 'str' required: true 'shard_limit': type: 'int' required: true 'shard_number': type: 'int' required: true 'topic_id': type: 'str' required: true 'total_member': type: 'int' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_channel_topic_response.py' example: |- models_channel_topic_response = chat_models.ModelsChannelTopicResponse.create(...) 'ModelsChannelTopicSummaryResponse@py.chat.mod': id: 'ModelsChannelTopicSummaryResponse@py.chat.mod' name: 'ModelsChannelTopicSummaryResponse' type: 'model' fields: 'total_channel': type: 'int' required: true 'total_shard': type: 'int' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_channel_topic_summary_response.py' example: |- models_channel_topic_summary_response = chat_models.ModelsChannelTopicSummaryResponse.create(...) 'ModelsChannelTopicWithPaginationResponse@py.chat.mod': id: 'ModelsChannelTopicWithPaginationResponse@py.chat.mod' name: 'ModelsChannelTopicWithPaginationResponse' type: 'model' fields: 'data': type: 'List[ModelsChannelTopicResponse]' required: true 'paging': type: 'ModelsPagination' required: true 'total_data': type: 'int' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_channel_topic_with_pagination_response.py' example: |- models_channel_topic_with_pagination_response = chat_models.ModelsChannelTopicWithPaginationResponse.create(...) 'ModelsChatMessageResponse@py.chat.mod': id: 'ModelsChatMessageResponse@py.chat.mod' name: 'ModelsChatMessageResponse' type: 'model' fields: 'from_': type: 'str' required: true 'id_': type: 'str' required: true 'message': type: 'str' required: true 'topic_id': type: 'str' required: true 'read_at': type: 'int' required: false 'received_at': type: 'int' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_chat_message_response.py' example: |- models_chat_message_response = chat_models.ModelsChatMessageResponse.create(...) 'ModelsChatMessageWithPaginationResponse@py.chat.mod': id: 'ModelsChatMessageWithPaginationResponse@py.chat.mod' name: 'ModelsChatMessageWithPaginationResponse' type: 'model' fields: 'data': type: 'List[ModelsChatMessageResponse]' required: true 'paging': type: 'ModelsPagination' required: true 'total_data': type: 'int' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_chat_message_with_pagination_response.py' example: |- models_chat_message_with_pagination_response = chat_models.ModelsChatMessageWithPaginationResponse.create(...) 'ModelsChatSnapshotMessage@py.chat.mod': id: 'ModelsChatSnapshotMessage@py.chat.mod' name: 'ModelsChatSnapshotMessage' type: 'model' fields: 'chat_id': type: 'str' required: true 'created_at': type: 'int' required: true 'message': type: 'str' required: true 'sender_id': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_chat_snapshot_message.py' example: |- models_chat_snapshot_message = chat_models.ModelsChatSnapshotMessage.create(...) 'ModelsChatSnapshots@py.chat.mod': id: 'ModelsChatSnapshots@py.chat.mod' name: 'ModelsChatSnapshots' type: 'model' fields: 'chat_id': type: 'str' required: true 'created_at': type: 'int' required: true 'joined_topics': type: 'List[str]' required: true 'messages': type: 'List[ModelsChatSnapshotMessage]' required: true 'namespace': type: 'str' required: true 'sender_id': type: 'str' required: true 'ticket_id': type: 'str' required: true 'topic_id': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_chat_snapshots.py' example: |- models_chat_snapshots = chat_models.ModelsChatSnapshots.create(...) 'ModelsConfig@py.chat.mod': id: 'ModelsConfig@py.chat.mod' name: 'ModelsConfig' type: 'model' fields: 'chat_rate_limit_burst': type: 'int' required: true 'chat_rate_limit_duration': type: 'int' required: true 'concurrent_users_limit': type: 'int' required: true 'enable_profanity_filter': type: 'bool' required: true 'filter_app_name': type: 'str' required: true 'filter_param': type: 'str' required: true 'filter_type': type: 'str' required: true 'general_rate_limit_burst': type: 'int' required: true 'general_rate_limit_duration': type: 'int' required: true 'namespace': type: 'str' required: true 'shard_capacity_limit': type: 'int' required: true 'shard_default_limit': type: 'int' required: true 'shard_hard_limit': type: 'int' required: true 'spam_chat_burst': type: 'int' required: true 'spam_chat_duration': type: 'int' required: true 'spam_mute_duration': type: 'int' required: true 'default_dictionary_loaded': type: 'bool' required: false 'enable_clan_chat': type: 'bool' required: false 'enable_manual_topic_creation': type: 'bool' required: false 'enable_pm_send_platform_id': type: 'bool' required: false 'max_chat_message_length': type: 'int' required: false 'use_default_dictionary': type: 'bool' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_config.py' example: |- models_config = chat_models.ModelsConfig.create(...) 'ModelsConfigExport@py.chat.mod': id: 'ModelsConfigExport@py.chat.mod' name: 'ModelsConfigExport' type: 'model' fields: 'chat_rate_limit_burst': type: 'int' required: true 'chat_rate_limit_duration': type: 'int' required: true 'concurrent_users_limit': type: 'int' required: true 'general_rate_limit_burst': type: 'int' required: true 'general_rate_limit_duration': type: 'int' required: true 'namespace': type: 'str' required: true 'enable_clan_chat': type: 'bool' required: false 'enable_manual_topic_creation': type: 'bool' required: false 'enable_pm_send_platform_id': type: 'bool' required: false 'enable_profanity_filter': type: 'bool' required: false 'filter_app_name': type: 'str' required: false 'filter_param': type: 'str' required: false 'filter_type': type: 'str' required: false 'shard_capacity_limit': type: 'int' required: false 'shard_default_limit': type: 'int' required: false 'shard_hard_limit': type: 'int' required: false 'spam_chat_burst': type: 'int' required: false 'spam_chat_duration': type: 'int' required: false 'spam_mute_duration': type: 'int' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_config_export.py' example: |- models_config_export = chat_models.ModelsConfigExport.create(...) 'ModelsConfigList@py.chat.mod': id: 'ModelsConfigList@py.chat.mod' name: 'ModelsConfigList' type: 'model' fields: 'configs': type: 'List[ModelsConfig]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_config_list.py' example: |- models_config_list = chat_models.ModelsConfigList.create(...) 'ModelsConfigResponse@py.chat.mod': id: 'ModelsConfigResponse@py.chat.mod' name: 'ModelsConfigResponse' type: 'model' fields: 'chat_rate_limit_burst': type: 'int' required: false 'chat_rate_limit_duration': type: 'int' required: false 'concurrent_users_limit': type: 'int' required: false 'enable_clan_chat': type: 'bool' required: false 'enable_manual_topic_creation': type: 'bool' required: false 'enable_pm_send_platform_id': type: 'bool' required: false 'enable_profanity_filter': type: 'bool' required: false 'filter_app_name': type: 'str' required: false 'filter_param': type: 'str' required: false 'filter_type': type: 'str' required: false 'general_rate_limit_burst': type: 'int' required: false 'general_rate_limit_duration': type: 'int' required: false 'max_chat_message_length': type: 'int' required: false 'shard_capacity_limit': type: 'int' required: false 'shard_default_limit': type: 'int' required: false 'shard_hard_limit': type: 'int' required: false 'spam_chat_burst': type: 'int' required: false 'spam_chat_duration': type: 'int' required: false 'spam_mute_duration': type: 'int' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_config_response.py' example: |- models_config_response = chat_models.ModelsConfigResponse.create(...) 'ModelsDictionary@py.chat.mod': id: 'ModelsDictionary@py.chat.mod' name: 'ModelsDictionary' type: 'model' fields: 'id_': type: 'str' required: true 'namespace': type: 'str' required: true 'word': type: 'str' required: true 'word_type': type: 'str' required: true 'parent_id': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_dictionary.py' example: |- models_dictionary = chat_models.ModelsDictionary.create(...) 'ModelsDictionaryChild@py.chat.mod': id: 'ModelsDictionaryChild@py.chat.mod' name: 'ModelsDictionaryChild' type: 'model' fields: 'id_': type: 'str' required: true 'word': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_dictionary_child.py' example: |- models_dictionary_child = chat_models.ModelsDictionaryChild.create(...) 'ModelsDictionaryExport@py.chat.mod': id: 'ModelsDictionaryExport@py.chat.mod' name: 'ModelsDictionaryExport' type: 'model' fields: 'dictionaries': type: 'List[ModelsDictionaryExportItem]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_dictionary_export.py' example: |- models_dictionary_export = chat_models.ModelsDictionaryExport.create(...) 'ModelsDictionaryExportItem@py.chat.mod': id: 'ModelsDictionaryExportItem@py.chat.mod' name: 'ModelsDictionaryExportItem' type: 'model' fields: 'word': type: 'str' required: true 'false_negative': type: 'List[str]' required: false 'false_positive': type: 'List[str]' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_dictionary_export_item.py' example: |- models_dictionary_export_item = chat_models.ModelsDictionaryExportItem.create(...) 'ModelsDictionaryGroup@py.chat.mod': id: 'ModelsDictionaryGroup@py.chat.mod' name: 'ModelsDictionaryGroup' type: 'model' fields: 'count': type: 'int' required: true 'name': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_dictionary_group.py' example: |- models_dictionary_group = chat_models.ModelsDictionaryGroup.create(...) 'ModelsDictionaryImportResult@py.chat.mod': id: 'ModelsDictionaryImportResult@py.chat.mod' name: 'ModelsDictionaryImportResult' type: 'model' fields: 'words': type: 'ModelsDictionaryWordChanges' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_dictionary_import_result.py' example: |- models_dictionary_import_result = chat_models.ModelsDictionaryImportResult.create(...) 'ModelsDictionaryInsertBulkRequest@py.chat.mod': id: 'ModelsDictionaryInsertBulkRequest@py.chat.mod' name: 'ModelsDictionaryInsertBulkRequest' type: 'model' fields: 'dictionaries': type: 'List[ModelsDictionaryInsertRequest]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_dictionary_insert_bulk_request.py' example: |- models_dictionary_insert_bulk_request = chat_models.ModelsDictionaryInsertBulkRequest.create(...) 'ModelsDictionaryInsertRequest@py.chat.mod': id: 'ModelsDictionaryInsertRequest@py.chat.mod' name: 'ModelsDictionaryInsertRequest' type: 'model' fields: 'false_negative': type: 'List[str]' required: true 'false_positive': type: 'List[str]' required: true 'word': type: 'str' required: true 'word_type': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_dictionary_insert_request.py' example: |- models_dictionary_insert_request = chat_models.ModelsDictionaryInsertRequest.create(...) 'ModelsDictionaryQueryResult@py.chat.mod': id: 'ModelsDictionaryQueryResult@py.chat.mod' name: 'ModelsDictionaryQueryResult' type: 'model' fields: 'data': type: 'List[ModelsDictionaryWithChildren]' 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.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_dictionary_query_result.py' example: |- models_dictionary_query_result = chat_models.ModelsDictionaryQueryResult.create(...) 'ModelsDictionaryUpdateRequest@py.chat.mod': id: 'ModelsDictionaryUpdateRequest@py.chat.mod' name: 'ModelsDictionaryUpdateRequest' type: 'model' fields: 'false_negative': type: 'List[str]' required: true 'false_positive': type: 'List[str]' required: true 'word': type: 'str' required: true 'word_type': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_dictionary_update_request.py' example: |- models_dictionary_update_request = chat_models.ModelsDictionaryUpdateRequest.create(...) 'ModelsDictionaryWithChildren@py.chat.mod': id: 'ModelsDictionaryWithChildren@py.chat.mod' name: 'ModelsDictionaryWithChildren' type: 'model' fields: 'id_': type: 'str' required: true 'namespace': type: 'str' required: true 'word': type: 'str' required: true 'word_type': type: 'str' required: true 'false_negatives': type: 'List[ModelsDictionaryChild]' required: false 'false_positives': type: 'List[ModelsDictionaryChild]' required: false 'parent_id': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_dictionary_with_children.py' example: |- models_dictionary_with_children = chat_models.ModelsDictionaryWithChildren.create(...) 'ModelsDictionaryWordChanges@py.chat.mod': id: 'ModelsDictionaryWordChanges@py.chat.mod' name: 'ModelsDictionaryWordChanges' type: 'model' fields: 'added': type: 'List[str]' required: true 'failed': type: 'List[str]' required: true 'ignored': type: 'List[str]' required: true 'replaced': type: 'List[str]' required: true 'unchanged': type: 'List[str]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_dictionary_word_changes.py' example: |- models_dictionary_word_changes = chat_models.ModelsDictionaryWordChanges.create(...) 'ModelsGetInboxCategoriesResponseItem@py.chat.mod': id: 'ModelsGetInboxCategoriesResponseItem@py.chat.mod' name: 'ModelsGetInboxCategoriesResponseItem' type: 'model' fields: 'enabled': type: 'bool' required: true 'expires_in': type: 'int' required: true 'name': type: 'str' required: true 'save_inbox': type: 'bool' required: true 'send_notification': type: 'bool' required: true 'hook': type: 'ModelsCategoryHook' required: false 'json_schema': type: 'Dict[str, Any]' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_get_inbox_categories_response_item.py' example: |- models_get_inbox_categories_response_item = chat_models.ModelsGetInboxCategoriesResponseItem.create(...) 'ModelsGetInboxMessagesResponse@py.chat.mod': id: 'ModelsGetInboxMessagesResponse@py.chat.mod' name: 'ModelsGetInboxMessagesResponse' type: 'model' fields: 'data': type: 'List[ModelsGetInboxMessagesResponseData]' 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.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_get_inbox_messages_response.py' example: |- models_get_inbox_messages_response = chat_models.ModelsGetInboxMessagesResponse.create(...) 'ModelsGetInboxMessagesResponseData@py.chat.mod': id: 'ModelsGetInboxMessagesResponseData@py.chat.mod' name: 'ModelsGetInboxMessagesResponseData' type: 'model' fields: 'created_at': type: 'int' required: true 'expired_at': type: 'int' required: true 'id_': type: 'str' required: true 'scope': type: 'Union[str, ScopeEnum]' required: true 'sender_id': type: 'str' required: true 'status': type: 'Union[str, StatusEnum]' required: true 'updated_at': type: 'int' required: true 'category': type: 'str' required: false 'message': type: 'Dict[str, Any]' required: false 'user_ids': type: 'List[str]' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_get_inbox_messages_response_data.py' example: |- models_get_inbox_messages_response_data = chat_models.ModelsGetInboxMessagesResponseData.create(...) 'ModelsGetInboxStatsResponse@py.chat.mod': id: 'ModelsGetInboxStatsResponse@py.chat.mod' name: 'ModelsGetInboxStatsResponse' type: 'model' fields: 'data': type: 'List[ModelsMessageStats]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_get_inbox_stats_response.py' example: |- models_get_inbox_stats_response = chat_models.ModelsGetInboxStatsResponse.create(...) 'ModelsGetInboxUsersResponse@py.chat.mod': id: 'ModelsGetInboxUsersResponse@py.chat.mod' name: 'ModelsGetInboxUsersResponse' type: 'model' fields: 'data': type: 'List[ModelsUserInbox]' 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.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_get_inbox_users_response.py' example: |- models_get_inbox_users_response = chat_models.ModelsGetInboxUsersResponse.create(...) 'ModelsGetListTopicKafkaResponse@py.chat.mod': id: 'ModelsGetListTopicKafkaResponse@py.chat.mod' name: 'ModelsGetListTopicKafkaResponse' type: 'model' fields: 'topic_name': type: 'List[str]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_get_list_topic_kafka_response.py' example: |- models_get_list_topic_kafka_response = chat_models.ModelsGetListTopicKafkaResponse.create(...) 'ModelsImportConfigResponse@py.chat.mod': id: 'ModelsImportConfigResponse@py.chat.mod' name: 'ModelsImportConfigResponse' type: 'model' fields: 'failed_configs': type: 'List[str]' required: true 'ignored_configs': type: 'List[str]' required: true 'new_configs': type: 'List[str]' required: true 'replaced_configs': type: 'List[str]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_import_config_response.py' example: |- models_import_config_response = chat_models.ModelsImportConfigResponse.create(...) 'ModelsJSONSchemaType@py.chat.mod': id: 'ModelsJSONSchemaType@py.chat.mod' name: 'ModelsJSONSchemaType' type: 'model' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_json_schema_type.py' example: |- models_json_schema_type = chat_models.ModelsJSONSchemaType.create(...) 'ModelsMessageRequest@py.chat.mod': id: 'ModelsMessageRequest@py.chat.mod' name: 'ModelsMessageRequest' type: 'model' fields: 'message': type: 'str' required: true 'timestamp': type: 'int' required: false 'topic_id': type: 'str' required: false 'topic_type': type: 'Union[str, TopicTypeEnum]' required: false 'user_id': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_message_request.py' example: |- models_message_request = chat_models.ModelsMessageRequest.create(...) 'ModelsMessageResultWithAttributes@py.chat.mod': id: 'ModelsMessageResultWithAttributes@py.chat.mod' name: 'ModelsMessageResultWithAttributes' type: 'model' fields: 'action': type: 'str' required: true 'final_message': type: 'str' required: true 'id_': type: 'str' required: true 'timestamp': type: 'int' required: true 'attributes': type: 'Dict[str, Any]' required: false 'cencored_words': type: 'List[str]' required: false 'classifications': type: 'List[str]' required: false 'reference_id': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_message_result_with_attributes.py' example: |- models_message_result_with_attributes = chat_models.ModelsMessageResultWithAttributes.create(...) 'ModelsMessageStats@py.chat.mod': id: 'ModelsMessageStats@py.chat.mod' name: 'ModelsMessageStats' type: 'model' fields: 'id_': type: 'str' required: true 'message_read': type: 'int' required: true 'message_stored': type: 'int' required: true 'notification_sent': type: 'int' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_message_stats.py' example: |- models_message_stats = chat_models.ModelsMessageStats.create(...) 'ModelsPagination@py.chat.mod': id: 'ModelsPagination@py.chat.mod' name: 'ModelsPagination' type: 'model' fields: '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.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_pagination.py' example: |- models_pagination = chat_models.ModelsPagination.create(...) 'ModelsPublicBanTopicMembersRequest@py.chat.mod': id: 'ModelsPublicBanTopicMembersRequest@py.chat.mod' name: 'ModelsPublicBanTopicMembersRequest' type: 'model' fields: 'user_i_ds': type: 'List[str]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_public_ban_topic_members_request.py' example: |- models_public_ban_topic_members_request = chat_models.ModelsPublicBanTopicMembersRequest.create(...) 'ModelsPublicBanTopicMembersResponse@py.chat.mod': id: 'ModelsPublicBanTopicMembersResponse@py.chat.mod' name: 'ModelsPublicBanTopicMembersResponse' type: 'model' fields: 'user_i_ds': type: 'List[str]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_public_ban_topic_members_response.py' example: |- models_public_ban_topic_members_response = chat_models.ModelsPublicBanTopicMembersResponse.create(...) 'ModelsPublicConfigResponse@py.chat.mod': id: 'ModelsPublicConfigResponse@py.chat.mod' name: 'ModelsPublicConfigResponse' type: 'model' fields: 'chat_rate_limit_burst': type: 'int' required: true 'chat_rate_limit_duration': type: 'int' required: true 'general_rate_limit_burst': type: 'int' required: true 'general_rate_limit_duration': type: 'int' required: true 'max_chat_message_length': type: 'int' required: true 'spam_chat_burst': type: 'int' required: true 'spam_chat_duration': type: 'int' required: true 'spam_mute_duration': type: 'int' required: true 'enable_pm_send_platform_id': type: 'bool' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_public_config_response.py' example: |- models_public_config_response = chat_models.ModelsPublicConfigResponse.create(...) 'ModelsPublicUnbanTopicMembersRequest@py.chat.mod': id: 'ModelsPublicUnbanTopicMembersRequest@py.chat.mod' name: 'ModelsPublicUnbanTopicMembersRequest' type: 'model' fields: 'user_i_ds': type: 'List[str]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_public_unban_topic_members_request.py' example: |- models_public_unban_topic_members_request = chat_models.ModelsPublicUnbanTopicMembersRequest.create(...) 'ModelsPublicUnbanTopicMembersResponse@py.chat.mod': id: 'ModelsPublicUnbanTopicMembersResponse@py.chat.mod' name: 'ModelsPublicUnbanTopicMembersResponse' type: 'model' fields: 'user_i_ds': type: 'List[str]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_public_unban_topic_members_response.py' example: |- models_public_unban_topic_members_response = chat_models.ModelsPublicUnbanTopicMembersResponse.create(...) 'ModelsSaveInboxMessageRequest@py.chat.mod': id: 'ModelsSaveInboxMessageRequest@py.chat.mod' name: 'ModelsSaveInboxMessageRequest' type: 'model' fields: 'expired_at': type: 'int' required: true 'message': type: 'Dict[str, Any]' required: true 'scope': type: 'Union[str, ScopeEnum]' required: true 'status': type: 'Union[str, StatusEnum]' required: true 'user_ids': type: 'List[str]' required: true 'category': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_save_inbox_message_request.py' example: |- models_save_inbox_message_request = chat_models.ModelsSaveInboxMessageRequest.create(...) 'ModelsSaveInboxMessageResponse@py.chat.mod': id: 'ModelsSaveInboxMessageResponse@py.chat.mod' name: 'ModelsSaveInboxMessageResponse' type: 'model' fields: 'expired_at': type: 'int' required: true 'id_': type: 'str' required: true 'scope': type: 'Union[str, ScopeEnum]' required: true 'status': type: 'Union[str, StatusEnum]' required: true 'category': type: 'str' required: false 'message': type: 'Dict[str, Any]' required: false 'user_i_ds': type: 'List[str]' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_save_inbox_message_response.py' example: |- models_save_inbox_message_response = chat_models.ModelsSaveInboxMessageResponse.create(...) 'ModelsSendInboxMessageRequest@py.chat.mod': id: 'ModelsSendInboxMessageRequest@py.chat.mod' name: 'ModelsSendInboxMessageRequest' type: 'model' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_send_inbox_message_request.py' example: |- models_send_inbox_message_request = chat_models.ModelsSendInboxMessageRequest.create(...) 'ModelsSendInboxMessageResponse@py.chat.mod': id: 'ModelsSendInboxMessageResponse@py.chat.mod' name: 'ModelsSendInboxMessageResponse' type: 'model' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_send_inbox_message_response.py' example: |- models_send_inbox_message_response = chat_models.ModelsSendInboxMessageResponse.create(...) 'ModelsTopicInfo@py.chat.mod': id: 'ModelsTopicInfo@py.chat.mod' name: 'ModelsTopicInfo' type: 'model' fields: 'created_at': type: 'int' required: true 'id_': type: 'str' required: true 'name': type: 'str' required: true 'sub_type': type: 'str' required: true 'type_': type: 'str' required: true 'deleted_at': type: 'int' required: false 'members': type: 'List[TopicInfoMember]' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_topic_info.py' example: |- models_topic_info = chat_models.ModelsTopicInfo.create(...) 'ModelsTopicLogItem@py.chat.mod': id: 'ModelsTopicLogItem@py.chat.mod' name: 'ModelsTopicLogItem' type: 'model' fields: 'created_at': type: 'int' required: true 'id_': type: 'str' required: true 'message': type: 'str' required: true 'sender_id': type: 'str' required: true 'topic_id': type: 'str' required: true 'type_': type: 'Union[str, TypeEnum]' required: true 'user_id': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_topic_log_item.py' example: |- models_topic_log_item = chat_models.ModelsTopicLogItem.create(...) 'ModelsTopicLogWithPaginationResponse@py.chat.mod': id: 'ModelsTopicLogWithPaginationResponse@py.chat.mod' name: 'ModelsTopicLogWithPaginationResponse' type: 'model' fields: 'data': type: 'List[ModelsTopicLogItem]' required: true 'paging': type: 'ModelsPagination' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_topic_log_with_pagination_response.py' example: |- models_topic_log_with_pagination_response = chat_models.ModelsTopicLogWithPaginationResponse.create(...) 'ModelsTopicMemberResponse@py.chat.mod': id: 'ModelsTopicMemberResponse@py.chat.mod' name: 'ModelsTopicMemberResponse' type: 'model' fields: 'is_admin': type: 'bool' required: true 'is_banned': type: 'bool' required: true 'shard_id': type: 'str' required: true 'user_id': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_topic_member_response.py' example: |- models_topic_member_response = chat_models.ModelsTopicMemberResponse.create(...) 'ModelsTopicMemberWithPaginationResponse@py.chat.mod': id: 'ModelsTopicMemberWithPaginationResponse@py.chat.mod' name: 'ModelsTopicMemberWithPaginationResponse' type: 'model' fields: 'data': type: 'List[ModelsTopicMemberResponse]' required: true 'paging': type: 'ModelsPagination' required: true 'total_data': type: 'int' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_topic_member_with_pagination_response.py' example: |- models_topic_member_with_pagination_response = chat_models.ModelsTopicMemberWithPaginationResponse.create(...) 'ModelsTopicResponse@py.chat.mod': id: 'ModelsTopicResponse@py.chat.mod' name: 'ModelsTopicResponse' type: 'model' fields: 'created_at': type: 'int' required: true 'created_by': type: 'str' required: true 'last_message_at': type: 'int' required: true 'name': type: 'str' required: true 'namespace': type: 'str' required: true 'topic_id': type: 'str' required: true 'type_': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_topic_response.py' example: |- models_topic_response = chat_models.ModelsTopicResponse.create(...) 'ModelsUnbanTopicMemberParam@py.chat.mod': id: 'ModelsUnbanTopicMemberParam@py.chat.mod' name: 'ModelsUnbanTopicMemberParam' type: 'model' fields: 'user_ids': type: 'List[str]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_unban_topic_member_param.py' example: |- models_unban_topic_member_param = chat_models.ModelsUnbanTopicMemberParam.create(...) 'ModelsUnbanTopicMemberResult@py.chat.mod': id: 'ModelsUnbanTopicMemberResult@py.chat.mod' name: 'ModelsUnbanTopicMemberResult' type: 'model' fields: 'user_ids': type: 'List[str]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_unban_topic_member_result.py' example: |- models_unban_topic_member_result = chat_models.ModelsUnbanTopicMemberResult.create(...) 'ModelsUnsendInboxMessageRequest@py.chat.mod': id: 'ModelsUnsendInboxMessageRequest@py.chat.mod' name: 'ModelsUnsendInboxMessageRequest' type: 'model' fields: 'user_ids': type: 'List[str]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_unsend_inbox_message_request.py' example: |- models_unsend_inbox_message_request = chat_models.ModelsUnsendInboxMessageRequest.create(...) 'ModelsUnsendInboxMessageResponse@py.chat.mod': id: 'ModelsUnsendInboxMessageResponse@py.chat.mod' name: 'ModelsUnsendInboxMessageResponse' type: 'model' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_unsend_inbox_message_response.py' example: |- models_unsend_inbox_message_response = chat_models.ModelsUnsendInboxMessageResponse.create(...) 'ModelsUpdateInboxCategoryRequest@py.chat.mod': id: 'ModelsUpdateInboxCategoryRequest@py.chat.mod' name: 'ModelsUpdateInboxCategoryRequest' type: 'model' fields: 'enabled': type: 'bool' required: true 'expires_in': type: 'int' required: true 'hook': type: 'ModelsCategoryHook' required: true 'save_inbox': type: 'bool' required: true 'send_notification': type: 'bool' required: true 'json_schema': type: 'Dict[str, Any]' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_update_inbox_category_request.py' example: |- models_update_inbox_category_request = chat_models.ModelsUpdateInboxCategoryRequest.create(...) 'ModelsUpdateInboxMessageRequest@py.chat.mod': id: 'ModelsUpdateInboxMessageRequest@py.chat.mod' name: 'ModelsUpdateInboxMessageRequest' type: 'model' fields: 'expired_at': type: 'int' required: true 'message': type: 'Dict[str, Any]' required: true 'scope': type: 'Union[str, ScopeEnum]' required: true 'user_ids': type: 'List[str]' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_update_inbox_message_request.py' example: |- models_update_inbox_message_request = chat_models.ModelsUpdateInboxMessageRequest.create(...) 'ModelsUserInbox@py.chat.mod': id: 'ModelsUserInbox@py.chat.mod' name: 'ModelsUserInbox' type: 'model' fields: 'keep': type: 'bool' required: true 'read_at': type: 'int' required: true 'user_id': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/models_user_inbox.py' example: |- models_user_inbox = chat_models.ModelsUserInbox.create(...) 'ResponseError@py.chat.mod': id: 'ResponseError@py.chat.mod' name: 'ResponseError' 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.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/response_error.py' example: |- response_error = chat_models.ResponseError.create(...) 'RestapiErrorResponseBody@py.chat.mod': id: 'RestapiErrorResponseBody@py.chat.mod' name: 'RestapiErrorResponseBody' 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.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/restapi_error_response_body.py' example: |- restapi_error_response_body = chat_models.RestapiErrorResponseBody.create(...) 'TopicInfoMember@py.chat.mod': id: 'TopicInfoMember@py.chat.mod' name: 'TopicInfoMember' type: 'model' fields: 'user_id': type: 'str' required: true 'left_at': type: 'int' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/models/topic_info_member.py' example: |- topic_info_member = chat_models.TopicInfoMember.create(...) # endregion models # region functions 'admin_add_inbox_category@py.chat.fun': id: 'admin_add_inbox_category@py.chat.fun' name: 'admin_add_inbox_category' type: 'function' description: |- Add inbox category. arguments: 'body': type: 'ModelsAddInboxCategoryRequest' required: true 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsAddInboxCategoryResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/inbox/admin_add_inbox_category.py' example: |- result, error = chat.admin_add_inbox_category(...) if error: # handle_error(error) tags: - 'add' - 'admin' - 'category' - 'inbox' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [CREATE]' 'admin_add_topic_member@py.chat.fun': id: 'admin_add_topic_member@py.chat.fun' name: 'admin_add_topic_member' type: 'function' description: |- Add new member for topic in a namespace. arguments: 'body': type: 'ApiAddMemberParams' required: true 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID that will added user to 'user_id': type: 'str' required: true description: |- user ID that will be added to topic return_type: 'Tuple[Union[None, MessageActionAddUserToTopicResult], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_add_topic_member.py' example: |- result, error = chat.admin_add_topic_member(...) if error: # handle_error(error) tags: - 'add' - 'admin' - 'member' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]' 'admin_ban_topic_members@py.chat.fun': id: 'admin_ban_topic_members@py.chat.fun' name: 'admin_ban_topic_members' type: 'function' description: |- Ban users in some topic. banned user not assigned to shard for channel topic, and cannot send and query chat. arguments: 'body': type: 'ModelsBanTopicMemberParam' required: true 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID that receive the chat return_type: 'Tuple[Union[None, ModelsBanTopicMemberResult], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_ban_topic_members.py' example: |- result, error = chat.admin_ban_topic_members(...) if error: # handle_error(error) tags: - 'admin' - 'ban' - 'members' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]' 'admin_channel_topic_info@py.chat.fun': id: 'admin_channel_topic_info@py.chat.fun' name: 'admin_channel_topic_info' type: 'function' description: |- Get chat list of topic in a namespace. arguments: 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID return_type: 'Tuple[Union[None, ModelsChannelTopicResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_channel_topic_info.py' example: |- result, error = chat.admin_channel_topic_info(...) if error: # handle_error(error) tags: - 'admin' - 'channel' - 'info' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]' 'admin_channel_topic_list@py.chat.fun': id: 'admin_channel_topic_list@py.chat.fun' name: 'admin_channel_topic_list' type: 'function' description: |- Get channel chat list of topic in a namespace. arguments: 'limit': type: 'Optional[int]' required: false description: |- limit 'namespace': type: 'str' required: true description: |- namespace 'offset': type: 'Optional[int]' required: false description: |- offset 'topic_name': type: 'Optional[str]' required: false description: |- name return_type: 'Tuple[Union[None, ModelsChannelTopicWithPaginationResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_channel_topic_list.py' example: |- result, error = chat.admin_channel_topic_list(...) if error: # handle_error(error) tags: - 'admin' - 'channel' - 'list' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]' 'admin_channel_topic_summary@py.chat.fun': id: 'admin_channel_topic_summary@py.chat.fun' name: 'admin_channel_topic_summary' type: 'function' description: |- Get chat list of topic in a namespace. arguments: 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsChannelTopicSummaryResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_channel_topic_summary.py' example: |- result, error = chat.admin_channel_topic_summary(...) if error: # handle_error(error) tags: - 'admin' - 'channel' - 'summary' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]' 'admin_chat_history@py.chat.fun': id: 'admin_chat_history@py.chat.fun' name: 'admin_chat_history' type: 'function' description: |- Get chat history in a namespace. arguments: 'chat_id': type: 'Optional[List[str]]' required: false description: |- chat ID of chat 'end_created_at': type: 'Optional[int]' required: false description: |- end date 'keyword': type: 'Optional[str]' required: false description: |- keyword containing in message 'limit': type: 'Optional[int]' required: false description: |- limit 'namespace': type: 'str' required: true description: |- namespace 'offset': type: 'Optional[int]' required: false description: |- offset 'order': type: 'Optional[str]' required: false description: |- anyof: createdAt:asc / createdAt:desc 'sender_user_id': type: 'Optional[str]' required: false description: |- sender user ID 'shard_id': type: 'Optional[str]' required: false description: |- shard id 'start_created_at': type: 'Optional[int]' required: false description: |- start date 'topic': type: 'Optional[List[str]]' required: false description: |- topic ID that receive the chat 'unfiltered': type: 'Optional[bool]' required: false description: |- unfiltered chat messages return_type: 'Tuple[Union[None, ModelsChatMessageWithPaginationResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_chat_history.py' example: |- result, error = chat.admin_chat_history(...) if error: # handle_error(error) tags: - 'admin' - 'chat' - 'history' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]' 'admin_create_namespace_topic@py.chat.fun': id: 'admin_create_namespace_topic@py.chat.fun' name: 'admin_create_namespace_topic' type: 'function' description: |- Create new namespace group topic in a namespace. arguments: 'body': type: 'ApiCreateNamespaceTopicParams' required: true 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ApiCreateTopicResponse], Union[None, HttpResponse]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_create_namespace_topic.py' example: |- result, error = chat.admin_create_namespace_topic(...) if error: # handle_error(error) tags: - 'admin' - 'create' - 'namespace' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [CREATE]' 'admin_create_topic@py.chat.fun': id: 'admin_create_topic@py.chat.fun' name: 'admin_create_topic' type: 'function' description: |- Create new group topic in a namespace. arguments: 'body': type: 'ApiCreateTopicParams' required: true 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ApiCreateTopicResponse], Union[None, HttpResponse]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_create_topic.py' example: |- result, error = chat.admin_create_topic(...) if error: # handle_error(error) tags: - 'admin' - 'create' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [CREATE]' 'admin_delete_chat@py.chat.fun': id: 'admin_delete_chat@py.chat.fun' name: 'admin_delete_chat' type: 'function' description: |- Delete chat. arguments: 'chat_id': type: 'str' required: true description: |- chat ID od the chat 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID of the chat return_type: 'Tuple[None, Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_delete_chat.py' example: |- result, error = chat.admin_delete_chat(...) if error: # handle_error(error) tags: - 'admin' - 'chat' - 'delete' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [DELETE]' 'admin_delete_chat_snapshot@py.chat.fun': id: 'admin_delete_chat_snapshot@py.chat.fun' name: 'admin_delete_chat_snapshot' type: 'function' description: |- Delete the chat snapshot arguments: 'chat_id': type: 'str' required: true description: |- id of the chat 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[None, Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/moderation/admin_delete_chat_snapshot.py' example: |- result, error = chat.admin_delete_chat_snapshot(...) if error: # handle_error(error) tags: - 'admin' - 'chat' - 'delete' - 'moderation' - 'snapshot' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [DELETE]' 'admin_delete_inbox_category@py.chat.fun': id: 'admin_delete_inbox_category@py.chat.fun' name: 'admin_delete_inbox_category' type: 'function' description: |- Delete inbox category arguments: 'category': type: 'str' required: true description: |- category 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/inbox/admin_delete_inbox_category.py' example: |- result, error = chat.admin_delete_inbox_category(...) if error: # handle_error(error) tags: - 'admin' - 'category' - 'delete' - 'inbox' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [DELETE]' 'admin_delete_inbox_message@py.chat.fun': id: 'admin_delete_inbox_message@py.chat.fun' name: 'admin_delete_inbox_message' type: 'function' description: |- Delete inbox message arguments: 'force': type: 'Optional[bool]' required: false description: |- only for testing purposes, to force delete data 'message_id': type: 'str' required: true description: |- message 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/inbox/admin_delete_inbox_message.py' example: |- result, error = chat.admin_delete_inbox_message(...) if error: # handle_error(error) tags: - 'admin' - 'delete' - 'inbox' - 'message' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [DELETE]' 'admin_delete_topic@py.chat.fun': id: 'admin_delete_topic@py.chat.fun' name: 'admin_delete_topic' type: 'function' description: |- Delete topic in a namespace. arguments: 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID that receive the chat return_type: 'Tuple[Union[None, MessageActionDeleteTopicResult], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_delete_topic.py' example: |- result, error = chat.admin_delete_topic(...) if error: # handle_error(error) tags: - 'admin' - 'delete' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [DELETE]' 'admin_filter_chat_message@py.chat.fun': id: 'admin_filter_chat_message@py.chat.fun' name: 'admin_filter_chat_message' type: 'function' description: |- For testing purpose, doesn't send any message to the topic. Always do filter regardless of enableProfanityFilter configuration. arguments: 'body': type: 'ModelsMessageRequest' required: true 'detail': type: 'Optional[bool]' required: false description: |- To show what filter driver is used 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsMessageResultWithAttributes], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_filter_chat_message.py' example: |- result, error = chat.admin_filter_chat_message(...) if error: # handle_error(error) tags: - 'admin' - 'chat' - 'filter' - 'message' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]' 'admin_get_all_config_v1@py.chat.fun': id: 'admin_get_all_config_v1@py.chat.fun' name: 'admin_get_all_config_v1' type: 'function' description: |- Get chat config of all namespaces. return_type: 'Tuple[Union[None, ModelsConfigList], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/config/admin_get_all_config_v1.py' example: |- result, error = chat.admin_get_all_config_v1(...) if error: # handle_error(error) tags: - 'admin' - 'all' - 'config' - 'get' - 'v1' permissions: - 'ADMIN:NAMESPACE:*:CHAT:CONFIG [READ]' 'admin_get_category_schema@py.chat.fun': id: 'admin_get_category_schema@py.chat.fun' name: 'admin_get_category_schema' type: 'function' description: |- Get category schema. arguments: 'category': type: 'str' required: true description: |- category 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsJSONSchemaType], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/inbox/admin_get_category_schema.py' example: |- result, error = chat.admin_get_category_schema(...) if error: # handle_error(error) tags: - 'admin' - 'category' - 'get' - 'inbox' - 'schema' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [READ]' 'admin_get_chat_snapshot@py.chat.fun': id: 'admin_get_chat_snapshot@py.chat.fun' name: 'admin_get_chat_snapshot' type: 'function' description: |- Get the chat snapshot arguments: 'chat_id': type: 'str' required: true description: |- id of the chat 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsChatSnapshots], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/moderation/admin_get_chat_snapshot.py' example: |- result, error = chat.admin_get_chat_snapshot(...) if error: # handle_error(error) tags: - 'admin' - 'chat' - 'get' - 'moderation' - 'snapshot' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]' 'admin_get_config_v1@py.chat.fun': id: 'admin_get_config_v1@py.chat.fun' name: 'admin_get_config_v1' type: 'function' description: |- Get chat config of a namespace. arguments: 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsConfigResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/config/admin_get_config_v1.py' example: |- result, error = chat.admin_get_config_v1(...) if error: # handle_error(error) tags: - 'admin' - 'config' - 'get' - 'v1' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:CONFIG [READ]' 'admin_get_inbox_categories@py.chat.fun': id: 'admin_get_inbox_categories@py.chat.fun' name: 'admin_get_inbox_categories' type: 'function' description: |- Get inbox categories arguments: 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, List[ModelsGetInboxCategoriesResponseItem]], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/inbox/admin_get_inbox_categories.py' example: |- result, error = chat.admin_get_inbox_categories(...) if error: # handle_error(error) tags: - 'admin' - 'categories' - 'get' - 'inbox' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [READ]' 'admin_get_inbox_messages@py.chat.fun': id: 'admin_get_inbox_messages@py.chat.fun' name: 'admin_get_inbox_messages' type: 'function' description: |- Get inbox messages arguments: 'active_only': type: 'Optional[bool]' required: false description: |- active only 'end_created_at': type: 'Optional[int]' required: false description: |- end created at 'limit': type: 'Optional[int]' required: false description: |- limit 'message_id': type: 'Optional[List[str]]' required: false description: |- message ids 'namespace': type: 'str' required: true description: |- namespace 'offset': type: 'Optional[int]' required: false description: |- offset 'order': type: 'Optional[str]' required: false description: |- anyof: createdAt:asc / createdAt:desc 'scope': type: 'Optional[Union[str, AdminGetInboxMessagesScopeEnum]]' required: false description: |- message scope 'start_created_at': type: 'Optional[int]' required: false description: |- start created at 'status': type: 'Optional[Union[str, AdminGetInboxMessagesStatusEnum]]' required: false description: |- message status 'transient': type: 'Optional[bool]' required: false description: |- transient message filter return_type: 'Tuple[Union[None, ModelsGetInboxMessagesResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/inbox/admin_get_inbox_messages.py' example: |- result, error = chat.admin_get_inbox_messages(...) if error: # handle_error(error) tags: - 'admin' - 'get' - 'inbox' - 'messages' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [READ]' 'admin_get_inbox_stats@py.chat.fun': id: 'admin_get_inbox_stats@py.chat.fun' name: 'admin_get_inbox_stats' type: 'function' description: |- Get inbox stats arguments: 'message_id': type: 'Optional[List[str]]' required: false description: |- message ids 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsGetInboxStatsResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/inbox/admin_get_inbox_stats.py' example: |- result, error = chat.admin_get_inbox_stats(...) if error: # handle_error(error) tags: - 'admin' - 'get' - 'inbox' - 'stats' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [READ]' 'admin_get_inbox_users@py.chat.fun': id: 'admin_get_inbox_users@py.chat.fun' name: 'admin_get_inbox_users' type: 'function' description: |- Get inbox users arguments: 'inbox': type: 'str' required: true description: |- message id 'limit': type: 'Optional[int]' required: false description: |- limit 'namespace': type: 'str' required: true description: |- namespace 'offset': type: 'Optional[int]' required: false description: |- offset 'status': type: 'Optional[Union[str, AdminGetInboxUsersStatusEnum]]' required: false description: |- message status 'user_id': type: 'Optional[str]' required: false description: |- userId return_type: 'Tuple[Union[None, ModelsGetInboxUsersResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/inbox/admin_get_inbox_users.py' example: |- result, error = chat.admin_get_inbox_users(...) if error: # handle_error(error) tags: - 'admin' - 'get' - 'inbox' - 'users' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [READ]' 'admin_get_log_config@py.chat.fun': id: 'admin_get_log_config@py.chat.fun' name: 'admin_get_log_config' type: 'function' description: |- Get Log Configuration logLevel use for logging in service, the value can use is trace|debug|info|warning|error|fatal|panic socketLogEnabled is use for enable socket log internalAccessLogEnabled is for enabling access log for internal endpoint logLevelDB use for logging in DB, the value can use is trace|debug|info|warning|error|fatal|panic slowQueryThreshold use for logging slow threshold in time measure is nano second return_type: 'Tuple[Union[None, LogconfigConfiguration], Union[None, HttpResponse]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/config/admin_get_log_config.py' example: |- result, error = chat.admin_get_log_config(...) if error: # handle_error(error) tags: - 'admin' - 'config' - 'get' - 'log' permissions: - 'ADMIN:CONFIG:LOG [READ]' 'admin_list_kafka_topic@py.chat.fun': id: 'admin_list_kafka_topic@py.chat.fun' name: 'admin_list_kafka_topic' type: 'function' description: |- Get list kafka topic. example result chat,sessionNotification arguments: 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsGetListTopicKafkaResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/inbox/admin_list_kafka_topic.py' example: |- result, error = chat.admin_list_kafka_topic(...) if error: # handle_error(error) tags: - 'admin' - 'inbox' - 'kafka' - 'list' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [READ]' 'admin_patch_update_log_config@py.chat.fun': id: 'admin_patch_update_log_config@py.chat.fun' name: 'admin_patch_update_log_config' type: 'function' description: |- Update Log Configuration logLevel use for logging in service, the value can use is trace|debug|info|warning|error|fatal|panic socketLogEnabled is use for enable socket log internalAccessLogEnabled is for enabling access log for internal endpoint logLevelDB use for logging in DB, the value can use is trace|debug|info|warning|error|fatal|panic slowQueryThreshold use for logging slow threshold in time measure is nano second arguments: 'body': type: 'LogconfigConfiguration' required: true return_type: 'Tuple[Union[None, LogconfigConfiguration], Union[None, HttpResponse]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/config/admin_patch_update_log_config.py' example: |- result, error = chat.admin_patch_update_log_config(...) if error: # handle_error(error) tags: - 'admin' - 'config' - 'log' - 'patch' - 'update' permissions: - 'ADMIN:CONFIG:LOG [UPDATE]' 'admin_profanity_create@py.chat.fun': id: 'admin_profanity_create@py.chat.fun' name: 'admin_profanity_create' type: 'function' description: |- Insert new word for profanity censor arguments: 'body': type: 'ModelsDictionaryInsertRequest' required: true 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsDictionary], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/profanity/admin_profanity_create.py' example: |- result, error = chat.admin_profanity_create(...) if error: # handle_error(error) tags: - 'admin' - 'create' - 'profanity' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [CREATE]' 'admin_profanity_create_bulk@py.chat.fun': id: 'admin_profanity_create_bulk@py.chat.fun' name: 'admin_profanity_create_bulk' type: 'function' description: |- Bulk insert new word for profanity censor arguments: 'body': type: 'ModelsDictionaryInsertBulkRequest' required: true 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[None, Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/profanity/admin_profanity_create_bulk.py' example: |- result, error = chat.admin_profanity_create_bulk(...) if error: # handle_error(error) tags: - 'admin' - 'bulk' - 'create' - 'profanity' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [CREATE]' 'admin_profanity_delete@py.chat.fun': id: 'admin_profanity_delete@py.chat.fun' name: 'admin_profanity_delete' type: 'function' description: |- Delete profanity words. arguments: 'id_': type: 'str' required: true description: |- id of the dictionary 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[None, Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/profanity/admin_profanity_delete.py' example: |- result, error = chat.admin_profanity_delete(...) if error: # handle_error(error) tags: - 'admin' - 'delete' - 'profanity' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [DELETE]' 'admin_profanity_export@py.chat.fun': id: 'admin_profanity_export@py.chat.fun' name: 'admin_profanity_export' type: 'function' description: |- Export profanity words arguments: 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsDictionaryExport], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/profanity/admin_profanity_export.py' example: |- result, error = chat.admin_profanity_export(...) if error: # handle_error(error) tags: - 'admin' - 'export' - 'profanity' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [READ]' 'admin_profanity_group@py.chat.fun': id: 'admin_profanity_group@py.chat.fun' name: 'admin_profanity_group' type: 'function' description: |- Get profanity words group. arguments: 'limit': type: 'Optional[int]' required: false description: |- default: 100 'namespace': type: 'str' required: true description: |- namespace 'offset': type: 'Optional[int]' required: false description: |- offset return_type: 'Tuple[Union[None, List[ModelsDictionaryGroup]], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/profanity/admin_profanity_group.py' example: |- result, error = chat.admin_profanity_group(...) if error: # handle_error(error) tags: - 'admin' - 'group' - 'profanity' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [READ]' 'admin_profanity_import@py.chat.fun': id: 'admin_profanity_import@py.chat.fun' name: 'admin_profanity_import' type: 'function' description: |- Import profanity words arguments: 'action': type: 'Optional[Union[str, AdminProfanityImportActionEnum]]' required: false description: |- The action when same words already exists</br> <b>REPLACE</b>: replace all same words with imported false positives and false negatives, existing non-imported words won't be removed</br> <b>FULLREPLACE</b>: replace all words with imported data and remove existing non-imported words, list words will be exactly same with imported data</br> <b>LEAVEOUT</b>: ignore imported same words, false positives and false negatives won't be replaced with imported data' 'file': type: 'Any' required: true description: |- file to be imported 'namespace': type: 'str' required: true description: |- namespace 'show_result': type: 'Optional[bool]' required: false description: |- When showResult=true, this endpoint with returns imported words result return_type: 'Tuple[Union[None, ModelsDictionaryImportResult], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/profanity/admin_profanity_import.py' example: |- result, error = chat.admin_profanity_import(...) if error: # handle_error(error) tags: - 'admin' - 'import' - 'profanity' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [CREATE]' 'admin_profanity_query@py.chat.fun': id: 'admin_profanity_query@py.chat.fun' name: 'admin_profanity_query' type: 'function' description: |- Query all profanity words. arguments: 'filter_mask': type: 'Optional[str]' required: false description: |- filter mask 'include_children': type: 'Optional[bool]' required: false description: |- include false positives and false negatives 'limit': type: 'Optional[int]' required: false description: |- limit 'namespace': type: 'str' required: true description: |- namespace 'offset': type: 'Optional[int]' required: false description: |- offset 'parent_id': type: 'Optional[str]' required: false description: |- parent ID of the word 'start_with': type: 'Optional[str]' required: false description: |- word start with 'word_type': type: 'Optional[str]' required: false description: |- type of the word: PROFANITY, FALSEPOSITIVE, FALSENEGATIVE return_type: 'Tuple[Union[None, ModelsDictionaryQueryResult], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/profanity/admin_profanity_query.py' example: |- result, error = chat.admin_profanity_query(...) if error: # handle_error(error) tags: - 'admin' - 'profanity' - 'query' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [READ]' 'admin_profanity_update@py.chat.fun': id: 'admin_profanity_update@py.chat.fun' name: 'admin_profanity_update' type: 'function' description: |- Update profanity word arguments: 'body': type: 'ModelsDictionaryUpdateRequest' required: true 'id_': type: 'str' required: true description: |- id of the dictionary 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsDictionary], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/profanity/admin_profanity_update.py' example: |- result, error = chat.admin_profanity_update(...) if error: # handle_error(error) tags: - 'admin' - 'profanity' - 'update' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:PROFANITY [UPDATE]' 'admin_query_topic@py.chat.fun': id: 'admin_query_topic@py.chat.fun' name: 'admin_query_topic' type: 'function' description: |- Get topics in a namespace. arguments: 'include_members': type: 'Optional[bool]' required: false description: |- include topic's members 'include_past_members': type: 'Optional[bool]' required: false description: |- include past members (user that had left topic) 'include_past_topics': type: 'Optional[bool]' required: false description: |- include topic that has been removed.<br/><b>NOTE:</b> only soft deleted topics are available 'limit': type: 'Optional[int]' required: false description: |- default: 100 'namespace': type: 'str' required: true description: |- namespace 'offset': type: 'Optional[int]' required: false description: |- offset 'topic': type: 'Optional[List[str]]' required: false description: |- topic 'topic_sub_type': type: 'Optional[Union[str, AdminQueryTopicTopicSubTypeEnum]]' required: false description: |- topicSubType 'topic_type': type: 'Optional[Union[str, AdminQueryTopicTopicTypeEnum]]' required: false description: |- topicType 'user_id': type: 'Optional[str]' required: false description: |- userId return_type: 'Tuple[Union[None, List[ModelsTopicInfo]], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_query_topic.py' example: |- result, error = chat.admin_query_topic(...) if error: # handle_error(error) tags: - 'admin' - 'query' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]' 'admin_query_topic_log@py.chat.fun': id: 'admin_query_topic_log@py.chat.fun' name: 'admin_query_topic_log' type: 'function' description: |- Get chat log of topic in a namespace. arguments: 'end_created_at': type: 'Optional[int]' required: false description: |- end date 'limit': type: 'Optional[int]' required: false description: |- limit 'namespace': type: 'str' required: true description: |- namespace 'offset': type: 'Optional[int]' required: false description: |- offset 'sender_user_id': type: 'Optional[str]' required: false description: |- senderUserId (actor, can be admin or the user itself) 'start_created_at': type: 'Optional[int]' required: false description: |- start date 'topic_id': type: 'Optional[str]' required: false description: |- topicId 'topic_ids': type: 'Optional[List[str]]' required: false description: |- topicIds 'user_id': type: 'Optional[str]' required: false description: |- userId return_type: 'Tuple[Union[None, ModelsTopicLogWithPaginationResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_query_topic_log.py' example: |- result, error = chat.admin_query_topic_log(...) if error: # handle_error(error) tags: - 'admin' - 'log' - 'query' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]' 'admin_query_users_topic@py.chat.fun': id: 'admin_query_users_topic@py.chat.fun' name: 'admin_query_users_topic' type: 'function' description: |- Get user's topics in a namespace. arguments: 'include_past_topics': type: 'Optional[bool]' required: false description: |- when true will include topics that user already left 'limit': type: 'Optional[int]' required: false description: |- default: 100 'namespace': type: 'str' required: true description: |- namespace 'offset': type: 'Optional[int]' required: false description: |- offset 'topic_sub_type': type: 'Optional[Union[str, AdminQueryUsersTopicTopicSubTypeEnum]]' required: false description: |- topicSubType 'topic_type': type: 'Optional[Union[str, AdminQueryUsersTopicTopicTypeEnum]]' required: false description: |- topicType 'user_id': type: 'str' required: true description: |- userId return_type: 'Tuple[Union[None, ModelsTopicLogWithPaginationResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_query_users_topic.py' example: |- result, error = chat.admin_query_users_topic(...) if error: # handle_error(error) tags: - 'admin' - 'query' - 'topic' - 'users' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]' 'admin_remove_topic_member@py.chat.fun': id: 'admin_remove_topic_member@py.chat.fun' name: 'admin_remove_topic_member' type: 'function' description: |- Remove member from topic in a namespace. arguments: 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID that will removed user from 'user_id': type: 'str' required: true description: |- user ID that will be removed from topic return_type: 'Tuple[Union[None, MessageActionAddUserToTopicResult], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_remove_topic_member.py' example: |- result, error = chat.admin_remove_topic_member(...) if error: # handle_error(error) tags: - 'admin' - 'member' - 'remove' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]' 'admin_save_inbox_message@py.chat.fun': id: 'admin_save_inbox_message@py.chat.fun' name: 'admin_save_inbox_message' type: 'function' description: |- Save inbox message arguments: 'body': type: 'ModelsSaveInboxMessageRequest' required: true 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsSaveInboxMessageResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/inbox/admin_save_inbox_message.py' example: |- result, error = chat.admin_save_inbox_message(...) if error: # handle_error(error) tags: - 'admin' - 'inbox' - 'message' - 'save' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [CREATE]' 'admin_send_chat@py.chat.fun': id: 'admin_send_chat@py.chat.fun' name: 'admin_send_chat' type: 'function' description: |- Send message to chat topic as system. arguments: 'body': type: 'ApiSendChatParams' required: true 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID that receive the chat return_type: 'Tuple[Union[None, List[ModelsChatMessageResponse]], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_send_chat.py' example: |- result, error = chat.admin_send_chat(...) if error: # handle_error(error) tags: - 'admin' - 'chat' - 'send' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]' 'admin_send_inbox_message@py.chat.fun': id: 'admin_send_inbox_message@py.chat.fun' name: 'admin_send_inbox_message' type: 'function' description: |- Send inbox message arguments: 'body': type: 'ModelsSendInboxMessageRequest' required: true 'message_id': type: 'str' required: true description: |- message 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsSendInboxMessageResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/inbox/admin_send_inbox_message.py' example: |- result, error = chat.admin_send_inbox_message(...) if error: # handle_error(error) tags: - 'admin' - 'inbox' - 'message' - 'send' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [UPDATE]' 'admin_topic_chat_history@py.chat.fun': id: 'admin_topic_chat_history@py.chat.fun' name: 'admin_topic_chat_history' type: 'function' description: |- Get chat history in a namespace. arguments: 'end_created_at': type: 'Optional[int]' required: false description: |- end date 'keyword': type: 'Optional[str]' required: false description: |- keyword containing in message 'limit': type: 'Optional[int]' required: false description: |- limit 'namespace': type: 'str' required: true description: |- namespace 'offset': type: 'Optional[int]' required: false description: |- offset 'order': type: 'Optional[str]' required: false description: |- anyof: createdAt:asc / createdAt:desc 'sender_user_id': type: 'Optional[str]' required: false description: |- sender user ID 'shard_id': type: 'Optional[str]' required: false description: |- shard id 'start_created_at': type: 'Optional[int]' required: false description: |- start date 'topic': type: 'str' required: true description: |- topic ID that receive the chat 'unfiltered': type: 'Optional[bool]' required: false description: |- unfiltered chat messages return_type: 'Tuple[Union[None, ModelsChatMessageWithPaginationResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_topic_chat_history.py' example: |- result, error = chat.admin_topic_chat_history(...) if error: # handle_error(error) tags: - 'admin' - 'chat' - 'history' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]' 'admin_topic_list@py.chat.fun': id: 'admin_topic_list@py.chat.fun' name: 'admin_topic_list' type: 'function' description: |- Get chat list of topic in a namespace. arguments: 'limit': type: 'Optional[int]' required: false description: |- limit 'namespace': type: 'str' required: true description: |- namespace 'offset': type: 'Optional[int]' required: false description: |- offset 'topic_type': type: 'Optional[str]' required: false description: |- PERSONAL or GROUP return_type: 'Tuple[Union[None, List[ModelsTopicResponse]], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_topic_list.py' example: |- result, error = chat.admin_topic_list(...) if error: # handle_error(error) tags: - 'admin' - 'list' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]' 'admin_topic_members@py.chat.fun': id: 'admin_topic_members@py.chat.fun' name: 'admin_topic_members' type: 'function' description: |- Get topic members. arguments: 'is_banned': type: 'Optional[bool]' required: false description: |- only show banned member 'is_moderator': type: 'Optional[bool]' required: false description: |- only show moderator member 'limit': type: 'Optional[int]' required: false description: |- limit 'namespace': type: 'str' required: true description: |- namespace 'offset': type: 'Optional[int]' required: false description: |- offset 'shard_id': type: 'Optional[str]' required: false description: |- shard ID 'topic': type: 'str' required: true description: |- topic ID return_type: 'Tuple[Union[None, ModelsTopicMemberWithPaginationResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_topic_members.py' example: |- result, error = chat.admin_topic_members(...) if error: # handle_error(error) tags: - 'admin' - 'members' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]' 'admin_topic_shards@py.chat.fun': id: 'admin_topic_shards@py.chat.fun' name: 'admin_topic_shards' type: 'function' description: |- Get shard list from topic. arguments: 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID return_type: 'Tuple[Union[None, List[str]], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_topic_shards.py' example: |- result, error = chat.admin_topic_shards(...) if error: # handle_error(error) tags: - 'admin' - 'shards' - 'topic' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [READ]' 'admin_unban_topic_members@py.chat.fun': id: 'admin_unban_topic_members@py.chat.fun' name: 'admin_unban_topic_members' type: 'function' description: |- Unban users in some topic. arguments: 'body': type: 'ModelsUnbanTopicMemberParam' required: true 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID that receive the chat return_type: 'Tuple[Union[None, ModelsUnbanTopicMemberResult], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_unban_topic_members.py' example: |- result, error = chat.admin_unban_topic_members(...) if error: # handle_error(error) tags: - 'admin' - 'members' - 'topic' - 'unban' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]' 'admin_unsend_inbox_message@py.chat.fun': id: 'admin_unsend_inbox_message@py.chat.fun' name: 'admin_unsend_inbox_message' type: 'function' description: |- Unsend inbox message arguments: 'body': type: 'ModelsUnsendInboxMessageRequest' required: true 'inbox': type: 'str' required: true description: |- message 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsUnsendInboxMessageResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/inbox/admin_unsend_inbox_message.py' example: |- result, error = chat.admin_unsend_inbox_message(...) if error: # handle_error(error) tags: - 'admin' - 'inbox' - 'message' - 'unsend' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [UPDATE]' 'admin_update_config_v1@py.chat.fun': id: 'admin_update_config_v1@py.chat.fun' name: 'admin_update_config_v1' type: 'function' description: |- Update chat config of a namespace. arguments: 'body': type: 'ModelsConfigResponse' required: true 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsConfigResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/config/admin_update_config_v1.py' example: |- result, error = chat.admin_update_config_v1(...) if error: # handle_error(error) tags: - 'admin' - 'config' - 'update' - 'v1' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:CONFIG [UPDATE]' 'admin_update_inbox_category@py.chat.fun': id: 'admin_update_inbox_category@py.chat.fun' name: 'admin_update_inbox_category' type: 'function' description: |- Update inbox category arguments: 'body': type: 'ModelsUpdateInboxCategoryRequest' required: true 'category': type: 'str' required: true description: |- category 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/inbox/admin_update_inbox_category.py' example: |- result, error = chat.admin_update_inbox_category(...) if error: # handle_error(error) tags: - 'admin' - 'category' - 'inbox' - 'update' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:CATEGORY [UPDATE]' 'admin_update_inbox_message@py.chat.fun': id: 'admin_update_inbox_message@py.chat.fun' name: 'admin_update_inbox_message' type: 'function' description: |- Update inbox message arguments: 'body': type: 'ModelsUpdateInboxMessageRequest' required: true 'message_id': type: 'str' required: true description: |- message 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/inbox/admin_update_inbox_message.py' example: |- result, error = chat.admin_update_inbox_message(...) if error: # handle_error(error) tags: - 'admin' - 'inbox' - 'message' - 'update' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:INBOX [UPDATE]' 'admin_update_topic@py.chat.fun': id: 'admin_update_topic@py.chat.fun' name: 'admin_update_topic' type: 'function' description: |- Update group topic in a namespace. arguments: 'body': type: 'ApiUpdateTopicParams' required: true 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID that receive the chat return_type: 'Tuple[Union[None, ApiCreateTopicResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/admin_update_topic.py' example: |- result, error = chat.admin_update_topic(...) if error: # handle_error(error) tags: - 'admin' - 'topic' - 'update' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:TOPIC [UPDATE]' 'export_config@py.chat.fun': id: 'export_config@py.chat.fun' name: 'export_config' type: 'function' description: |- Export chat configuration to a json file. The file can then be imported from the /import endpoint. arguments: 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, List[ModelsConfigExport]], Union[None, HttpResponse, ResponseError]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/config/export_config.py' example: |- result, error = chat.export_config(...) if error: # handle_error(error) tags: - 'config' - 'export' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:CONFIG [READ]' 'import_config@py.chat.fun': id: 'import_config@py.chat.fun' name: 'import_config' type: 'function' description: |- Import config configuration from file. The existing configuration will be replaced. The json file to import can be obtained from the /export endpoint. arguments: 'file': type: 'Optional[Any]' required: false description: |- file to be imported 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsImportConfigResponse], Union[None, HttpResponse, ResponseError]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/config/import_config.py' example: |- result, error = chat.import_config(...) if error: # handle_error(error) tags: - 'config' - 'import' permissions: - 'ADMIN:NAMESPACE:{namespace}:CHAT:CONFIG [UPDATE]' 'public_ban_topic_members@py.chat.fun': id: 'public_ban_topic_members@py.chat.fun' name: 'public_ban_topic_members' type: 'function' description: |- Ban topic members in a group topic. arguments: 'body': type: 'ModelsPublicBanTopicMembersRequest' required: true 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID return_type: 'Tuple[Union[None, ModelsPublicBanTopicMembersResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/public_ban_topic_members.py' example: |- result, error = chat.public_ban_topic_members(...) if error: # handle_error(error) tags: - 'ban' - 'members' - 'public' - 'topic' 'public_chat_history@py.chat.fun': id: 'public_chat_history@py.chat.fun' name: 'public_chat_history' type: 'function' description: |- get chat history in a namespace. arguments: 'limit': type: 'Optional[int]' required: false description: |- limit 'namespace': type: 'str' required: true description: |- namespace 'order': type: 'Optional[str]' required: false description: |- anyof: createdAt:asc / createdAt:desc 'start_created_at': type: 'Optional[int]' required: false description: |- lastChatCreatedAt 'topic': type: 'str' required: true description: |- topic ID that receive the chat return_type: 'Tuple[Union[None, List[ModelsChatMessageResponse]], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/public_chat_history.py' example: |- result, error = chat.public_chat_history(...) if error: # handle_error(error) tags: - 'chat' - 'history' - 'public' - 'topic' 'public_delete_chat@py.chat.fun': id: 'public_delete_chat@py.chat.fun' name: 'public_delete_chat' type: 'function' description: |- Delete chat. arguments: 'chat_id': type: 'str' required: true description: |- chat ID od the chat 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID of the chat return_type: 'Tuple[None, Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/public_delete_chat.py' example: |- result, error = chat.public_delete_chat(...) if error: # handle_error(error) tags: - 'chat' - 'delete' - 'public' - 'topic' 'public_get_chat_snapshot@py.chat.fun': id: 'public_get_chat_snapshot@py.chat.fun' name: 'public_get_chat_snapshot' type: 'function' description: |- Get the chat snapshot arguments: 'chat_id': type: 'str' required: true description: |- id of the chat 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic return_type: 'Tuple[Union[None, ModelsChatSnapshots], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/moderation/public_get_chat_snapshot.py' example: |- result, error = chat.public_get_chat_snapshot(...) if error: # handle_error(error) tags: - 'chat' - 'get' - 'moderation' - 'public' - 'snapshot' 'public_get_config_v1@py.chat.fun': id: 'public_get_config_v1@py.chat.fun' name: 'public_get_config_v1' type: 'function' description: |- Get chat config of a namespace. arguments: 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, ModelsPublicConfigResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/config/public_get_config_v1.py' example: |- result, error = chat.public_get_config_v1(...) if error: # handle_error(error) tags: - 'config' - 'get' - 'public' - 'v1' 'public_get_messages@py.chat.fun': id: 'public_get_messages@py.chat.fun' name: 'public_get_messages' type: 'function' description: |- get the list of messages. return_type: 'Tuple[Union[None, List[LogAppMessageDeclaration]], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/operations/public_get_messages.py' example: |- result, error = chat.public_get_messages(...) if error: # handle_error(error) tags: - 'get' - 'messages' - 'public' 'public_get_muted_topics@py.chat.fun': id: 'public_get_muted_topics@py.chat.fun' name: 'public_get_muted_topics' type: 'function' description: |- get chat muted topics in a namespace. arguments: 'namespace': type: 'str' required: true description: |- namespace return_type: 'Tuple[Union[None, List[ApiMutedTopicResponse]], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/public_get_muted_topics.py' example: |- result, error = chat.public_get_muted_topics(...) if error: # handle_error(error) tags: - 'get' - 'muted' - 'public' - 'topic' - 'topics' 'public_mute_user@py.chat.fun': id: 'public_mute_user@py.chat.fun' name: 'public_mute_user' type: 'function' description: |- Mute user. arguments: 'body': type: 'ApiMuteUserRequest' required: true 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID return_type: 'Tuple[None, Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/public_mute_user.py' example: |- result, error = chat.public_mute_user(...) if error: # handle_error(error) tags: - 'mute' - 'public' - 'topic' - 'user' 'public_topic_list@py.chat.fun': id: 'public_topic_list@py.chat.fun' name: 'public_topic_list' type: 'function' description: |- get chat list of topic in a namespace. arguments: 'limit': type: 'Optional[int]' required: false description: |- limit 'namespace': type: 'str' required: true description: |- namespace 'offset': type: 'Optional[int]' required: false description: |- offset 'topic_type': type: 'Optional[str]' required: false description: |- PERSONAL or GROUP return_type: 'Tuple[Union[None, List[ModelsChatMessageResponse]], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/public_topic_list.py' example: |- result, error = chat.public_topic_list(...) if error: # handle_error(error) tags: - 'list' - 'public' - 'topic' 'public_unban_topic_members@py.chat.fun': id: 'public_unban_topic_members@py.chat.fun' name: 'public_unban_topic_members' type: 'function' description: |- Unban topic members in a group topic. arguments: 'body': type: 'ModelsPublicUnbanTopicMembersRequest' required: true 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID return_type: 'Tuple[Union[None, ModelsPublicUnbanTopicMembersResponse], Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/public_unban_topic_members.py' example: |- result, error = chat.public_unban_topic_members(...) if error: # handle_error(error) tags: - 'members' - 'public' - 'topic' - 'unban' 'public_unmute_user@py.chat.fun': id: 'public_unmute_user@py.chat.fun' name: 'public_unmute_user' type: 'function' description: |- Unmute user. arguments: 'body': type: 'ApiUnmuteUserRequest' required: true 'namespace': type: 'str' required: true description: |- namespace 'topic': type: 'str' required: true description: |- topic ID return_type: 'Tuple[None, Union[None, HttpResponse, RestapiErrorResponseBody]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.chat as chat' - 'import accelbyte_py_sdk.api.chat.models as chat_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/chat/operations/topic/public_unmute_user.py' example: |- result, error = chat.public_unmute_user(...) if error: # handle_error(error) tags: - 'public' - 'topic' - 'unmute' - 'user' # endregion functions