symbols:
# region models
'ModelsArchiveLeaderboardReq@py.leaderboard.mod':
id: 'ModelsArchiveLeaderboardReq@py.leaderboard.mod'
name: 'ModelsArchiveLeaderboardReq'
type: 'model'
fields:
'leaderboard_codes':
type: 'List[str]'
required: true
'limit':
type: 'int'
required: true
'slug':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_archive_leaderboard_req.py'
example: |-
models_archive_leaderboard_req = leaderboard_models.ModelsArchiveLeaderboardReq.create(...)
'ModelsArchiveLeaderboardSignedURLResponse@py.leaderboard.mod':
id: 'ModelsArchiveLeaderboardSignedURLResponse@py.leaderboard.mod'
name: 'ModelsArchiveLeaderboardSignedURLResponse'
type: 'model'
fields:
'leaderboard_code':
type: 'str'
required: true
'url':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_archive_leaderboard_signed_url_response.py'
example: |-
models_archive_leaderboard_signed_url_response = leaderboard_models.ModelsArchiveLeaderboardSignedURLResponse.create(...)
'ModelsBulkUserIDsRequest@py.leaderboard.mod':
id: 'ModelsBulkUserIDsRequest@py.leaderboard.mod'
name: 'ModelsBulkUserIDsRequest'
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.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_bulk_user_i_ds_request.py'
example: |-
models_bulk_user_i_ds_request = leaderboard_models.ModelsBulkUserIDsRequest.create(...)
'ModelsBulkUserRankingResponseV3@py.leaderboard.mod':
id: 'ModelsBulkUserRankingResponseV3@py.leaderboard.mod'
name: 'ModelsBulkUserRankingResponseV3'
type: 'model'
fields:
'data':
type: 'List[ModelsUserRankingResponseV3]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_bulk_user_ranking_response_v3.py'
example: |-
models_bulk_user_ranking_response_v3 = leaderboard_models.ModelsBulkUserRankingResponseV3.create(...)
'ModelsDailyConfig@py.leaderboard.mod':
id: 'ModelsDailyConfig@py.leaderboard.mod'
name: 'ModelsDailyConfig'
type: 'model'
fields:
'reset_time':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_daily_config.py'
example: |-
models_daily_config = leaderboard_models.ModelsDailyConfig.create(...)
'ModelsDeleteBulkLeaderboardFailedResp@py.leaderboard.mod':
id: 'ModelsDeleteBulkLeaderboardFailedResp@py.leaderboard.mod'
name: 'ModelsDeleteBulkLeaderboardFailedResp'
type: 'model'
fields:
'error':
type: 'str'
required: true
'leaderboard_code':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_delete_bulk_leaderboard_failed_resp.py'
example: |-
models_delete_bulk_leaderboard_failed_resp = leaderboard_models.ModelsDeleteBulkLeaderboardFailedResp.create(...)
'ModelsDeleteBulkLeaderboardsReq@py.leaderboard.mod':
id: 'ModelsDeleteBulkLeaderboardsReq@py.leaderboard.mod'
name: 'ModelsDeleteBulkLeaderboardsReq'
type: 'model'
fields:
'leaderboard_codes':
type: 'List[str]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_delete_bulk_leaderboards_req.py'
example: |-
models_delete_bulk_leaderboards_req = leaderboard_models.ModelsDeleteBulkLeaderboardsReq.create(...)
'ModelsDeleteBulkLeaderboardsResp@py.leaderboard.mod':
id: 'ModelsDeleteBulkLeaderboardsResp@py.leaderboard.mod'
name: 'ModelsDeleteBulkLeaderboardsResp'
type: 'model'
fields:
'failed':
type: 'List[ModelsDeleteBulkLeaderboardFailedResp]'
required: true
'success':
type: 'List[ModelsDeleteBulkLeaderboardSuccessResp]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_delete_bulk_leaderboards_resp.py'
example: |-
models_delete_bulk_leaderboards_resp = leaderboard_models.ModelsDeleteBulkLeaderboardsResp.create(...)
'ModelsDeleteBulkLeaderboardSuccessResp@py.leaderboard.mod':
id: 'ModelsDeleteBulkLeaderboardSuccessResp@py.leaderboard.mod'
name: 'ModelsDeleteBulkLeaderboardSuccessResp'
type: 'model'
fields:
'leaderboard_code':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_delete_bulk_leaderboard_success_resp.py'
example: |-
models_delete_bulk_leaderboard_success_resp = leaderboard_models.ModelsDeleteBulkLeaderboardSuccessResp.create(...)
'ModelsGetAllLeaderboardConfigsPublicResp@py.leaderboard.mod':
id: 'ModelsGetAllLeaderboardConfigsPublicResp@py.leaderboard.mod'
name: 'ModelsGetAllLeaderboardConfigsPublicResp'
type: 'model'
fields:
'data':
type: 'List[ModelsGetLeaderboardConfigPublicResp]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_get_all_leaderboard_configs_public_resp.py'
example: |-
models_get_all_leaderboard_configs_public_resp = leaderboard_models.ModelsGetAllLeaderboardConfigsPublicResp.create(...)
'ModelsGetAllLeaderboardConfigsPublicRespV3@py.leaderboard.mod':
id: 'ModelsGetAllLeaderboardConfigsPublicRespV3@py.leaderboard.mod'
name: 'ModelsGetAllLeaderboardConfigsPublicRespV3'
type: 'model'
fields:
'data':
type: 'List[ModelsGetLeaderboardConfigPublicRespV3]'
required: true
'paging':
type: 'ModelsPaginationV3'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_get_all_leaderboard_configs_public_resp_v3.py'
example: |-
models_get_all_leaderboard_configs_public_resp_v3 = leaderboard_models.ModelsGetAllLeaderboardConfigsPublicRespV3.create(...)
'ModelsGetAllLeaderboardConfigsResp@py.leaderboard.mod':
id: 'ModelsGetAllLeaderboardConfigsResp@py.leaderboard.mod'
name: 'ModelsGetAllLeaderboardConfigsResp'
type: 'model'
fields:
'data':
type: 'List[ModelsGetLeaderboardConfigResp]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_get_all_leaderboard_configs_resp.py'
example: |-
models_get_all_leaderboard_configs_resp = leaderboard_models.ModelsGetAllLeaderboardConfigsResp.create(...)
'ModelsGetAllLeaderboardConfigsRespV3@py.leaderboard.mod':
id: 'ModelsGetAllLeaderboardConfigsRespV3@py.leaderboard.mod'
name: 'ModelsGetAllLeaderboardConfigsRespV3'
type: 'model'
fields:
'data':
type: 'List[ModelsGetLeaderboardConfigRespV3]'
required: true
'paging':
type: 'ModelsPaginationV3'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_get_all_leaderboard_configs_resp_v3.py'
example: |-
models_get_all_leaderboard_configs_resp_v3 = leaderboard_models.ModelsGetAllLeaderboardConfigsRespV3.create(...)
'ModelsGetAllUserLeaderboardsResp@py.leaderboard.mod':
id: 'ModelsGetAllUserLeaderboardsResp@py.leaderboard.mod'
name: 'ModelsGetAllUserLeaderboardsResp'
type: 'model'
fields:
'data':
type: 'List[ModelsUserLeaderboardRanking]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_get_all_user_leaderboards_resp.py'
example: |-
models_get_all_user_leaderboards_resp = leaderboard_models.ModelsGetAllUserLeaderboardsResp.create(...)
'ModelsGetAllUserLeaderboardsRespV3@py.leaderboard.mod':
id: 'ModelsGetAllUserLeaderboardsRespV3@py.leaderboard.mod'
name: 'ModelsGetAllUserLeaderboardsRespV3'
type: 'model'
fields:
'data':
type: 'List[ModelsUserLeaderboardRankingV3]'
required: true
'paging':
type: 'ModelsPaginationV3'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_get_all_user_leaderboards_resp_v3.py'
example: |-
models_get_all_user_leaderboards_resp_v3 = leaderboard_models.ModelsGetAllUserLeaderboardsRespV3.create(...)
'ModelsGetHiddenUserResponse@py.leaderboard.mod':
id: 'ModelsGetHiddenUserResponse@py.leaderboard.mod'
name: 'ModelsGetHiddenUserResponse'
type: 'model'
fields:
'data':
type: 'List[str]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_get_hidden_user_response.py'
example: |-
models_get_hidden_user_response = leaderboard_models.ModelsGetHiddenUserResponse.create(...)
'ModelsGetLeaderboardConfigPublicResp@py.leaderboard.mod':
id: 'ModelsGetLeaderboardConfigPublicResp@py.leaderboard.mod'
name: 'ModelsGetLeaderboardConfigPublicResp'
type: 'model'
fields:
'icon_url':
type: 'str'
required: true
'leaderboard_code':
type: 'str'
required: true
'name':
type: 'str'
required: true
'stat_code':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_get_leaderboard_config_public_resp.py'
example: |-
models_get_leaderboard_config_public_resp = leaderboard_models.ModelsGetLeaderboardConfigPublicResp.create(...)
'ModelsGetLeaderboardConfigPublicRespV3@py.leaderboard.mod':
id: 'ModelsGetLeaderboardConfigPublicRespV3@py.leaderboard.mod'
name: 'ModelsGetLeaderboardConfigPublicRespV3'
type: 'model'
fields:
'all_time':
type: 'bool'
required: true
'cycle_ids':
type: 'List[str]'
required: true
'icon_url':
type: 'str'
required: true
'leaderboard_code':
type: 'str'
required: true
'name':
type: 'str'
required: true
'stat_code':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_get_leaderboard_config_public_resp_v3.py'
example: |-
models_get_leaderboard_config_public_resp_v3 = leaderboard_models.ModelsGetLeaderboardConfigPublicRespV3.create(...)
'ModelsGetLeaderboardConfigResp@py.leaderboard.mod':
id: 'ModelsGetLeaderboardConfigResp@py.leaderboard.mod'
name: 'ModelsGetLeaderboardConfigResp'
type: 'model'
fields:
'daily':
type: 'ModelsDailyConfig'
required: true
'descending':
type: 'bool'
required: true
'icon_url':
type: 'str'
required: true
'is_archived':
type: 'bool'
required: true
'is_deleted':
type: 'bool'
required: true
'leaderboard_code':
type: 'str'
required: true
'monthly':
type: 'ModelsMonthlyConfig'
required: true
'name':
type: 'str'
required: true
'season_period':
type: 'int'
required: true
'start_time':
type: 'str'
required: true
'stat_code':
type: 'str'
required: true
'weekly':
type: 'ModelsWeeklyConfig'
required: true
'deleted_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_get_leaderboard_config_resp.py'
example: |-
models_get_leaderboard_config_resp = leaderboard_models.ModelsGetLeaderboardConfigResp.create(...)
'ModelsGetLeaderboardConfigRespV3@py.leaderboard.mod':
id: 'ModelsGetLeaderboardConfigRespV3@py.leaderboard.mod'
name: 'ModelsGetLeaderboardConfigRespV3'
type: 'model'
fields:
'all_time':
type: 'bool'
required: true
'created_at':
type: 'str'
required: true
'cycle_ids':
type: 'List[str]'
required: true
'descending':
type: 'bool'
required: true
'is_deleted':
type: 'bool'
required: true
'leaderboard_code':
type: 'str'
required: true
'name':
type: 'str'
required: true
'stat_code':
type: 'str'
required: true
'updated_at':
type: 'str'
required: true
'deleted_at':
type: 'str'
required: false
'description':
type: 'str'
required: false
'icon_url':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_get_leaderboard_config_resp_v3.py'
example: |-
models_get_leaderboard_config_resp_v3 = leaderboard_models.ModelsGetLeaderboardConfigRespV3.create(...)
'ModelsGetLeaderboardRankingResp@py.leaderboard.mod':
id: 'ModelsGetLeaderboardRankingResp@py.leaderboard.mod'
name: 'ModelsGetLeaderboardRankingResp'
type: 'model'
fields:
'data':
type: 'List[ModelsUserPoint]'
required: true
'paging':
type: 'ModelsPagination'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_get_leaderboard_ranking_resp.py'
example: |-
models_get_leaderboard_ranking_resp = leaderboard_models.ModelsGetLeaderboardRankingResp.create(...)
'ModelsGetUserVisibilityResponse@py.leaderboard.mod':
id: 'ModelsGetUserVisibilityResponse@py.leaderboard.mod'
name: 'ModelsGetUserVisibilityResponse'
type: 'model'
fields:
'namespace':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
'visibility':
type: 'bool'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_get_user_visibility_response.py'
example: |-
models_get_user_visibility_response = leaderboard_models.ModelsGetUserVisibilityResponse.create(...)
'ModelsLeaderboardConfigReq@py.leaderboard.mod':
id: 'ModelsLeaderboardConfigReq@py.leaderboard.mod'
name: 'ModelsLeaderboardConfigReq'
type: 'model'
fields:
'daily':
type: 'ModelsDailyConfig'
required: true
'descending':
type: 'bool'
required: true
'icon_url':
type: 'str'
required: true
'leaderboard_code':
type: 'str'
required: true
'monthly':
type: 'ModelsMonthlyConfig'
required: true
'name':
type: 'str'
required: true
'season_period':
type: 'int'
required: true
'start_time':
type: 'str'
required: true
'stat_code':
type: 'str'
required: true
'weekly':
type: 'ModelsWeeklyConfig'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_leaderboard_config_req.py'
example: |-
models_leaderboard_config_req = leaderboard_models.ModelsLeaderboardConfigReq.create(...)
'ModelsLeaderboardConfigReqV3@py.leaderboard.mod':
id: 'ModelsLeaderboardConfigReqV3@py.leaderboard.mod'
name: 'ModelsLeaderboardConfigReqV3'
type: 'model'
fields:
'all_time':
type: 'bool'
required: true
'descending':
type: 'bool'
required: true
'leaderboard_code':
type: 'str'
required: true
'name':
type: 'str'
required: true
'stat_code':
type: 'str'
required: true
'cycle_ids':
type: 'List[str]'
required: false
'description':
type: 'str'
required: false
'icon_url':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_leaderboard_config_req_v3.py'
example: |-
models_leaderboard_config_req_v3 = leaderboard_models.ModelsLeaderboardConfigReqV3.create(...)
'ModelsMonthlyConfig@py.leaderboard.mod':
id: 'ModelsMonthlyConfig@py.leaderboard.mod'
name: 'ModelsMonthlyConfig'
type: 'model'
fields:
'reset_date':
type: 'int'
required: true
'reset_time':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_monthly_config.py'
example: |-
models_monthly_config = leaderboard_models.ModelsMonthlyConfig.create(...)
'ModelsPagination@py.leaderboard.mod':
id: 'ModelsPagination@py.leaderboard.mod'
name: 'ModelsPagination'
type: 'model'
fields:
'first':
type: 'str'
required: true
'last':
type: 'str'
required: true
'next_':
type: 'str'
required: true
'previous':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_pagination.py'
example: |-
models_pagination = leaderboard_models.ModelsPagination.create(...)
'ModelsPaginationV3@py.leaderboard.mod':
id: 'ModelsPaginationV3@py.leaderboard.mod'
name: 'ModelsPaginationV3'
type: 'model'
fields:
'first':
type: 'str'
required: true
'last':
type: 'str'
required: true
'next_':
type: 'str'
required: true
'previous':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_pagination_v3.py'
example: |-
models_pagination_v3 = leaderboard_models.ModelsPaginationV3.create(...)
'ModelsSetUserVisibilityRequest@py.leaderboard.mod':
id: 'ModelsSetUserVisibilityRequest@py.leaderboard.mod'
name: 'ModelsSetUserVisibilityRequest'
type: 'model'
fields:
'visibility':
type: 'bool'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_set_user_visibility_request.py'
example: |-
models_set_user_visibility_request = leaderboard_models.ModelsSetUserVisibilityRequest.create(...)
'ModelsUpdateLeaderboardConfigReq@py.leaderboard.mod':
id: 'ModelsUpdateLeaderboardConfigReq@py.leaderboard.mod'
name: 'ModelsUpdateLeaderboardConfigReq'
type: 'model'
fields:
'daily':
type: 'ModelsDailyConfig'
required: true
'descending':
type: 'bool'
required: true
'icon_url':
type: 'str'
required: true
'monthly':
type: 'ModelsMonthlyConfig'
required: true
'name':
type: 'str'
required: true
'season_period':
type: 'int'
required: true
'start_time':
type: 'str'
required: true
'stat_code':
type: 'str'
required: true
'weekly':
type: 'ModelsWeeklyConfig'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_update_leaderboard_config_req.py'
example: |-
models_update_leaderboard_config_req = leaderboard_models.ModelsUpdateLeaderboardConfigReq.create(...)
'ModelsUpdateLeaderboardConfigReqV3@py.leaderboard.mod':
id: 'ModelsUpdateLeaderboardConfigReqV3@py.leaderboard.mod'
name: 'ModelsUpdateLeaderboardConfigReqV3'
type: 'model'
fields:
'all_time':
type: 'bool'
required: true
'descending':
type: 'bool'
required: true
'name':
type: 'str'
required: true
'cycle_ids':
type: 'List[str]'
required: false
'description':
type: 'str'
required: false
'icon_url':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_update_leaderboard_config_req_v3.py'
example: |-
models_update_leaderboard_config_req_v3 = leaderboard_models.ModelsUpdateLeaderboardConfigReqV3.create(...)
'ModelsUpdateUserPointAdminV1Request@py.leaderboard.mod':
id: 'ModelsUpdateUserPointAdminV1Request@py.leaderboard.mod'
name: 'ModelsUpdateUserPointAdminV1Request'
type: 'model'
fields:
'inc':
type: 'float'
required: true
'latest_value':
type: 'float'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_update_user_point_admin_v1_request.py'
example: |-
models_update_user_point_admin_v1_request = leaderboard_models.ModelsUpdateUserPointAdminV1Request.create(...)
'ModelsUpdateUserPointAdminV1Response@py.leaderboard.mod':
id: 'ModelsUpdateUserPointAdminV1Response@py.leaderboard.mod'
name: 'ModelsUpdateUserPointAdminV1Response'
type: 'model'
fields:
'point':
type: 'float'
required: true
'user_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_update_user_point_admin_v1_response.py'
example: |-
models_update_user_point_admin_v1_response = leaderboard_models.ModelsUpdateUserPointAdminV1Response.create(...)
'ModelsUserCycleRankingResponseDetail@py.leaderboard.mod':
id: 'ModelsUserCycleRankingResponseDetail@py.leaderboard.mod'
name: 'ModelsUserCycleRankingResponseDetail'
type: 'model'
fields:
'cycle_id':
type: 'str'
required: true
'point':
type: 'float'
required: true
'rank':
type: 'int'
required: true
'additional_data':
type: 'Dict[str, Any]'
required: false
'hidden':
type: 'bool'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_user_cycle_ranking_response_detail.py'
example: |-
models_user_cycle_ranking_response_detail = leaderboard_models.ModelsUserCycleRankingResponseDetail.create(...)
'ModelsUserLeaderboardRanking@py.leaderboard.mod':
id: 'ModelsUserLeaderboardRanking@py.leaderboard.mod'
name: 'ModelsUserLeaderboardRanking'
type: 'model'
fields:
'all_time':
type: 'ModelsUserRankingResponseDetail'
required: true
'current':
type: 'ModelsUserRankingResponseDetail'
required: true
'daily':
type: 'ModelsUserRankingResponseDetail'
required: true
'leaderboard_code':
type: 'str'
required: true
'leaderboard_name':
type: 'str'
required: true
'monthly':
type: 'ModelsUserRankingResponseDetail'
required: true
'user_id':
type: 'str'
required: true
'weekly':
type: 'ModelsUserRankingResponseDetail'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_user_leaderboard_ranking.py'
example: |-
models_user_leaderboard_ranking = leaderboard_models.ModelsUserLeaderboardRanking.create(...)
'ModelsUserLeaderboardRankingV3@py.leaderboard.mod':
id: 'ModelsUserLeaderboardRankingV3@py.leaderboard.mod'
name: 'ModelsUserLeaderboardRankingV3'
type: 'model'
fields:
'cycles':
type: 'List[ModelsUserCycleRankingResponseDetail]'
required: true
'leaderboard_code':
type: 'str'
required: true
'leaderboard_name':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
'all_time':
type: 'ModelsUserRankingResponseDetailV3'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_user_leaderboard_ranking_v3.py'
example: |-
models_user_leaderboard_ranking_v3 = leaderboard_models.ModelsUserLeaderboardRankingV3.create(...)
'ModelsUserPoint@py.leaderboard.mod':
id: 'ModelsUserPoint@py.leaderboard.mod'
name: 'ModelsUserPoint'
type: 'model'
fields:
'additional_data':
type: 'Dict[str, Any]'
required: true
'point':
type: 'float'
required: true
'user_id':
type: 'str'
required: true
'hidden':
type: 'bool'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_user_point.py'
example: |-
models_user_point = leaderboard_models.ModelsUserPoint.create(...)
'ModelsUserRankingResponse@py.leaderboard.mod':
id: 'ModelsUserRankingResponse@py.leaderboard.mod'
name: 'ModelsUserRankingResponse'
type: 'model'
fields:
'all_time':
type: 'ModelsUserRankingResponseDetail'
required: true
'current':
type: 'ModelsUserRankingResponseDetail'
required: true
'daily':
type: 'ModelsUserRankingResponseDetail'
required: true
'monthly':
type: 'ModelsUserRankingResponseDetail'
required: true
'user_id':
type: 'str'
required: true
'weekly':
type: 'ModelsUserRankingResponseDetail'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_user_ranking_response.py'
example: |-
models_user_ranking_response = leaderboard_models.ModelsUserRankingResponse.create(...)
'ModelsUserRankingResponseDetail@py.leaderboard.mod':
id: 'ModelsUserRankingResponseDetail@py.leaderboard.mod'
name: 'ModelsUserRankingResponseDetail'
type: 'model'
fields:
'additional_data':
type: 'Dict[str, Any]'
required: true
'point':
type: 'float'
required: true
'rank':
type: 'int'
required: true
'hidden':
type: 'bool'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_user_ranking_response_detail.py'
example: |-
models_user_ranking_response_detail = leaderboard_models.ModelsUserRankingResponseDetail.create(...)
'ModelsUserRankingResponseDetailV3@py.leaderboard.mod':
id: 'ModelsUserRankingResponseDetailV3@py.leaderboard.mod'
name: 'ModelsUserRankingResponseDetailV3'
type: 'model'
fields:
'point':
type: 'float'
required: true
'rank':
type: 'int'
required: true
'additional_data':
type: 'Dict[str, Any]'
required: false
'hidden':
type: 'bool'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_user_ranking_response_detail_v3.py'
example: |-
models_user_ranking_response_detail_v3 = leaderboard_models.ModelsUserRankingResponseDetailV3.create(...)
'ModelsUserRankingResponseV3@py.leaderboard.mod':
id: 'ModelsUserRankingResponseV3@py.leaderboard.mod'
name: 'ModelsUserRankingResponseV3'
type: 'model'
fields:
'cycles':
type: 'List[ModelsUserCycleRankingResponseDetail]'
required: true
'user_id':
type: 'str'
required: true
'all_time':
type: 'ModelsUserRankingResponseDetailV3'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_user_ranking_response_v3.py'
example: |-
models_user_ranking_response_v3 = leaderboard_models.ModelsUserRankingResponseV3.create(...)
'ModelsWeeklyConfig@py.leaderboard.mod':
id: 'ModelsWeeklyConfig@py.leaderboard.mod'
name: 'ModelsWeeklyConfig'
type: 'model'
fields:
'reset_day':
type: 'int'
required: true
'reset_time':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/models_weekly_config.py'
example: |-
models_weekly_config = leaderboard_models.ModelsWeeklyConfig.create(...)
'ResponseErrorResponse@py.leaderboard.mod':
id: 'ResponseErrorResponse@py.leaderboard.mod'
name: 'ResponseErrorResponse'
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.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/response_error_response.py'
example: |-
response_error_response = leaderboard_models.ResponseErrorResponse.create(...)
'V2Entry@py.leaderboard.mod':
id: 'V2Entry@py.leaderboard.mod'
name: 'V2Entry'
type: 'model'
fields:
'point':
type: 'float'
required: true
'additional_data':
type: 'Dict[str, Any]'
required: false
'hidden':
type: 'bool'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/v2_entry.py'
example: |-
v2_entry = leaderboard_models.V2Entry.create(...)
'V2GetAllLeaderboardConfigsPublicResp@py.leaderboard.mod':
id: 'V2GetAllLeaderboardConfigsPublicResp@py.leaderboard.mod'
name: 'V2GetAllLeaderboardConfigsPublicResp'
type: 'model'
fields:
'data':
type: 'List[V2GetLeaderboardConfigPublicResp]'
required: true
'paging':
type: 'V2PaginationV2'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/v2_get_all_leaderboard_configs_public_resp.py'
example: |-
v2_get_all_leaderboard_configs_public_resp = leaderboard_models.V2GetAllLeaderboardConfigsPublicResp.create(...)
'V2GetLeaderboardConfigPublicResp@py.leaderboard.mod':
id: 'V2GetLeaderboardConfigPublicResp@py.leaderboard.mod'
name: 'V2GetLeaderboardConfigPublicResp'
type: 'model'
fields:
'icon_url':
type: 'str'
required: true
'leaderboard_code':
type: 'str'
required: true
'name':
type: 'str'
required: true
'stat_code':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/v2_get_leaderboard_config_public_resp.py'
example: |-
v2_get_leaderboard_config_public_resp = leaderboard_models.V2GetLeaderboardConfigPublicResp.create(...)
'V2GetPublicLeaderboardRankingResponse@py.leaderboard.mod':
id: 'V2GetPublicLeaderboardRankingResponse@py.leaderboard.mod'
name: 'V2GetPublicLeaderboardRankingResponse'
type: 'model'
fields:
'data':
type: 'List[V2Entry]'
required: true
'paging':
type: 'V2PaginationV2'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/v2_get_public_leaderboard_ranking_response.py'
example: |-
v2_get_public_leaderboard_ranking_response = leaderboard_models.V2GetPublicLeaderboardRankingResponse.create(...)
'V2PaginationV2@py.leaderboard.mod':
id: 'V2PaginationV2@py.leaderboard.mod'
name: 'V2PaginationV2'
type: 'model'
fields:
'first':
type: 'str'
required: true
'last':
type: 'str'
required: true
'next_':
type: 'str'
required: true
'previous':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/models/v2_pagination_v2.py'
example: |-
v2_pagination_v2 = leaderboard_models.V2PaginationV2.create(...)
# endregion models
# region functions
'admin_anonymize_user_leaderboard_admin_v1@py.leaderboard.fun':
id: 'admin_anonymize_user_leaderboard_admin_v1@py.leaderboard.fun'
name: 'admin_anonymize_user_leaderboard_admin_v1'
type: 'function'
description: |-
This API will delete specified user leaderboard
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
User ID used for leaderboard entry
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/anonymization/admin_anonymize_user_le_6fbe1f.py'
example: |-
result, error = leaderboard.admin_anonymize_user_leaderboard_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'anonymization'
- 'anonymize'
- 'leaderboard'
- 'user'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ANONYMIZATION [DELETE]'
scopes:
- 'social'
'admin_get_archived_leaderboard_ranking_data_v1_handler@py.leaderboard.fun':
id: 'admin_get_archived_leaderboard_ranking_data_v1_handler@py.leaderboard.fun'
name: 'admin_get_archived_leaderboard_ranking_data_v1_handler'
type: 'function'
description: |-
Admin Get signed url in an all time leaderboard that archived. Notes: This will be a bulk endpoint to get sign url
arguments:
'leaderboard_codes':
type: 'str'
required: true
description: |-
list of leaderboard codes split by comma
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'slug':
type: 'Optional[str]'
required: false
description: |-
slug type of leaderboard
return_type: 'Tuple[Union[None, List[ModelsArchiveLeaderboardSignedURLResponse]], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/admin_get_archived_lead_191726.py'
example: |-
result, error = leaderboard.admin_get_archived_leaderboard_ranking_data_v1_handler(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'archived'
- 'data'
- 'get'
- 'handler'
- 'leaderboard'
- 'ranking'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [READ]'
scopes:
- 'social'
'bulk_get_users_ranking_public_v3@py.leaderboard.fun':
id: 'bulk_get_users_ranking_public_v3@py.leaderboard.fun'
name: 'bulk_get_users_ranking_public_v3'
type: 'function'
description: |-
Bulk get users ranking in leaderboard, max allowed 20 userIDs at a time.
arguments:
'body':
type: 'ModelsBulkUserIDsRequest'
required: true
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
return_type: 'Tuple[Union[None, ModelsBulkUserRankingResponseV3], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data_v3/bulk_get_users_ranking__e7e5b3.py'
example: |-
result, error = leaderboard.bulk_get_users_ranking_public_v3(...)
if error:
# handle_error(error)
tags:
- 'bulk'
- 'data'
- 'get'
- 'leaderboard'
- 'public'
- 'ranking'
- 'users'
- 'v3'
scopes:
- 'social'
'create_archived_leaderboard_ranking_data_v1_handler@py.leaderboard.fun':
id: 'create_archived_leaderboard_ranking_data_v1_handler@py.leaderboard.fun'
name: 'create_archived_leaderboard_ranking_data_v1_handler'
type: 'function'
description: |-
Archive leaderboard ranking data for specified leaderboard codes. NOTE: This will remove all data of the leaderboard on every slug,
remove the leaderboard code on stat mapping, and remove the leaderboard on the queue reset. This will be a bulk endpoint
arguments:
'body':
type: 'ModelsArchiveLeaderboardReq'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, Optional[str]], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/create_archived_leaderb_5492e4.py'
example: |-
result, error = leaderboard.create_archived_leaderboard_ranking_data_v1_handler(...)
if error:
# handle_error(error)
tags:
- 'archived'
- 'create'
- 'data'
- 'handler'
- 'leaderboard'
- 'ranking'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [CREATE]'
scopes:
- 'social'
'create_leaderboard_configuration_admin_v1@py.leaderboard.fun':
id: 'create_leaderboard_configuration_admin_v1@py.leaderboard.fun'
name: 'create_leaderboard_configuration_admin_v1'
type: 'function'
description: |-
Fields :
* LeaderboardConfig code must be lowercase and maximum length is 48 characters. (required).
* Maximum length for leaderboard name is 128 characters. (required).
* Start time must be follow RFC3339 standard. e.g. 2020-10-02T15:00:00.05Z (required).
* Season period must be greater than 31 days.
* If seasonPeriod is filled, the LeaderboardConfig would have seasonal leaderboard.
* Reset Date must be a number 1 - 31. Default is '1'.
* Reset Day must be a number 0 - 6. 0 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday (day of week). Default is '0'.
* Reset time must be hours:minutes in 24 hours format e.g. 01:30, 10:30, 15:30, 23:15.Default is '00:00'.
* Stat Code is related with statistic code in statistic service. (required).
arguments:
'body':
type: 'ModelsLeaderboardConfigReq'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsLeaderboardConfigReq], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration/create_leaderboard_conf_663810.py'
example: |-
result, error = leaderboard.create_leaderboard_configuration_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'create'
- 'leaderboard'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [CREATE]'
scopes:
- 'social'
'create_leaderboard_configuration_admin_v3@py.leaderboard.fun':
id: 'create_leaderboard_configuration_admin_v3@py.leaderboard.fun'
name: 'create_leaderboard_configuration_admin_v3'
type: 'function'
description: |-
Fields :
* leaderboardCode: unique leaderboard config code must be lowercase and maximum length is 48 characters. (required).
* name: leaderboard name, maximum length for leaderboard name is 128 characters. (required).
* description: leaderboard description, maximum length for leaderboard description is 2048 characters. (optional).
* iconURL: leaderboard icon image url. (optional).
* allTime: if true, all time leaderboard will be created. (required).
* descending: leaderboard order. If true, the points will be sorted in descending order. (required).
* statCode: Stat Code is related with statistic code in statistic service. (required).
* cycleIds: Statistic cycle ids that will be tracked in the leaderboard. (required).
arguments:
'body':
type: 'ModelsLeaderboardConfigReqV3'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsGetLeaderboardConfigRespV3], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration_v3/create_leaderboard_conf_2ad364.py'
example: |-
result, error = leaderboard.create_leaderboard_configuration_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'create'
- 'leaderboard'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [CREATE]'
scopes:
- 'social'
'create_leaderboard_configuration_public_v1@py.leaderboard.fun':
id: 'create_leaderboard_configuration_public_v1@py.leaderboard.fun'
name: 'create_leaderboard_configuration_public_v1'
type: 'function'
description: |-
Public endpoint to create a new leaderboard.
Fields :
* LeaderboardConfig code must be lowercase and maximum length is 48 characters. (required).
* Maximum length for leaderboard name is 128 characters. (required).
* Start time must be follow RFC3339 standard. e.g. 2020-10-02T15:00:00.05Z (required).
* Season period must be greater than 31 days.
* If seasonPeriod is filled, the LeaderboardConfig would have seasonal leaderboard.
* Reset Date must be a number 1 - 31. Default is '1'.
* Reset Day must be a number 0 - 6. 0 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday (day of week). Default is '0'.
* Reset time must be hours:minutes in 24 hours format e.g. 01:30, 10:30, 15:30, 23:15.Default is '00:00'.
* Stat Code is related with statistic code in statistic service. (required).
arguments:
'body':
type: 'ModelsLeaderboardConfigReq'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsLeaderboardConfigReq], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration/create_leaderboard_conf_8287f9.py'
example: |-
result, error = leaderboard.create_leaderboard_configuration_public_v1(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'create'
- 'leaderboard'
- 'public'
- 'v1'
permissions:
- 'NAMESPACE:{namespace}:LEADERBOARD [CREATE]'
scopes:
- 'social'
'delete_all_user_ranking_by_cycle_id_admin_v3@py.leaderboard.fun':
id: 'delete_all_user_ranking_by_cycle_id_admin_v3@py.leaderboard.fun'
name: 'delete_all_user_ranking_by_cycle_id_admin_v3'
type: 'function'
description: |-
This endpoint will delete user ranking by cycleId
Warning : This will permanently delete your data. Make sure to back up anything important before continuing.
arguments:
'cycle_id':
type: 'str'
required: true
description: |-
human readable unique code to identify cycles.
'leaderboard_code':
type: 'str'
required: true
description: |-
human readable unique code to identify leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data_v3/delete_all_user_ranking_204ce6.py'
example: |-
result, error = leaderboard.delete_all_user_ranking_by_cycle_id_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'all'
- 'by'
- 'cycle'
- 'data'
- 'delete'
- 'id'
- 'leaderboard'
- 'ranking'
- 'user'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [DELETE]'
scopes:
- 'social'
'delete_bulk_leaderboard_configuration_admin_v1@py.leaderboard.fun':
id: 'delete_bulk_leaderboard_configuration_admin_v1@py.leaderboard.fun'
name: 'delete_bulk_leaderboard_configuration_admin_v1'
type: 'function'
description: |-
This endpoint delete multiple leaderboards configuration in one request
arguments:
'body':
type: 'ModelsDeleteBulkLeaderboardsReq'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsDeleteBulkLeaderboardsResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration/delete_bulk_leaderboard_94414e.py'
example: |-
result, error = leaderboard.delete_bulk_leaderboard_configuration_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'bulk'
- 'configuration'
- 'delete'
- 'leaderboard'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [DELETE]'
scopes:
- 'social'
'delete_bulk_leaderboard_configuration_admin_v3@py.leaderboard.fun':
id: 'delete_bulk_leaderboard_configuration_admin_v3@py.leaderboard.fun'
name: 'delete_bulk_leaderboard_configuration_admin_v3'
type: 'function'
description: |-
This endpoint delete multiple leaderboards configuration in one request
arguments:
'body':
type: 'ModelsDeleteBulkLeaderboardsReq'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsDeleteBulkLeaderboardsResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration_v3/delete_bulk_leaderboard_f7002d.py'
example: |-
result, error = leaderboard.delete_bulk_leaderboard_configuration_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'bulk'
- 'configuration'
- 'delete'
- 'leaderboard'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [DELETE]'
scopes:
- 'social'
'delete_leaderboard_configuration_admin_v1@py.leaderboard.fun':
id: 'delete_leaderboard_configuration_admin_v1@py.leaderboard.fun'
name: 'delete_leaderboard_configuration_admin_v1'
type: 'function'
description: |-
This endpoint delete a leaderboard configuration
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
human readable unique code to indentify leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration/delete_leaderboard_conf_e6fbfe.py'
example: |-
result, error = leaderboard.delete_leaderboard_configuration_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'delete'
- 'leaderboard'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [DELETE]'
scopes:
- 'social'
'delete_leaderboard_configuration_admin_v3@py.leaderboard.fun':
id: 'delete_leaderboard_configuration_admin_v3@py.leaderboard.fun'
name: 'delete_leaderboard_configuration_admin_v3'
type: 'function'
description: |-
This endpoint delete a leaderboard configuration
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
human readable unique code to indentify leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration_v3/delete_leaderboard_conf_8f143c.py'
example: |-
result, error = leaderboard.delete_leaderboard_configuration_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'delete'
- 'leaderboard'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [DELETE]'
scopes:
- 'social'
'delete_user_ranking_admin_v1@py.leaderboard.fun':
id: 'delete_user_ranking_admin_v1@py.leaderboard.fun'
name: 'delete_user_ranking_admin_v1'
type: 'function'
description: |-
Delete user ranking
Remove entry with provided userId from leaderboard.
If leaderboard with given leaderboard code not found, it will return http status not found (404).
If the leaderboard is found and no entry found in it, it will still return success (204)
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
User ID used for leaderboard entry
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/delete_user_ranking_admin_v1.py'
example: |-
result, error = leaderboard.delete_user_ranking_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'delete'
- 'leaderboard'
- 'ranking'
- 'user'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD:USER [DELETE]'
scopes:
- 'social'
'delete_user_ranking_admin_v3@py.leaderboard.fun':
id: 'delete_user_ranking_admin_v3@py.leaderboard.fun'
name: 'delete_user_ranking_admin_v3'
type: 'function'
description: |-
Delete user ranking
Remove entry with provided userId from leaderboard.
If leaderboard with given leaderboard code not found, it will return http status not found (404).
If the leaderboard is found and no entry found in it, it will still return success (204)
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
User ID used for leaderboard entry
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data_v3/delete_user_ranking_admin_v3.py'
example: |-
result, error = leaderboard.delete_user_ranking_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'delete'
- 'leaderboard'
- 'ranking'
- 'user'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD:USER [DELETE]'
scopes:
- 'social'
'delete_user_ranking_by_cycle_id_admin_v3@py.leaderboard.fun':
id: 'delete_user_ranking_by_cycle_id_admin_v3@py.leaderboard.fun'
name: 'delete_user_ranking_by_cycle_id_admin_v3'
type: 'function'
description: |-
Delete user ranking by cycle id
Remove entry with provided cycleId and userId from leaderboard.
If leaderboard with given leaderboard code not found, it will return http status not found (404).
If the leaderboard is found and no entry found in it, it will still return success (204)
arguments:
'cycle_id':
type: 'str'
required: true
description: |-
human readable unique code to identify cycles.
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
User ID used for leaderboard entry
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data_v3/delete_user_ranking_by__2fdfe5.py'
example: |-
result, error = leaderboard.delete_user_ranking_by_cycle_id_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'by'
- 'cycle'
- 'data'
- 'delete'
- 'id'
- 'leaderboard'
- 'ranking'
- 'user'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD:USER [DELETE]'
scopes:
- 'social'
'delete_user_ranking_by_leaderboard_code_admin_v1@py.leaderboard.fun':
id: 'delete_user_ranking_by_leaderboard_code_admin_v1@py.leaderboard.fun'
name: 'delete_user_ranking_by_leaderboard_code_admin_v1'
type: 'function'
description: |-
This endpoint will delete user ranking by leaderboard code
Warning : This will permanently delete your data. Make sure to back up anything important before continuing.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
human readable unique code to indentify leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/delete_user_ranking_by__ed6de1.py'
example: |-
result, error = leaderboard.delete_user_ranking_by_leaderboard_code_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'by'
- 'code'
- 'data'
- 'delete'
- 'leaderboard'
- 'ranking'
- 'user'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [DELETE]'
scopes:
- 'social'
'delete_user_ranking_by_leaderboard_code_admin_v3@py.leaderboard.fun':
id: 'delete_user_ranking_by_leaderboard_code_admin_v3@py.leaderboard.fun'
name: 'delete_user_ranking_by_leaderboard_code_admin_v3'
type: 'function'
description: |-
This endpoint will delete user ranking by leaderboard code
Warning : This will permanently delete your data. Make sure to back up anything important before continuing.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
human readable unique code to indentify leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data_v3/delete_user_ranking_by__c762e5.py'
example: |-
result, error = leaderboard.delete_user_ranking_by_leaderboard_code_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'by'
- 'code'
- 'data'
- 'delete'
- 'leaderboard'
- 'ranking'
- 'user'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [DELETE]'
scopes:
- 'social'
'delete_user_ranking_public_v1@py.leaderboard.fun':
id: 'delete_user_ranking_public_v1@py.leaderboard.fun'
name: 'delete_user_ranking_public_v1'
type: 'function'
description: |-
Delete user ranking
Remove entry with provided userId from leaderboard.
If leaderboard with given leaderboard code not found, it will return http status not found (404).
If the leaderboard is found and no entry found in it, it will still return success (204)
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
User ID used for leaderboard entry
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/delete_user_ranking_public_v1.py'
example: |-
result, error = leaderboard.delete_user_ranking_public_v1(...)
if error:
# handle_error(error)
tags:
- 'data'
- 'delete'
- 'leaderboard'
- 'public'
- 'ranking'
- 'user'
- 'v1'
permissions:
- 'NAMESPACE:{namespace}:LEADERBOARD:USER:{userId} [DELETE]'
scopes:
- 'social'
'delete_user_rankings_admin_v1@py.leaderboard.fun':
id: 'delete_user_rankings_admin_v1@py.leaderboard.fun'
name: 'delete_user_rankings_admin_v1'
type: 'function'
description: |-
Delete user ranking across leaderboard
Remove entry with provided userId from leaderboard.
arguments:
'leaderboard_code':
type: 'List[str]'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48. At least one leaderboard code MUST be provided
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
User ID used for leaderboard entry
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/delete_user_rankings_admin_v1.py'
example: |-
result, error = leaderboard.delete_user_rankings_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'delete'
- 'leaderboard'
- 'rankings'
- 'user'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD:USER [DELETE]'
scopes:
- 'social'
'delete_user_rankings_admin_v3@py.leaderboard.fun':
id: 'delete_user_rankings_admin_v3@py.leaderboard.fun'
name: 'delete_user_rankings_admin_v3'
type: 'function'
description: |-
Delete user ranking across leaderboard
Remove entry with provided userId from leaderboard.
arguments:
'leaderboard_code':
type: 'List[str]'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48. At least one leaderboard code MUST be provided
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
User ID used for leaderboard entry
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data_v3/delete_user_rankings_admin_v3.py'
example: |-
result, error = leaderboard.delete_user_rankings_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'delete'
- 'leaderboard'
- 'rankings'
- 'user'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD:USER [DELETE]'
scopes:
- 'social'
'get_all_time_leaderboard_ranking_admin_v1@py.leaderboard.fun':
id: 'get_all_time_leaderboard_ranking_admin_v1@py.leaderboard.fun'
name: 'get_all_time_leaderboard_ranking_admin_v1'
type: 'function'
description: |-
Get rankings in an all time leaderboard.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
return_type: 'Tuple[Union[None, ModelsGetLeaderboardRankingResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/get_all_time_leaderboar_d0fb4b.py'
example: |-
result, error = leaderboard.get_all_time_leaderboard_ranking_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'all'
- 'data'
- 'get'
- 'leaderboard'
- 'ranking'
- 'time'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_all_time_leaderboard_ranking_admin_v3@py.leaderboard.fun':
id: 'get_all_time_leaderboard_ranking_admin_v3@py.leaderboard.fun'
name: 'get_all_time_leaderboard_ranking_admin_v3'
type: 'function'
description: |-
Get rankings in an all time leaderboard.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
return_type: 'Tuple[Union[None, ModelsGetLeaderboardRankingResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data_v3/get_all_time_leaderboar_489ddb.py'
example: |-
result, error = leaderboard.get_all_time_leaderboard_ranking_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'all'
- 'data'
- 'get'
- 'leaderboard'
- 'ranking'
- 'time'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_all_time_leaderboard_ranking_public_v1@py.leaderboard.fun':
id: 'get_all_time_leaderboard_ranking_public_v1@py.leaderboard.fun'
name: 'get_all_time_leaderboard_ranking_public_v1'
type: 'function'
description: |-
Get rankings in an all time leaderboard.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
return_type: 'Tuple[Union[None, ModelsGetLeaderboardRankingResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/get_all_time_leaderboar_358b23.py'
example: |-
result, error = leaderboard.get_all_time_leaderboard_ranking_public_v1(...)
if error:
# handle_error(error)
tags:
- 'all'
- 'data'
- 'get'
- 'leaderboard'
- 'public'
- 'ranking'
- 'time'
- 'v1'
'get_all_time_leaderboard_ranking_public_v2@py.leaderboard.fun':
id: 'get_all_time_leaderboard_ranking_public_v2@py.leaderboard.fun'
name: 'get_all_time_leaderboard_ranking_public_v2'
type: 'function'
description: |-
Get rankings in an all time leaderboard.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
return_type: 'Tuple[Union[None, V2GetPublicLeaderboardRankingResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/get_all_time_leaderboar_9cbcdd.py'
example: |-
result, error = leaderboard.get_all_time_leaderboard_ranking_public_v2(...)
if error:
# handle_error(error)
tags:
- 'all'
- 'data'
- 'get'
- 'leaderboard'
- 'public'
- 'ranking'
- 'time'
- 'v2'
'get_all_time_leaderboard_ranking_public_v3@py.leaderboard.fun':
id: 'get_all_time_leaderboard_ranking_public_v3@py.leaderboard.fun'
name: 'get_all_time_leaderboard_ranking_public_v3'
type: 'function'
description: |-
Get rankings in an all time leaderboard.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
return_type: 'Tuple[Union[None, ModelsGetLeaderboardRankingResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data_v3/get_all_time_leaderboar_5b0d52.py'
example: |-
result, error = leaderboard.get_all_time_leaderboard_ranking_public_v3(...)
if error:
# handle_error(error)
tags:
- 'all'
- 'data'
- 'get'
- 'leaderboard'
- 'public'
- 'ranking'
- 'time'
- 'v3'
'get_archived_leaderboard_ranking_data_v1_handler@py.leaderboard.fun':
id: 'get_archived_leaderboard_ranking_data_v1_handler@py.leaderboard.fun'
name: 'get_archived_leaderboard_ranking_data_v1_handler'
type: 'function'
description: |-
Get signed url in an all time leaderboard that archived. NOTE: This will be a bulk endpoint to get sign url
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'leaderboard_codes':
type: 'str'
required: true
description: |-
list of leaderboard codes split by comma
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'slug':
type: 'Optional[str]'
required: false
description: |-
slug type of leaderboard
return_type: 'Tuple[Union[None, List[ModelsArchiveLeaderboardSignedURLResponse]], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/get_archived_leaderboar_c023ea.py'
example: |-
result, error = leaderboard.get_archived_leaderboard_ranking_data_v1_handler(...)
if error:
# handle_error(error)
tags:
- 'archived'
- 'data'
- 'get'
- 'handler'
- 'leaderboard'
- 'ranking'
- 'v1'
scopes:
- 'social'
'get_current_cycle_leaderboard_ranking_admin_v3@py.leaderboard.fun':
id: 'get_current_cycle_leaderboard_ranking_admin_v3@py.leaderboard.fun'
name: 'get_current_cycle_leaderboard_ranking_admin_v3'
type: 'function'
description: |-
Get rankings in cycle leaderboard.
arguments:
'cycle_id':
type: 'str'
required: true
description: |-
the cycle id
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
return_type: 'Tuple[Union[None, ModelsGetLeaderboardRankingResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data_v3/get_current_cycle_leade_f8a4d7.py'
example: |-
result, error = leaderboard.get_current_cycle_leaderboard_ranking_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'current'
- 'cycle'
- 'data'
- 'get'
- 'leaderboard'
- 'ranking'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_current_cycle_leaderboard_ranking_public_v3@py.leaderboard.fun':
id: 'get_current_cycle_leaderboard_ranking_public_v3@py.leaderboard.fun'
name: 'get_current_cycle_leaderboard_ranking_public_v3'
type: 'function'
description: |-
Get rankings in cycle leaderboard.
arguments:
'cycle_id':
type: 'str'
required: true
description: |-
the cycle id
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
return_type: 'Tuple[Union[None, ModelsGetLeaderboardRankingResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data_v3/get_current_cycle_leade_2c20ce.py'
example: |-
result, error = leaderboard.get_current_cycle_leaderboard_ranking_public_v3(...)
if error:
# handle_error(error)
tags:
- 'current'
- 'cycle'
- 'data'
- 'get'
- 'leaderboard'
- 'public'
- 'ranking'
- 'v3'
'get_current_month_leaderboard_ranking_admin_v1@py.leaderboard.fun':
id: 'get_current_month_leaderboard_ranking_admin_v1@py.leaderboard.fun'
name: 'get_current_month_leaderboard_ranking_admin_v1'
type: 'function'
description: |-
Get rankings in current month leaderboard.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
return_type: 'Tuple[Union[None, ModelsGetLeaderboardRankingResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/get_current_month_leade_26486d.py'
example: |-
result, error = leaderboard.get_current_month_leaderboard_ranking_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'current'
- 'data'
- 'get'
- 'leaderboard'
- 'month'
- 'ranking'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_current_month_leaderboard_ranking_public_v1@py.leaderboard.fun':
id: 'get_current_month_leaderboard_ranking_public_v1@py.leaderboard.fun'
name: 'get_current_month_leaderboard_ranking_public_v1'
type: 'function'
description: |-
Get rankings in current month leaderboard.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
return_type: 'Tuple[Union[None, ModelsGetLeaderboardRankingResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/get_current_month_leade_4373db.py'
example: |-
result, error = leaderboard.get_current_month_leaderboard_ranking_public_v1(...)
if error:
# handle_error(error)
tags:
- 'current'
- 'data'
- 'get'
- 'leaderboard'
- 'month'
- 'public'
- 'ranking'
- 'v1'
'get_current_season_leaderboard_ranking_admin_v1@py.leaderboard.fun':
id: 'get_current_season_leaderboard_ranking_admin_v1@py.leaderboard.fun'
name: 'get_current_season_leaderboard_ranking_admin_v1'
type: 'function'
description: |-
Get rankings in current season leaderboard.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
return_type: 'Tuple[Union[None, ModelsGetLeaderboardRankingResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/get_current_season_lead_a79ffc.py'
example: |-
result, error = leaderboard.get_current_season_leaderboard_ranking_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'current'
- 'data'
- 'get'
- 'leaderboard'
- 'ranking'
- 'season'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_current_season_leaderboard_ranking_public_v1@py.leaderboard.fun':
id: 'get_current_season_leaderboard_ranking_public_v1@py.leaderboard.fun'
name: 'get_current_season_leaderboard_ranking_public_v1'
type: 'function'
description: |-
Get rankings in current season leaderboard.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
return_type: 'Tuple[Union[None, ModelsGetLeaderboardRankingResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/get_current_season_lead_51d992.py'
example: |-
result, error = leaderboard.get_current_season_leaderboard_ranking_public_v1(...)
if error:
# handle_error(error)
tags:
- 'current'
- 'data'
- 'get'
- 'leaderboard'
- 'public'
- 'ranking'
- 'season'
- 'v1'
'get_current_week_leaderboard_ranking_admin_v1@py.leaderboard.fun':
id: 'get_current_week_leaderboard_ranking_admin_v1@py.leaderboard.fun'
name: 'get_current_week_leaderboard_ranking_admin_v1'
type: 'function'
description: |-
Get rankings in current week leaderboard.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
return_type: 'Tuple[Union[None, ModelsGetLeaderboardRankingResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/get_current_week_leader_bdd5ce.py'
example: |-
result, error = leaderboard.get_current_week_leaderboard_ranking_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'current'
- 'data'
- 'get'
- 'leaderboard'
- 'ranking'
- 'v1'
- 'week'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_current_week_leaderboard_ranking_public_v1@py.leaderboard.fun':
id: 'get_current_week_leaderboard_ranking_public_v1@py.leaderboard.fun'
name: 'get_current_week_leaderboard_ranking_public_v1'
type: 'function'
description: |-
Get rankings in current week leaderboard.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
return_type: 'Tuple[Union[None, ModelsGetLeaderboardRankingResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/get_current_week_leader_07d571.py'
example: |-
result, error = leaderboard.get_current_week_leaderboard_ranking_public_v1(...)
if error:
# handle_error(error)
tags:
- 'current'
- 'data'
- 'get'
- 'leaderboard'
- 'public'
- 'ranking'
- 'v1'
- 'week'
'get_hidden_users_v2@py.leaderboard.fun':
id: 'get_hidden_users_v2@py.leaderboard.fun'
name: 'get_hidden_users_v2'
type: 'function'
description: |-
Return hidden users on a leaderboard
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
Leaderboard Code
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
return_type: 'Tuple[Union[None, ModelsGetHiddenUserResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/user_visibility/get_hidden_users_v2.py'
example: |-
result, error = leaderboard.get_hidden_users_v2(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'hidden'
- 'user'
- 'users'
- 'v2'
- 'visibility'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_hidden_users_v3@py.leaderboard.fun':
id: 'get_hidden_users_v3@py.leaderboard.fun'
name: 'get_hidden_users_v3'
type: 'function'
description: |-
Return hidden users on a leaderboard
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
Leaderboard Code
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
return_type: 'Tuple[Union[None, ModelsGetHiddenUserResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/user_visibility_v3/get_hidden_users_v3.py'
example: |-
result, error = leaderboard.get_hidden_users_v3(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'hidden'
- 'user'
- 'users'
- 'v3'
- 'visibility'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_leaderboard_configuration_admin_v1@py.leaderboard.fun':
id: 'get_leaderboard_configuration_admin_v1@py.leaderboard.fun'
name: 'get_leaderboard_configuration_admin_v1'
type: 'function'
description: |-
This endpoint returns a leaderboard configuration
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
human readable unique code to indentify leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsGetLeaderboardConfigResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration/get_leaderboard_configu_dfbf1e.py'
example: |-
result, error = leaderboard.get_leaderboard_configuration_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'get'
- 'leaderboard'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_leaderboard_configuration_admin_v3@py.leaderboard.fun':
id: 'get_leaderboard_configuration_admin_v3@py.leaderboard.fun'
name: 'get_leaderboard_configuration_admin_v3'
type: 'function'
description: |-
This endpoint returns a leaderboard configuration
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
human readable unique code to indentify leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsGetLeaderboardConfigRespV3], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration_v3/get_leaderboard_configu_33150a.py'
example: |-
result, error = leaderboard.get_leaderboard_configuration_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'get'
- 'leaderboard'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_leaderboard_configuration_public_v3@py.leaderboard.fun':
id: 'get_leaderboard_configuration_public_v3@py.leaderboard.fun'
name: 'get_leaderboard_configuration_public_v3'
type: 'function'
description: |-
This endpoint returns a leaderboard configuration
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
human readable unique code to indentify leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsGetLeaderboardConfigPublicRespV3], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration_v3/get_leaderboard_configu_290af8.py'
example: |-
result, error = leaderboard.get_leaderboard_configuration_public_v3(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'get'
- 'leaderboard'
- 'public'
- 'v3'
scopes:
- 'social'
'get_leaderboard_configurations_admin_v1@py.leaderboard.fun':
id: 'get_leaderboard_configurations_admin_v1@py.leaderboard.fun'
name: 'get_leaderboard_configurations_admin_v1'
type: 'function'
description: |-
This endpoint return all leaderboard configurations
arguments:
'is_archived':
type: 'Optional[bool]'
required: false
description: |-
filter for archived leaderboard
'is_deleted':
type: 'Optional[bool]'
required: false
description: |-
filter for deleted leaderboard config
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
return_type: 'Tuple[Union[None, ModelsGetAllLeaderboardConfigsResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration/get_leaderboard_configu_3c85d9.py'
example: |-
result, error = leaderboard.get_leaderboard_configurations_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'configurations'
- 'get'
- 'leaderboard'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_leaderboard_configurations_admin_v3@py.leaderboard.fun':
id: 'get_leaderboard_configurations_admin_v3@py.leaderboard.fun'
name: 'get_leaderboard_configurations_admin_v3'
type: 'function'
description: |-
This endpoint return all leaderboard configurations
arguments:
'is_deleted':
type: 'Optional[bool]'
required: false
description: |-
filter for deleted leaderboard config
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
return_type: 'Tuple[Union[None, ModelsGetAllLeaderboardConfigsRespV3], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration_v3/get_leaderboard_configu_9b2b53.py'
example: |-
result, error = leaderboard.get_leaderboard_configurations_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'configurations'
- 'get'
- 'leaderboard'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_leaderboard_configurations_public_v1@py.leaderboard.fun':
id: 'get_leaderboard_configurations_public_v1@py.leaderboard.fun'
name: 'get_leaderboard_configurations_public_v1'
type: 'function'
description: |-
This endpoint return all leaderboard configurations
arguments:
'is_archived':
type: 'Optional[bool]'
required: false
description: |-
filter for archived leaderboard
'is_deleted':
type: 'Optional[bool]'
required: false
description: |-
filter for deleted leaderboard config
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
return_type: 'Tuple[Union[None, ModelsGetAllLeaderboardConfigsPublicResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration/get_leaderboard_configu_e27832.py'
example: |-
result, error = leaderboard.get_leaderboard_configurations_public_v1(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'configurations'
- 'get'
- 'leaderboard'
- 'public'
- 'v1'
scopes:
- 'social'
'get_leaderboard_configurations_public_v2@py.leaderboard.fun':
id: 'get_leaderboard_configurations_public_v2@py.leaderboard.fun'
name: 'get_leaderboard_configurations_public_v2'
type: 'function'
description: |-
This endpoint return all leaderboard configurations
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
return_type: 'Tuple[Union[None, V2GetAllLeaderboardConfigsPublicResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration/get_leaderboard_configu_d8a38d.py'
example: |-
result, error = leaderboard.get_leaderboard_configurations_public_v2(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'configurations'
- 'get'
- 'leaderboard'
- 'public'
- 'v2'
'get_leaderboard_configurations_public_v3@py.leaderboard.fun':
id: 'get_leaderboard_configurations_public_v3@py.leaderboard.fun'
name: 'get_leaderboard_configurations_public_v3'
type: 'function'
description: |-
This endpoint return all leaderboard configurations
arguments:
'is_deleted':
type: 'Optional[bool]'
required: false
description: |-
filter for deleted leaderboard config
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
return_type: 'Tuple[Union[None, ModelsGetAllLeaderboardConfigsPublicRespV3], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration_v3/get_leaderboard_configu_b16dd3.py'
example: |-
result, error = leaderboard.get_leaderboard_configurations_public_v3(...)
if error:
# handle_error(error)
tags:
- 'configuration'
- 'configurations'
- 'get'
- 'leaderboard'
- 'public'
- 'v3'
scopes:
- 'social'
'get_today_leaderboard_ranking_admin_v1@py.leaderboard.fun':
id: 'get_today_leaderboard_ranking_admin_v1@py.leaderboard.fun'
name: 'get_today_leaderboard_ranking_admin_v1'
type: 'function'
description: |-
Get rankings in today leaderboard.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
return_type: 'Tuple[Union[None, ModelsGetLeaderboardRankingResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/get_today_leaderboard_r_2eefd7.py'
example: |-
result, error = leaderboard.get_today_leaderboard_ranking_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'get'
- 'leaderboard'
- 'ranking'
- 'today'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_today_leaderboard_ranking_public_v1@py.leaderboard.fun':
id: 'get_today_leaderboard_ranking_public_v1@py.leaderboard.fun'
name: 'get_today_leaderboard_ranking_public_v1'
type: 'function'
description: |-
Get rankings in today leaderboard.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
return_type: 'Tuple[Union[None, ModelsGetLeaderboardRankingResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/get_today_leaderboard_r_51cbb5.py'
example: |-
result, error = leaderboard.get_today_leaderboard_ranking_public_v1(...)
if error:
# handle_error(error)
tags:
- 'data'
- 'get'
- 'leaderboard'
- 'public'
- 'ranking'
- 'today'
- 'v1'
'get_user_leaderboard_rankings_admin_v1@py.leaderboard.fun':
id: 'get_user_leaderboard_rankings_admin_v1@py.leaderboard.fun'
name: 'get_user_leaderboard_rankings_admin_v1'
type: 'function'
description: |-
Get user leaderboard rankings
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, > 1 will be archived/history leaderboard data. Currently only support 1 previous version, default value will be 0 (active leaderboard)
'user_id':
type: 'str'
required: true
description: |-
User ID
return_type: 'Tuple[Union[None, ModelsGetAllUserLeaderboardsResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/user_data/get_user_leaderboard_ra_d2aae2.py'
example: |-
result, error = leaderboard.get_user_leaderboard_rankings_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'get'
- 'leaderboard'
- 'rankings'
- 'user'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_user_leaderboard_rankings_admin_v3@py.leaderboard.fun':
id: 'get_user_leaderboard_rankings_admin_v3@py.leaderboard.fun'
name: 'get_user_leaderboard_rankings_admin_v3'
type: 'function'
description: |-
Get user leaderboard rankings
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
size of displayed data
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
The start position that points to query data
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
'user_id':
type: 'str'
required: true
description: |-
User ID
return_type: 'Tuple[Union[None, ModelsGetAllUserLeaderboardsRespV3], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/user_data_v3/get_user_leaderboard_ra_e5b21a.py'
example: |-
result, error = leaderboard.get_user_leaderboard_rankings_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'get'
- 'leaderboard'
- 'rankings'
- 'user'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_user_ranking_admin_v1@py.leaderboard.fun':
id: 'get_user_ranking_admin_v1@py.leaderboard.fun'
name: 'get_user_ranking_admin_v1'
type: 'function'
description: |-
Get user ranking in leaderboard
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
'user_id':
type: 'str'
required: true
description: |-
User ID
return_type: 'Tuple[Union[None, ModelsUserRankingResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/get_user_ranking_admin_v1.py'
example: |-
result, error = leaderboard.get_user_ranking_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'get'
- 'leaderboard'
- 'ranking'
- 'user'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_user_ranking_admin_v3@py.leaderboard.fun':
id: 'get_user_ranking_admin_v3@py.leaderboard.fun'
name: 'get_user_ranking_admin_v3'
type: 'function'
description: |-
Get user ranking in leaderboard
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
'user_id':
type: 'str'
required: true
description: |-
User ID
return_type: 'Tuple[Union[None, ModelsUserRankingResponseV3], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data_v3/get_user_ranking_admin_v3.py'
example: |-
result, error = leaderboard.get_user_ranking_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'get'
- 'leaderboard'
- 'ranking'
- 'user'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_user_ranking_public_v1@py.leaderboard.fun':
id: 'get_user_ranking_public_v1@py.leaderboard.fun'
name: 'get_user_ranking_public_v1'
type: 'function'
description: |-
Get user ranking in leaderboard
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
'user_id':
type: 'str'
required: true
description: |-
User ID
return_type: 'Tuple[Union[None, ModelsUserRankingResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/get_user_ranking_public_v1.py'
example: |-
result, error = leaderboard.get_user_ranking_public_v1(...)
if error:
# handle_error(error)
tags:
- 'data'
- 'get'
- 'leaderboard'
- 'public'
- 'ranking'
- 'user'
- 'v1'
scopes:
- 'social'
'get_user_ranking_public_v3@py.leaderboard.fun':
id: 'get_user_ranking_public_v3@py.leaderboard.fun'
name: 'get_user_ranking_public_v3'
type: 'function'
description: |-
Get user ranking in leaderboard
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'previous_version':
type: 'Optional[int]'
required: false
description: |-
Specify specific version of leaderboard data, If the value of version is more than 0, it’ll retrieve the achieved history of leaderboard data. For example, if value of PreviousVersionParam is 1, means it’ll fetch one previous version. Currently only support 1 previous version, default value will be 0 (active leaderboard)
'user_id':
type: 'str'
required: true
description: |-
User ID
return_type: 'Tuple[Union[None, ModelsUserRankingResponseV3], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data_v3/get_user_ranking_public_v3.py'
example: |-
result, error = leaderboard.get_user_ranking_public_v3(...)
if error:
# handle_error(error)
tags:
- 'data'
- 'get'
- 'leaderboard'
- 'public'
- 'ranking'
- 'user'
- 'v3'
scopes:
- 'social'
'get_user_visibility_status_v2@py.leaderboard.fun':
id: 'get_user_visibility_status_v2@py.leaderboard.fun'
name: 'get_user_visibility_status_v2'
type: 'function'
description: |-
User with false visibility status will have hidden attribute set to true on it's leaderboard entry
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
Leaderboard 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, ModelsGetUserVisibilityResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/user_visibility/get_user_visibility_status_v2.py'
example: |-
result, error = leaderboard.get_user_visibility_status_v2(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'status'
- 'user'
- 'v2'
- 'visibility'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:LEADERBOARD [READ]'
scopes:
- 'social'
'get_user_visibility_status_v3@py.leaderboard.fun':
id: 'get_user_visibility_status_v3@py.leaderboard.fun'
name: 'get_user_visibility_status_v3'
type: 'function'
description: |-
User with false visibility status will have hidden attribute set to true on it's leaderboard entry
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
Leaderboard 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, ModelsGetUserVisibilityResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/user_visibility_v3/get_user_visibility_status_v3.py'
example: |-
result, error = leaderboard.get_user_visibility_status_v3(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'status'
- 'user'
- 'v3'
- 'visibility'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:LEADERBOARD [READ]'
scopes:
- 'social'
'hard_delete_leaderboard_admin_v1@py.leaderboard.fun':
id: 'hard_delete_leaderboard_admin_v1@py.leaderboard.fun'
name: 'hard_delete_leaderboard_admin_v1'
type: 'function'
description: |-
[Test Facility Only]
Required permission 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD:HARDDELETE [DELETE]'
This endpoint will delete leaderboard configuration and its data
Note: this endpoint only works on development environment, you might want to use archive endpoint instead hard delete.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
human readable unique code to indentify leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration/hard_delete_leaderboard_e07e01.py'
example: |-
result, error = leaderboard.hard_delete_leaderboard_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'delete'
- 'hard'
- 'leaderboard'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD:HARDDELETE [DELETE]'
scopes:
- 'social'
'hard_delete_leaderboard_admin_v3@py.leaderboard.fun':
id: 'hard_delete_leaderboard_admin_v3@py.leaderboard.fun'
name: 'hard_delete_leaderboard_admin_v3'
type: 'function'
description: |-
[Test Facility Only]
Required permission 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD:HARDDELETE [DELETE]'
This endpoint will delete leaderboard configuration and its data
Note: this endpoint only works on development environment, you might want to use archive endpoint instead hard delete.
arguments:
'leaderboard_code':
type: 'str'
required: true
description: |-
human readable unique code to indentify leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration_v3/hard_delete_leaderboard_c58ff0.py'
example: |-
result, error = leaderboard.hard_delete_leaderboard_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'delete'
- 'hard'
- 'leaderboard'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [DELETE]'
scopes:
- 'social'
'set_user_leaderboard_visibility_status_v2@py.leaderboard.fun':
id: 'set_user_leaderboard_visibility_status_v2@py.leaderboard.fun'
name: 'set_user_leaderboard_visibility_status_v2'
type: 'function'
description: |-
User with false visibility status will have hidden attribute set to true on it's leaderboard entry
arguments:
'body':
type: 'ModelsSetUserVisibilityRequest'
required: true
'leaderboard_code':
type: 'str'
required: true
description: |-
Leaderboard 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, ModelsGetUserVisibilityResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/user_visibility/set_user_leaderboard_vi_7b0546.py'
example: |-
result, error = leaderboard.set_user_leaderboard_visibility_status_v2(...)
if error:
# handle_error(error)
tags:
- 'leaderboard'
- 'set'
- 'status'
- 'user'
- 'v2'
- 'visibility'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:LEADERBOARD [UPDATE]'
scopes:
- 'social'
'set_user_leaderboard_visibility_v3@py.leaderboard.fun':
id: 'set_user_leaderboard_visibility_v3@py.leaderboard.fun'
name: 'set_user_leaderboard_visibility_v3'
type: 'function'
description: |-
User with false visibility status will have hidden attribute set to true on it's leaderboard entry
arguments:
'body':
type: 'ModelsSetUserVisibilityRequest'
required: true
'leaderboard_code':
type: 'str'
required: true
description: |-
Leaderboard 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, ModelsGetUserVisibilityResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/user_visibility_v3/set_user_leaderboard_vi_da19f8.py'
example: |-
result, error = leaderboard.set_user_leaderboard_visibility_v3(...)
if error:
# handle_error(error)
tags:
- 'leaderboard'
- 'set'
- 'user'
- 'v3'
- 'visibility'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:LEADERBOARD [UPDATE]'
scopes:
- 'social'
'set_user_visibility_status_v2@py.leaderboard.fun':
id: 'set_user_visibility_status_v2@py.leaderboard.fun'
name: 'set_user_visibility_status_v2'
type: 'function'
description: |-
User with false visibility status will have hidden attribute set to true on it's leaderboard entry
arguments:
'body':
type: 'ModelsSetUserVisibilityRequest'
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, ModelsGetUserVisibilityResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/user_visibility/set_user_visibility_status_v2.py'
example: |-
result, error = leaderboard.set_user_visibility_status_v2(...)
if error:
# handle_error(error)
tags:
- 'set'
- 'status'
- 'user'
- 'v2'
- 'visibility'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:LEADERBOARD [UPDATE]'
scopes:
- 'social'
'set_user_visibility_v3@py.leaderboard.fun':
id: 'set_user_visibility_v3@py.leaderboard.fun'
name: 'set_user_visibility_v3'
type: 'function'
description: |-
User with false visibility status will have hidden attribute set to true on it's leaderboard entry
arguments:
'body':
type: 'ModelsSetUserVisibilityRequest'
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, ModelsGetUserVisibilityResponse], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/user_visibility_v3/set_user_visibility_v3.py'
example: |-
result, error = leaderboard.set_user_visibility_v3(...)
if error:
# handle_error(error)
tags:
- 'set'
- 'user'
- 'v3'
- 'visibility'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:LEADERBOARD [UPDATE]'
scopes:
- 'social'
'update_leaderboard_configuration_admin_v1@py.leaderboard.fun':
id: 'update_leaderboard_configuration_admin_v1@py.leaderboard.fun'
name: 'update_leaderboard_configuration_admin_v1'
type: 'function'
description: |-
Fields :
* Maximum length for leaderboard name is 128 characters.
* Start time must be follow RFC3339 standard. e.g. 2020-10-02T15:00:00.05Z
* Season period must be greater than 31 days.
* If seasonPeriod is filled, the LeaderboardConfig would have seasonal leaderboard.
* Reset Date must be a number 1 - 31. Default is '1'.
* Reset Day must be a number 0 - 6. 0 = Sunday, 1 = Monday, 2 = Tuesday, 3 = Wednesday, 4 = Thursday, 5 = Friday, 6 = Saturday (day of week). Default is '0'.
* Reset time must be hours:minutes in 24 hours format e.g. 01:30, 10:30, 15:30, 23:15.
arguments:
'body':
type: 'ModelsUpdateLeaderboardConfigReq'
required: true
'leaderboard_code':
type: 'str'
required: true
description: |-
human readable unique code to indentify leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsGetLeaderboardConfigResp], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration/update_leaderboard_conf_ca626e.py'
example: |-
result, error = leaderboard.update_leaderboard_configuration_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'leaderboard'
- 'update'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [UPDATE]'
scopes:
- 'social'
'update_leaderboard_configuration_admin_v3@py.leaderboard.fun':
id: 'update_leaderboard_configuration_admin_v3@py.leaderboard.fun'
name: 'update_leaderboard_configuration_admin_v3'
type: 'function'
description: |-
Fields :
* leaderboardCode: unique leaderboard config code must be lowercase and maximum length is 48 characters. (required).
* name: leaderboard name, maximum length for leaderboard name is 128 characters. (required).
* description: leaderboard description, maximum length for leaderboard description is 2048 characters. (optional).
* iconURL: leaderboard icon image url. (optional).
* allTime: if true, all time leaderboard will be created. (required).
* descending: leaderboard order. If true, the points will be sorted in descending order. (required).
* statCode: Stat Code is related with statistic code in statistic service. (required).
* cycleIds: Statistic cycle ids that will be tracked in the leaderboard. (required).
arguments:
'body':
type: 'ModelsUpdateLeaderboardConfigReqV3'
required: true
'leaderboard_code':
type: 'str'
required: true
description: |-
human readable unique code to indentify leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsGetLeaderboardConfigRespV3], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_configuration_v3/update_leaderboard_conf_1b8e6b.py'
example: |-
result, error = leaderboard.update_leaderboard_configuration_admin_v3(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'leaderboard'
- 'update'
- 'v3'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [UPDATE]'
scopes:
- 'social'
'update_user_point_admin_v1@py.leaderboard.fun':
id: 'update_user_point_admin_v1@py.leaderboard.fun'
name: 'update_user_point_admin_v1'
type: 'function'
description: |-
Update user point in a leaderboard. This endpoint uses for test utility only.
Other detail info:
* Returns: user ranking
arguments:
'body':
type: 'ModelsUpdateUserPointAdminV1Request'
required: true
'leaderboard_code':
type: 'str'
required: true
description: |-
the human readable unique code to identify the leaderboard. Must be lowercase and maximum length is 48
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'user_id':
type: 'str'
required: true
description: |-
User ID, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, ModelsUpdateUserPointAdminV1Response], Union[None, HttpResponse, ResponseErrorResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.leaderboard as leaderboard'
- 'import accelbyte_py_sdk.api.leaderboard.models as leaderboard_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/leaderboard/operations/leaderboard_data/update_user_point_admin_v1.py'
example: |-
result, error = leaderboard.update_user_point_admin_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'data'
- 'leaderboard'
- 'point'
- 'update'
- 'user'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:LEADERBOARD [UPDATE]'
scopes:
- 'social'
# endregion functions
