symbols:
# region models
'ModelsAchievementOrderUpdateRequest@py.achievement.mod':
id: 'ModelsAchievementOrderUpdateRequest@py.achievement.mod'
name: 'ModelsAchievementOrderUpdateRequest'
type: 'model'
fields:
'target_order':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_achievement_order_update_request.py'
example: |-
models_achievement_order_update_request = achievement_models.ModelsAchievementOrderUpdateRequest.create(...)
'ModelsAchievementRequest@py.achievement.mod':
id: 'ModelsAchievementRequest@py.achievement.mod'
name: 'ModelsAchievementRequest'
type: 'model'
fields:
'achievement_code':
type: 'str'
required: true
'default_language':
type: 'str'
required: true
'description':
type: 'Dict[str, str]'
required: true
'goal_value':
type: 'float'
required: true
'hidden':
type: 'bool'
required: true
'incremental':
type: 'bool'
required: true
'locked_icons':
type: 'List[ModelsIcon]'
required: true
'name':
type: 'Dict[str, str]'
required: true
'stat_code':
type: 'str'
required: true
'tags':
type: 'List[str]'
required: true
'unlocked_icons':
type: 'List[ModelsIcon]'
required: true
'custom_attributes':
type: 'Dict[str, Any]'
required: false
'global_':
type: 'bool'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_achievement_request.py'
example: |-
models_achievement_request = achievement_models.ModelsAchievementRequest.create(...)
'ModelsAchievementResponse@py.achievement.mod':
id: 'ModelsAchievementResponse@py.achievement.mod'
name: 'ModelsAchievementResponse'
type: 'model'
fields:
'achievement_code':
type: 'str'
required: true
'created_at':
type: 'str'
required: true
'default_language':
type: 'str'
required: true
'description':
type: 'Dict[str, str]'
required: true
'global_':
type: 'bool'
required: true
'hidden':
type: 'bool'
required: true
'incremental':
type: 'bool'
required: true
'list_order':
type: 'int'
required: true
'locked_icons':
type: 'List[ModelsIcon]'
required: true
'name':
type: 'Dict[str, str]'
required: true
'namespace':
type: 'str'
required: true
'tags':
type: 'List[str]'
required: true
'unlocked_icons':
type: 'List[ModelsIcon]'
required: true
'updated_at':
type: 'str'
required: true
'custom_attributes':
type: 'Dict[str, Any]'
required: false
'goal_value':
type: 'float'
required: false
'stat_code':
type: 'str'
required: false
'status':
type: 'str'
required: false
description: |-
Achievement progression status: [INIT, TIED]
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_achievement_response.py'
example: |-
models_achievement_response = achievement_models.ModelsAchievementResponse.create(...)
'ModelsAchievementUpdateRequest@py.achievement.mod':
id: 'ModelsAchievementUpdateRequest@py.achievement.mod'
name: 'ModelsAchievementUpdateRequest'
type: 'model'
fields:
'default_language':
type: 'str'
required: true
'description':
type: 'Dict[str, str]'
required: true
'goal_value':
type: 'float'
required: true
'hidden':
type: 'bool'
required: true
'incremental':
type: 'bool'
required: true
'locked_icons':
type: 'List[ModelsIcon]'
required: true
'name':
type: 'Dict[str, str]'
required: true
'stat_code':
type: 'str'
required: true
'tags':
type: 'List[str]'
required: true
'unlocked_icons':
type: 'List[ModelsIcon]'
required: true
'custom_attributes':
type: 'Dict[str, Any]'
required: false
'global_':
type: 'bool'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_achievement_update_request.py'
example: |-
models_achievement_update_request = achievement_models.ModelsAchievementUpdateRequest.create(...)
'ModelsAdditionalInfo@py.achievement.mod':
id: 'ModelsAdditionalInfo@py.achievement.mod'
name: 'ModelsAdditionalInfo'
type: 'model'
fields:
'number_of_achievements':
type: 'int'
required: true
'number_of_hidden_achievements':
type: 'int'
required: true
'number_of_visible_achievements':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_additional_info.py'
example: |-
models_additional_info = achievement_models.ModelsAdditionalInfo.create(...)
'ModelsBulkCreatePSNEventResponse@py.achievement.mod':
id: 'ModelsBulkCreatePSNEventResponse@py.achievement.mod'
name: 'ModelsBulkCreatePSNEventResponse'
type: 'model'
fields:
'data':
type: 'List[ModelsPSNEventResult]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_bulk_create_psn_event_response.py'
example: |-
models_bulk_create_psn_event_response = achievement_models.ModelsBulkCreatePSNEventResponse.create(...)
'ModelsBulkCreatePSNEvents@py.achievement.mod':
id: 'ModelsBulkCreatePSNEvents@py.achievement.mod'
name: 'ModelsBulkCreatePSNEvents'
type: 'model'
fields:
'data':
type: 'List[ModelsCreatePSNEvent]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_bulk_create_psn_events.py'
example: |-
models_bulk_create_psn_events = achievement_models.ModelsBulkCreatePSNEvents.create(...)
'ModelsBulkUnlockAchievementRequest@py.achievement.mod':
id: 'ModelsBulkUnlockAchievementRequest@py.achievement.mod'
name: 'ModelsBulkUnlockAchievementRequest'
type: 'model'
fields:
'achievement_codes':
type: 'List[str]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_bulk_unlock_achievement_request.py'
example: |-
models_bulk_unlock_achievement_request = achievement_models.ModelsBulkUnlockAchievementRequest.create(...)
'ModelsBulkUnlockAchievementResponse@py.achievement.mod':
id: 'ModelsBulkUnlockAchievementResponse@py.achievement.mod'
name: 'ModelsBulkUnlockAchievementResponse'
type: 'model'
fields:
'achievement_code':
type: 'str'
required: true
'success':
type: 'bool'
required: true
'error_detail':
type: 'ModelsErrorDetails'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_bulk_unlock_achievement_response.py'
example: |-
models_bulk_unlock_achievement_response = achievement_models.ModelsBulkUnlockAchievementResponse.create(...)
'ModelsContributorResponse@py.achievement.mod':
id: 'ModelsContributorResponse@py.achievement.mod'
name: 'ModelsContributorResponse'
type: 'model'
fields:
'achievement_code':
type: 'str'
required: true
'contributed_value':
type: 'float'
required: true
'created_at':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
'updated_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_contributor_response.py'
example: |-
models_contributor_response = achievement_models.ModelsContributorResponse.create(...)
'ModelsCreatePSNEvent@py.achievement.mod':
id: 'ModelsCreatePSNEvent@py.achievement.mod'
name: 'ModelsCreatePSNEvent'
type: 'model'
fields:
'events':
type: 'List[ModelsPSNEvent]'
required: true
'third_party_user_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.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_create_psn_event.py'
example: |-
models_create_psn_event = achievement_models.ModelsCreatePSNEvent.create(...)
'ModelsErrorDetails@py.achievement.mod':
id: 'ModelsErrorDetails@py.achievement.mod'
name: 'ModelsErrorDetails'
type: 'model'
fields:
'error_code':
type: 'int'
required: true
'error_message':
type: 'str'
required: true
'third_party_reference_id':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_error_details.py'
example: |-
models_error_details = achievement_models.ModelsErrorDetails.create(...)
'ModelsGlobalAchievementResponse@py.achievement.mod':
id: 'ModelsGlobalAchievementResponse@py.achievement.mod'
name: 'ModelsGlobalAchievementResponse'
type: 'model'
fields:
'achievement_code':
type: 'str'
required: true
'created_at':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'latest_value':
type: 'float'
required: true
'name':
type: 'Dict[str, str]'
required: true
'namespace':
type: 'str'
required: true
'status':
type: 'int'
required: true
'achieved_at':
type: 'str'
required: false
'updated_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_global_achievement_response.py'
example: |-
models_global_achievement_response = achievement_models.ModelsGlobalAchievementResponse.create(...)
'ModelsIcon@py.achievement.mod':
id: 'ModelsIcon@py.achievement.mod'
name: 'ModelsIcon'
type: 'model'
fields:
'slug':
type: 'str'
required: true
'url':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_icon.py'
example: |-
models_icon = achievement_models.ModelsIcon.create(...)
'ModelsPaginatedAchievementResponse@py.achievement.mod':
id: 'ModelsPaginatedAchievementResponse@py.achievement.mod'
name: 'ModelsPaginatedAchievementResponse'
type: 'model'
fields:
'data':
type: 'List[ModelsAchievementResponse]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_paginated_achievement_response.py'
example: |-
models_paginated_achievement_response = achievement_models.ModelsPaginatedAchievementResponse.create(...)
'ModelsPaginatedContributorResponse@py.achievement.mod':
id: 'ModelsPaginatedContributorResponse@py.achievement.mod'
name: 'ModelsPaginatedContributorResponse'
type: 'model'
fields:
'data':
type: 'List[ModelsContributorResponse]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_paginated_contributor_response.py'
example: |-
models_paginated_contributor_response = achievement_models.ModelsPaginatedContributorResponse.create(...)
'ModelsPaginatedGlobalAchievementResponse@py.achievement.mod':
id: 'ModelsPaginatedGlobalAchievementResponse@py.achievement.mod'
name: 'ModelsPaginatedGlobalAchievementResponse'
type: 'model'
fields:
'data':
type: 'List[ModelsGlobalAchievementResponse]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_paginated_global_achievement_response.py'
example: |-
models_paginated_global_achievement_response = achievement_models.ModelsPaginatedGlobalAchievementResponse.create(...)
'ModelsPaginatedTagResponse@py.achievement.mod':
id: 'ModelsPaginatedTagResponse@py.achievement.mod'
name: 'ModelsPaginatedTagResponse'
type: 'model'
fields:
'data':
type: 'List[ModelsTagResponse]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_paginated_tag_response.py'
example: |-
models_paginated_tag_response = achievement_models.ModelsPaginatedTagResponse.create(...)
'ModelsPaginatedUserAchievementResponse@py.achievement.mod':
id: 'ModelsPaginatedUserAchievementResponse@py.achievement.mod'
name: 'ModelsPaginatedUserAchievementResponse'
type: 'model'
fields:
'count_info':
type: 'ModelsAdditionalInfo'
required: true
'data':
type: 'List[ModelsUserAchievementResponse]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_paginated_user_achievement_response.py'
example: |-
models_paginated_user_achievement_response = achievement_models.ModelsPaginatedUserAchievementResponse.create(...)
'ModelsPaginatedUserContributionResponse@py.achievement.mod':
id: 'ModelsPaginatedUserContributionResponse@py.achievement.mod'
name: 'ModelsPaginatedUserContributionResponse'
type: 'model'
fields:
'data':
type: 'List[ModelsUserContributionResponse]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_paginated_user_contribution_response.py'
example: |-
models_paginated_user_contribution_response = achievement_models.ModelsPaginatedUserContributionResponse.create(...)
'ModelsPagination@py.achievement.mod':
id: 'ModelsPagination@py.achievement.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.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_pagination.py'
example: |-
models_pagination = achievement_models.ModelsPagination.create(...)
'ModelsPSNEvent@py.achievement.mod':
id: 'ModelsPSNEvent@py.achievement.mod'
name: 'ModelsPSNEvent'
type: 'model'
fields:
'date_time':
type: 'str'
required: true
'event_data':
type: 'ModelsPSNEventData'
required: true
'event_id':
type: 'str'
required: true
'version':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_psn_event.py'
example: |-
models_psn_event = achievement_models.ModelsPSNEvent.create(...)
'ModelsPSNEventData@py.achievement.mod':
id: 'ModelsPSNEventData@py.achievement.mod'
name: 'ModelsPSNEventData'
type: 'model'
fields:
'event_name':
type: 'str'
required: true
'properties':
type: 'Dict[str, Any]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_psn_event_data.py'
example: |-
models_psn_event_data = achievement_models.ModelsPSNEventData.create(...)
'ModelsPSNEventResult@py.achievement.mod':
id: 'ModelsPSNEventResult@py.achievement.mod'
name: 'ModelsPSNEventResult'
type: 'model'
fields:
'is_success':
type: 'bool'
required: true
'third_party_user_id':
type: 'str'
required: true
'error_detail':
type: 'ModelsErrorDetails'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_psn_event_result.py'
example: |-
models_psn_event_result = achievement_models.ModelsPSNEventResult.create(...)
'ModelsPublicAchievementResponse@py.achievement.mod':
id: 'ModelsPublicAchievementResponse@py.achievement.mod'
name: 'ModelsPublicAchievementResponse'
type: 'model'
fields:
'achievement_code':
type: 'str'
required: true
'created_at':
type: 'str'
required: true
'description':
type: 'str'
required: true
'global_':
type: 'bool'
required: true
'hidden':
type: 'bool'
required: true
'incremental':
type: 'bool'
required: true
'list_order':
type: 'int'
required: true
'locked_icons':
type: 'List[ModelsIcon]'
required: true
'name':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'tags':
type: 'List[str]'
required: true
'unlocked_icons':
type: 'List[ModelsIcon]'
required: true
'updated_at':
type: 'str'
required: true
'custom_attributes':
type: 'Dict[str, Any]'
required: false
'goal_value':
type: 'float'
required: false
'stat_code':
type: 'str'
required: false
'status':
type: 'str'
required: false
description: |-
Achievement progression status: [INIT, TIED]
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_public_achievement_response.py'
example: |-
models_public_achievement_response = achievement_models.ModelsPublicAchievementResponse.create(...)
'ModelsPublicAchievementsResponse@py.achievement.mod':
id: 'ModelsPublicAchievementsResponse@py.achievement.mod'
name: 'ModelsPublicAchievementsResponse'
type: 'model'
fields:
'data':
type: 'List[ModelsPublicAchievementResponse]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_public_achievements_response.py'
example: |-
models_public_achievements_response = achievement_models.ModelsPublicAchievementsResponse.create(...)
'ModelsTagResponse@py.achievement.mod':
id: 'ModelsTagResponse@py.achievement.mod'
name: 'ModelsTagResponse'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'name':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_tag_response.py'
example: |-
models_tag_response = achievement_models.ModelsTagResponse.create(...)
'ModelsUserAchievementResponse@py.achievement.mod':
id: 'ModelsUserAchievementResponse@py.achievement.mod'
name: 'ModelsUserAchievementResponse'
type: 'model'
fields:
'achieved_at':
type: 'str'
required: true
'achievement_code':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'latest_value':
type: 'float'
required: true
'name':
type: 'Dict[str, str]'
required: true
'status':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_user_achievement_response.py'
example: |-
models_user_achievement_response = achievement_models.ModelsUserAchievementResponse.create(...)
'ModelsUserContributionResponse@py.achievement.mod':
id: 'ModelsUserContributionResponse@py.achievement.mod'
name: 'ModelsUserContributionResponse'
type: 'model'
fields:
'achievement_code':
type: 'str'
required: true
'can_claim_reward':
type: 'bool'
required: true
description: |-
CanClaimReward is a flag whether the user can claim the reward of not
'contributed_value':
type: 'float'
required: true
'id_':
type: 'str'
required: true
'name':
type: 'Dict[str, str]'
required: true
description: |-
Name is achievement name
'namespace':
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.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/models_user_contribution_response.py'
example: |-
models_user_contribution_response = achievement_models.ModelsUserContributionResponse.create(...)
'ResponseError@py.achievement.mod':
id: 'ResponseError@py.achievement.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.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/response_error.py'
example: |-
response_error = achievement_models.ResponseError.create(...)
'ServiceImportConfigResponse@py.achievement.mod':
id: 'ServiceImportConfigResponse@py.achievement.mod'
name: 'ServiceImportConfigResponse'
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.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/models/service_import_config_response.py'
example: |-
service_import_config_response = achievement_models.ServiceImportConfigResponse.create(...)
# endregion models
# region functions
'admin_anonymize_user_achievement@py.achievement.fun':
id: 'admin_anonymize_user_achievement@py.achievement.fun'
name: 'admin_anonymize_user_achievement'
type: 'function'
description: |-
This API will delete specified user achievement
Required permission
`ADMIN:NAMESPACE:{namespace}:USER:{userId}:ANONYMIZATION [DELETE]`
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
user id
return_type: 'Tuple[None, 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/anonymization/admin_anonymize_user_ac_c61ab2.py'
example: |-
result, error = achievement.admin_anonymize_user_achievement(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'admin'
- 'anonymization'
- 'anonymize'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ANONYMIZATION [DELETE]'
'admin_bulk_unlock_achievement@py.achievement.fun':
id: 'admin_bulk_unlock_achievement@py.achievement.fun'
name: 'admin_bulk_unlock_achievement'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social`
arguments:
'body':
type: 'ModelsBulkUnlockAchievementRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
user id
return_type: 'Tuple[Union[None, List[ModelsBulkUnlockAchievementResponse]], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/user_achievements/admin_bulk_unlock_achievement.py'
example: |-
result, error = achievement.admin_bulk_unlock_achievement(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'bulk'
- 'unlock'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'admin_create_new_achievement@py.achievement.fun':
id: 'admin_create_new_achievement@py.achievement.fun'
name: 'admin_create_new_achievement'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [CREATE]` and scope `social`
Other detail info:
- achievementCode: Human readable unique code to indentify the achievement. Must be lowercase
and maximum length is 32
- incremental: If the achievement is not incremental, it does not need to store a goal value
of a stat to be unlocked.
If the achievement is incremental, it needs to set statCode and goalValue
- statCode: Selected statistic code, from the published statistic code event.Human readable unique
code to indentify the achievement. Must be lowercase and maximum length is 32
- goalValue: Statistics value required to unlock the achievement.
- defaultLanguage: localozation for achievement name and achievement description. Allowed format : en, en-US
- slug: specify the image they want to use, it can be file image name or something
to define the achievement icon.
arguments:
'body':
type: 'ModelsAchievementRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsAchievementResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/achievements/admin_create_new_achievement.py'
example: |-
result, error = achievement.admin_create_new_achievement(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'create'
- 'new'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [CREATE]'
scopes:
- 'social'
'admin_delete_achievement@py.achievement.fun':
id: 'admin_delete_achievement@py.achievement.fun'
name: 'admin_delete_achievement'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [DELETE]` and scope `social`
arguments:
'achievement_code':
type: 'str'
required: true
description: |-
achievement code
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[None, 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/achievements/admin_delete_achievement.py'
example: |-
result, error = achievement.admin_delete_achievement(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'delete'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [DELETE]'
scopes:
- 'social'
'admin_get_achievement@py.achievement.fun':
id: 'admin_get_achievement@py.achievement.fun'
name: 'admin_get_achievement'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'achievement_code':
type: 'str'
required: true
description: |-
achievement code
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsAchievementResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/achievements/admin_get_achievement.py'
example: |-
result, error = achievement.admin_get_achievement(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'get'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'admin_list_achievements@py.achievement.fun':
id: 'admin_list_achievements@py.achievement.fun'
name: 'admin_list_achievements'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'global_':
type: 'Optional[bool]'
required: false
description: |-
filter by global achievement flag
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'sort_by':
type: 'Optional[Union[str, AdminListAchievementsSortByEnum]]'
required: false
description: |-
sort by, default is 'listOrder:asc', allow values: [listOrder, listOrder:asc, listOrder:desc, createdAt, createdAt:asc, createdAt:desc, updatedAt, updatedAt:asc, updatedAt:desc]
'tags':
type: 'Optional[List[str]]'
required: false
description: |-
tags
return_type: 'Tuple[Union[None, ModelsPaginatedAchievementResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/achievements/admin_list_achievements.py'
example: |-
result, error = achievement.admin_list_achievements(...)
if error:
# handle_error(error)
tags:
- 'achievements'
- 'admin'
- 'list'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'admin_list_global_achievement_contributors@py.achievement.fun':
id: 'admin_list_global_achievement_contributors@py.achievement.fun'
name: 'admin_list_global_achievement_contributors'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'achievement_code':
type: 'str'
required: true
description: |-
achievement code
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'sort_by':
type: 'Optional[Union[str, AdminListGlobalAchievementContributorsSortByEnum]]'
required: false
description: |-
sort by, default is 'contributedValue:desc', allow values: [contributedValue, contributedValue:asc, contributedValue:desc]
return_type: 'Tuple[Union[None, ModelsPaginatedContributorResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/global_achievements/admin_list_global_achie_0b49fb.py'
example: |-
result, error = achievement.admin_list_global_achievement_contributors(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'contributors'
- 'global'
- 'list'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'admin_list_global_achievements@py.achievement.fun':
id: 'admin_list_global_achievements@py.achievement.fun'
name: 'admin_list_global_achievements'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
Note:
Global achievement status value mean: `status = 1 (in progress)` and `status = 2 (unlocked)`
arguments:
'achievement_codes':
type: 'Optional[str]'
required: false
description: |-
filter by achievement codes. multiple value separated by comma
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'sort_by':
type: 'Optional[Union[str, AdminListGlobalAchievementsSortByEnum]]'
required: false
description: |-
sort by, allow values: [achievedAt, achievedAt:asc, achievedAt:desc, createdAt, createdAt:asc, createdAt:desc]
'status':
type: 'Optional[str]'
required: false
description: |-
filter by status. available value: [in_progress, unlocked]
'tags':
type: 'Optional[List[str]]'
required: false
description: |-
tags
return_type: 'Tuple[Union[None, ModelsPaginatedGlobalAchievementResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/global_achievements/admin_list_global_achievements.py'
example: |-
result, error = achievement.admin_list_global_achievements(...)
if error:
# handle_error(error)
tags:
- 'achievements'
- 'admin'
- 'global'
- 'list'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'admin_list_tags@py.achievement.fun':
id: 'admin_list_tags@py.achievement.fun'
name: 'admin_list_tags'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'name':
type: 'Optional[str]'
required: false
description: |-
like's query by tag name
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'sort_by':
type: 'Optional[Union[str, AdminListTagsSortByEnum]]'
required: false
description: |-
sort by, default is 'name:asc', allow values: [name, name:asc, name:desc, createdAt, createdAt:asc, createdAt:desc]
return_type: 'Tuple[Union[None, ModelsPaginatedTagResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/tags/admin_list_tags.py'
example: |-
result, error = achievement.admin_list_tags(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'list'
- 'tags'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'admin_list_user_achievements@py.achievement.fun':
id: 'admin_list_user_achievements@py.achievement.fun'
name: 'admin_list_user_achievements'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]` and scope `social`
Note:
User Achievement status value mean: `status = 1 (in progress)` and `status = 2 (unlocked)`
`achievedAt` value will return default value: `0001-01-01T00:00:00Z` for user achievement that locked or in progress
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'prefer_unlocked':
type: 'Optional[bool]'
required: false
description: |-
prefer to query achieved
'sort_by':
type: 'Optional[Union[str, AdminListUserAchievementsSortByEnum]]'
required: false
description: |-
sort by, allow values: [achievedAt, achievedAt:asc, achievedAt:desc, createdAt, createdAt:asc, createdAt:desc]
'tags':
type: 'Optional[List[str]]'
required: false
description: |-
tags
'user_id':
type: 'str'
required: true
description: |-
user id
return_type: 'Tuple[Union[None, ModelsPaginatedUserAchievementResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/user_achievements/admin_list_user_achievements.py'
example: |-
result, error = achievement.admin_list_user_achievements(...)
if error:
# handle_error(error)
tags:
- 'achievements'
- 'admin'
- 'list'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'admin_list_user_contributions@py.achievement.fun':
id: 'admin_list_user_contributions@py.achievement.fun'
name: 'admin_list_user_contributions'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'achievement_codes':
type: 'Optional[str]'
required: false
description: |-
achievement codes. multiple value separated by comma
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'sort_by':
type: 'Optional[Union[str, AdminListUserContributionsSortByEnum]]'
required: false
description: |-
sort by, default is 'contributedValue:desc', allow values: [contributedValue, contributedValue:asc, contributedValue:desc]
'tags':
type: 'Optional[List[str]]'
required: false
description: |-
tags
'user_id':
type: 'str'
required: true
description: |-
user ID
return_type: 'Tuple[Union[None, ModelsPaginatedUserContributionResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/global_achievements/admin_list_user_contributions.py'
example: |-
result, error = achievement.admin_list_user_contributions(...)
if error:
# handle_error(error)
tags:
- 'achievements'
- 'admin'
- 'contributions'
- 'global'
- 'list'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'admin_reset_achievement@py.achievement.fun':
id: 'admin_reset_achievement@py.achievement.fun'
name: 'admin_reset_achievement'
type: 'function'
description: |-
[TEST FACILITY ONLY]
Required permission
`ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [DELETE]` and scope `social`
arguments:
'achievement_code':
type: 'str'
required: true
description: |-
achievement code
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
user id
return_type: 'Tuple[None, 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/user_achievements/admin_reset_achievement.py'
example: |-
result, error = achievement.admin_reset_achievement(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'reset'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [DELETE]'
scopes:
- 'social'
'admin_unlock_achievement@py.achievement.fun':
id: 'admin_unlock_achievement@py.achievement.fun'
name: 'admin_unlock_achievement'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social`
arguments:
'achievement_code':
type: 'str'
required: true
description: |-
achievement code
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
user id
return_type: 'Tuple[None, 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/user_achievements/admin_unlock_achievement.py'
example: |-
result, error = achievement.admin_unlock_achievement(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'unlock'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'admin_update_achievement@py.achievement.fun':
id: 'admin_update_achievement@py.achievement.fun'
name: 'admin_update_achievement'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]` and scope `social`
arguments:
'achievement_code':
type: 'str'
required: true
description: |-
achievement code
'body':
type: 'ModelsAchievementUpdateRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsAchievementResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/achievements/admin_update_achievement.py'
example: |-
result, error = achievement.admin_update_achievement(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'admin_update_achievement_list_order@py.achievement.fun':
id: 'admin_update_achievement_list_order@py.achievement.fun'
name: 'admin_update_achievement_list_order'
type: 'function'
description: |-
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]` and scope `social`
arguments:
'achievement_code':
type: 'str'
required: true
description: |-
achievement code
'body':
type: 'ModelsAchievementOrderUpdateRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[None, 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/achievements/admin_update_achievemen_d288a7.py'
example: |-
result, error = achievement.admin_update_achievement_list_order(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'admin'
- 'list'
- 'order'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'bulk_create_psn_event@py.achievement.fun':
id: 'bulk_create_psn_event@py.achievement.fun'
name: 'bulk_create_psn_event'
type: 'function'
description: |-
Create PSN UDS events. Player need to login first using playstation token to IAM service.
arguments:
'body':
type: 'ModelsBulkCreatePSNEvents'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsBulkCreatePSNEventResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/platform_achievement/bulk_create_psn_event.py'
example: |-
result, error = achievement.bulk_create_psn_event(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'bulk'
- 'create'
- 'event'
- 'platform'
- 'psn'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT:PLATFORM [CREATE]'
scopes:
- 'social'
'claim_global_achievement_reward@py.achievement.fun':
id: 'claim_global_achievement_reward@py.achievement.fun'
name: 'claim_global_achievement_reward'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social`
Note:
Global achievement should be unlocked to claim the reward. Only contributor of global achievement are eligible for rewards
arguments:
'achievement_code':
type: 'str'
required: true
description: |-
achievement code
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
user ID
return_type: 'Tuple[Union[None, HttpResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/global_achievements/claim_global_achievemen_1ea8df.py'
example: |-
result, error = achievement.claim_global_achievement_reward(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'claim'
- 'global'
- 'reward'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'export_achievements@py.achievement.fun':
id: 'export_achievements@py.achievement.fun'
name: 'export_achievements'
type: 'function'
description: |-
Required permission `ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]`
Required Scope: `social`
Successful response header will contain: `content-disposition: attachment; filename=achievement__config.json`
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'tags':
type: 'Optional[List[str]]'
required: false
description: |-
tags
return_type: 'Tuple[Union[None, Any], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/achievements/export_achievements.py'
example: |-
result, error = achievement.export_achievements(...)
if error:
# handle_error(error)
tags:
- 'achievements'
- 'export'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'import_achievements@py.achievement.fun':
id: 'import_achievements@py.achievement.fun'
name: 'import_achievements'
type: 'function'
description: |-
Required permission ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]
Required Scope: social
Import achievement configuration from file. It will merge with existing achievement.
Available import strategy:
- leaveOut: if achievement with same key exist, the existing will be used and imported one will be ignored (default)
- replace: if achievement with same key exist, the imported achievement will be used and existing one will be removed
arguments:
'file':
type: 'Optional[Any]'
required: false
description: |-
file to be imported
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'strategy':
type: 'Optional[str]'
required: false
description: |-
strategy for import
return_type: 'Tuple[Union[None, ServiceImportConfigResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/achievements/import_achievements.py'
example: |-
result, error = achievement.import_achievements(...)
if error:
# handle_error(error)
tags:
- 'achievements'
- 'import'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'list_global_achievement_contributors@py.achievement.fun':
id: 'list_global_achievement_contributors@py.achievement.fun'
name: 'list_global_achievement_contributors'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'achievement_code':
type: 'str'
required: true
description: |-
achievement code
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'sort_by':
type: 'Optional[Union[str, ListGlobalAchievementContributorsSortByEnum]]'
required: false
description: |-
sort by, default is 'contributedValue:desc', allow values: [contributedValue, contributedValue:asc, contributedValue:desc]
return_type: 'Tuple[Union[None, ModelsPaginatedContributorResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/global_achievements/list_global_achievement_b19e66.py'
example: |-
result, error = achievement.list_global_achievement_contributors(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'contributors'
- 'global'
- 'list'
permissions:
- 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'list_user_contributions@py.achievement.fun':
id: 'list_user_contributions@py.achievement.fun'
name: 'list_user_contributions'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'achievement_codes':
type: 'Optional[str]'
required: false
description: |-
achievement codes. multiple value separated by comma
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'sort_by':
type: 'Optional[Union[str, ListUserContributionsSortByEnum]]'
required: false
description: |-
sort by, default is 'contributedValue:desc', allow values: [contributedValue, contributedValue:asc, contributedValue:desc]
'tags':
type: 'Optional[List[str]]'
required: false
description: |-
tags
'user_id':
type: 'str'
required: true
description: |-
user ID
return_type: 'Tuple[Union[None, ModelsPaginatedUserContributionResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/global_achievements/list_user_contributions.py'
example: |-
result, error = achievement.list_user_contributions(...)
if error:
# handle_error(error)
tags:
- 'achievements'
- 'contributions'
- 'global'
- 'list'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'public_bulk_unlock_achievement@py.achievement.fun':
id: 'public_bulk_unlock_achievement@py.achievement.fun'
name: 'public_bulk_unlock_achievement'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social`
arguments:
'body':
type: 'ModelsBulkUnlockAchievementRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
user id
return_type: 'Tuple[Union[None, List[ModelsBulkUnlockAchievementResponse]], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/user_achievements/public_bulk_unlock_achievement.py'
example: |-
result, error = achievement.public_bulk_unlock_achievement(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'bulk'
- 'public'
- 'unlock'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'public_get_achievement@py.achievement.fun':
id: 'public_get_achievement@py.achievement.fun'
name: 'public_get_achievement'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'achievement_code':
type: 'str'
required: true
description: |-
achievement code
'language':
type: 'str'
required: true
description: |-
language, if the selected language not exist in achievement,it use default language
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsPublicAchievementResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/achievements/public_get_achievement.py'
example: |-
result, error = achievement.public_get_achievement(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'get'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'public_list_achievements@py.achievement.fun':
id: 'public_list_achievements@py.achievement.fun'
name: 'public_list_achievements'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'global_':
type: 'Optional[bool]'
required: false
description: |-
filter by global achievement flag
'language':
type: 'str'
required: true
description: |-
language, if the selected language not exist in achievement,it use default language
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'sort_by':
type: 'Optional[Union[str, PublicListAchievementsSortByEnum]]'
required: false
description: |-
sort by, default is 'listOrder:asc', allow values: [listOrder, listOrder:asc, listOrder:desc, createdAt, createdAt:asc, createdAt:desc, updatedAt, updatedAt:asc, updatedAt:desc]
'tags':
type: 'Optional[List[str]]'
required: false
description: |-
tags
return_type: 'Tuple[Union[None, ModelsPublicAchievementsResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/achievements/public_list_achievements.py'
example: |-
result, error = achievement.public_list_achievements(...)
if error:
# handle_error(error)
tags:
- 'achievements'
- 'list'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'public_list_global_achievements@py.achievement.fun':
id: 'public_list_global_achievements@py.achievement.fun'
name: 'public_list_global_achievements'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
Note:
Global achievement status value mean: `status = 1 (in progress)` and `status = 2 (unlocked)`
arguments:
'achievement_codes':
type: 'Optional[str]'
required: false
description: |-
filter by achievement codes. multiple value separated by comma
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'sort_by':
type: 'Optional[Union[str, PublicListGlobalAchievementsSortByEnum]]'
required: false
description: |-
sort by, allow values: [achievedAt, achievedAt:asc, achievedAt:desc, createdAt, createdAt:asc, createdAt:desc]
'status':
type: 'Optional[str]'
required: false
description: |-
filter by status. available value: [in_progress, unlocked]
'tags':
type: 'Optional[List[str]]'
required: false
description: |-
tags
return_type: 'Tuple[Union[None, ModelsPaginatedGlobalAchievementResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/global_achievements/public_list_global_achi_9c838b.py'
example: |-
result, error = achievement.public_list_global_achievements(...)
if error:
# handle_error(error)
tags:
- 'achievements'
- 'global'
- 'list'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'public_list_tags@py.achievement.fun':
id: 'public_list_tags@py.achievement.fun'
name: 'public_list_tags'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social`
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'name':
type: 'Optional[str]'
required: false
description: |-
like's query by tag name
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'sort_by':
type: 'Optional[Union[str, PublicListTagsSortByEnum]]'
required: false
description: |-
sort by, default is 'name:asc', allow values: [name, name:asc, name:desc, createdAt, createdAt:asc, createdAt:desc]
return_type: 'Tuple[Union[None, ModelsPaginatedTagResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/tags/public_list_tags.py'
example: |-
result, error = achievement.public_list_tags(...)
if error:
# handle_error(error)
tags:
- 'list'
- 'public'
- 'tags'
permissions:
- 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'public_list_user_achievements@py.achievement.fun':
id: 'public_list_user_achievements@py.achievement.fun'
name: 'public_list_user_achievements'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]` and scope `social`
Note:
User Achievement status value mean: `status = 1 (in progress)` and `status = 2 (unlocked)`
`achievedAt` value will return default value: `0001-01-01T00:00:00Z` for user achievement that locked or in progress
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
the maximum number of data that may be returned (1...100)
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'prefer_unlocked':
type: 'Optional[bool]'
required: false
description: |-
prefer to query achieved
'sort_by':
type: 'Optional[Union[str, PublicListUserAchievementsSortByEnum]]'
required: false
description: |-
sort by, allow values: [achievedAt, achievedAt:asc, achievedAt:desc, createdAt, createdAt:asc, createdAt:desc]
'tags':
type: 'Optional[List[str]]'
required: false
description: |-
tags
'user_id':
type: 'str'
required: true
description: |-
user id
return_type: 'Tuple[Union[None, ModelsPaginatedUserAchievementResponse], 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/user_achievements/public_list_user_achievements.py'
example: |-
result, error = achievement.public_list_user_achievements(...)
if error:
# handle_error(error)
tags:
- 'achievements'
- 'list'
- 'public'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]'
scopes:
- 'social'
'public_unlock_achievement@py.achievement.fun':
id: 'public_unlock_achievement@py.achievement.fun'
name: 'public_unlock_achievement'
type: 'function'
description: |-
Required permission
`NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social`
arguments:
'achievement_code':
type: 'str'
required: true
description: |-
achievement code
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
user id
return_type: 'Tuple[None, 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/user_achievements/public_unlock_achievement.py'
example: |-
result, error = achievement.public_unlock_achievement(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'public'
- 'unlock'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]'
scopes:
- 'social'
'reset_global_achievement@py.achievement.fun':
id: 'reset_global_achievement@py.achievement.fun'
name: 'reset_global_achievement'
type: 'function'
description: |-
[TEST FACILITY ONLY]
Required permission
`ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [DELETE]` and scope `social`
arguments:
'achievement_code':
type: 'str'
required: true
description: |-
achievement code
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[None, 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.achievement as achievement'
- 'import accelbyte_py_sdk.api.achievement.models as achievement_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/achievement/operations/global_achievements/reset_global_achievement.py'
example: |-
result, error = achievement.reset_global_achievement(...)
if error:
# handle_error(error)
tags:
- 'achievement'
- 'achievements'
- 'global'
- 'reset'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [DELETE]'
scopes:
- 'social'
# endregion functions
