symbols:
# region models
'BulkUserProgressionRequest@jv.seasonpass.mod':
id: 'BulkUserProgressionRequest@jv.seasonpass.mod'
name: 'BulkUserProgressionRequest'
type: 'model'
fields:
'userIds':
type: 'List<String>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/BulkUserProgressionRequest.java'
'ClaimableRewards@jv.seasonpass.mod':
id: 'ClaimableRewards@jv.seasonpass.mod'
name: 'ClaimableRewards'
type: 'model'
description: |-
A DTO object for claimable rewards.
fields:
'claimingRewards':
type: 'Map<String, ?>'
required: true
description: |-
Claiming rewards, zero based tier index as key, rewards per pass as value
'toClaimRewards':
type: 'Map<String, ?>'
required: true
description: |-
To claim rewards, zero based tier index as key, rewards per pass as value
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/ClaimableRewards.java'
'ClaimableUserSeasonInfo@jv.seasonpass.mod':
id: 'ClaimableUserSeasonInfo@jv.seasonpass.mod'
name: 'ClaimableUserSeasonInfo'
type: 'model'
description: |-
A DTO object for claimable user season data.
fields:
'claimingRewards':
type: 'Map<String, ?>'
required: true
description: |-
Claiming rewards, zero based tier index as key, rewards per pass as value
'cleared':
type: 'Boolean'
required: true
description: |-
whether cleared all tiers
'createdAt':
type: 'String'
required: true
description: |-
created at
'currentExp':
type: 'Integer'
required: true
description: |-
gained exp for current tier
'currentTierIndex':
type: 'Integer'
required: true
description: |-
current tier index, zero based
'enrolledAt':
type: 'String'
required: true
description: |-
enroll date time
'enrolledPasses':
type: 'List<String>'
required: true
description: |-
enrolled passes
'id':
type: 'String'
required: true
description: |-
id
'lastTierIndex':
type: 'Integer'
required: true
description: |-
last tier index, zero based
'namespace':
type: 'String'
required: true
description: |-
namespace
'requiredExp':
type: 'Integer'
required: true
description: |-
required exp for current tier
'seasonId':
type: 'String'
required: true
description: |-
season id
'toClaimRewards':
type: 'Map<String, ?>'
required: true
description: |-
To claim rewards, zero based tier index as key, rewards per pass as value
'updatedAt':
type: 'String'
required: true
description: |-
updated at
'userId':
type: 'String'
required: true
description: |-
user id
'season':
type: 'SeasonSummary'
required: false
description: |-
season summary
'totalExp':
type: 'Long'
required: false
description: |-
total exp
'totalPaidForExp':
type: 'Long'
required: false
description: |-
total paid-for exp
'totalSweatExp':
type: 'Long'
required: false
description: |-
total sweat exp
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/ClaimableUserSeasonInfo.java'
'ErrorEntity@jv.seasonpass.mod':
id: 'ErrorEntity@jv.seasonpass.mod'
name: 'ErrorEntity'
type: 'model'
fields:
'errorCode':
type: 'Integer'
required: true
description: |-
numeric error code
'errorMessage':
type: 'String'
required: true
description: |-
error message
'devStackTrace':
type: 'String'
required: false
description: |-
internal server error stack trace in configured environment
'messageVariables':
type: 'Map<String, String>'
required: false
description: |-
message variables
'requiredPermission':
type: 'Permission'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/ErrorEntity.java'
'ExcessStrategy@jv.seasonpass.mod':
id: 'ExcessStrategy@jv.seasonpass.mod'
name: 'ExcessStrategy'
type: 'model'
fields:
'method':
type: 'String'
required: true
description: |-
method while excess the final tier exp
'currency':
type: 'String'
required: false
description: |-
virtual currency for grant, required while method is CURRENCY
'percentPerExp':
type: 'Integer'
required: false
description: |-
percent per exp, required while method is CURRENCY
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/ExcessStrategy.java'
'ExpGrantHistoryInfo@jv.seasonpass.mod':
id: 'ExpGrantHistoryInfo@jv.seasonpass.mod'
name: 'ExpGrantHistoryInfo'
type: 'model'
description: |-
A DTO object for exp grant history details.
fields:
'createdAt':
type: 'String'
required: true
description: |-
acquired at
'grantExp':
type: 'Long'
required: true
description: |-
grant exp
'id':
type: 'String'
required: true
description: |-
id
'namespace':
type: 'String'
required: true
description: |-
namespace
'seasonId':
type: 'String'
required: true
description: |-
season id
'userId':
type: 'String'
required: true
description: |-
user id
'source':
type: 'String'
required: false
description: |-
id
'tags':
type: 'List<String>'
required: false
description: |-
id
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/ExpGrantHistoryInfo.java'
'ExpGrantHistoryPagingSlicedResult@jv.seasonpass.mod':
id: 'ExpGrantHistoryPagingSlicedResult@jv.seasonpass.mod'
name: 'ExpGrantHistoryPagingSlicedResult'
type: 'model'
fields:
'data':
type: 'List<ExpGrantHistoryInfo>'
required: true
description: |-
data
'paging':
type: 'Paging'
required: false
'total':
type: 'Long'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/ExpGrantHistoryPagingSlicedResult.java'
'FieldValidationError@jv.seasonpass.mod':
id: 'FieldValidationError@jv.seasonpass.mod'
name: 'FieldValidationError'
type: 'model'
fields:
'errorCode':
type: 'String'
required: false
'errorField':
type: 'String'
required: false
'errorMessage':
type: 'String'
required: false
'errorValue':
type: 'String'
required: false
'messageVariables':
type: 'Map<String, String>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/FieldValidationError.java'
'FullSeasonInfo@jv.seasonpass.mod':
id: 'FullSeasonInfo@jv.seasonpass.mod'
name: 'FullSeasonInfo'
type: 'model'
description: |-
A DTO object for season full content.
fields:
'id':
type: 'String'
required: true
description: |-
id
'localizations':
type: 'Map<String, Localization>'
required: true
description: |-
localization, {language: localization} map
'name':
type: 'String'
required: true
description: |-
name, max length is 127
'namespace':
type: 'String'
required: true
description: |-
namespace
'passes':
type: 'List<PassInfo>'
required: true
description: |-
passes info
'rewards':
type: 'Map<String, RewardInfo>'
required: true
description: |-
rewards info
'tiers':
type: 'List<Tier>'
required: true
description: |-
tiers info
'images':
type: 'List<Image>'
required: false
description: |-
images
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/FullSeasonInfo.java'
'Image@jv.seasonpass.mod':
id: 'Image@jv.seasonpass.mod'
name: 'Image'
type: 'model'
fields:
'height':
type: 'Integer'
required: true
description: |-
height
'imageUrl':
type: 'String'
required: true
description: |-
imageUrl
'width':
type: 'Integer'
required: true
description: |-
width
'as':
type: 'String'
required: false
description: |-
image for
'caption':
type: 'String'
required: false
description: |-
image caption
'smallImageUrl':
type: 'String'
required: false
description: |-
smallImageUrl
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/Image.java'
'ItemReference@jv.seasonpass.mod':
id: 'ItemReference@jv.seasonpass.mod'
name: 'ItemReference'
type: 'model'
description: |-
A DTO object for item references.
fields:
'module':
type: 'String'
required: false
description: |-
module
'references':
type: 'List<Map<String, ?>>'
required: false
description: |-
references
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/ItemReference.java'
'ItemReferenceInfo@jv.seasonpass.mod':
id: 'ItemReferenceInfo@jv.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:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/ItemReferenceInfo.java'
'ListSeasonInfo@jv.seasonpass.mod':
id: 'ListSeasonInfo@jv.seasonpass.mod'
name: 'ListSeasonInfo'
type: 'model'
description: |-
A DTO object for listing season info.
fields:
'createdAt':
type: 'String'
required: true
description: |-
created at
'defaultLanguage':
type: 'String'
required: true
description: |-
default language, BCP 47 language tag
'end':
type: 'String'
required: true
description: |-
end date time
'id':
type: 'String'
required: true
description: |-
id
'name':
type: 'String'
required: true
description: |-
name, max length is 127
'namespace':
type: 'String'
required: true
description: |-
namespace
'start':
type: 'String'
required: true
description: |-
start date time
'status':
type: 'String'
required: true
description: |-
status
'tierItemId':
type: 'String'
required: true
description: |-
tier item id
'tierItemName':
type: 'String'
required: true
description: |-
tier item name
'updatedAt':
type: 'String'
required: true
description: |-
updated at
'passCodes':
type: 'List<String>'
required: false
description: |-
pass codes
'publishedAt':
type: 'String'
required: false
description: |-
publishedAt
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/ListSeasonInfo.java'
'ListSeasonInfoPagingSlicedResult@jv.seasonpass.mod':
id: 'ListSeasonInfoPagingSlicedResult@jv.seasonpass.mod'
name: 'ListSeasonInfoPagingSlicedResult'
type: 'model'
fields:
'data':
type: 'List<ListSeasonInfo>'
required: true
description: |-
data
'paging':
type: 'Paging'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/ListSeasonInfoPagingSlicedResult.java'
'ListUserSeasonInfo@jv.seasonpass.mod':
id: 'ListUserSeasonInfo@jv.seasonpass.mod'
name: 'ListUserSeasonInfo'
type: 'model'
description: |-
A DTO object for listing user season data.
fields:
'cleared':
type: 'Boolean'
required: true
description: |-
whether cleared all tiers
'currentTierIndex':
type: 'Integer'
required: true
description: |-
current tier index, zero based
'enrolledAt':
type: 'String'
required: true
description: |-
enroll date time
'id':
type: 'String'
required: true
description: |-
id
'lastTierIndex':
type: 'Integer'
required: true
description: |-
last tier index, zero based
'namespace':
type: 'String'
required: true
description: |-
namespace
'seasonId':
type: 'String'
required: true
description: |-
season id
'userId':
type: 'String'
required: true
description: |-
user id
'season':
type: 'SeasonSummary'
required: false
description: |-
season summary
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/ListUserSeasonInfo.java'
'ListUserSeasonInfoPagingSlicedResult@jv.seasonpass.mod':
id: 'ListUserSeasonInfoPagingSlicedResult@jv.seasonpass.mod'
name: 'ListUserSeasonInfoPagingSlicedResult'
type: 'model'
fields:
'data':
type: 'List<ListUserSeasonInfo>'
required: true
description: |-
data
'paging':
type: 'Paging'
required: false
'total':
type: 'Long'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/ListUserSeasonInfoPagingSlicedResult.java'
'Localization@jv.seasonpass.mod':
id: 'Localization@jv.seasonpass.mod'
name: 'Localization'
type: 'model'
fields:
'description':
type: 'String'
required: false
description: |-
description info
'title':
type: 'String'
required: false
description: |-
title info
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/Localization.java'
'LocalizedPassInfo@jv.seasonpass.mod':
id: 'LocalizedPassInfo@jv.seasonpass.mod'
name: 'LocalizedPassInfo'
type: 'model'
description: |-
A DTO object for public user retrieving pass info.
fields:
'autoEnroll':
type: 'Boolean'
required: true
description: |-
autoEnroll
'code':
type: 'String'
required: true
description: |-
code
'createdAt':
type: 'String'
required: true
description: |-
created at
'displayOrder':
type: 'String'
required: true
description: |-
displayOrder
'language':
type: 'String'
required: true
description: |-
current language
'namespace':
type: 'String'
required: true
description: |-
namespace
'passItemId':
type: 'String'
required: true
description: |-
pass item id
'seasonId':
type: 'String'
required: true
description: |-
season id
'updatedAt':
type: 'String'
required: true
description: |-
updated at
'description':
type: 'String'
required: false
description: |-
description info
'images':
type: 'List<Image>'
required: false
description: |-
images
'title':
type: 'String'
required: false
description: |-
title info
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/LocalizedPassInfo.java'
'LocalizedSeasonInfo@jv.seasonpass.mod':
id: 'LocalizedSeasonInfo@jv.seasonpass.mod'
name: 'LocalizedSeasonInfo'
type: 'model'
description: |-
A DTO object for public user retrieving season info.
fields:
'autoClaim':
type: 'Boolean'
required: true
description: |-
whether auto claim rewards
'createdAt':
type: 'String'
required: true
description: |-
created at
'end':
type: 'String'
required: true
description: |-
end date time
'id':
type: 'String'
required: true
description: |-
id
'language':
type: 'String'
required: true
description: |-
current language
'name':
type: 'String'
required: true
description: |-
name, max length is 127
'namespace':
type: 'String'
required: true
description: |-
namespace
'passes':
type: 'List<LocalizedPassInfo>'
required: true
description: |-
passes info
'rewards':
type: 'Map<String, RewardInfo>'
required: true
description: |-
rewards info
'start':
type: 'String'
required: true
description: |-
start date time
'status':
type: 'String'
required: true
description: |-
status
'tierItemId':
type: 'String'
required: true
description: |-
tier item id
'tiers':
type: 'List<Tier>'
required: true
description: |-
tiers info
'updatedAt':
type: 'String'
required: true
description: |-
updated at
'description':
type: 'String'
required: false
description: |-
description info
'images':
type: 'List<Image>'
required: false
description: |-
images
'passCodes':
type: 'List<String>'
required: false
description: |-
pass codes
'publishedAt':
type: 'String'
required: false
description: |-
publishedAt
'title':
type: 'String'
required: false
description: |-
title info
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/LocalizedSeasonInfo.java'
'Ownership@jv.seasonpass.mod':
id: 'Ownership@jv.seasonpass.mod'
name: 'Ownership'
type: 'model'
fields:
'owned':
type: 'Boolean'
required: true
description: |-
ownership
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/Ownership.java'
'Paging@jv.seasonpass.mod':
id: 'Paging@jv.seasonpass.mod'
name: 'Paging'
type: 'model'
fields:
'next':
type: 'String'
required: false
'previous':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/Paging.java'
'PassCreate@jv.seasonpass.mod':
id: 'PassCreate@jv.seasonpass.mod'
name: 'PassCreate'
type: 'model'
description: |-
A DTO object for creating pass API call.
fields:
'code':
type: 'String'
required: true
description: |-
code, allowed characters from a-z0-9_:- and start/end in alphanumeric, max length is 255
'displayOrder':
type: 'Integer'
required: true
description: |-
displayOrder for frontend to arrange the pass
'localizations':
type: 'Map<String, Localization>'
required: true
description: |-
localization, {language: localization} map
'passItemId':
type: 'String'
required: true
description: |-
pass item id
'autoEnroll':
type: 'Boolean'
required: false
description: |-
autoEnroll for free pass, default false
'images':
type: 'List<Image>'
required: false
description: |-
images
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/PassCreate.java'
'PassInfo@jv.seasonpass.mod':
id: 'PassInfo@jv.seasonpass.mod'
name: 'PassInfo'
type: 'model'
description: |-
A DTO object for pass info.
fields:
'autoEnroll':
type: 'Boolean'
required: true
description: |-
autoEnroll
'code':
type: 'String'
required: true
description: |-
code
'createdAt':
type: 'String'
required: true
description: |-
created at
'displayOrder':
type: 'String'
required: true
description: |-
displayOrder
'localizations':
type: 'Map<String, Localization>'
required: true
description: |-
localization, {language: localization} map
'namespace':
type: 'String'
required: true
description: |-
namespace
'passItemId':
type: 'String'
required: true
description: |-
pass item id
'passItemName':
type: 'String'
required: true
description: |-
pass item name
'seasonId':
type: 'String'
required: true
description: |-
season id
'updatedAt':
type: 'String'
required: true
description: |-
updated at
'images':
type: 'List<Image>'
required: false
description: |-
images
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/PassInfo.java'
'PassUpdate@jv.seasonpass.mod':
id: 'PassUpdate@jv.seasonpass.mod'
name: 'PassUpdate'
type: 'model'
description: |-
A DTO object for updating pass API call.
fields:
'autoEnroll':
type: 'Boolean'
required: false
description: |-
autoEnroll for free pass
'displayOrder':
type: 'Integer'
required: false
description: |-
displayOrder for frontend to arrange the pass
'images':
type: 'List<Image>'
required: false
description: |-
images
'localizations':
type: 'Map<String, Localization>'
required: false
description: |-
localization, {language: localization} map
'passItemId':
type: 'String'
required: false
description: |-
pass item id
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/PassUpdate.java'
'Permission@jv.seasonpass.mod':
id: 'Permission@jv.seasonpass.mod'
name: 'Permission'
type: 'model'
fields:
'action':
type: 'Integer'
required: false
'resource':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/Permission.java'
'ReasonTagsResult@jv.seasonpass.mod':
id: 'ReasonTagsResult@jv.seasonpass.mod'
name: 'ReasonTagsResult'
type: 'model'
description: |-
A DTO object for reason tags.
fields:
'tags':
type: 'List<String>'
required: true
description: |-
tags
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/ReasonTagsResult.java'
'RewardCreate@jv.seasonpass.mod':
id: 'RewardCreate@jv.seasonpass.mod'
name: 'RewardCreate'
type: 'model'
description: |-
A DTO object for creating reward API call.
fields:
'code':
type: 'String'
required: true
description: |-
code, allowed characters from a-z0-9_:- and start/end in alphanumeric, max length is 255
'type':
type: 'String'
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
'itemId':
type: 'String'
required: false
description: |-
itemId, required when reward type is ITEM, the item type should be one of: INGAMEITEM,COINS,BUNDLE
'quantity':
type: 'Integer'
required: false
description: |-
Item quantity or Currency amount, default 1
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/RewardCreate.java'
'RewardCurrency@jv.seasonpass.mod':
id: 'RewardCurrency@jv.seasonpass.mod'
name: 'RewardCurrency'
type: 'model'
description: |-
A DTO object for reward currency.
fields:
'currencyCode':
type: 'String'
required: true
description: |-
currency code, alphabet uppercase
'namespace':
type: 'String'
required: true
description: |-
namespace, allowed values: game namespace or publisher namespace
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/RewardCurrency.java'
'RewardInfo@jv.seasonpass.mod':
id: 'RewardInfo@jv.seasonpass.mod'
name: 'RewardInfo'
type: 'model'
description: |-
A DTO object for reward info.
fields:
'code':
type: 'String'
required: true
description: |-
code
'namespace':
type: 'String'
required: true
description: |-
namespace
'seasonId':
type: 'String'
required: true
description: |-
seasonId
'type':
type: 'String'
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
'itemId':
type: 'String'
required: false
description: |-
itemId, required when reward type is ITEM
'itemName':
type: 'String'
required: false
description: |-
itemName, required when reward type is ITEM
'itemSku':
type: 'String'
required: false
description: |-
itemSku, required when reward type is ITEM
'itemType':
type: 'String'
required: false
description: |-
itemType, required when reward type is ITEM
'quantity':
type: 'Integer'
required: false
description: |-
Item quantity or Currency amount, default 1
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/RewardInfo.java'
'RewardUpdate@jv.seasonpass.mod':
id: 'RewardUpdate@jv.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
'itemId':
type: 'String'
required: false
description: |-
itemId, required when reward type is ITEM, the item type should be one of: INGAMEITEM,COINS,BUNDLE
'nullFields':
type: 'List<String>'
required: false
description: |-
nullFields
'quantity':
type: 'Integer'
required: false
description: |-
Item quantity or Currency amount, default 1
'type':
type: 'String'
required: false
description: |-
type, at current only support ITEM
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/RewardUpdate.java'
'SeasonCloneRequest@jv.seasonpass.mod':
id: 'SeasonCloneRequest@jv.seasonpass.mod'
name: 'SeasonCloneRequest'
type: 'model'
description: |-
A DTO object for clone season API call.
fields:
'end':
type: 'String'
required: true
description: |-
end date time
'name':
type: 'String'
required: true
description: |-
name, max length is 127
'start':
type: 'String'
required: true
description: |-
start date time
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/SeasonCloneRequest.java'
'SeasonCreate@jv.seasonpass.mod':
id: 'SeasonCreate@jv.seasonpass.mod'
name: 'SeasonCreate'
type: 'model'
description: |-
A DTO object for creating season API call.
fields:
'defaultRequiredExp':
type: 'Integer'
required: true
description: |-
default exp required for a tier
'draftStoreId':
type: 'String'
required: true
description: |-
draft store id
'end':
type: 'String'
required: true
description: |-
end date time
'localizations':
type: 'Map<String, Localization>'
required: true
description: |-
localization, {language: localization} map
'name':
type: 'String'
required: true
description: |-
name, max length is 127
'start':
type: 'String'
required: true
description: |-
start date time
'tierItemId':
type: 'String'
required: true
description: |-
tier item id
'autoClaim':
type: 'Boolean'
required: false
description: |-
whether auto claim rewards, default true
'defaultLanguage':
type: 'String'
required: false
description: |-
default language, BCP 47 language tag, default is en
'excessStrategy':
type: 'ExcessStrategy'
required: false
description: |-
strategy while exceed final tier exp, default NONE
'images':
type: 'List<Image>'
required: false
description: |-
images
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/SeasonCreate.java'
'SeasonInfo@jv.seasonpass.mod':
id: 'SeasonInfo@jv.seasonpass.mod'
name: 'SeasonInfo'
type: 'model'
description: |-
A DTO object for season info.
fields:
'autoClaim':
type: 'Boolean'
required: true
description: |-
whether auto claim rewards
'createdAt':
type: 'String'
required: true
description: |-
created at
'defaultLanguage':
type: 'String'
required: true
description: |-
default language, BCP 47 language tag
'defaultRequiredExp':
type: 'Integer'
required: true
description: |-
default required exp for a tier
'draftStoreId':
type: 'String'
required: true
description: |-
draft store id
'end':
type: 'String'
required: true
description: |-
end date time
'excessStrategy':
type: 'ExcessStrategy'
required: true
description: |-
strategy while exceed final tier exp
'id':
type: 'String'
required: true
description: |-
id
'localizations':
type: 'Map<String, Localization>'
required: true
description: |-
localization, {language: localization} map
'name':
type: 'String'
required: true
description: |-
name, max length is 127
'namespace':
type: 'String'
required: true
description: |-
namespace
'start':
type: 'String'
required: true
description: |-
start date time
'status':
type: 'String'
required: true
description: |-
status
'tierItemId':
type: 'String'
required: true
description: |-
tier item id
'tierItemName':
type: 'String'
required: true
description: |-
tier item name
'updatedAt':
type: 'String'
required: true
description: |-
updated at
'images':
type: 'List<Image>'
required: false
description: |-
images
'passCodes':
type: 'List<String>'
required: false
description: |-
pass codes
'publishedAt':
type: 'String'
required: false
description: |-
publishedAt
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/SeasonInfo.java'
'SeasonSummary@jv.seasonpass.mod':
id: 'SeasonSummary@jv.seasonpass.mod'
name: 'SeasonSummary'
type: 'model'
description: |-
A DTO object for season summary.
fields:
'end':
type: 'String'
required: true
description: |-
end date time
'id':
type: 'String'
required: true
description: |-
id
'name':
type: 'String'
required: true
description: |-
name, max length is 127
'namespace':
type: 'String'
required: true
description: |-
namespace
'start':
type: 'String'
required: true
description: |-
start date time
'status':
type: 'String'
required: true
description: |-
status
'passCodes':
type: 'List<String>'
required: false
description: |-
season pass codes
'previous':
type: 'SeasonSummary'
required: false
description: |-
previous season, only present in some situation
'publishedAt':
type: 'String'
required: false
description: |-
publishedAt
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/SeasonSummary.java'
'SeasonUpdate@jv.seasonpass.mod':
id: 'SeasonUpdate@jv.seasonpass.mod'
name: 'SeasonUpdate'
type: 'model'
description: |-
A DTO object for updating season API call.
fields:
'autoClaim':
type: 'Boolean'
required: false
description: |-
whether auto claim rewards
'defaultLanguage':
type: 'String'
required: false
description: |-
default language, BCP 47 language tag
'defaultRequiredExp':
type: 'Integer'
required: false
description: |-
default exp required for a tier
'draftStoreId':
type: 'String'
required: false
description: |-
draft store id
'end':
type: 'String'
required: false
description: |-
end date time
'excessStrategy':
type: 'ExcessStrategy'
required: false
description: |-
strategy while exceed final tier exp
'images':
type: 'List<Image>'
required: false
description: |-
images
'localizations':
type: 'Map<String, Localization>'
required: false
description: |-
localization, {language: localization} map
'name':
type: 'String'
required: false
description: |-
name, max length is 127
'start':
type: 'String'
required: false
description: |-
start date time
'tierItemId':
type: 'String'
required: false
description: |-
tier item id
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/SeasonUpdate.java'
'Tier@jv.seasonpass.mod':
id: 'Tier@jv.seasonpass.mod'
name: 'Tier'
type: 'model'
fields:
'id':
type: 'String'
required: false
description: |-
tier id, auto generated.
'requiredExp':
type: 'Integer'
required: false
description: |-
required exp for tier, it will automatically use season defaultRequiredExp if not set
'rewards':
type: 'Map<String, List<String>>'
required: false
description: |-
rewards map, passCode as key, rewardCode list as value
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/Tier.java'
'TierCreate@jv.seasonpass.mod':
id: 'TierCreate@jv.seasonpass.mod'
name: 'TierCreate'
type: 'model'
description: |-
A DTO object for creating tier API call.
fields:
'index':
type: 'Integer'
required: false
description: |-
zero based tier index to be inserted at, -1 means appending to the end, default -1
'quantity':
type: 'Integer'
required: false
description: |-
create tier quantity, default 1
'tier':
type: 'TierInput'
required: false
description: |-
tier content, default null tier
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/TierCreate.java'
'TierInput@jv.seasonpass.mod':
id: 'TierInput@jv.seasonpass.mod'
name: 'TierInput'
type: 'model'
description: |-
A DTO object for tier input.
fields:
'requiredExp':
type: 'Integer'
required: false
description: |-
required exp for tier, it will automatically use season defaultRequiredExp if not set
'rewards':
type: 'Map<String, List<String>>'
required: false
description: |-
rewards map, passCode as key, rewardCode list as value
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/TierInput.java'
'TierPagingSlicedResult@jv.seasonpass.mod':
id: 'TierPagingSlicedResult@jv.seasonpass.mod'
name: 'TierPagingSlicedResult'
type: 'model'
fields:
'data':
type: 'List<Tier>'
required: true
description: |-
data
'paging':
type: 'Paging'
required: false
'total':
type: 'Long'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/TierPagingSlicedResult.java'
'TierReorder@jv.seasonpass.mod':
id: 'TierReorder@jv.seasonpass.mod'
name: 'TierReorder'
type: 'model'
fields:
'newIndex':
type: 'Integer'
required: false
description: |-
new index tier should be moved to, zero based, -1 means appending to the end
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/TierReorder.java'
'UserExpGrant@jv.seasonpass.mod':
id: 'UserExpGrant@jv.seasonpass.mod'
name: 'UserExpGrant'
type: 'model'
description: |-
A DTO object for granting user exp.
fields:
'exp':
type: 'Integer'
required: false
description: |-
exp to grant
'source':
type: 'String'
required: false
description: |-
source
'tags':
type: 'List<String>'
required: false
description: |-
tags
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/UserExpGrant.java'
'UserPassGrant@jv.seasonpass.mod':
id: 'UserPassGrant@jv.seasonpass.mod'
name: 'UserPassGrant'
type: 'model'
description: |-
A DTO object for granting user pass.
fields:
'passCode':
type: 'String'
required: false
description: |-
pass code, required if passItemId null
'passItemId':
type: 'String'
required: false
description: |-
pass item id, required if passCode null and ignored if passCode present
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/UserPassGrant.java'
'UserPurchasable@jv.seasonpass.mod':
id: 'UserPurchasable@jv.seasonpass.mod'
name: 'UserPurchasable'
type: 'model'
description: |-
A DTO object for user purchasable.
fields:
'passItemId':
type: 'String'
required: false
description: |-
pass item id
'tierItemCount':
type: 'Integer'
required: false
description: |-
tier item count, default 1
'tierItemId':
type: 'String'
required: false
description: |-
tier item id
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/UserPurchasable.java'
'UserRewardClaim@jv.seasonpass.mod':
id: 'UserRewardClaim@jv.seasonpass.mod'
name: 'UserRewardClaim'
type: 'model'
description: |-
A DTO object for claiming user reward.
fields:
'passCode':
type: 'String'
required: true
description: |-
pass code
'rewardCode':
type: 'String'
required: true
description: |-
reward code
'tierIndex':
type: 'Integer'
required: true
description: |-
tier index
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/UserRewardClaim.java'
'UserSeasonSummary@jv.seasonpass.mod':
id: 'UserSeasonSummary@jv.seasonpass.mod'
name: 'UserSeasonSummary'
type: 'model'
description: |-
A DTO object for user season summary.
fields:
'namespace':
type: 'String'
required: true
description: |-
namespace
'userId':
type: 'String'
required: true
description: |-
user id
'cleared':
type: 'Boolean'
required: false
description: |-
whether cleared all tiers
'createdAt':
type: 'String'
required: false
description: |-
created at
'currentExp':
type: 'Integer'
required: false
description: |-
gained exp for current tier
'currentTierIndex':
type: 'Integer'
required: false
description: |-
current tier index, zero based
'enrolledAt':
type: 'String'
required: false
description: |-
enroll date time
'enrolledPasses':
type: 'List<String>'
required: false
description: |-
enrolled passes
'id':
type: 'String'
required: false
description: |-
id
'lastTierIndex':
type: 'Integer'
required: false
description: |-
last tier index, zero based
'requiredExp':
type: 'Integer'
required: false
description: |-
required exp for current tier
'seasonId':
type: 'String'
required: false
description: |-
season id
'updatedAt':
type: 'String'
required: false
description: |-
updated at
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/UserSeasonSummary.java'
'UserTierGrant@jv.seasonpass.mod':
id: 'UserTierGrant@jv.seasonpass.mod'
name: 'UserTierGrant'
type: 'model'
description: |-
A DTO object for granting user tier.
fields:
'count':
type: 'Integer'
required: false
description: |-
count to grant
'source':
type: 'String'
required: false
description: |-
source
'tags':
type: 'List<String>'
required: false
description: |-
tags
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/UserTierGrant.java'
'ValidationErrorEntity@jv.seasonpass.mod':
id: 'ValidationErrorEntity@jv.seasonpass.mod'
name: 'ValidationErrorEntity'
type: 'model'
fields:
'errorCode':
type: 'Integer'
required: true
description: |-
numeric error code
'errorMessage':
type: 'String'
required: true
description: |-
error message
'errors':
type: 'List<FieldValidationError>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/models/ValidationErrorEntity.java'
# endregion models
# region functions
'BulkGetUserSeasonProgression@jv.seasonpass.fun':
id: 'BulkGetUserSeasonProgression@jv.seasonpass.fun'
name: 'BulkGetUserSeasonProgression'
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: 'BulkUserProgressionRequest'
required: false
'namespace':
type: 'String'
required: true
description: |-
Namespace
return_type: 'List<UserSeasonSummary>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/BulkGetUserSeasonProgression.java'
example: |-
try {
final BulkGetUserSeasonProgression operation = BulkGetUserSeasonProgression.builder()
.body(...)
.build(
namespace,
);
final Season wrapper = new Season(sdk);
final List<UserSeasonSummary> response = wrapper.bulkGetUserSeasonProgression(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'bulk'
- 'get'
- 'progression'
- 'season'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'CheckSeasonPurchasable@jv.seasonpass.fun':
id: 'CheckSeasonPurchasable@jv.seasonpass.fun'
name: 'CheckSeasonPurchasable'
type: 'function'
description: |-
This API is used to check pass or tier purchasable, season only located in non-publisher namespace.
arguments:
'body':
type: 'UserPurchasable'
required: false
'namespace':
type: 'String'
required: true
description: |-
Namespace
'userId':
type: 'String'
required: true
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/CheckSeasonPurchasable.java'
example: |-
try {
final CheckSeasonPurchasable operation = CheckSeasonPurchasable.builder()
.body(...)
.build(
namespace,
userId,
);
final Season wrapper = new Season(sdk);
wrapper.checkSeasonPurchasable(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'check'
- 'purchasable'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'CloneSeason@jv.seasonpass.fun':
id: 'CloneSeason@jv.seasonpass.fun'
name: 'CloneSeason'
type: 'function'
description: |-
This API is used to clone a season.
Other detail info:
* Returns : cloned season info
arguments:
'body':
type: 'SeasonCloneRequest'
required: false
'namespace':
type: 'String'
required: true
'seasonId':
type: 'String'
required: true
return_type: 'SeasonInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/CloneSeason.java'
example: |-
try {
final CloneSeason operation = CloneSeason.builder()
.body(...)
.build(
namespace,
seasonId,
);
final Season wrapper = new Season(sdk);
final SeasonInfo response = wrapper.cloneSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'clone'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'CreatePass@jv.seasonpass.fun':
id: 'CreatePass@jv.seasonpass.fun'
name: 'CreatePass'
type: 'function'
description: |-
This API is used to create a pass for a draft season.
Other detail info:
* Returns : created pass
arguments:
'body':
type: 'PassCreate'
required: false
'namespace':
type: 'String'
required: true
description: |-
Namespace
'seasonId':
type: 'String'
required: true
return_type: 'PassInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.pass.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Pass.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/pass/CreatePass.java'
example: |-
try {
final CreatePass operation = CreatePass.builder()
.body(...)
.build(
namespace,
seasonId,
);
final Pass wrapper = new Pass(sdk);
final PassInfo response = wrapper.createPass(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'create'
- 'pass'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'CreateReward@jv.seasonpass.fun':
id: 'CreateReward@jv.seasonpass.fun'
name: 'CreateReward'
type: 'function'
description: |-
This API is used to create a reward for a draft season.
Other detail info:
* Returns : created reward
arguments:
'body':
type: 'RewardCreate'
required: false
'namespace':
type: 'String'
required: true
description: |-
Namespace
'seasonId':
type: 'String'
required: true
return_type: 'RewardInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.reward.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Reward.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/reward/CreateReward.java'
example: |-
try {
final CreateReward operation = CreateReward.builder()
.body(...)
.build(
namespace,
seasonId,
);
final Reward wrapper = new Reward(sdk);
final RewardInfo response = wrapper.createReward(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'create'
- 'reward'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'CreateSeason@jv.seasonpass.fun':
id: 'CreateSeason@jv.seasonpass.fun'
name: 'CreateSeason'
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: 'SeasonCreate'
required: false
'namespace':
type: 'String'
required: true
description: |-
Namespace
return_type: 'SeasonInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/CreateSeason.java'
example: |-
try {
final CreateSeason operation = CreateSeason.builder()
.body(...)
.build(
namespace,
);
final Season wrapper = new Season(sdk);
final SeasonInfo response = wrapper.createSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'create'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'CreateTier@jv.seasonpass.fun':
id: 'CreateTier@jv.seasonpass.fun'
name: 'CreateTier'
type: 'function'
description: |-
This API is used to create tier for a draft season, can create multiple tiers at same time.
arguments:
'body':
type: 'TierCreate'
required: false
'namespace':
type: 'String'
required: true
description: |-
Namespace
'seasonId':
type: 'String'
required: true
return_type: 'List<Tier>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.tier.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Tier.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/tier/CreateTier.java'
example: |-
try {
final CreateTier operation = CreateTier.builder()
.body(...)
.build(
namespace,
seasonId,
);
final Tier wrapper = new Tier(sdk);
final List<Tier> response = wrapper.createTier(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'create'
- 'tier'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'DeletePass@jv.seasonpass.fun':
id: 'DeletePass@jv.seasonpass.fun'
name: 'DeletePass'
type: 'function'
description: |-
This API is used to delete a pass permanently, only draft season pass can be deleted.
arguments:
'code':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
description: |-
Namespace
'seasonId':
type: 'String'
required: true
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.pass.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Pass.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/pass/DeletePass.java'
example: |-
try {
final DeletePass operation = DeletePass.builder()
.build(
code,
namespace,
seasonId,
);
final Pass wrapper = new Pass(sdk);
wrapper.deletePass(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'pass'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]'
'DeleteReward@jv.seasonpass.fun':
id: 'DeleteReward@jv.seasonpass.fun'
name: 'DeleteReward'
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: 'String'
required: true
'namespace':
type: 'String'
required: true
description: |-
Namespace
'seasonId':
type: 'String'
required: true
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.reward.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Reward.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/reward/DeleteReward.java'
example: |-
try {
final DeleteReward operation = DeleteReward.builder()
.build(
code,
namespace,
seasonId,
);
final Reward wrapper = new Reward(sdk);
wrapper.deleteReward(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'reward'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]'
'DeleteSeason@jv.seasonpass.fun':
id: 'DeleteSeason@jv.seasonpass.fun'
name: 'DeleteSeason'
type: 'function'
description: |-
This API is used to delete a season permanently, only draft season can be deleted.
arguments:
'namespace':
type: 'String'
required: true
description: |-
Namespace
'seasonId':
type: 'String'
required: true
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/DeleteSeason.java'
example: |-
try {
final DeleteSeason operation = DeleteSeason.builder()
.build(
namespace,
seasonId,
);
final Season wrapper = new Season(sdk);
wrapper.deleteSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]'
'DeleteTier@jv.seasonpass.fun':
id: 'DeleteTier@jv.seasonpass.fun'
name: 'DeleteTier'
type: 'function'
description: |-
This API is used to delete a tier permanently, only draft season pass can be deleted.
arguments:
'id':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
description: |-
Namespace
'seasonId':
type: 'String'
required: true
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.tier.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Tier.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/tier/DeleteTier.java'
example: |-
try {
final DeleteTier operation = DeleteTier.builder()
.build(
id,
namespace,
seasonId,
);
final Tier wrapper = new Tier(sdk);
wrapper.deleteTier(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'tier'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]'
'ExistsAnyPassByPassCodes@jv.seasonpass.fun':
id: 'ExistsAnyPassByPassCodes@jv.seasonpass.fun'
name: 'ExistsAnyPassByPassCodes'
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: 'String'
required: true
description: |-
Namespace
'passCodes':
type: 'List<String>'
required: false
'userId':
type: 'String'
required: true
return_type: 'Ownership'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/ExistsAnyPassByPassCodes.java'
example: |-
try {
final ExistsAnyPassByPassCodes operation = ExistsAnyPassByPassCodes.builder()
.passCodes(...)
.build(
namespace,
userId,
);
final Season wrapper = new Season(sdk);
final Ownership response = wrapper.existsAnyPassByPassCodes(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'any'
- 'by'
- 'codes'
- 'exists'
- 'pass'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'ExportSeason@jv.seasonpass.fun':
id: 'ExportSeason@jv.seasonpass.fun'
name: 'ExportSeason'
type: 'function'
description: |-
This API is used to export all of season service data files with csv format.
arguments:
'namespace':
type: 'String'
required: true
description: |-
Namespace
return_type: 'File'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.export.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Export.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/export/ExportSeason.java'
example: |-
try {
final ExportSeason operation = ExportSeason.builder()
.build(
namespace,
);
final Export wrapper = new Export(sdk);
final File response = wrapper.exportSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'export'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'GetCurrentSeason@jv.seasonpass.fun':
id: 'GetCurrentSeason@jv.seasonpass.fun'
name: 'GetCurrentSeason'
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: 'String'
required: true
description: |-
Namespace
return_type: 'SeasonSummary'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/GetCurrentSeason.java'
example: |-
try {
final GetCurrentSeason operation = GetCurrentSeason.builder()
.build(
namespace,
);
final Season wrapper = new Season(sdk);
final SeasonSummary response = wrapper.getCurrentSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'current'
- 'get'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'GetCurrentUserSeasonProgression@jv.seasonpass.fun':
id: 'GetCurrentUserSeasonProgression@jv.seasonpass.fun'
name: 'GetCurrentUserSeasonProgression'
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: 'String'
required: true
description: |-
Namespace
'userId':
type: 'String'
required: true
return_type: 'UserSeasonSummary'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/GetCurrentUserSeasonProgression.java'
example: |-
try {
final GetCurrentUserSeasonProgression operation = GetCurrentUserSeasonProgression.builder()
.build(
namespace,
userId,
);
final Season wrapper = new Season(sdk);
final UserSeasonSummary response = wrapper.getCurrentUserSeasonProgression(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'current'
- 'get'
- 'progression'
- 'season'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'GetFullSeason@jv.seasonpass.fun':
id: 'GetFullSeason@jv.seasonpass.fun'
name: 'GetFullSeason'
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: 'String'
required: true
description: |-
Namespace
'seasonId':
type: 'String'
required: true
return_type: 'FullSeasonInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/GetFullSeason.java'
example: |-
try {
final GetFullSeason operation = GetFullSeason.builder()
.build(
namespace,
seasonId,
);
final Season wrapper = new Season(sdk);
final FullSeasonInfo response = wrapper.getFullSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'full'
- 'get'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'GetItemReferences@jv.seasonpass.fun':
id: 'GetItemReferences@jv.seasonpass.fun'
name: 'GetItemReferences'
type: 'function'
description: |-
This API is used to get season pass ecommerce item references.
Other detail info:
* Returns : item references data
arguments:
'itemId':
type: 'String'
required: true
description: |-
the id of the ecommerce item
'namespace':
type: 'String'
required: true
description: |-
namespace
return_type: 'ItemReferenceInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.utilities.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Utilities.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/utilities/GetItemReferences.java'
example: |-
try {
final GetItemReferences operation = GetItemReferences.builder()
.build(
itemId,
namespace,
);
final Utilities wrapper = new Utilities(sdk);
final ItemReferenceInfo response = wrapper.getItemReferences(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'item'
- 'references'
- 'utilities'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'GetPass@jv.seasonpass.fun':
id: 'GetPass@jv.seasonpass.fun'
name: 'GetPass'
type: 'function'
description: |-
This API is used to get a pass for a season.
Other detail info:
* Returns : pass data
arguments:
'code':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
description: |-
Namespace
'seasonId':
type: 'String'
required: true
return_type: 'PassInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.pass.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Pass.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/pass/GetPass.java'
example: |-
try {
final GetPass operation = GetPass.builder()
.build(
code,
namespace,
seasonId,
);
final Pass wrapper = new Pass(sdk);
final PassInfo response = wrapper.getPass(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'pass'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'GetReward@jv.seasonpass.fun':
id: 'GetReward@jv.seasonpass.fun'
name: 'GetReward'
type: 'function'
description: |-
This API is used to get a reward for a season.
Other detail info:
* Returns : reward data
arguments:
'code':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
description: |-
Namespace
'seasonId':
type: 'String'
required: true
return_type: 'RewardInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.reward.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Reward.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/reward/GetReward.java'
example: |-
try {
final GetReward operation = GetReward.builder()
.build(
code,
namespace,
seasonId,
);
final Reward wrapper = new Reward(sdk);
final RewardInfo response = wrapper.getReward(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'reward'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'GetSeason@jv.seasonpass.fun':
id: 'GetSeason@jv.seasonpass.fun'
name: 'GetSeason'
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: 'String'
required: true
description: |-
Namespace
'seasonId':
type: 'String'
required: true
return_type: 'SeasonInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/GetSeason.java'
example: |-
try {
final GetSeason operation = GetSeason.builder()
.build(
namespace,
seasonId,
);
final Season wrapper = new Season(sdk);
final SeasonInfo response = wrapper.getSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'GetUserParticipatedSeasons@jv.seasonpass.fun':
id: 'GetUserParticipatedSeasons@jv.seasonpass.fun'
name: 'GetUserParticipatedSeasons'
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: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
description: |-
Namespace
'offset':
type: 'Integer'
required: false
description: |-
offset
'userId':
type: 'String'
required: true
return_type: 'ListUserSeasonInfoPagingSlicedResult'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/GetUserParticipatedSeasons.java'
example: |-
try {
final GetUserParticipatedSeasons operation = GetUserParticipatedSeasons.builder()
.limit(...)
.offset(...)
.build(
namespace,
userId,
);
final Season wrapper = new Season(sdk);
final ListUserSeasonInfoPagingSlicedResult response = wrapper.getUserParticipatedSeasons(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'participated'
- 'season'
- 'seasons'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'GetUserSeason@jv.seasonpass.fun':
id: 'GetUserSeason@jv.seasonpass.fun'
name: 'GetUserSeason'
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: 'String'
required: true
description: |-
Namespace
'seasonId':
type: 'String'
required: true
'userId':
type: 'String'
required: true
return_type: 'ClaimableUserSeasonInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/GetUserSeason.java'
example: |-
try {
final GetUserSeason operation = GetUserSeason.builder()
.build(
namespace,
seasonId,
userId,
);
final Season wrapper = new Season(sdk);
final ClaimableUserSeasonInfo response = wrapper.getUserSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'season'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'GrantUserExp@jv.seasonpass.fun':
id: 'GrantUserExp@jv.seasonpass.fun'
name: 'GrantUserExp'
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: 'UserExpGrant'
required: false
'namespace':
type: 'String'
required: true
description: |-
Namespace
'userId':
type: 'String'
required: true
return_type: 'UserSeasonSummary'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.tier.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Tier.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/tier/GrantUserExp.java'
example: |-
try {
final GrantUserExp operation = GrantUserExp.builder()
.body(...)
.build(
namespace,
userId,
);
final Tier wrapper = new Tier(sdk);
final UserSeasonSummary response = wrapper.grantUserExp(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'exp'
- 'grant'
- 'tier'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]'
'GrantUserPass@jv.seasonpass.fun':
id: 'GrantUserPass@jv.seasonpass.fun'
name: 'GrantUserPass'
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: 'UserPassGrant'
required: false
'namespace':
type: 'String'
required: true
description: |-
Namespace
'userId':
type: 'String'
required: true
return_type: 'UserSeasonSummary'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.pass.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Pass.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/pass/GrantUserPass.java'
example: |-
try {
final GrantUserPass operation = GrantUserPass.builder()
.body(...)
.build(
namespace,
userId,
);
final Pass wrapper = new Pass(sdk);
final UserSeasonSummary response = wrapper.grantUserPass(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'grant'
- 'pass'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]'
'GrantUserTier@jv.seasonpass.fun':
id: 'GrantUserTier@jv.seasonpass.fun'
name: 'GrantUserTier'
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: 'UserTierGrant'
required: false
'namespace':
type: 'String'
required: true
description: |-
Namespace
'userId':
type: 'String'
required: true
return_type: 'UserSeasonSummary'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.tier.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Tier.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/tier/GrantUserTier.java'
example: |-
try {
final GrantUserTier operation = GrantUserTier.builder()
.body(...)
.build(
namespace,
userId,
);
final Tier wrapper = new Tier(sdk);
final UserSeasonSummary response = wrapper.grantUserTier(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'grant'
- 'tier'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]'
'PublicBulkClaimUserRewards@jv.seasonpass.fun':
id: 'PublicBulkClaimUserRewards@jv.seasonpass.fun'
name: 'PublicBulkClaimUserRewards'
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: 'String'
required: true
description: |-
Namespace
'userId':
type: 'String'
required: true
return_type: 'ClaimableRewards'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.reward.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Reward.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/reward/PublicBulkClaimUserRewards.java'
example: |-
try {
final PublicBulkClaimUserRewards operation = PublicBulkClaimUserRewards.builder()
.build(
namespace,
userId,
);
final Reward wrapper = new Reward(sdk);
final ClaimableRewards response = wrapper.publicBulkClaimUserRewards(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'bulk'
- 'claim'
- 'public'
- 'reward'
- 'rewards'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]'
'PublicClaimUserReward@jv.seasonpass.fun':
id: 'PublicClaimUserReward@jv.seasonpass.fun'
name: 'PublicClaimUserReward'
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: 'UserRewardClaim'
required: false
'namespace':
type: 'String'
required: true
description: |-
Namespace
'userId':
type: 'String'
required: true
return_type: 'ClaimableRewards'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.reward.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Reward.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/reward/PublicClaimUserReward.java'
example: |-
try {
final PublicClaimUserReward operation = PublicClaimUserReward.builder()
.body(...)
.build(
namespace,
userId,
);
final Reward wrapper = new Reward(sdk);
final ClaimableRewards response = wrapper.publicClaimUserReward(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'claim'
- 'public'
- 'reward'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]'
'PublicGetCurrentSeason@jv.seasonpass.fun':
id: 'PublicGetCurrentSeason@jv.seasonpass.fun'
name: 'PublicGetCurrentSeason'
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: 'String'
required: false
'namespace':
type: 'String'
required: true
description: |-
Namespace
return_type: 'LocalizedSeasonInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/PublicGetCurrentSeason.java'
example: |-
try {
final PublicGetCurrentSeason operation = PublicGetCurrentSeason.builder()
.language(...)
.build(
namespace,
);
final Season wrapper = new Season(sdk);
final LocalizedSeasonInfo response = wrapper.publicGetCurrentSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'current'
- 'get'
- 'public'
- 'season'
'PublicGetCurrentUserSeason@jv.seasonpass.fun':
id: 'PublicGetCurrentUserSeason@jv.seasonpass.fun'
name: 'PublicGetCurrentUserSeason'
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: 'String'
required: true
description: |-
Namespace
'userId':
type: 'String'
required: true
return_type: 'ClaimableUserSeasonInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/PublicGetCurrentUserSeason.java'
example: |-
try {
final PublicGetCurrentUserSeason operation = PublicGetCurrentUserSeason.builder()
.build(
namespace,
userId,
);
final Season wrapper = new Season(sdk);
final ClaimableUserSeasonInfo response = wrapper.publicGetCurrentUserSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'current'
- 'get'
- 'public'
- 'season'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'PublicGetUserSeason@jv.seasonpass.fun':
id: 'PublicGetUserSeason@jv.seasonpass.fun'
name: 'PublicGetUserSeason'
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: 'String'
required: true
description: |-
Namespace
'seasonId':
type: 'String'
required: true
'userId':
type: 'String'
required: true
return_type: 'ClaimableUserSeasonInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/PublicGetUserSeason.java'
example: |-
try {
final PublicGetUserSeason operation = PublicGetUserSeason.builder()
.build(
namespace,
seasonId,
userId,
);
final Season wrapper = new Season(sdk);
final ClaimableUserSeasonInfo response = wrapper.publicGetUserSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'public'
- 'season'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'PublishSeason@jv.seasonpass.fun':
id: 'PublishSeason@jv.seasonpass.fun'
name: 'PublishSeason'
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: 'String'
required: true
'seasonId':
type: 'String'
required: true
return_type: 'SeasonInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/PublishSeason.java'
example: |-
try {
final PublishSeason operation = PublishSeason.builder()
.build(
namespace,
seasonId,
);
final Season wrapper = new Season(sdk);
final SeasonInfo response = wrapper.publishSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'publish'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'QueryPasses@jv.seasonpass.fun':
id: 'QueryPasses@jv.seasonpass.fun'
name: 'QueryPasses'
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: 'String'
required: true
'seasonId':
type: 'String'
required: true
return_type: 'List<PassInfo>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.pass.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Pass.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/pass/QueryPasses.java'
example: |-
try {
final QueryPasses operation = QueryPasses.builder()
.build(
namespace,
seasonId,
);
final Pass wrapper = new Pass(sdk);
final List<PassInfo> response = wrapper.queryPasses(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'pass'
- 'passes'
- 'query'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'QueryRewards@jv.seasonpass.fun':
id: 'QueryRewards@jv.seasonpass.fun'
name: 'QueryRewards'
type: 'function'
description: |-
This API is used to query rewards for a season.
Other detail info:
* Returns : the list of rewards
arguments:
'namespace':
type: 'String'
required: true
'q':
type: 'String'
required: false
'seasonId':
type: 'String'
required: true
return_type: 'List<RewardInfo>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.reward.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Reward.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/reward/QueryRewards.java'
example: |-
try {
final QueryRewards operation = QueryRewards.builder()
.q(...)
.build(
namespace,
seasonId,
);
final Reward wrapper = new Reward(sdk);
final List<RewardInfo> response = wrapper.queryRewards(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'query'
- 'reward'
- 'rewards'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'QuerySeasons@jv.seasonpass.fun':
id: 'QuerySeasons@jv.seasonpass.fun'
name: 'QuerySeasons'
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: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
'offset':
type: 'Integer'
required: false
description: |-
offset
'status':
type: 'List<String>'
required: false
return_type: 'ListSeasonInfoPagingSlicedResult'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/QuerySeasons.java'
example: |-
try {
final QuerySeasons operation = QuerySeasons.builder()
.limit(...)
.offset(...)
.status(...)
.build(
namespace,
);
final Season wrapper = new Season(sdk);
final ListSeasonInfoPagingSlicedResult response = wrapper.querySeasons(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'query'
- 'season'
- 'seasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'QueryTiers@jv.seasonpass.fun':
id: 'QueryTiers@jv.seasonpass.fun'
name: 'QueryTiers'
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: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
'offset':
type: 'Integer'
required: false
description: |-
offset
'seasonId':
type: 'String'
required: true
return_type: 'TierPagingSlicedResult'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.tier.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Tier.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/tier/QueryTiers.java'
example: |-
try {
final QueryTiers operation = QueryTiers.builder()
.limit(...)
.offset(...)
.build(
namespace,
seasonId,
);
final Tier wrapper = new Tier(sdk);
final TierPagingSlicedResult response = wrapper.queryTiers(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'query'
- 'tier'
- 'tiers'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'QueryUserExpGrantHistory@jv.seasonpass.fun':
id: 'QueryUserExpGrantHistory@jv.seasonpass.fun'
name: 'QueryUserExpGrantHistory'
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: 'String'
required: false
description: |-
section active range time start , using ISO 8601 format e.g. yyyy-MM-dd'T'HH:mm:ssZZ
'limit':
type: 'Integer'
required: false
description: |-
limit
'namespace':
type: 'String'
required: true
description: |-
Namespace
'offset':
type: 'Integer'
required: false
description: |-
offset
'seasonId':
type: 'String'
required: false
description: |-
if not provide, will query current season
'source':
type: 'String'
required: false
description: |-
exp grant source
'tags':
type: 'List<String>'
required: false
description: |-
exp grant tags
'to':
type: 'String'
required: false
description: |-
section active range time end, using ISO 8601 format e.g. yyyy-MM-dd'T'HH:mm:ssZZ
'userId':
type: 'String'
required: true
return_type: 'ExpGrantHistoryPagingSlicedResult'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/QueryUserExpGrantHistory.java'
example: |-
try {
final QueryUserExpGrantHistory operation = QueryUserExpGrantHistory.builder()
.from(...)
.limit(...)
.offset(...)
.seasonId(...)
.source(...)
.tags(...)
.to(...)
.build(
namespace,
userId,
);
final Season wrapper = new Season(sdk);
final ExpGrantHistoryPagingSlicedResult response = wrapper.queryUserExpGrantHistory(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'exp'
- 'grant'
- 'history'
- 'query'
- 'season'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'QueryUserExpGrantHistoryTag@jv.seasonpass.fun':
id: 'QueryUserExpGrantHistoryTag@jv.seasonpass.fun'
name: 'QueryUserExpGrantHistoryTag'
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: 'String'
required: true
description: |-
Namespace
'seasonId':
type: 'String'
required: false
description: |-
if not provide, will query current season
'userId':
type: 'String'
required: true
return_type: 'ReasonTagsResult'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/QueryUserExpGrantHistoryTag.java'
example: |-
try {
final QueryUserExpGrantHistoryTag operation = QueryUserExpGrantHistoryTag.builder()
.seasonId(...)
.build(
namespace,
userId,
);
final Season wrapper = new Season(sdk);
final ReasonTagsResult response = wrapper.queryUserExpGrantHistoryTag(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'exp'
- 'grant'
- 'history'
- 'query'
- 'season'
- 'tag'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]'
'ReorderTier@jv.seasonpass.fun':
id: 'ReorderTier@jv.seasonpass.fun'
name: 'ReorderTier'
type: 'function'
description: |-
This API is used to reorder a tier. Only draft season pass can be updated.
arguments:
'body':
type: 'TierReorder'
required: false
'id':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
'seasonId':
type: 'String'
required: true
return_type: 'Tier'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.tier.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Tier.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/tier/ReorderTier.java'
example: |-
try {
final ReorderTier operation = ReorderTier.builder()
.body(...)
.build(
id,
namespace,
seasonId,
);
final Tier wrapper = new Tier(sdk);
final Tier response = wrapper.reorderTier(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'reorder'
- 'tier'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'ResetUserSeason@jv.seasonpass.fun':
id: 'ResetUserSeason@jv.seasonpass.fun'
name: 'ResetUserSeason'
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: 'String'
required: true
description: |-
Namespace
'userId':
type: 'String'
required: true
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/ResetUserSeason.java'
example: |-
try {
final ResetUserSeason operation = ResetUserSeason.builder()
.build(
namespace,
userId,
);
final Season wrapper = new Season(sdk);
wrapper.resetUserSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'reset'
- 'season'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [DELETE]'
'RetireSeason@jv.seasonpass.fun':
id: 'RetireSeason@jv.seasonpass.fun'
name: 'RetireSeason'
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: 'Boolean'
required: false
'namespace':
type: 'String'
required: true
'seasonId':
type: 'String'
required: true
return_type: 'SeasonInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/RetireSeason.java'
example: |-
try {
final RetireSeason operation = RetireSeason.builder()
.force(...)
.build(
namespace,
seasonId,
);
final Season wrapper = new Season(sdk);
final SeasonInfo response = wrapper.retireSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'retire'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'UnpublishSeason@jv.seasonpass.fun':
id: 'UnpublishSeason@jv.seasonpass.fun'
name: 'UnpublishSeason'
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: 'Boolean'
required: false
'namespace':
type: 'String'
required: true
'seasonId':
type: 'String'
required: true
return_type: 'SeasonInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/UnpublishSeason.java'
example: |-
try {
final UnpublishSeason operation = UnpublishSeason.builder()
.force(...)
.build(
namespace,
seasonId,
);
final Season wrapper = new Season(sdk);
final SeasonInfo response = wrapper.unpublishSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'season'
- 'unpublish'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'UpdatePass@jv.seasonpass.fun':
id: 'UpdatePass@jv.seasonpass.fun'
name: 'UpdatePass'
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: 'PassUpdate'
required: false
'code':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
'seasonId':
type: 'String'
required: true
return_type: 'PassInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.pass.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Pass.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/pass/UpdatePass.java'
example: |-
try {
final UpdatePass operation = UpdatePass.builder()
.body(...)
.build(
code,
namespace,
seasonId,
);
final Pass wrapper = new Pass(sdk);
final PassInfo response = wrapper.updatePass(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'pass'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'UpdateReward@jv.seasonpass.fun':
id: 'UpdateReward@jv.seasonpass.fun'
name: 'UpdateReward'
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: 'RewardUpdate'
required: false
'code':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
'seasonId':
type: 'String'
required: true
return_type: 'RewardInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.reward.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Reward.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/reward/UpdateReward.java'
example: |-
try {
final UpdateReward operation = UpdateReward.builder()
.body(...)
.build(
code,
namespace,
seasonId,
);
final Reward wrapper = new Reward(sdk);
final RewardInfo response = wrapper.updateReward(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'reward'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'UpdateSeason@jv.seasonpass.fun':
id: 'UpdateSeason@jv.seasonpass.fun'
name: 'UpdateSeason'
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: 'SeasonUpdate'
required: false
'namespace':
type: 'String'
required: true
'seasonId':
type: 'String'
required: true
return_type: 'SeasonInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.season.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Season.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/season/UpdateSeason.java'
example: |-
try {
final UpdateSeason operation = UpdateSeason.builder()
.body(...)
.build(
namespace,
seasonId,
);
final Season wrapper = new Season(sdk);
final SeasonInfo response = wrapper.updateSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'season'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'UpdateTier@jv.seasonpass.fun':
id: 'UpdateTier@jv.seasonpass.fun'
name: 'UpdateTier'
type: 'function'
description: |-
This API is used to update a tier. Only draft season pass can be updated.
arguments:
'body':
type: 'TierInput'
required: false
'id':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
'seasonId':
type: 'String'
required: true
return_type: 'Tier'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.seasonpass.models.*;'
- 'import net.accelbyte.sdk.api.seasonpass.operations.tier.*;'
- 'import net.accelbyte.sdk.api.seasonpass.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/wrappers/Tier.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/seasonpass/operations/tier/UpdateTier.java'
example: |-
try {
final UpdateTier operation = UpdateTier.builder()
.body(...)
.build(
id,
namespace,
seasonId,
);
final Tier wrapper = new Tier(sdk);
final Tier response = wrapper.updateTier(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'tier'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
# endregion functions
