symbols:
# region models
'BulkUserProgressionRequest@cs.seasonpass.mod':
id: 'BulkUserProgressionRequest@cs.seasonpass.mod'
name: 'BulkUserProgressionRequest'
type: 'model'
fields:
'UserIds':
type: 'List<string>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/BulkUserProgressionRequest.cs'
'ClaimableRewards@cs.seasonpass.mod':
id: 'ClaimableRewards@cs.seasonpass.mod'
name: 'ClaimableRewards'
type: 'model'
description: |-
A DTO object for claimable rewards.
fields:
'ClaimingRewards':
type: 'Dictionary<string, object>'
required: true
description: |-
Claiming rewards, zero based tier index as key, rewards per pass as value
'ToClaimRewards':
type: 'Dictionary<string, object>'
required: true
description: |-
To claim rewards, zero based tier index as key, rewards per pass as value
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/ClaimableRewards.cs'
'ClaimableUserSeasonInfo@cs.seasonpass.mod':
id: 'ClaimableUserSeasonInfo@cs.seasonpass.mod'
name: 'ClaimableUserSeasonInfo'
type: 'model'
description: |-
A DTO object for claimable user season data.
fields:
'ClaimingRewards':
type: 'Dictionary<string, object>'
required: true
description: |-
Claiming rewards, zero based tier index as key, rewards per pass as value
'Cleared':
type: 'bool'
required: true
description: |-
whether cleared all tiers
'CreatedAt':
type: 'DateTime'
required: true
description: |-
created at
'CurrentExp':
type: 'int'
required: true
description: |-
gained exp for current tier
'CurrentTierIndex':
type: 'int'
required: true
description: |-
current tier index, zero based
'EnrolledAt':
type: 'DateTime'
required: true
description: |-
enroll date time
'EnrolledPasses':
type: 'List<string>'
required: true
description: |-
enrolled passes
'Id':
type: 'string'
required: true
description: |-
id
'LastTierIndex':
type: 'int'
required: true
description: |-
last tier index, zero based
'Namespace':
type: 'string'
required: true
description: |-
namespace
'RequiredExp':
type: 'int'
required: true
description: |-
required exp for current tier
'SeasonId':
type: 'string'
required: true
description: |-
season id
'ToClaimRewards':
type: 'Dictionary<string, object>'
required: true
description: |-
To claim rewards, zero based tier index as key, rewards per pass as value
'UpdatedAt':
type: 'DateTime'
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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/ClaimableUserSeasonInfo.cs'
'ErrorEntity@cs.seasonpass.mod':
id: 'ErrorEntity@cs.seasonpass.mod'
name: 'ErrorEntity'
type: 'model'
fields:
'ErrorCode':
type: 'int'
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: 'Dictionary<string, string>'
required: false
description: |-
message variables
'RequiredPermission':
type: 'Permission'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/ErrorEntity.cs'
'ExcessStrategy@cs.seasonpass.mod':
id: 'ExcessStrategy@cs.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: 'int'
required: false
description: |-
percent per exp, required while method is CURRENCY
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/ExcessStrategy.cs'
'ExpGrantHistoryInfo@cs.seasonpass.mod':
id: 'ExpGrantHistoryInfo@cs.seasonpass.mod'
name: 'ExpGrantHistoryInfo'
type: 'model'
description: |-
A DTO object for exp grant history details.
fields:
'CreatedAt':
type: 'DateTime'
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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/ExpGrantHistoryInfo.cs'
'ExpGrantHistoryPagingSlicedResult@cs.seasonpass.mod':
id: 'ExpGrantHistoryPagingSlicedResult@cs.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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/ExpGrantHistoryPagingSlicedResult.cs'
'FieldValidationError@cs.seasonpass.mod':
id: 'FieldValidationError@cs.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: 'Dictionary<string, string>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/FieldValidationError.cs'
'FullSeasonInfo@cs.seasonpass.mod':
id: 'FullSeasonInfo@cs.seasonpass.mod'
name: 'FullSeasonInfo'
type: 'model'
description: |-
A DTO object for season full content.
fields:
'Id':
type: 'string'
required: true
description: |-
id
'Localizations':
type: 'Dictionary<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: 'Dictionary<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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/FullSeasonInfo.cs'
'Image@cs.seasonpass.mod':
id: 'Image@cs.seasonpass.mod'
name: 'Image'
type: 'model'
fields:
'Height':
type: 'int'
required: true
description: |-
height
'ImageUrl':
type: 'string'
required: true
description: |-
imageUrl
'Width':
type: 'int'
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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/Image.cs'
'ItemReference@cs.seasonpass.mod':
id: 'ItemReference@cs.seasonpass.mod'
name: 'ItemReference'
type: 'model'
description: |-
A DTO object for item references.
fields:
'Module':
type: 'string'
required: false
description: |-
module
'References':
type: 'List<object>'
required: false
description: |-
references
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/ItemReference.cs'
'ItemReferenceInfo@cs.seasonpass.mod':
id: 'ItemReferenceInfo@cs.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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/ItemReferenceInfo.cs'
'ListSeasonInfo@cs.seasonpass.mod':
id: 'ListSeasonInfo@cs.seasonpass.mod'
name: 'ListSeasonInfo'
type: 'model'
description: |-
A DTO object for listing season info.
fields:
'CreatedAt':
type: 'DateTime'
required: true
description: |-
created at
'DefaultLanguage':
type: 'string'
required: true
description: |-
default language, BCP 47 language tag
'End':
type: 'DateTime'
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: 'DateTime'
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: 'DateTime'
required: true
description: |-
updated at
'PassCodes':
type: 'List<string>'
required: false
description: |-
pass codes
'PublishedAt':
type: 'DateTime'
required: false
description: |-
publishedAt
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/ListSeasonInfo.cs'
'ListSeasonInfoPagingSlicedResult@cs.seasonpass.mod':
id: 'ListSeasonInfoPagingSlicedResult@cs.seasonpass.mod'
name: 'ListSeasonInfoPagingSlicedResult'
type: 'model'
fields:
'Data':
type: 'List<ListSeasonInfo>'
required: true
description: |-
data
'Paging':
type: 'Paging'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/ListSeasonInfoPagingSlicedResult.cs'
'ListUserSeasonInfo@cs.seasonpass.mod':
id: 'ListUserSeasonInfo@cs.seasonpass.mod'
name: 'ListUserSeasonInfo'
type: 'model'
description: |-
A DTO object for listing user season data.
fields:
'Cleared':
type: 'bool'
required: true
description: |-
whether cleared all tiers
'CurrentTierIndex':
type: 'int'
required: true
description: |-
current tier index, zero based
'EnrolledAt':
type: 'DateTime'
required: true
description: |-
enroll date time
'Id':
type: 'string'
required: true
description: |-
id
'LastTierIndex':
type: 'int'
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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/ListUserSeasonInfo.cs'
'ListUserSeasonInfoPagingSlicedResult@cs.seasonpass.mod':
id: 'ListUserSeasonInfoPagingSlicedResult@cs.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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/ListUserSeasonInfoPagingSlicedResult.cs'
'Localization@cs.seasonpass.mod':
id: 'Localization@cs.seasonpass.mod'
name: 'Localization'
type: 'model'
fields:
'Description':
type: 'string'
required: false
description: |-
description info
'Title':
type: 'string'
required: false
description: |-
title info
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/Localization.cs'
'LocalizedPassInfo@cs.seasonpass.mod':
id: 'LocalizedPassInfo@cs.seasonpass.mod'
name: 'LocalizedPassInfo'
type: 'model'
description: |-
A DTO object for public user retrieving pass info.
fields:
'AutoEnroll':
type: 'bool'
required: true
description: |-
autoEnroll
'Code':
type: 'string'
required: true
description: |-
code
'CreatedAt':
type: 'DateTime'
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: 'DateTime'
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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/LocalizedPassInfo.cs'
'LocalizedSeasonInfo@cs.seasonpass.mod':
id: 'LocalizedSeasonInfo@cs.seasonpass.mod'
name: 'LocalizedSeasonInfo'
type: 'model'
description: |-
A DTO object for public user retrieving season info.
fields:
'AutoClaim':
type: 'bool'
required: true
description: |-
whether auto claim rewards
'CreatedAt':
type: 'DateTime'
required: true
description: |-
created at
'End':
type: 'DateTime'
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: 'Dictionary<string, RewardInfo>'
required: true
description: |-
rewards info
'Start':
type: 'DateTime'
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: 'DateTime'
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: 'DateTime'
required: false
description: |-
publishedAt
'Title':
type: 'string'
required: false
description: |-
title info
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/LocalizedSeasonInfo.cs'
'Ownership@cs.seasonpass.mod':
id: 'Ownership@cs.seasonpass.mod'
name: 'Ownership'
type: 'model'
fields:
'Owned':
type: 'bool'
required: true
description: |-
ownership
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/Ownership.cs'
'Paging@cs.seasonpass.mod':
id: 'Paging@cs.seasonpass.mod'
name: 'Paging'
type: 'model'
fields:
'Next':
type: 'string'
required: false
'Previous':
type: 'string'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/Paging.cs'
'PassCreate@cs.seasonpass.mod':
id: 'PassCreate@cs.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: 'int'
required: true
description: |-
displayOrder for frontend to arrange the pass
'Localizations':
type: 'Dictionary<string, Localization>'
required: true
description: |-
localization, {language: localization} map
'PassItemId':
type: 'string'
required: true
description: |-
pass item id
'AutoEnroll':
type: 'bool'
required: false
description: |-
autoEnroll for free pass, default false
'Images':
type: 'List<Image>'
required: false
description: |-
images
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/PassCreate.cs'
'PassInfo@cs.seasonpass.mod':
id: 'PassInfo@cs.seasonpass.mod'
name: 'PassInfo'
type: 'model'
description: |-
A DTO object for pass info.
fields:
'AutoEnroll':
type: 'bool'
required: true
description: |-
autoEnroll
'Code':
type: 'string'
required: true
description: |-
code
'CreatedAt':
type: 'DateTime'
required: true
description: |-
created at
'DisplayOrder':
type: 'string'
required: true
description: |-
displayOrder
'Localizations':
type: 'Dictionary<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: 'DateTime'
required: true
description: |-
updated at
'Images':
type: 'List<Image>'
required: false
description: |-
images
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/PassInfo.cs'
'PassUpdate@cs.seasonpass.mod':
id: 'PassUpdate@cs.seasonpass.mod'
name: 'PassUpdate'
type: 'model'
description: |-
A DTO object for updating pass API call.
fields:
'AutoEnroll':
type: 'bool'
required: false
description: |-
autoEnroll for free pass
'DisplayOrder':
type: 'int'
required: false
description: |-
displayOrder for frontend to arrange the pass
'Images':
type: 'List<Image>'
required: false
description: |-
images
'Localizations':
type: 'Dictionary<string, Localization>'
required: false
description: |-
localization, {language: localization} map
'PassItemId':
type: 'string'
required: false
description: |-
pass item id
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/PassUpdate.cs'
'Permission@cs.seasonpass.mod':
id: 'Permission@cs.seasonpass.mod'
name: 'Permission'
type: 'model'
fields:
'Action':
type: 'int'
required: false
'Resource':
type: 'string'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/Permission.cs'
'ReasonTagsResult@cs.seasonpass.mod':
id: 'ReasonTagsResult@cs.seasonpass.mod'
name: 'ReasonTagsResult'
type: 'model'
description: |-
A DTO object for reason tags.
fields:
'Tags':
type: 'List<string>'
required: true
description: |-
tags
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/ReasonTagsResult.cs'
'RewardCreate@cs.seasonpass.mod':
id: 'RewardCreate@cs.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: 'int'
required: false
description: |-
Item quantity or Currency amount, default 1
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/RewardCreate.cs'
'RewardCurrency@cs.seasonpass.mod':
id: 'RewardCurrency@cs.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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/RewardCurrency.cs'
'RewardInfo@cs.seasonpass.mod':
id: 'RewardInfo@cs.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: 'int'
required: false
description: |-
Item quantity or Currency amount, default 1
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/RewardInfo.cs'
'RewardUpdate@cs.seasonpass.mod':
id: 'RewardUpdate@cs.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: 'int'
required: false
description: |-
Item quantity or Currency amount, default 1
'Type':
type: 'string'
required: false
description: |-
type, at current only support ITEM
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/RewardUpdate.cs'
'SeasonCloneRequest@cs.seasonpass.mod':
id: 'SeasonCloneRequest@cs.seasonpass.mod'
name: 'SeasonCloneRequest'
type: 'model'
description: |-
A DTO object for clone season API call.
fields:
'End':
type: 'DateTime'
required: true
description: |-
end date time
'Name':
type: 'string'
required: true
description: |-
name, max length is 127
'Start':
type: 'DateTime'
required: true
description: |-
start date time
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/SeasonCloneRequest.cs'
'SeasonCreate@cs.seasonpass.mod':
id: 'SeasonCreate@cs.seasonpass.mod'
name: 'SeasonCreate'
type: 'model'
description: |-
A DTO object for creating season API call.
fields:
'DefaultRequiredExp':
type: 'int'
required: true
description: |-
default exp required for a tier
'DraftStoreId':
type: 'string'
required: true
description: |-
draft store id
'End':
type: 'DateTime'
required: true
description: |-
end date time
'Localizations':
type: 'Dictionary<string, Localization>'
required: true
description: |-
localization, {language: localization} map
'Name':
type: 'string'
required: true
description: |-
name, max length is 127
'Start':
type: 'DateTime'
required: true
description: |-
start date time
'TierItemId':
type: 'string'
required: true
description: |-
tier item id
'AutoClaim':
type: 'bool'
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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/SeasonCreate.cs'
'SeasonInfo@cs.seasonpass.mod':
id: 'SeasonInfo@cs.seasonpass.mod'
name: 'SeasonInfo'
type: 'model'
description: |-
A DTO object for season info.
fields:
'AutoClaim':
type: 'bool'
required: true
description: |-
whether auto claim rewards
'CreatedAt':
type: 'DateTime'
required: true
description: |-
created at
'DefaultLanguage':
type: 'string'
required: true
description: |-
default language, BCP 47 language tag
'DefaultRequiredExp':
type: 'int'
required: true
description: |-
default required exp for a tier
'DraftStoreId':
type: 'string'
required: true
description: |-
draft store id
'End':
type: 'DateTime'
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: 'Dictionary<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: 'DateTime'
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: 'DateTime'
required: true
description: |-
updated at
'Images':
type: 'List<Image>'
required: false
description: |-
images
'PassCodes':
type: 'List<string>'
required: false
description: |-
pass codes
'PublishedAt':
type: 'DateTime'
required: false
description: |-
publishedAt
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/SeasonInfo.cs'
'SeasonSummary@cs.seasonpass.mod':
id: 'SeasonSummary@cs.seasonpass.mod'
name: 'SeasonSummary'
type: 'model'
description: |-
A DTO object for season summary.
fields:
'End':
type: 'DateTime'
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: 'DateTime'
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: 'DateTime'
required: false
description: |-
publishedAt
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/SeasonSummary.cs'
'SeasonUpdate@cs.seasonpass.mod':
id: 'SeasonUpdate@cs.seasonpass.mod'
name: 'SeasonUpdate'
type: 'model'
description: |-
A DTO object for updating season API call.
fields:
'AutoClaim':
type: 'bool'
required: false
description: |-
whether auto claim rewards
'DefaultLanguage':
type: 'string'
required: false
description: |-
default language, BCP 47 language tag
'DefaultRequiredExp':
type: 'int'
required: false
description: |-
default exp required for a tier
'DraftStoreId':
type: 'string'
required: false
description: |-
draft store id
'End':
type: 'DateTime'
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: 'Dictionary<string, Localization>'
required: false
description: |-
localization, {language: localization} map
'Name':
type: 'string'
required: false
description: |-
name, max length is 127
'Start':
type: 'DateTime'
required: false
description: |-
start date time
'TierItemId':
type: 'string'
required: false
description: |-
tier item id
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/SeasonUpdate.cs'
'Tier@cs.seasonpass.mod':
id: 'Tier@cs.seasonpass.mod'
name: 'Tier'
type: 'model'
fields:
'Id':
type: 'string'
required: false
description: |-
tier id, auto generated.
'RequiredExp':
type: 'int'
required: false
description: |-
required exp for tier, it will automatically use season defaultRequiredExp if not set
'Rewards':
type: 'Dictionary<string, object>'
required: false
description: |-
rewards map, passCode as key, rewardCode list as value
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/Tier.cs'
'TierCreate@cs.seasonpass.mod':
id: 'TierCreate@cs.seasonpass.mod'
name: 'TierCreate'
type: 'model'
description: |-
A DTO object for creating tier API call.
fields:
'Index':
type: 'int'
required: false
description: |-
zero based tier index to be inserted at, -1 means appending to the end, default -1
'Quantity':
type: 'int'
required: false
description: |-
create tier quantity, default 1
'Tier':
type: 'TierInput'
required: false
description: |-
tier content, default null tier
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/TierCreate.cs'
'TierInput@cs.seasonpass.mod':
id: 'TierInput@cs.seasonpass.mod'
name: 'TierInput'
type: 'model'
description: |-
A DTO object for tier input.
fields:
'RequiredExp':
type: 'int'
required: false
description: |-
required exp for tier, it will automatically use season defaultRequiredExp if not set
'Rewards':
type: 'Dictionary<string, object>'
required: false
description: |-
rewards map, passCode as key, rewardCode list as value
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/TierInput.cs'
'TierPagingSlicedResult@cs.seasonpass.mod':
id: 'TierPagingSlicedResult@cs.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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/TierPagingSlicedResult.cs'
'TierReorder@cs.seasonpass.mod':
id: 'TierReorder@cs.seasonpass.mod'
name: 'TierReorder'
type: 'model'
fields:
'NewIndex':
type: 'int'
required: false
description: |-
new index tier should be moved to, zero based, -1 means appending to the end
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/TierReorder.cs'
'UserExpGrant@cs.seasonpass.mod':
id: 'UserExpGrant@cs.seasonpass.mod'
name: 'UserExpGrant'
type: 'model'
description: |-
A DTO object for granting user exp.
fields:
'Exp':
type: 'int'
required: false
description: |-
exp to grant
'Source':
type: 'string'
required: false
description: |-
source
'Tags':
type: 'List<string>'
required: false
description: |-
tags
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/UserExpGrant.cs'
'UserPassGrant@cs.seasonpass.mod':
id: 'UserPassGrant@cs.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:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/UserPassGrant.cs'
'UserPurchasable@cs.seasonpass.mod':
id: 'UserPurchasable@cs.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: 'int'
required: false
description: |-
tier item count, default 1
'TierItemId':
type: 'string'
required: false
description: |-
tier item id
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/UserPurchasable.cs'
'UserRewardClaim@cs.seasonpass.mod':
id: 'UserRewardClaim@cs.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: 'int'
required: true
description: |-
tier index
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/UserRewardClaim.cs'
'UserSeasonSummary@cs.seasonpass.mod':
id: 'UserSeasonSummary@cs.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: 'bool'
required: false
description: |-
whether cleared all tiers
'CreatedAt':
type: 'DateTime'
required: false
description: |-
created at
'CurrentExp':
type: 'int'
required: false
description: |-
gained exp for current tier
'CurrentTierIndex':
type: 'int'
required: false
description: |-
current tier index, zero based
'EnrolledAt':
type: 'DateTime'
required: false
description: |-
enroll date time
'EnrolledPasses':
type: 'List<string>'
required: false
description: |-
enrolled passes
'Id':
type: 'string'
required: false
description: |-
id
'LastTierIndex':
type: 'int'
required: false
description: |-
last tier index, zero based
'RequiredExp':
type: 'int'
required: false
description: |-
required exp for current tier
'SeasonId':
type: 'string'
required: false
description: |-
season id
'UpdatedAt':
type: 'DateTime'
required: false
description: |-
updated at
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/UserSeasonSummary.cs'
'UserTierGrant@cs.seasonpass.mod':
id: 'UserTierGrant@cs.seasonpass.mod'
name: 'UserTierGrant'
type: 'model'
description: |-
A DTO object for granting user tier.
fields:
'Count':
type: 'int'
required: false
description: |-
count to grant
'Source':
type: 'string'
required: false
description: |-
source
'Tags':
type: 'List<string>'
required: false
description: |-
tags
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/UserTierGrant.cs'
'ValidationErrorEntity@cs.seasonpass.mod':
id: 'ValidationErrorEntity@cs.seasonpass.mod'
name: 'ValidationErrorEntity'
type: 'model'
fields:
'ErrorCode':
type: 'int'
required: true
description: |-
numeric error code
'ErrorMessage':
type: 'string'
required: true
description: |-
error message
'Errors':
type: 'List<FieldValidationError>'
required: false
imports:
- 'using System;'
- 'using System.Collections.Generic;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Model/ValidationErrorEntity.cs'
# endregion models
# region functions
'BulkGetUserSeasonProgression@cs.seasonpass.fun':
id: 'BulkGetUserSeasonProgression@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/BulkGetUserSeasonProgression.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.BulkGetUserSeasonProgressionOp
.SetBody(...)
.Build(
namespace_,
);
var response = sdk.Seasonpass.Season.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@cs.seasonpass.fun':
id: 'CheckSeasonPurchasable@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/CheckSeasonPurchasable.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.CheckSeasonPurchasableOp
.SetBody(...)
.Build(
namespace_,
userId,
);
sdk.Seasonpass.Season.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@cs.seasonpass.fun':
id: 'CloneSeason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/CloneSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.CloneSeasonOp
.SetBody(...)
.Build(
namespace_,
seasonId,
);
var response = sdk.Seasonpass.Season.CloneSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'clone'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'CreatePass@cs.seasonpass.fun':
id: 'CreatePass@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Pass.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Pass/CreatePass.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Pass.CreatePassOp
.SetBody(...)
.Build(
namespace_,
seasonId,
);
var response = sdk.Seasonpass.Pass.CreatePass(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'create'
- 'pass'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'CreateReward@cs.seasonpass.fun':
id: 'CreateReward@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Reward.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Reward/CreateReward.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Reward.CreateRewardOp
.SetBody(...)
.Build(
namespace_,
seasonId,
);
var response = sdk.Seasonpass.Reward.CreateReward(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'create'
- 'reward'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'CreateSeason@cs.seasonpass.fun':
id: 'CreateSeason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/CreateSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.CreateSeasonOp
.SetBody(...)
.Build(
namespace_,
);
var response = sdk.Seasonpass.Season.CreateSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'create'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'CreateTier@cs.seasonpass.fun':
id: 'CreateTier@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Tier.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Tier/CreateTier.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Tier.CreateTierOp
.SetBody(...)
.Build(
namespace_,
seasonId,
);
var response = sdk.Seasonpass.Tier.CreateTier(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'create'
- 'tier'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]'
'DeletePass@cs.seasonpass.fun':
id: 'DeletePass@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Pass.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Pass/DeletePass.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Pass.DeletePassOp
.Build();
sdk.Seasonpass.Pass.DeletePass(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'pass'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]'
'DeleteReward@cs.seasonpass.fun':
id: 'DeleteReward@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Reward.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Reward/DeleteReward.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Reward.DeleteRewardOp
.Build();
sdk.Seasonpass.Reward.DeleteReward(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'reward'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]'
'DeleteSeason@cs.seasonpass.fun':
id: 'DeleteSeason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/DeleteSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.DeleteSeasonOp
.Build();
sdk.Seasonpass.Season.DeleteSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]'
'DeleteTier@cs.seasonpass.fun':
id: 'DeleteTier@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Tier.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Tier/DeleteTier.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Tier.DeleteTierOp
.Build();
sdk.Seasonpass.Tier.DeleteTier(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'tier'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]'
'ExistsAnyPassByPassCodes@cs.seasonpass.fun':
id: 'ExistsAnyPassByPassCodes@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/ExistsAnyPassByPassCodes.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.ExistsAnyPassByPassCodesOp
.SetPassCodes(...)
.Build(
namespace_,
userId,
);
var response = sdk.Seasonpass.Season.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@cs.seasonpass.fun':
id: 'ExportSeason@cs.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: 'Stream'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Export.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Export/ExportSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Export.ExportSeasonOp
.Build();
var response = sdk.Seasonpass.Export.ExportSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'export'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'GetCurrentSeason@cs.seasonpass.fun':
id: 'GetCurrentSeason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/GetCurrentSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.GetCurrentSeasonOp
.Build();
var response = sdk.Seasonpass.Season.GetCurrentSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'current'
- 'get'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'GetCurrentUserSeasonProgression@cs.seasonpass.fun':
id: 'GetCurrentUserSeasonProgression@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/GetCurrentUserSeasonProgression.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.GetCurrentUserSeasonProgressionOp
.Build();
var response = sdk.Seasonpass.Season.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@cs.seasonpass.fun':
id: 'GetFullSeason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/GetFullSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.GetFullSeasonOp
.Build();
var response = sdk.Seasonpass.Season.GetFullSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'full'
- 'get'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'GetItemReferences@cs.seasonpass.fun':
id: 'GetItemReferences@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Utilities.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Utilities/GetItemReferences.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Utilities.GetItemReferencesOp
.Build();
var response = sdk.Seasonpass.Utilities.GetItemReferences(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'item'
- 'references'
- 'utilities'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'GetPass@cs.seasonpass.fun':
id: 'GetPass@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Pass.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Pass/GetPass.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Pass.GetPassOp
.Build();
var response = sdk.Seasonpass.Pass.GetPass(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'pass'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'GetReward@cs.seasonpass.fun':
id: 'GetReward@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Reward.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Reward/GetReward.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Reward.GetRewardOp
.Build();
var response = sdk.Seasonpass.Reward.GetReward(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'reward'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'GetSeason@cs.seasonpass.fun':
id: 'GetSeason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/GetSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.GetSeasonOp
.Build();
var response = sdk.Seasonpass.Season.GetSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'GetUserParticipatedSeasons@cs.seasonpass.fun':
id: 'GetUserParticipatedSeasons@cs.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: 'int'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
Namespace
'Offset':
type: 'int'
required: false
description: |-
offset
'UserId':
type: 'string'
required: true
return_type: 'ListUserSeasonInfoPagingSlicedResult'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/GetUserParticipatedSeasons.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.GetUserParticipatedSeasonsOp
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
userId,
);
var response = sdk.Seasonpass.Season.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@cs.seasonpass.fun':
id: 'GetUserSeason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/GetUserSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.GetUserSeasonOp
.Build();
var response = sdk.Seasonpass.Season.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@cs.seasonpass.fun':
id: 'GrantUserExp@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Tier.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Tier/GrantUserExp.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Tier.GrantUserExpOp
.SetBody(...)
.Build(
namespace_,
userId,
);
var response = sdk.Seasonpass.Tier.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@cs.seasonpass.fun':
id: 'GrantUserPass@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Pass.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Pass/GrantUserPass.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Pass.GrantUserPassOp
.SetBody(...)
.Build(
namespace_,
userId,
);
var response = sdk.Seasonpass.Pass.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@cs.seasonpass.fun':
id: 'GrantUserTier@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Tier.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Tier/GrantUserTier.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Tier.GrantUserTierOp
.SetBody(...)
.Build(
namespace_,
userId,
);
var response = sdk.Seasonpass.Tier.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@cs.seasonpass.fun':
id: 'PublicBulkClaimUserRewards@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Reward.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Reward/PublicBulkClaimUserRewards.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Reward.PublicBulkClaimUserRewardsOp
.Build();
var response = sdk.Seasonpass.Reward.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@cs.seasonpass.fun':
id: 'PublicClaimUserReward@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Reward.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Reward/PublicClaimUserReward.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Reward.PublicClaimUserRewardOp
.SetBody(...)
.Build(
namespace_,
userId,
);
var response = sdk.Seasonpass.Reward.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@cs.seasonpass.fun':
id: 'PublicGetCurrentSeason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/PublicGetCurrentSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.PublicGetCurrentSeasonOp
.SetLanguage(...)
.Build(
namespace_,
);
var response = sdk.Seasonpass.Season.PublicGetCurrentSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'current'
- 'get'
- 'public'
- 'season'
'PublicGetCurrentUserSeason@cs.seasonpass.fun':
id: 'PublicGetCurrentUserSeason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/PublicGetCurrentUserSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.PublicGetCurrentUserSeasonOp
.Build();
var response = sdk.Seasonpass.Season.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@cs.seasonpass.fun':
id: 'PublicGetUserSeason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/PublicGetUserSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.PublicGetUserSeasonOp
.Build();
var response = sdk.Seasonpass.Season.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@cs.seasonpass.fun':
id: 'PublishSeason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/PublishSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.PublishSeasonOp
.Build();
var response = sdk.Seasonpass.Season.PublishSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'publish'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'QueryPasses@cs.seasonpass.fun':
id: 'QueryPasses@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Pass.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Pass/QueryPasses.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Pass.QueryPassesOp
.Build();
var response = sdk.Seasonpass.Pass.QueryPasses(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'pass'
- 'passes'
- 'query'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'QueryRewards@cs.seasonpass.fun':
id: 'QueryRewards@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Reward.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Reward/QueryRewards.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Reward.QueryRewardsOp
.SetQ(...)
.Build(
namespace_,
seasonId,
);
var response = sdk.Seasonpass.Reward.QueryRewards(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'query'
- 'reward'
- 'rewards'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'QuerySeasons@cs.seasonpass.fun':
id: 'QuerySeasons@cs.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: 'int'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
'Offset':
type: 'int'
required: false
description: |-
offset
'Status':
type: 'List<string>'
required: false
return_type: 'ListSeasonInfoPagingSlicedResult'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/QuerySeasons.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.QuerySeasonsOp
.SetLimit(...)
.SetOffset(...)
.SetStatus(...)
.Build(
namespace_,
);
var response = sdk.Seasonpass.Season.QuerySeasons(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'query'
- 'season'
- 'seasons'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'QueryTiers@cs.seasonpass.fun':
id: 'QueryTiers@cs.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: 'int'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
'Offset':
type: 'int'
required: false
description: |-
offset
'SeasonId':
type: 'string'
required: true
return_type: 'TierPagingSlicedResult'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Tier.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Tier/QueryTiers.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Tier.QueryTiersOp
.SetLimit(...)
.SetOffset(...)
.Build(
namespace_,
seasonId,
);
var response = sdk.Seasonpass.Tier.QueryTiers(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'query'
- 'tier'
- 'tiers'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]'
'QueryUserExpGrantHistory@cs.seasonpass.fun':
id: 'QueryUserExpGrantHistory@cs.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: 'int'
required: false
description: |-
limit
'Namespace':
type: 'string'
required: true
description: |-
Namespace
'Offset':
type: 'int'
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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/QueryUserExpGrantHistory.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.QueryUserExpGrantHistoryOp
.SetFrom(...)
.SetLimit(...)
.SetOffset(...)
.SetSeasonId(...)
.SetSource(...)
.SetTags(...)
.SetTo(...)
.Build(
namespace_,
userId,
);
var response = sdk.Seasonpass.Season.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@cs.seasonpass.fun':
id: 'QueryUserExpGrantHistoryTag@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/QueryUserExpGrantHistoryTag.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.QueryUserExpGrantHistoryTagOp
.SetSeasonId(...)
.Build(
namespace_,
userId,
);
var response = sdk.Seasonpass.Season.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@cs.seasonpass.fun':
id: 'ReorderTier@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Tier.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Tier/ReorderTier.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Tier.ReorderTierOp
.SetBody(...)
.Build(
id,
namespace_,
seasonId,
);
var response = sdk.Seasonpass.Tier.ReorderTier(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'reorder'
- 'tier'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'ResetUserSeason@cs.seasonpass.fun':
id: 'ResetUserSeason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/ResetUserSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.ResetUserSeasonOp
.Build();
sdk.Seasonpass.Season.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@cs.seasonpass.fun':
id: 'RetireSeason@cs.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: 'bool'
required: false
'Namespace':
type: 'string'
required: true
'SeasonId':
type: 'string'
required: true
return_type: 'SeasonInfo'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/RetireSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.RetireSeasonOp
.SetForce(...)
.Build(
namespace_,
seasonId,
);
var response = sdk.Seasonpass.Season.RetireSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'retire'
- 'season'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'UnpublishSeason@cs.seasonpass.fun':
id: 'UnpublishSeason@cs.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: 'bool'
required: false
'Namespace':
type: 'string'
required: true
'SeasonId':
type: 'string'
required: true
return_type: 'SeasonInfo'
imports:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/UnpublishSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.UnpublishSeasonOp
.SetForce(...)
.Build(
namespace_,
seasonId,
);
var response = sdk.Seasonpass.Season.UnpublishSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'season'
- 'unpublish'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'UpdatePass@cs.seasonpass.fun':
id: 'UpdatePass@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Pass.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Pass/UpdatePass.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Pass.UpdatePassOp
.SetBody(...)
.Build(
code,
namespace_,
seasonId,
);
var response = sdk.Seasonpass.Pass.UpdatePass(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'pass'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'UpdateReward@cs.seasonpass.fun':
id: 'UpdateReward@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Reward.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Reward/UpdateReward.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Reward.UpdateRewardOp
.SetBody(...)
.Build(
code,
namespace_,
seasonId,
);
var response = sdk.Seasonpass.Reward.UpdateReward(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'reward'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'UpdateSeason@cs.seasonpass.fun':
id: 'UpdateSeason@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Season.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Season/UpdateSeason.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Season.UpdateSeasonOp
.SetBody(...)
.Build(
namespace_,
seasonId,
);
var response = sdk.Seasonpass.Season.UpdateSeason(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'season'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
'UpdateTier@cs.seasonpass.fun':
id: 'UpdateTier@cs.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:
- 'using AccelByte.Sdk.Core;'
- 'using AccelByte.Sdk.Api.Seasonpass.Model;'
- 'using AccelByte.Sdk.Api.Seasonpass.Operation;'
- 'using AccelByte.Sdk.Api.Seasonpass.Wrapper;'
files:
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Wrapper/Tier.cs'
- 'https://github.com/AccelByte/accelbyte-csharp-sdk/blob/main/AccelByte.Sdk/Api/Seasonpass/Operation/Tier/UpdateTier.cs'
example: |-
try
{
var operation = sdk.Seasonpass.Tier.UpdateTierOp
.SetBody(...)
.Build(
id,
namespace_,
seasonId,
);
var response = sdk.Seasonpass.Tier.UpdateTier(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'tier'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]'
# endregion functions