symbols:
# region models
'BulkUserProgressionRequest@py.seasonpass.mod':
id: 'BulkUserProgressionRequest@py.seasonpass.mod'
name: 'BulkUserProgressionRequest'
type: 'model'
fields:
'user_ids':
type: 'List[str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/bulk_user_progression_request.py'
example: |-
bulk_user_progression_request = seasonpass_models.BulkUserProgressionRequest.create(...)
'ClaimableRewards@py.seasonpass.mod':
id: 'ClaimableRewards@py.seasonpass.mod'
name: 'ClaimableRewards'
type: 'model'
description: |-
A DTO object for claimable rewards.
fields:
'claiming_rewards':
type: 'Dict[str, Any]'
required: true
description: |-
Claiming rewards, zero based tier index as key, rewards per pass as value
'to_claim_rewards':
type: 'Dict[str, Any]'
required: true
description: |-
To claim rewards, zero based tier index as key, rewards per pass as value
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/claimable_rewards.py'
example: |-
claimable_rewards = seasonpass_models.ClaimableRewards.create(...)
'ClaimableUserSeasonInfo@py.seasonpass.mod':
id: 'ClaimableUserSeasonInfo@py.seasonpass.mod'
name: 'ClaimableUserSeasonInfo'
type: 'model'
description: |-
A DTO object for claimable user season data.
fields:
'claiming_rewards':
type: 'Dict[str, Any]'
required: true
description: |-
Claiming rewards, zero based tier index as key, rewards per pass as value
'cleared':
type: 'bool'
required: true
description: |-
whether cleared all tiers
'created_at':
type: 'str'
required: true
description: |-
created at
'current_exp':
type: 'int'
required: true
description: |-
gained exp for current tier
'current_tier_index':
type: 'int'
required: true
description: |-
current tier index, zero based
'enrolled_at':
type: 'str'
required: true
description: |-
enroll date time
'enrolled_passes':
type: 'List[str]'
required: true
description: |-
enrolled passes
'id_':
type: 'str'
required: true
description: |-
id
'last_tier_index':
type: 'int'
required: true
description: |-
last tier index, zero based
'namespace':
type: 'str'
required: true
description: |-
namespace
'required_exp':
type: 'int'
required: true
description: |-
required exp for current tier
'season_id':
type: 'str'
required: true
description: |-
season id
'to_claim_rewards':
type: 'Dict[str, Any]'
required: true
description: |-
To claim rewards, zero based tier index as key, rewards per pass as value
'updated_at':
type: 'str'
required: true
description: |-
updated at
'user_id':
type: 'str'
required: true
description: |-
user id
'season':
type: 'SeasonSummary'
required: false
description: |-
season summary
'total_exp':
type: 'int'
required: false
description: |-
total exp
'total_paid_for_exp':
type: 'int'
required: false
description: |-
total paid-for exp
'total_sweat_exp':
type: 'int'
required: false
description: |-
total sweat exp
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/claimable_user_season_info.py'
example: |-
claimable_user_season_info = seasonpass_models.ClaimableUserSeasonInfo.create(...)
'ErrorEntity@py.seasonpass.mod':
id: 'ErrorEntity@py.seasonpass.mod'
name: 'ErrorEntity'
type: 'model'
fields:
'error_code':
type: 'int'
required: true
description: |-
numeric error code
'error_message':
type: 'str'
required: true
description: |-
error message
'dev_stack_trace':
type: 'str'
required: false
description: |-
internal server error stack trace in configured environment
'message_variables':
type: 'Dict[str, str]'
required: false
description: |-
message variables
'required_permission':
type: 'Permission'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/error_entity.py'
example: |-
error_entity = seasonpass_models.ErrorEntity.create(...)
'ExcessStrategy@py.seasonpass.mod':
id: 'ExcessStrategy@py.seasonpass.mod'
name: 'ExcessStrategy'
type: 'model'
fields:
'method':
type: 'Union[str, MethodEnum]'
required: true
description: |-
method while excess the final tier exp
'currency':
type: 'str'
required: false
description: |-
virtual currency for grant, required while method is CURRENCY
'percent_per_exp':
type: 'int'
required: false
description: |-
percent per exp, required while method is CURRENCY
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/excess_strategy.py'
example: |-
excess_strategy = seasonpass_models.ExcessStrategy.create(...)
'ExpGrantHistoryInfo@py.seasonpass.mod':
id: 'ExpGrantHistoryInfo@py.seasonpass.mod'
name: 'ExpGrantHistoryInfo'
type: 'model'
description: |-
A DTO object for exp grant history details.
fields:
'created_at':
type: 'str'
required: true
description: |-
acquired at
'grant_exp':
type: 'int'
required: true
description: |-
grant exp
'id_':
type: 'str'
required: true
description: |-
id
'namespace':
type: 'str'
required: true
description: |-
namespace
'season_id':
type: 'str'
required: true
description: |-
season id
'user_id':
type: 'str'
required: true
description: |-
user id
'source':
type: 'Union[str, SourceEnum]'
required: false
description: |-
id
'tags':
type: 'List[str]'
required: false
description: |-
id
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/exp_grant_history_info.py'
example: |-
exp_grant_history_info = seasonpass_models.ExpGrantHistoryInfo.create(...)
'ExpGrantHistoryPagingSlicedResult@py.seasonpass.mod':
id: 'ExpGrantHistoryPagingSlicedResult@py.seasonpass.mod'
name: 'ExpGrantHistoryPagingSlicedResult'
type: 'model'
fields:
'data':
type: 'List[ExpGrantHistoryInfo]'
required: true
description: |-
data
'paging':
type: 'Paging'
required: false
'total':
type: 'int'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/exp_grant_history_paging_sliced_result.py'
example: |-
exp_grant_history_paging_sliced_result = seasonpass_models.ExpGrantHistoryPagingSlicedResult.create(...)
'FieldValidationError@py.seasonpass.mod':
id: 'FieldValidationError@py.seasonpass.mod'
name: 'FieldValidationError'
type: 'model'
fields:
'error_code':
type: 'str'
required: false
'error_field':
type: 'str'
required: false
'error_message':
type: 'str'
required: false
'error_value':
type: 'str'
required: false
'message_variables':
type: 'Dict[str, str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/field_validation_error.py'
example: |-
field_validation_error = seasonpass_models.FieldValidationError.create(...)
'FullSeasonInfo@py.seasonpass.mod':
id: 'FullSeasonInfo@py.seasonpass.mod'
name: 'FullSeasonInfo'
type: 'model'
description: |-
A DTO object for season full content.
fields:
'id_':
type: 'str'
required: true
description: |-
id
'localizations':
type: 'Dict[str, Localization]'
required: true
description: |-
localization, {language: localization} map
'name':
type: 'str'
required: true
description: |-
name, max length is 127
'namespace':
type: 'str'
required: true
description: |-
namespace
'passes':
type: 'List[PassInfo]'
required: true
description: |-
passes info
'rewards':
type: 'Dict[str, RewardInfo]'
required: true
description: |-
rewards info
'tiers':
type: 'List[Tier]'
required: true
description: |-
tiers info
'images':
type: 'List[Image]'
required: false
description: |-
images
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/full_season_info.py'
example: |-
full_season_info = seasonpass_models.FullSeasonInfo.create(...)
'Image@py.seasonpass.mod':
id: 'Image@py.seasonpass.mod'
name: 'Image'
type: 'model'
fields:
'height':
type: 'int'
required: true
description: |-
height
'image_url':
type: 'str'
required: true
description: |-
imageUrl
'width':
type: 'int'
required: true
description: |-
width
'as_':
type: 'str'
required: false
description: |-
image for
'caption':
type: 'str'
required: false
description: |-
image caption
'small_image_url':
type: 'str'
required: false
description: |-
smallImageUrl
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/image.py'
example: |-
image = seasonpass_models.Image.create(...)
'ItemReference@py.seasonpass.mod':
id: 'ItemReference@py.seasonpass.mod'
name: 'ItemReference'
type: 'model'
description: |-
A DTO object for item references.
fields:
'module':
type: 'str'
required: false
description: |-
module
'references':
type: 'List[Dict[str, Any]]'
required: false
description: |-
references
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/item_reference.py'
example: |-
item_reference = seasonpass_models.ItemReference.create(...)
'ItemReferenceInfo@py.seasonpass.mod':
id: 'ItemReferenceInfo@py.seasonpass.mod'
name: 'ItemReferenceInfo'
type: 'model'
description: |-
A DTO object for item references info.
fields:
'references':
type: 'List[ItemReference]'
required: false
description: |-
item references
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/item_reference_info.py'
example: |-
item_reference_info = seasonpass_models.ItemReferenceInfo.create(...)
'ListSeasonInfo@py.seasonpass.mod':
id: 'ListSeasonInfo@py.seasonpass.mod'
name: 'ListSeasonInfo'
type: 'model'
description: |-
A DTO object for listing season info.
fields:
'created_at':
type: 'str'
required: true
description: |-
created at
'default_language':
type: 'str'
required: true
description: |-
default language, BCP 47 language tag
'end':
type: 'str'
required: true
description: |-
end date time
'id_':
type: 'str'
required: true
description: |-
id
'name':
type: 'str'
required: true
description: |-
name, max length is 127
'namespace':
type: 'str'
required: true
description: |-
namespace
'start':
type: 'str'
required: true
description: |-
start date time
'status':
type: 'Union[str, StatusEnum]'
required: true
description: |-
status
'tier_item_id':
type: 'str'
required: true
description: |-
tier item id
'tier_item_name':
type: 'str'
required: true
description: |-
tier item name
'updated_at':
type: 'str'
required: true
description: |-
updated at
'pass_codes':
type: 'List[str]'
required: false
description: |-
pass codes
'published_at':
type: 'str'
required: false
description: |-
publishedAt
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/list_season_info.py'
example: |-
list_season_info = seasonpass_models.ListSeasonInfo.create(...)
'ListSeasonInfoPagingSlicedResult@py.seasonpass.mod':
id: 'ListSeasonInfoPagingSlicedResult@py.seasonpass.mod'
name: 'ListSeasonInfoPagingSlicedResult'
type: 'model'
fields:
'data':
type: 'List[ListSeasonInfo]'
required: true
description: |-
data
'paging':
type: 'Paging'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/list_season_info_paging_sliced_result.py'
example: |-
list_season_info_paging_sliced_result = seasonpass_models.ListSeasonInfoPagingSlicedResult.create(...)
'ListUserSeasonInfo@py.seasonpass.mod':
id: 'ListUserSeasonInfo@py.seasonpass.mod'
name: 'ListUserSeasonInfo'
type: 'model'
description: |-
A DTO object for listing user season data.
fields:
'cleared':
type: 'bool'
required: true
description: |-
whether cleared all tiers
'current_tier_index':
type: 'int'
required: true
description: |-
current tier index, zero based
'enrolled_at':
type: 'str'
required: true
description: |-
enroll date time
'id_':
type: 'str'
required: true
description: |-
id
'last_tier_index':
type: 'int'
required: true
description: |-
last tier index, zero based
'namespace':
type: 'str'
required: true
description: |-
namespace
'season_id':
type: 'str'
required: true
description: |-
season id
'user_id':
type: 'str'
required: true
description: |-
user id
'season':
type: 'SeasonSummary'
required: false
description: |-
season summary
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/list_user_season_info.py'
example: |-
list_user_season_info = seasonpass_models.ListUserSeasonInfo.create(...)
'ListUserSeasonInfoPagingSlicedResult@py.seasonpass.mod':
id: 'ListUserSeasonInfoPagingSlicedResult@py.seasonpass.mod'
name: 'ListUserSeasonInfoPagingSlicedResult'
type: 'model'
fields:
'data':
type: 'List[ListUserSeasonInfo]'
required: true
description: |-
data
'paging':
type: 'Paging'
required: false
'total':
type: 'int'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/list_user_season_info_paging_sliced_result.py'
example: |-
list_user_season_info_paging_sliced_result = seasonpass_models.ListUserSeasonInfoPagingSlicedResult.create(...)
'Localization@py.seasonpass.mod':
id: 'Localization@py.seasonpass.mod'
name: 'Localization'
type: 'model'
fields:
'description':
type: 'str'
required: false
description: |-
description info
'title':
type: 'str'
required: false
description: |-
title info
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/localization.py'
example: |-
localization = seasonpass_models.Localization.create(...)
'LocalizedPassInfo@py.seasonpass.mod':
id: 'LocalizedPassInfo@py.seasonpass.mod'
name: 'LocalizedPassInfo'
type: 'model'
description: |-
A DTO object for public user retrieving pass info.
fields:
'auto_enroll':
type: 'bool'
required: true
description: |-
autoEnroll
'code':
type: 'str'
required: true
description: |-
code
'created_at':
type: 'str'
required: true
description: |-
created at
'display_order':
type: 'str'
required: true
description: |-
displayOrder
'language':
type: 'str'
required: true
description: |-
current language
'namespace':
type: 'str'
required: true
description: |-
namespace
'pass_item_id':
type: 'str'
required: true
description: |-
pass item id
'season_id':
type: 'str'
required: true
description: |-
season id
'updated_at':
type: 'str'
required: true
description: |-
updated at
'description':
type: 'str'
required: false
description: |-
description info
'images':
type: 'List[Image]'
required: false
description: |-
images
'title':
type: 'str'
required: false
description: |-
title info
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/localized_pass_info.py'
example: |-
localized_pass_info = seasonpass_models.LocalizedPassInfo.create(...)
'LocalizedSeasonInfo@py.seasonpass.mod':
id: 'LocalizedSeasonInfo@py.seasonpass.mod'
name: 'LocalizedSeasonInfo'
type: 'model'
description: |-
A DTO object for public user retrieving season info.
fields:
'auto_claim':
type: 'bool'
required: true
description: |-
whether auto claim rewards
'created_at':
type: 'str'
required: true
description: |-
created at
'end':
type: 'str'
required: true
description: |-
end date time
'id_':
type: 'str'
required: true
description: |-
id
'language':
type: 'str'
required: true
description: |-
current language
'name':
type: 'str'
required: true
description: |-
name, max length is 127
'namespace':
type: 'str'
required: true
description: |-
namespace
'passes':
type: 'List[LocalizedPassInfo]'
required: true
description: |-
passes info
'rewards':
type: 'Dict[str, RewardInfo]'
required: true
description: |-
rewards info
'start':
type: 'str'
required: true
description: |-
start date time
'status':
type: 'Union[str, StatusEnum]'
required: true
description: |-
status
'tier_item_id':
type: 'str'
required: true
description: |-
tier item id
'tiers':
type: 'List[Tier]'
required: true
description: |-
tiers info
'updated_at':
type: 'str'
required: true
description: |-
updated at
'description':
type: 'str'
required: false
description: |-
description info
'images':
type: 'List[Image]'
required: false
description: |-
images
'pass_codes':
type: 'List[str]'
required: false
description: |-
pass codes
'published_at':
type: 'str'
required: false
description: |-
publishedAt
'title':
type: 'str'
required: false
description: |-
title info
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/localized_season_info.py'
example: |-
localized_season_info = seasonpass_models.LocalizedSeasonInfo.create(...)
'Ownership@py.seasonpass.mod':
id: 'Ownership@py.seasonpass.mod'
name: 'Ownership'
type: 'model'
fields:
'owned':
type: 'bool'
required: true
description: |-
ownership
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/ownership.py'
example: |-
ownership = seasonpass_models.Ownership.create(...)
'Paging@py.seasonpass.mod':
id: 'Paging@py.seasonpass.mod'
name: 'Paging'
type: 'model'
fields:
'next_':
type: 'str'
required: false
'previous':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/paging.py'
example: |-
paging = seasonpass_models.Paging.create(...)
'PassCreate@py.seasonpass.mod':
id: 'PassCreate@py.seasonpass.mod'
name: 'PassCreate'
type: 'model'
description: |-
A DTO object for creating pass API call.
fields:
'code':
type: 'str'
required: true
description: |-
code, allowed characters from a-z0-9_:- and start/end in alphanumeric, max length is 255
'display_order':
type: 'int'
required: true
description: |-
displayOrder for frontend to arrange the pass
'localizations':
type: 'Dict[str, Localization]'
required: true
description: |-
localization, {language: localization} map
'pass_item_id':
type: 'str'
required: true
description: |-
pass item id
'auto_enroll':
type: 'bool'
required: false
description: |-
autoEnroll for free pass, default false
'images':
type: 'List[Image]'
required: false
description: |-
images
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/pass_create.py'
example: |-
pass_create = seasonpass_models.PassCreate.create(...)
'PassInfo@py.seasonpass.mod':
id: 'PassInfo@py.seasonpass.mod'
name: 'PassInfo'
type: 'model'
description: |-
A DTO object for pass info.
fields:
'auto_enroll':
type: 'bool'
required: true
description: |-
autoEnroll
'code':
type: 'str'
required: true
description: |-
code
'created_at':
type: 'str'
required: true
description: |-
created at
'display_order':
type: 'str'
required: true
description: |-
displayOrder
'localizations':
type: 'Dict[str, Localization]'
required: true
description: |-
localization, {language: localization} map
'namespace':
type: 'str'
required: true
description: |-
namespace
'pass_item_id':
type: 'str'
required: true
description: |-
pass item id
'pass_item_name':
type: 'str'
required: true
description: |-
pass item name
'season_id':
type: 'str'
required: true
description: |-
season id
'updated_at':
type: 'str'
required: true
description: |-
updated at
'images':
type: 'List[Image]'
required: false
description: |-
images
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/pass_info.py'
example: |-
pass_info = seasonpass_models.PassInfo.create(...)
'PassUpdate@py.seasonpass.mod':
id: 'PassUpdate@py.seasonpass.mod'
name: 'PassUpdate'
type: 'model'
description: |-
A DTO object for updating pass API call.
fields:
'auto_enroll':
type: 'bool'
required: false
description: |-
autoEnroll for free pass
'display_order':
type: 'int'
required: false
description: |-
displayOrder for frontend to arrange the pass
'images':
type: 'List[Image]'
required: false
description: |-
images
'localizations':
type: 'Dict[str, Localization]'
required: false
description: |-
localization, {language: localization} map
'pass_item_id':
type: 'str'
required: false
description: |-
pass item id
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/pass_update.py'
example: |-
pass_update = seasonpass_models.PassUpdate.create(...)
'Permission@py.seasonpass.mod':
id: 'Permission@py.seasonpass.mod'
name: 'Permission'
type: 'model'
fields:
'action':
type: 'int'
required: false
'resource':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/permission.py'
example: |-
permission = seasonpass_models.Permission.create(...)
'ReasonTagsResult@py.seasonpass.mod':
id: 'ReasonTagsResult@py.seasonpass.mod'
name: 'ReasonTagsResult'
type: 'model'
description: |-
A DTO object for reason tags.
fields:
'tags':
type: 'List[str]'
required: true
description: |-
tags
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/reason_tags_result.py'
example: |-
reason_tags_result = seasonpass_models.ReasonTagsResult.create(...)
'RewardCreate@py.seasonpass.mod':
id: 'RewardCreate@py.seasonpass.mod'
name: 'RewardCreate'
type: 'model'
description: |-
A DTO object for creating reward API call.
fields:
'code':
type: 'str'
required: true
description: |-
code, allowed characters from a-z0-9_:- and start/end in alphanumeric, max length is 255
'type_':
type: 'Union[str, TypeEnum]'
required: true
description: |-
type, at current only support ITEM
'currency':
type: 'RewardCurrency'
required: false
description: |-
currency, required when reward type is CURRENCY
'image':
type: 'Image'
required: false
description: |-
image, thumbnail for reward
'item_id':
type: 'str'
required: false
description: |-
itemId, required when reward type is ITEM, the item type should be one of: INGAMEITEM,COINS,BUNDLE
'quantity':
type: 'int'
required: false
description: |-
Item quantity or Currency amount, default 1
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/reward_create.py'
example: |-
reward_create = seasonpass_models.RewardCreate.create(...)
'RewardCurrency@py.seasonpass.mod':
id: 'RewardCurrency@py.seasonpass.mod'
name: 'RewardCurrency'
type: 'model'
description: |-
A DTO object for reward currency.
fields:
'currency_code':
type: 'str'
required: true
description: |-
currency code, alphabet uppercase
'namespace':
type: 'str'
required: true
description: |-
namespace, allowed values: game namespace or publisher namespace
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/reward_currency.py'
example: |-
reward_currency = seasonpass_models.RewardCurrency.create(...)
'RewardInfo@py.seasonpass.mod':
id: 'RewardInfo@py.seasonpass.mod'
name: 'RewardInfo'
type: 'model'
description: |-
A DTO object for reward info.
fields:
'code':
type: 'str'
required: true
description: |-
code
'namespace':
type: 'str'
required: true
description: |-
namespace
'season_id':
type: 'str'
required: true
description: |-
seasonId
'type_':
type: 'Union[str, TypeEnum]'
required: true
description: |-
type
'currency':
type: 'RewardCurrency'
required: false
description: |-
currency, required when reward type is CURRENCY
'image':
type: 'Image'
required: false
description: |-
image, thumbnail for reward
'item_id':
type: 'str'
required: false
description: |-
itemId, required when reward type is ITEM
'item_name':
type: 'str'
required: false
description: |-
itemName, required when reward type is ITEM
'item_sku':
type: 'str'
required: false
description: |-
itemSku, required when reward type is ITEM
'item_type':
type: 'Union[str, ItemTypeEnum]'
required: false
description: |-
itemType, required when reward type is ITEM
'quantity':
type: 'int'
required: false
description: |-
Item quantity or Currency amount, default 1
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/reward_info.py'
example: |-
reward_info = seasonpass_models.RewardInfo.create(...)
'RewardUpdate@py.seasonpass.mod':
id: 'RewardUpdate@py.seasonpass.mod'
name: 'RewardUpdate'
type: 'model'
description: |-
A DTO object for updating reward API call.
fields:
'currency':
type: 'RewardCurrency'
required: false
description: |-
currency, required when reward type is CURRENCY
'image':
type: 'Image'
required: false
description: |-
image, thumbnail for reward
'item_id':
type: 'str'
required: false
description: |-
itemId, required when reward type is ITEM, the item type should be one of: INGAMEITEM,COINS,BUNDLE
'null_fields':
type: 'List[str]'
required: false
description: |-
nullFields
'quantity':
type: 'int'
required: false
description: |-
Item quantity or Currency amount, default 1
'type_':
type: 'Union[str, TypeEnum]'
required: false
description: |-
type, at current only support ITEM
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/reward_update.py'
example: |-
reward_update = seasonpass_models.RewardUpdate.create(...)
'SeasonCloneRequest@py.seasonpass.mod':
id: 'SeasonCloneRequest@py.seasonpass.mod'
name: 'SeasonCloneRequest'
type: 'model'
description: |-
A DTO object for clone season API call.
fields:
'end':
type: 'str'
required: true
description: |-
end date time
'name':
type: 'str'
required: true
description: |-
name, max length is 127
'start':
type: 'str'
required: true
description: |-
start date time
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/season_clone_request.py'
example: |-
season_clone_request = seasonpass_models.SeasonCloneRequest.create(...)
'SeasonCreate@py.seasonpass.mod':
id: 'SeasonCreate@py.seasonpass.mod'
name: 'SeasonCreate'
type: 'model'
description: |-
A DTO object for creating season API call.
fields:
'default_required_exp':
type: 'int'
required: true
description: |-
default exp required for a tier
'draft_store_id':
type: 'str'
required: true
description: |-
draft store id
'end':
type: 'str'
required: true
description: |-
end date time
'localizations':
type: 'Dict[str, Localization]'
required: true
description: |-
localization, {language: localization} map
'name':
type: 'str'
required: true
description: |-
name, max length is 127
'start':
type: 'str'
required: true
description: |-
start date time
'tier_item_id':
type: 'str'
required: true
description: |-
tier item id
'auto_claim':
type: 'bool'
required: false
description: |-
whether auto claim rewards, default true
'default_language':
type: 'str'
required: false
description: |-
default language, BCP 47 language tag, default is en
'excess_strategy':
type: 'ExcessStrategy'
required: false
description: |-
strategy while exceed final tier exp, default NONE
'images':
type: 'List[Image]'
required: false
description: |-
images
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/season_create.py'
example: |-
season_create = seasonpass_models.SeasonCreate.create(...)
'SeasonInfo@py.seasonpass.mod':
id: 'SeasonInfo@py.seasonpass.mod'
name: 'SeasonInfo'
type: 'model'
description: |-
A DTO object for season info.
fields:
'auto_claim':
type: 'bool'
required: true
description: |-
whether auto claim rewards
'created_at':
type: 'str'
required: true
description: |-
created at
'default_language':
type: 'str'
required: true
description: |-
default language, BCP 47 language tag
'default_required_exp':
type: 'int'
required: true
description: |-
default required exp for a tier
'draft_store_id':
type: 'str'
required: true
description: |-
draft store id
'end':
type: 'str'
required: true
description: |-
end date time
'excess_strategy':
type: 'ExcessStrategy'
required: true
description: |-
strategy while exceed final tier exp
'id_':
type: 'str'
required: true
description: |-
id
'localizations':
type: 'Dict[str, Localization]'
required: true
description: |-
localization, {language: localization} map
'name':
type: 'str'
required: true
description: |-
name, max length is 127
'namespace':
type: 'str'
required: true
description: |-
namespace
'start':
type: 'str'
required: true
description: |-
start date time
'status':
type: 'Union[str, StatusEnum]'
required: true
description: |-
status
'tier_item_id':
type: 'str'
required: true
description: |-
tier item id
'tier_item_name':
type: 'str'
required: true
description: |-
tier item name
'updated_at':
type: 'str'
required: true
description: |-
updated at
'images':
type: 'List[Image]'
required: false
description: |-
images
'pass_codes':
type: 'List[str]'
required: false
description: |-
pass codes
'published_at':
type: 'str'
required: false
description: |-
publishedAt
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/season_info.py'
example: |-
season_info = seasonpass_models.SeasonInfo.create(...)
'SeasonSummary@py.seasonpass.mod':
id: 'SeasonSummary@py.seasonpass.mod'
name: 'SeasonSummary'
type: 'model'
description: |-
A DTO object for season summary.
fields:
'end':
type: 'str'
required: true
description: |-
end date time
'id_':
type: 'str'
required: true
description: |-
id
'name':
type: 'str'
required: true
description: |-
name, max length is 127
'namespace':
type: 'str'
required: true
description: |-
namespace
'start':
type: 'str'
required: true
description: |-
start date time
'status':
type: 'Union[str, StatusEnum]'
required: true
description: |-
status
'pass_codes':
type: 'List[str]'
required: false
description: |-
season pass codes
'previous':
type: 'SeasonSummary'
required: false
description: |-
previous season, only present in some situation
'published_at':
type: 'str'
required: false
description: |-
publishedAt
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/season_summary.py'
example: |-
season_summary = seasonpass_models.SeasonSummary.create(...)
'SeasonUpdate@py.seasonpass.mod':
id: 'SeasonUpdate@py.seasonpass.mod'
name: 'SeasonUpdate'
type: 'model'
description: |-
A DTO object for updating season API call.
fields:
'auto_claim':
type: 'bool'
required: false
description: |-
whether auto claim rewards
'default_language':
type: 'str'
required: false
description: |-
default language, BCP 47 language tag
'default_required_exp':
type: 'int'
required: false
description: |-
default exp required for a tier
'draft_store_id':
type: 'str'
required: false
description: |-
draft store id
'end':
type: 'str'
required: false
description: |-
end date time
'excess_strategy':
type: 'ExcessStrategy'
required: false
description: |-
strategy while exceed final tier exp
'images':
type: 'List[Image]'
required: false
description: |-
images
'localizations':
type: 'Dict[str, Localization]'
required: false
description: |-
localization, {language: localization} map
'name':
type: 'str'
required: false
description: |-
name, max length is 127
'start':
type: 'str'
required: false
description: |-
start date time
'tier_item_id':
type: 'str'
required: false
description: |-
tier item id
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/season_update.py'
example: |-
season_update = seasonpass_models.SeasonUpdate.create(...)
'Tier@py.seasonpass.mod':
id: 'Tier@py.seasonpass.mod'
name: 'Tier'
type: 'model'
fields:
'id_':
type: 'str'
required: false
description: |-
tier id, auto generated.
'required_exp':
type: 'int'
required: false
description: |-
required exp for tier, it will automatically use season defaultRequiredExp if not set
'rewards':
type: 'Dict[str, List[str]]'
required: false
description: |-
rewards map, passCode as key, rewardCode list as value
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/tier.py'
example: |-
tier = seasonpass_models.Tier.create(...)
'TierCreate@py.seasonpass.mod':
id: 'TierCreate@py.seasonpass.mod'
name: 'TierCreate'
type: 'model'
description: |-
A DTO object for creating tier API call.
fields:
'index':
type: 'int'
required: false
description: |-
zero based tier index to be inserted at, -1 means appending to the end, default -1
'quantity':
type: 'int'
required: false
description: |-
create tier quantity, default 1
'tier':
type: 'TierInput'
required: false
description: |-
tier content, default null tier
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/tier_create.py'
example: |-
tier_create = seasonpass_models.TierCreate.create(...)
'TierInput@py.seasonpass.mod':
id: 'TierInput@py.seasonpass.mod'
name: 'TierInput'
type: 'model'
description: |-
A DTO object for tier input.
fields:
'required_exp':
type: 'int'
required: false
description: |-
required exp for tier, it will automatically use season defaultRequiredExp if not set
'rewards':
type: 'Dict[str, List[str]]'
required: false
description: |-
rewards map, passCode as key, rewardCode list as value
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/tier_input.py'
example: |-
tier_input = seasonpass_models.TierInput.create(...)
'TierPagingSlicedResult@py.seasonpass.mod':
id: 'TierPagingSlicedResult@py.seasonpass.mod'
name: 'TierPagingSlicedResult'
type: 'model'
fields:
'data':
type: 'List[Tier]'
required: true
description: |-
data
'paging':
type: 'Paging'
required: false
'total':
type: 'int'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/tier_paging_sliced_result.py'
example: |-
tier_paging_sliced_result = seasonpass_models.TierPagingSlicedResult.create(...)
'TierReorder@py.seasonpass.mod':
id: 'TierReorder@py.seasonpass.mod'
name: 'TierReorder'
type: 'model'
fields:
'new_index':
type: 'int'
required: false
description: |-
new index tier should be moved to, zero based, -1 means appending to the end
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/tier_reorder.py'
example: |-
tier_reorder = seasonpass_models.TierReorder.create(...)
'UserExpGrant@py.seasonpass.mod':
id: 'UserExpGrant@py.seasonpass.mod'
name: 'UserExpGrant'
type: 'model'
description: |-
A DTO object for granting user exp.
fields:
'exp':
type: 'int'
required: false
description: |-
exp to grant
'source':
type: 'Union[str, SourceEnum]'
required: false
description: |-
source
'tags':
type: 'List[str]'
required: false
description: |-
tags
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/user_exp_grant.py'
example: |-
user_exp_grant = seasonpass_models.UserExpGrant.create(...)
'UserPassGrant@py.seasonpass.mod':
id: 'UserPassGrant@py.seasonpass.mod'
name: 'UserPassGrant'
type: 'model'
description: |-
A DTO object for granting user pass.
fields:
'pass_code':
type: 'str'
required: false
description: |-
pass code, required if passItemId null
'pass_item_id':
type: 'str'
required: false
description: |-
pass item id, required if passCode null and ignored if passCode present
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/user_pass_grant.py'
example: |-
user_pass_grant = seasonpass_models.UserPassGrant.create(...)
'UserPurchasable@py.seasonpass.mod':
id: 'UserPurchasable@py.seasonpass.mod'
name: 'UserPurchasable'
type: 'model'
description: |-
A DTO object for user purchasable.
fields:
'pass_item_id':
type: 'str'
required: false
description: |-
pass item id
'tier_item_count':
type: 'int'
required: false
description: |-
tier item count, default 1
'tier_item_id':
type: 'str'
required: false
description: |-
tier item id
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/user_purchasable.py'
example: |-
user_purchasable = seasonpass_models.UserPurchasable.create(...)
'UserRewardClaim@py.seasonpass.mod':
id: 'UserRewardClaim@py.seasonpass.mod'
name: 'UserRewardClaim'
type: 'model'
description: |-
A DTO object for claiming user reward.
fields:
'pass_code':
type: 'str'
required: true
description: |-
pass code
'reward_code':
type: 'str'
required: true
description: |-
reward code
'tier_index':
type: 'int'
required: true
description: |-
tier index
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/user_reward_claim.py'
example: |-
user_reward_claim = seasonpass_models.UserRewardClaim.create(...)
'UserSeasonSummary@py.seasonpass.mod':
id: 'UserSeasonSummary@py.seasonpass.mod'
name: 'UserSeasonSummary'
type: 'model'
description: |-
A DTO object for user season summary.
fields:
'namespace':
type: 'str'
required: true
description: |-
namespace
'user_id':
type: 'str'
required: true
description: |-
user id
'cleared':
type: 'bool'
required: false
description: |-
whether cleared all tiers
'created_at':
type: 'str'
required: false
description: |-
created at
'current_exp':
type: 'int'
required: false
description: |-
gained exp for current tier
'current_tier_index':
type: 'int'
required: false
description: |-
current tier index, zero based
'enrolled_at':
type: 'str'
required: false
description: |-
enroll date time
'enrolled_passes':
type: 'List[str]'
required: false
description: |-
enrolled passes
'id_':
type: 'str'
required: false
description: |-
id
'last_tier_index':
type: 'int'
required: false
description: |-
last tier index, zero based
'required_exp':
type: 'int'
required: false
description: |-
required exp for current tier
'season_id':
type: 'str'
required: false
description: |-
season id
'updated_at':
type: 'str'
required: false
description: |-
updated at
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/user_season_summary.py'
example: |-
user_season_summary = seasonpass_models.UserSeasonSummary.create(...)
'UserTierGrant@py.seasonpass.mod':
id: 'UserTierGrant@py.seasonpass.mod'
name: 'UserTierGrant'
type: 'model'
description: |-
A DTO object for granting user tier.
fields:
'count':
type: 'int'
required: false
description: |-
count to grant
'source':
type: 'Union[str, SourceEnum]'
required: false
description: |-
source
'tags':
type: 'List[str]'
required: false
description: |-
tags
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/user_tier_grant.py'
example: |-
user_tier_grant = seasonpass_models.UserTierGrant.create(...)
'ValidationErrorEntity@py.seasonpass.mod':
id: 'ValidationErrorEntity@py.seasonpass.mod'
name: 'ValidationErrorEntity'
type: 'model'
fields:
'error_code':
type: 'int'
required: true
description: |-
numeric error code
'error_message':
type: 'str'
required: true
description: |-
error message
'errors':
type: 'List[FieldValidationError]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/models/validation_error_entity.py'
example: |-
validation_error_entity = seasonpass_models.ValidationErrorEntity.create(...)
# endregion models
# region functions
'bulk_get_user_season_progression@py.seasonpass.fun':
id: 'bulk_get_user_season_progression@py.seasonpass.fun'
name: 'bulk_get_user_season_progression'
type: 'function'
description: |-
This API is used to bulk get user current season progression, season only located in non-publisher namespace.
Other detail info:
* Returns : user season progression
arguments:
'body':
type: 'Optional[BulkUserProgressionRequest]'
required: false
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, List[UserSeasonSummary]], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/bulk_get_user_season_pr_a15d63.py'
example: |-
result, error = seasonpass.bulk_get_user_season_progression(...)
if error:
# handle_error(error)
tags:
- 'bulk'
- 'get'
- 'progression'
- 'season'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'check_season_purchasable@py.seasonpass.fun':
id: 'check_season_purchasable@py.seasonpass.fun'
name: 'check_season_purchasable'
type: 'function'
description: |-
This API is used to check pass or tier purchasable, season only located in non-publisher namespace.
arguments:
'body':
type: 'Optional[UserPurchasable]'
required: false
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
return_type: 'Tuple[None, Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/check_season_purchasable.py'
example: |-
result, error = seasonpass.check_season_purchasable(...)
if error:
# handle_error(error)
tags:
- 'check'
- 'purchasable'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'clone_season@py.seasonpass.fun':
id: 'clone_season@py.seasonpass.fun'
name: 'clone_season'
type: 'function'
description: |-
This API is used to clone a season.
Other detail info:
* Returns : cloned season info
arguments:
'body':
type: 'Optional[SeasonCloneRequest]'
required: false
'namespace':
type: 'str'
required: true
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, SeasonInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/clone_season.py'
example: |-
result, error = seasonpass.clone_season(...)
if error:
# handle_error(error)
tags:
- 'clone'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'create_pass@py.seasonpass.fun':
id: 'create_pass@py.seasonpass.fun'
name: 'create_pass'
type: 'function'
description: |-
This API is used to create a pass for a draft season.
Other detail info:
* Returns : created pass
arguments:
'body':
type: 'Optional[PassCreate]'
required: false
'namespace':
type: 'str'
required: true
description: |-
Namespace
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, PassInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/pass_/create_pass.py'
example: |-
result, error = seasonpass.create_pass(...)
if error:
# handle_error(error)
tags:
- 'create'
- 'pass'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'create_reward@py.seasonpass.fun':
id: 'create_reward@py.seasonpass.fun'
name: 'create_reward'
type: 'function'
description: |-
This API is used to create a reward for a draft season.
Other detail info:
* Returns : created reward
arguments:
'body':
type: 'Optional[RewardCreate]'
required: false
'namespace':
type: 'str'
required: true
description: |-
Namespace
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RewardInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/reward/create_reward.py'
example: |-
result, error = seasonpass.create_reward(...)
if error:
# handle_error(error)
tags:
- 'create'
- 'reward'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'create_season@py.seasonpass.fun':
id: 'create_season@py.seasonpass.fun'
name: 'create_season'
type: 'function'
description: |-
This API is used to create a season, season only allowed in non-publisher namespace.
Other detail info:
* Returns : created season
arguments:
'body':
type: 'Optional[SeasonCreate]'
required: false
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, SeasonInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/create_season.py'
example: |-
result, error = seasonpass.create_season(...)
if error:
# handle_error(error)
tags:
- 'create'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'create_tier@py.seasonpass.fun':
id: 'create_tier@py.seasonpass.fun'
name: 'create_tier'
type: 'function'
description: |-
This API is used to create tier for a draft season, can create multiple tiers at same time.
arguments:
'body':
type: 'Optional[TierCreate]'
required: false
'namespace':
type: 'str'
required: true
description: |-
Namespace
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, List[Tier]], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/tier/create_tier.py'
example: |-
result, error = seasonpass.create_tier(...)
if error:
# handle_error(error)
tags:
- 'create'
- 'tier'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'delete_pass@py.seasonpass.fun':
id: 'delete_pass@py.seasonpass.fun'
name: 'delete_pass'
type: 'function'
description: |-
This API is used to delete a pass permanently, only draft season pass can be deleted.
arguments:
'code':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
description: |-
Namespace
'season_id':
type: 'str'
required: true
return_type: 'Tuple[None, Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/pass_/delete_pass.py'
example: |-
result, error = seasonpass.delete_pass(...)
if error:
# handle_error(error)
tags:
- 'delete'
- 'pass'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]'
'delete_reward@py.seasonpass.fun':
id: 'delete_reward@py.seasonpass.fun'
name: 'delete_reward'
type: 'function'
description: |-
This API is used to delete a reward permanently, only draft season reward can be deleted.
Other detail info:
arguments:
'code':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
description: |-
Namespace
'season_id':
type: 'str'
required: true
return_type: 'Tuple[None, Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/reward/delete_reward.py'
example: |-
result, error = seasonpass.delete_reward(...)
if error:
# handle_error(error)
tags:
- 'delete'
- 'reward'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]'
'delete_season@py.seasonpass.fun':
id: 'delete_season@py.seasonpass.fun'
name: 'delete_season'
type: 'function'
description: |-
This API is used to delete a season permanently, only draft season can be deleted.
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
'season_id':
type: 'str'
required: true
return_type: 'Tuple[None, Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/delete_season.py'
example: |-
result, error = seasonpass.delete_season(...)
if error:
# handle_error(error)
tags:
- 'delete'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]'
'delete_tier@py.seasonpass.fun':
id: 'delete_tier@py.seasonpass.fun'
name: 'delete_tier'
type: 'function'
description: |-
This API is used to delete a tier permanently, only draft season pass can be deleted.
arguments:
'id_':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
description: |-
Namespace
'season_id':
type: 'str'
required: true
return_type: 'Tuple[None, Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/tier/delete_tier.py'
example: |-
result, error = seasonpass.delete_tier(...)
if error:
# handle_error(error)
tags:
- 'delete'
- 'tier'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]'
'exists_any_pass_by_pass_codes@py.seasonpass.fun':
id: 'exists_any_pass_by_pass_codes@py.seasonpass.fun'
name: 'exists_any_pass_by_pass_codes'
type: 'function'
description: |-
[SERVICE COMMUNICATION ONLY]This API is used to get ownership for any pass codes, season only located in non-publisher namespace.
Other detail info:
* Returns : ownership
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
'pass_codes':
type: 'Optional[List[str]]'
required: false
'user_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, Ownership], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/exists_any_pass_by_pass_codes.py'
example: |-
result, error = seasonpass.exists_any_pass_by_pass_codes(...)
if error:
# handle_error(error)
tags:
- 'any'
- 'by'
- 'codes'
- 'exists'
- 'pass'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'export_season@py.seasonpass.fun':
id: 'export_season@py.seasonpass.fun'
name: 'export_season'
type: 'function'
description: |-
This API is used to export all of season service data files with csv format.
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, Any], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/export/export_season.py'
example: |-
result, error = seasonpass.export_season(...)
if error:
# handle_error(error)
tags:
- 'export'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'get_current_season@py.seasonpass.fun':
id: 'get_current_season@py.seasonpass.fun'
name: 'get_current_season'
type: 'function'
description: |-
[SERVICE COMMUNICATION ONLY]This API is used to get current published season summary which includes previous published season summary if exists, season only located in non-publisher namespace.
Other detail info:
* Returns : season summary data
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, SeasonSummary], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/get_current_season.py'
example: |-
result, error = seasonpass.get_current_season(...)
if error:
# handle_error(error)
tags:
- 'current'
- 'get'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'get_current_user_season_progression@py.seasonpass.fun':
id: 'get_current_user_season_progression@py.seasonpass.fun'
name: 'get_current_user_season_progression'
type: 'function'
description: |-
This API is used to get current user season progression, season only located in non-publisher namespace.
Other detail info:
* Returns : user season progression
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, UserSeasonSummary], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/get_current_user_season_eed4c8.py'
example: |-
result, error = seasonpass.get_current_user_season_progression(...)
if error:
# handle_error(error)
tags:
- 'current'
- 'get'
- 'progression'
- 'season'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'get_full_season@py.seasonpass.fun':
id: 'get_full_season@py.seasonpass.fun'
name: 'get_full_season'
type: 'function'
description: |-
This API is used to get a season full content, season only located in non-publisher namespace.
Other detail info:
* Returns : season data
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, FullSeasonInfo], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/get_full_season.py'
example: |-
result, error = seasonpass.get_full_season(...)
if error:
# handle_error(error)
tags:
- 'full'
- 'get'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'get_item_references@py.seasonpass.fun':
id: 'get_item_references@py.seasonpass.fun'
name: 'get_item_references'
type: 'function'
description: |-
This API is used to get season pass ecommerce item references.
Other detail info:
* Returns : item references data
arguments:
'item_id':
type: 'str'
required: true
description: |-
the id of the ecommerce item
'namespace':
type: 'str'
required: true
description: |-
namespace
return_type: 'Tuple[Union[None, ItemReferenceInfo], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/utilities/get_item_references.py'
example: |-
result, error = seasonpass.get_item_references(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'item'
- 'references'
- 'utilities'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'get_pass@py.seasonpass.fun':
id: 'get_pass@py.seasonpass.fun'
name: 'get_pass'
type: 'function'
description: |-
This API is used to get a pass for a season.
Other detail info:
* Returns : pass data
arguments:
'code':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
description: |-
Namespace
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, PassInfo], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/pass_/get_pass.py'
example: |-
result, error = seasonpass.get_pass(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'pass'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'get_reward@py.seasonpass.fun':
id: 'get_reward@py.seasonpass.fun'
name: 'get_reward'
type: 'function'
description: |-
This API is used to get a reward for a season.
Other detail info:
* Returns : reward data
arguments:
'code':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
description: |-
Namespace
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RewardInfo], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/reward/get_reward.py'
example: |-
result, error = seasonpass.get_reward(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'reward'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'get_season@py.seasonpass.fun':
id: 'get_season@py.seasonpass.fun'
name: 'get_season'
type: 'function'
description: |-
This API is used to get a season, season only located in non-publisher namespace.
Other detail info:
* Returns : season data
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, SeasonInfo], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/get_season.py'
example: |-
result, error = seasonpass.get_season(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'get_user_participated_seasons@py.seasonpass.fun':
id: 'get_user_participated_seasons@py.seasonpass.fun'
name: 'get_user_participated_seasons'
type: 'function'
description: |-
This API is used to get user participated season data, season only located in non-publisher namespace.
Other detail info:
* Returns : user participated season data
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
limit
'namespace':
type: 'str'
required: true
description: |-
Namespace
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'user_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, ListUserSeasonInfoPagingSlicedResult], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/get_user_participated_seasons.py'
example: |-
result, error = seasonpass.get_user_participated_seasons(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'participated'
- 'season'
- 'seasons'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'get_user_season@py.seasonpass.fun':
id: 'get_user_season@py.seasonpass.fun'
name: 'get_user_season'
type: 'function'
description: |-
This API is used to get user season data, season only located in non-publisher namespace.
Other detail info:
* Returns : user season data
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
'season_id':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, ClaimableUserSeasonInfo], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/get_user_season.py'
example: |-
result, error = seasonpass.get_user_season(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'season'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'grant_user_exp@py.seasonpass.fun':
id: 'grant_user_exp@py.seasonpass.fun'
name: 'grant_user_exp'
type: 'function'
description: |-
This API is used to grant exp to user, it will auto enroll if there's no user season but active published season exist, season only located in non-publisher namespace, otherwise ignore.
Other detail info:
* Returns : user season data
arguments:
'body':
type: 'Optional[UserExpGrant]'
required: false
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, UserSeasonSummary], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/tier/grant_user_exp.py'
example: |-
result, error = seasonpass.grant_user_exp(...)
if error:
# handle_error(error)
tags:
- 'exp'
- 'grant'
- 'tier'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]'
'grant_user_pass@py.seasonpass.fun':
id: 'grant_user_pass@py.seasonpass.fun'
name: 'grant_user_pass'
type: 'function'
description: |-
This API is used to grant pass to user, it will auto enroll if there's no user season but active published season exist, season only located in non-publisher namespace, otherwise ignore.
Other detail info:
* Returns : user season data
arguments:
'body':
type: 'Optional[UserPassGrant]'
required: false
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, UserSeasonSummary], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/pass_/grant_user_pass.py'
example: |-
result, error = seasonpass.grant_user_pass(...)
if error:
# handle_error(error)
tags:
- 'grant'
- 'pass'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]'
'grant_user_tier@py.seasonpass.fun':
id: 'grant_user_tier@py.seasonpass.fun'
name: 'grant_user_tier'
type: 'function'
description: |-
This API is used to grant tier to user, it will auto enroll if there's no user season but active published season exist, season only located in non-publisher namespace, otherwise ignore.
Other detail info:
* Returns : user season data
arguments:
'body':
type: 'Optional[UserTierGrant]'
required: false
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, UserSeasonSummary], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/tier/grant_user_tier.py'
example: |-
result, error = seasonpass.grant_user_tier(...)
if error:
# handle_error(error)
tags:
- 'grant'
- 'tier'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]'
'public_bulk_claim_user_rewards@py.seasonpass.fun':
id: 'public_bulk_claim_user_rewards@py.seasonpass.fun'
name: 'public_bulk_claim_user_rewards'
type: 'function'
description: |-
This API is used to bulk claim all remained rewards, season only located in non-publisher namespace.
Other detail info:
* Returns : user season data
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, ClaimableRewards], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/reward/public_bulk_claim_user_rewards.py'
example: |-
result, error = seasonpass.public_bulk_claim_user_rewards(...)
if error:
# handle_error(error)
tags:
- 'bulk'
- 'claim'
- 'public'
- 'reward'
- 'rewards'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]'
'public_claim_user_reward@py.seasonpass.fun':
id: 'public_claim_user_reward@py.seasonpass.fun'
name: 'public_claim_user_reward'
type: 'function'
description: |-
This API is used to claim reward, season only located in non-publisher namespace.
Other detail info:
* Returns : user season data
arguments:
'body':
type: 'Optional[UserRewardClaim]'
required: false
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, ClaimableRewards], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/reward/public_claim_user_reward.py'
example: |-
result, error = seasonpass.public_claim_user_reward(...)
if error:
# handle_error(error)
tags:
- 'claim'
- 'public'
- 'reward'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]'
'public_get_current_season@py.seasonpass.fun':
id: 'public_get_current_season@py.seasonpass.fun'
name: 'public_get_current_season'
type: 'function'
description: |-
This API is used to get current published season, season only located in non-publisher namespace.
Other detail info:
* Returns : localized season data
arguments:
'language':
type: 'Optional[str]'
required: false
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, LocalizedSeasonInfo], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/public_get_current_season.py'
example: |-
result, error = seasonpass.public_get_current_season(...)
if error:
# handle_error(error)
tags:
- 'current'
- 'get'
- 'public'
- 'season'
'public_get_current_user_season@py.seasonpass.fun':
id: 'public_get_current_user_season@py.seasonpass.fun'
name: 'public_get_current_user_season'
type: 'function'
description: |-
This API is used to get current user season data, it will auto enroll if there's no user season but active published season exist, season only located in non-publisher namespace.
Other detail info:
* Returns : user season data
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, ClaimableUserSeasonInfo], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/public_get_current_user_season.py'
example: |-
result, error = seasonpass.public_get_current_user_season(...)
if error:
# handle_error(error)
tags:
- 'current'
- 'get'
- 'public'
- 'season'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'public_get_user_season@py.seasonpass.fun':
id: 'public_get_user_season@py.seasonpass.fun'
name: 'public_get_user_season'
type: 'function'
description: |-
This API is used to get user season data, season only located in non-publisher namespace.
Other detail info:
* Returns : user season data
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
'season_id':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, ClaimableUserSeasonInfo], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/public_get_user_season.py'
example: |-
result, error = seasonpass.public_get_user_season(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'public'
- 'season'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'publish_season@py.seasonpass.fun':
id: 'publish_season@py.seasonpass.fun'
name: 'publish_season'
type: 'function'
description: |-
This API is used to publish a draft season, only one published season allowed at same time in a namespace.
Other detail info:
* Returns : published season
arguments:
'namespace':
type: 'str'
required: true
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, SeasonInfo], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/publish_season.py'
example: |-
result, error = seasonpass.publish_season(...)
if error:
# handle_error(error)
tags:
- 'publish'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'query_passes@py.seasonpass.fun':
id: 'query_passes@py.seasonpass.fun'
name: 'query_passes'
type: 'function'
description: |-
This API is used to query all passes for a season.
Other detail info:
* Returns : the list of passes
arguments:
'namespace':
type: 'str'
required: true
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, List[PassInfo]], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/pass_/query_passes.py'
example: |-
result, error = seasonpass.query_passes(...)
if error:
# handle_error(error)
tags:
- 'pass'
- 'passes'
- 'query'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'query_rewards@py.seasonpass.fun':
id: 'query_rewards@py.seasonpass.fun'
name: 'query_rewards'
type: 'function'
description: |-
This API is used to query rewards for a season.
Other detail info:
* Returns : the list of rewards
arguments:
'namespace':
type: 'str'
required: true
'q':
type: 'Optional[str]'
required: false
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, List[RewardInfo]], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/reward/query_rewards.py'
example: |-
result, error = seasonpass.query_rewards(...)
if error:
# handle_error(error)
tags:
- 'query'
- 'reward'
- 'rewards'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'query_seasons@py.seasonpass.fun':
id: 'query_seasons@py.seasonpass.fun'
name: 'query_seasons'
type: 'function'
description: |-
This API is used to query seasons, seasons only located in non-publisher namespace.
Other detail info:
* Returns : the list of season basic info
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
limit
'namespace':
type: 'str'
required: true
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'status':
type: 'Optional[Union[List[str], List[QuerySeasonsStatusEnum]]]'
required: false
return_type: 'Tuple[Union[None, ListSeasonInfoPagingSlicedResult], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/query_seasons.py'
example: |-
result, error = seasonpass.query_seasons(...)
if error:
# handle_error(error)
tags:
- 'query'
- 'season'
- 'seasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'query_tiers@py.seasonpass.fun':
id: 'query_tiers@py.seasonpass.fun'
name: 'query_tiers'
type: 'function'
description: |-
This API is used to query paginated tiers for a season.
Other detail info:
* Returns : the list of passes
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
limit
'namespace':
type: 'str'
required: true
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, TierPagingSlicedResult], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/tier/query_tiers.py'
example: |-
result, error = seasonpass.query_tiers(...)
if error:
# handle_error(error)
tags:
- 'query'
- 'tier'
- 'tiers'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'query_user_exp_grant_history@py.seasonpass.fun':
id: 'query_user_exp_grant_history@py.seasonpass.fun'
name: 'query_user_exp_grant_history'
type: 'function'
description: |-
This API is used to get user exp acquisition history, season only located in non-publisher namespace.
Other detail info:
* default will query from current active season
* Returns : paginated grant history
arguments:
'from_':
type: 'Optional[str]'
required: false
description: |-
section active range time start , using ISO 8601 format e.g. yyyy-MM-dd'T'HH:mm:ssZZ
'limit':
type: 'Optional[int]'
required: false
description: |-
limit
'namespace':
type: 'str'
required: true
description: |-
Namespace
'offset':
type: 'Optional[int]'
required: false
description: |-
offset
'season_id':
type: 'Optional[str]'
required: false
description: |-
if not provide, will query current season
'source':
type: 'Optional[Union[str, QueryUserExpGrantHistorySourceEnum]]'
required: false
description: |-
exp grant source
'tags':
type: 'Optional[List[str]]'
required: false
description: |-
exp grant tags
'to':
type: 'Optional[str]'
required: false
description: |-
section active range time end, using ISO 8601 format e.g. yyyy-MM-dd'T'HH:mm:ssZZ
'user_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, ExpGrantHistoryPagingSlicedResult], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/query_user_exp_grant_history.py'
example: |-
result, error = seasonpass.query_user_exp_grant_history(...)
if error:
# handle_error(error)
tags:
- 'exp'
- 'grant'
- 'history'
- 'query'
- 'season'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'query_user_exp_grant_history_tag@py.seasonpass.fun':
id: 'query_user_exp_grant_history_tag@py.seasonpass.fun'
name: 'query_user_exp_grant_history_tag'
type: 'function'
description: |-
This API is used to get user exp acquisition history's tag list.
Other detail info:
* default will query from current active season
* Returns : exp grant history tags list
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
'season_id':
type: 'Optional[str]'
required: false
description: |-
if not provide, will query current season
'user_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, ReasonTagsResult], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/query_user_exp_grant_hi_12346c.py'
example: |-
result, error = seasonpass.query_user_exp_grant_history_tag(...)
if error:
# handle_error(error)
tags:
- 'exp'
- 'grant'
- 'history'
- 'query'
- 'season'
- 'tag'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'reorder_tier@py.seasonpass.fun':
id: 'reorder_tier@py.seasonpass.fun'
name: 'reorder_tier'
type: 'function'
description: |-
This API is used to reorder a tier. Only draft season pass can be updated.
arguments:
'body':
type: 'Optional[TierReorder]'
required: false
'id_':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, Tier], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/tier/reorder_tier.py'
example: |-
result, error = seasonpass.reorder_tier(...)
if error:
# handle_error(error)
tags:
- 'reorder'
- 'tier'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'reset_user_season@py.seasonpass.fun':
id: 'reset_user_season@py.seasonpass.fun'
name: 'reset_user_season'
type: 'function'
description: |-
[TEST FACILITY ONLY] Forbidden in live environment. This API is used to reset user data in current season, it will not revoke the rewarded entitlements.
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
return_type: 'Tuple[None, Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/reset_user_season.py'
example: |-
result, error = seasonpass.reset_user_season(...)
if error:
# handle_error(error)
tags:
- 'reset'
- 'season'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [DELETE]'
'retire_season@py.seasonpass.fun':
id: 'retire_season@py.seasonpass.fun'
name: 'retire_season'
type: 'function'
description: |-
This API is used to retire a published season, if the season has not ended it will report error except with force.
Other detail info:
* Returns : season info
arguments:
'force':
type: 'Optional[bool]'
required: false
'namespace':
type: 'str'
required: true
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, SeasonInfo], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/retire_season.py'
example: |-
result, error = seasonpass.retire_season(...)
if error:
# handle_error(error)
tags:
- 'retire'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'unpublish_season@py.seasonpass.fun':
id: 'unpublish_season@py.seasonpass.fun'
name: 'unpublish_season'
type: 'function'
description: |-
This API is used to unpublish a published season, if the season already started it will report error except with force.
Other detail info:
* Returns : season info
arguments:
'force':
type: 'Optional[bool]'
required: false
'namespace':
type: 'str'
required: true
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, SeasonInfo], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/unpublish_season.py'
example: |-
result, error = seasonpass.unpublish_season(...)
if error:
# handle_error(error)
tags:
- 'season'
- 'unpublish'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'update_pass@py.seasonpass.fun':
id: 'update_pass@py.seasonpass.fun'
name: 'update_pass'
type: 'function'
description: |-
This API is used to update a pass. Only draft season pass can be updated.
Other detail info:
* Returns : updated pass
arguments:
'body':
type: 'Optional[PassUpdate]'
required: false
'code':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, PassInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/pass_/update_pass.py'
example: |-
result, error = seasonpass.update_pass(...)
if error:
# handle_error(error)
tags:
- 'pass'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'update_reward@py.seasonpass.fun':
id: 'update_reward@py.seasonpass.fun'
name: 'update_reward'
type: 'function'
description: |-
This API is used to update a reward. Only draft season reward can be updated.
Other detail info:
* Returns : updated reward
arguments:
'body':
type: 'Optional[RewardUpdate]'
required: false
'code':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, RewardInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/reward/update_reward.py'
example: |-
result, error = seasonpass.update_reward(...)
if error:
# handle_error(error)
tags:
- 'reward'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'update_season@py.seasonpass.fun':
id: 'update_season@py.seasonpass.fun'
name: 'update_season'
type: 'function'
description: |-
This API is used to update a season. Only draft season can be updated.
Other detail info:
* Returns : updated season
arguments:
'body':
type: 'Optional[SeasonUpdate]'
required: false
'namespace':
type: 'str'
required: true
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, SeasonInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/season/update_season.py'
example: |-
result, error = seasonpass.update_season(...)
if error:
# handle_error(error)
tags:
- 'season'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'update_tier@py.seasonpass.fun':
id: 'update_tier@py.seasonpass.fun'
name: 'update_tier'
type: 'function'
description: |-
This API is used to update a tier. Only draft season pass can be updated.
arguments:
'body':
type: 'Optional[TierInput]'
required: false
'id_':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'season_id':
type: 'str'
required: true
return_type: 'Tuple[Union[None, Tier], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.seasonpass as seasonpass'
- 'import accelbyte_py_sdk.api.seasonpass.models as seasonpass_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/seasonpass/operations/tier/update_tier.py'
example: |-
result, error = seasonpass.update_tier(...)
if error:
# handle_error(error)
tags:
- 'tier'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
# endregion functions
