AGS Extend SDK MCP Server

symbols: 'NewSeasonpassClient@go.seasonpass.fun': id: 'NewSeasonpassClient@go.seasonpass.fun' name: 'NewSeasonpassClient' type: 'function' arguments: configRepository: type: 'repository.ConfigRepository' return_type: '*seasonpassclient.JusticeSeasonpassService' imports: - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository' - 'github.com/AccelByte/accelbyte-go-modular-sdk/seasonpass-sdk/pkg/seasonpassclient' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/justice_seasonpass_service_client.go' - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/factory/seasonpassclientfactory.go' example: |- seasonpassClient := factory.NewSeasonpassClient(configRepo) # region wrappers 'ExportService@go.seasonpass.mod': id: 'ExportService@go.seasonpass.mod' name: 'ExportService' type: 'model' fields: Client: type: '*seasonpassclient.JusticeSeasonpassService' ConfigRepository: type: 'repository.ConfigRepository' TokenRepository: type: 'repository.TokenRepository' imports: - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/export.go' example: |- seasonpassClient := factory.NewSeasonpassClient(configRepo) // re-use if it exists already exportService := ExportService{ Client: seasonpassClient, ConfigRepository: configRepo, TokenRepository: tokenRepo, } 'PassService@go.seasonpass.mod': id: 'PassService@go.seasonpass.mod' name: 'PassService' type: 'model' fields: Client: type: '*seasonpassclient.JusticeSeasonpassService' ConfigRepository: type: 'repository.ConfigRepository' TokenRepository: type: 'repository.TokenRepository' imports: - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/pass.go' example: |- seasonpassClient := factory.NewSeasonpassClient(configRepo) // re-use if it exists already passService := PassService{ Client: seasonpassClient, ConfigRepository: configRepo, TokenRepository: tokenRepo, } 'RewardService@go.seasonpass.mod': id: 'RewardService@go.seasonpass.mod' name: 'RewardService' type: 'model' fields: Client: type: '*seasonpassclient.JusticeSeasonpassService' ConfigRepository: type: 'repository.ConfigRepository' TokenRepository: type: 'repository.TokenRepository' imports: - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/reward.go' example: |- seasonpassClient := factory.NewSeasonpassClient(configRepo) // re-use if it exists already rewardService := RewardService{ Client: seasonpassClient, ConfigRepository: configRepo, TokenRepository: tokenRepo, } 'SeasonService@go.seasonpass.mod': id: 'SeasonService@go.seasonpass.mod' name: 'SeasonService' type: 'model' fields: Client: type: '*seasonpassclient.JusticeSeasonpassService' ConfigRepository: type: 'repository.ConfigRepository' TokenRepository: type: 'repository.TokenRepository' imports: - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonpassClient := factory.NewSeasonpassClient(configRepo) // re-use if it exists already seasonService := SeasonService{ Client: seasonpassClient, ConfigRepository: configRepo, TokenRepository: tokenRepo, } 'TierService@go.seasonpass.mod': id: 'TierService@go.seasonpass.mod' name: 'TierService' type: 'model' fields: Client: type: '*seasonpassclient.JusticeSeasonpassService' ConfigRepository: type: 'repository.ConfigRepository' TokenRepository: type: 'repository.TokenRepository' imports: - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/tier.go' example: |- seasonpassClient := factory.NewSeasonpassClient(configRepo) // re-use if it exists already tierService := TierService{ Client: seasonpassClient, ConfigRepository: configRepo, TokenRepository: tokenRepo, } 'UtilitiesService@go.seasonpass.mod': id: 'UtilitiesService@go.seasonpass.mod' name: 'UtilitiesService' type: 'model' fields: Client: type: '*seasonpassclient.JusticeSeasonpassService' ConfigRepository: type: 'repository.ConfigRepository' TokenRepository: type: 'repository.TokenRepository' imports: - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/factory' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/repository' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/utilities.go' example: |- seasonpassClient := factory.NewSeasonpassClient(configRepo) // re-use if it exists already utilitiesService := UtilitiesService{ Client: seasonpassClient, ConfigRepository: configRepo, TokenRepository: tokenRepo, } # endregion wrappers # region params 'BulkGetUserSeasonProgressionParams@go.seasonpass.mod': id: 'BulkGetUserSeasonProgressionParams@go.seasonpass.mod' name: 'BulkGetUserSeasonProgressionParams' type: 'model' fields: 'Body': type: '*BulkUserProgressionRequest' required: false 'Namespace': type: 'string' required: true description: |- Namespace imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/bulk_get_user_season_progression_parameters.go' 'CheckSeasonPurchasableParams@go.seasonpass.mod': id: 'CheckSeasonPurchasableParams@go.seasonpass.mod' name: 'CheckSeasonPurchasableParams' type: 'model' fields: 'Body': type: '*UserPurchasable' required: false 'Namespace': type: 'string' required: true description: |- Namespace 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/check_season_purchasable_parameters.go' 'CloneSeasonParams@go.seasonpass.mod': id: 'CloneSeasonParams@go.seasonpass.mod' name: 'CloneSeasonParams' type: 'model' fields: 'Body': type: '*SeasonCloneRequest' required: false 'Namespace': type: 'string' required: true 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/clone_season_parameters.go' 'CreatePassParams@go.seasonpass.mod': id: 'CreatePassParams@go.seasonpass.mod' name: 'CreatePassParams' type: 'model' fields: 'Body': type: '*PassCreate' required: false 'Namespace': type: 'string' required: true description: |- Namespace 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/pass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/pass/create_pass_parameters.go' 'CreateRewardParams@go.seasonpass.mod': id: 'CreateRewardParams@go.seasonpass.mod' name: 'CreateRewardParams' type: 'model' fields: 'Body': type: '*RewardCreate' required: false 'Namespace': type: 'string' required: true description: |- Namespace 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/reward' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/reward/create_reward_parameters.go' 'CreateSeasonParams@go.seasonpass.mod': id: 'CreateSeasonParams@go.seasonpass.mod' name: 'CreateSeasonParams' type: 'model' fields: 'Body': type: '*SeasonCreate' required: false 'Namespace': type: 'string' required: true description: |- Namespace imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/create_season_parameters.go' 'CreateTierParams@go.seasonpass.mod': id: 'CreateTierParams@go.seasonpass.mod' name: 'CreateTierParams' type: 'model' fields: 'Body': type: '*TierCreate' required: false 'Namespace': type: 'string' required: true description: |- Namespace 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/tier' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/tier/create_tier_parameters.go' 'DeletePassParams@go.seasonpass.mod': id: 'DeletePassParams@go.seasonpass.mod' name: 'DeletePassParams' type: 'model' fields: 'Code': type: 'string' required: true 'Namespace': type: 'string' required: true description: |- Namespace 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/pass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/pass/delete_pass_parameters.go' 'DeleteRewardParams@go.seasonpass.mod': id: 'DeleteRewardParams@go.seasonpass.mod' name: 'DeleteRewardParams' type: 'model' fields: 'Code': type: 'string' required: true 'Namespace': type: 'string' required: true description: |- Namespace 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/reward' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/reward/delete_reward_parameters.go' 'DeleteSeasonParams@go.seasonpass.mod': id: 'DeleteSeasonParams@go.seasonpass.mod' name: 'DeleteSeasonParams' type: 'model' fields: 'Namespace': type: 'string' required: true description: |- Namespace 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/delete_season_parameters.go' 'DeleteTierParams@go.seasonpass.mod': id: 'DeleteTierParams@go.seasonpass.mod' name: 'DeleteTierParams' type: 'model' fields: 'ID': type: 'string' required: true 'Namespace': type: 'string' required: true description: |- Namespace 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/tier' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/tier/delete_tier_parameters.go' 'ExistsAnyPassByPassCodesParams@go.seasonpass.mod': id: 'ExistsAnyPassByPassCodesParams@go.seasonpass.mod' name: 'ExistsAnyPassByPassCodesParams' type: 'model' fields: 'Namespace': type: 'string' required: true description: |- Namespace 'PassCodes': type: '[]string' required: false 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/exists_any_pass_by_pass_codes_parameters.go' 'ExportSeasonParams@go.seasonpass.mod': id: 'ExportSeasonParams@go.seasonpass.mod' name: 'ExportSeasonParams' type: 'model' fields: 'Namespace': type: 'string' required: true description: |- Namespace imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/export' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/export/export_season_parameters.go' 'GetCurrentSeasonParams@go.seasonpass.mod': id: 'GetCurrentSeasonParams@go.seasonpass.mod' name: 'GetCurrentSeasonParams' type: 'model' fields: 'Namespace': type: 'string' required: true description: |- Namespace imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/get_current_season_parameters.go' 'GetCurrentUserSeasonProgressionParams@go.seasonpass.mod': id: 'GetCurrentUserSeasonProgressionParams@go.seasonpass.mod' name: 'GetCurrentUserSeasonProgressionParams' type: 'model' fields: 'Namespace': type: 'string' required: true description: |- Namespace 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/get_current_user_season_progression_parameters.go' 'GetFullSeasonParams@go.seasonpass.mod': id: 'GetFullSeasonParams@go.seasonpass.mod' name: 'GetFullSeasonParams' type: 'model' fields: 'Namespace': type: 'string' required: true description: |- Namespace 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/get_full_season_parameters.go' 'GetItemReferencesParams@go.seasonpass.mod': id: 'GetItemReferencesParams@go.seasonpass.mod' name: 'GetItemReferencesParams' type: 'model' fields: 'ItemID': type: 'string' required: true description: |- the id of the ecommerce item 'Namespace': type: 'string' required: true description: |- namespace imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/utilities' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/utilities/get_item_references_parameters.go' 'GetPassParams@go.seasonpass.mod': id: 'GetPassParams@go.seasonpass.mod' name: 'GetPassParams' type: 'model' fields: 'Code': type: 'string' required: true 'Namespace': type: 'string' required: true description: |- Namespace 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/pass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/pass/get_pass_parameters.go' 'GetRewardParams@go.seasonpass.mod': id: 'GetRewardParams@go.seasonpass.mod' name: 'GetRewardParams' type: 'model' fields: 'Code': type: 'string' required: true 'Namespace': type: 'string' required: true description: |- Namespace 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/reward' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/reward/get_reward_parameters.go' 'GetSeasonParams@go.seasonpass.mod': id: 'GetSeasonParams@go.seasonpass.mod' name: 'GetSeasonParams' type: 'model' fields: 'Namespace': type: 'string' required: true description: |- Namespace 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/get_season_parameters.go' 'GetUserParticipatedSeasonsParams@go.seasonpass.mod': id: 'GetUserParticipatedSeasonsParams@go.seasonpass.mod' name: 'GetUserParticipatedSeasonsParams' type: 'model' fields: 'Limit': type: 'int32' required: false description: |- limit 'Namespace': type: 'string' required: true description: |- Namespace 'Offset': type: 'int32' required: false description: |- offset 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/get_user_participated_seasons_parameters.go' 'GetUserSeasonParams@go.seasonpass.mod': id: 'GetUserSeasonParams@go.seasonpass.mod' name: 'GetUserSeasonParams' type: 'model' fields: 'Namespace': type: 'string' required: true description: |- Namespace 'SeasonID': type: 'string' required: true 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/get_user_season_parameters.go' 'GrantUserExpParams@go.seasonpass.mod': id: 'GrantUserExpParams@go.seasonpass.mod' name: 'GrantUserExpParams' type: 'model' fields: 'Body': type: '*UserExpGrant' required: false 'Namespace': type: 'string' required: true description: |- Namespace 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/tier' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/tier/grant_user_exp_parameters.go' 'GrantUserPassParams@go.seasonpass.mod': id: 'GrantUserPassParams@go.seasonpass.mod' name: 'GrantUserPassParams' type: 'model' fields: 'Body': type: '*UserPassGrant' required: false 'Namespace': type: 'string' required: true description: |- Namespace 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/pass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/pass/grant_user_pass_parameters.go' 'GrantUserTierParams@go.seasonpass.mod': id: 'GrantUserTierParams@go.seasonpass.mod' name: 'GrantUserTierParams' type: 'model' fields: 'Body': type: '*UserTierGrant' required: false 'Namespace': type: 'string' required: true description: |- Namespace 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/tier' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/tier/grant_user_tier_parameters.go' 'PublicBulkClaimUserRewardsParams@go.seasonpass.mod': id: 'PublicBulkClaimUserRewardsParams@go.seasonpass.mod' name: 'PublicBulkClaimUserRewardsParams' type: 'model' fields: 'Namespace': type: 'string' required: true description: |- Namespace 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/reward' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/reward/public_bulk_claim_user_rewards_parameters.go' 'PublicClaimUserRewardParams@go.seasonpass.mod': id: 'PublicClaimUserRewardParams@go.seasonpass.mod' name: 'PublicClaimUserRewardParams' type: 'model' fields: 'Body': type: '*UserRewardClaim' required: false 'Namespace': type: 'string' required: true description: |- Namespace 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/reward' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/reward/public_claim_user_reward_parameters.go' 'PublicGetCurrentSeasonParams@go.seasonpass.mod': id: 'PublicGetCurrentSeasonParams@go.seasonpass.mod' name: 'PublicGetCurrentSeasonParams' type: 'model' fields: 'Language': type: 'string' required: false 'Namespace': type: 'string' required: true description: |- Namespace imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/public_get_current_season_parameters.go' 'PublicGetCurrentUserSeasonParams@go.seasonpass.mod': id: 'PublicGetCurrentUserSeasonParams@go.seasonpass.mod' name: 'PublicGetCurrentUserSeasonParams' type: 'model' fields: 'Namespace': type: 'string' required: true description: |- Namespace 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/public_get_current_user_season_parameters.go' 'PublicGetUserSeasonParams@go.seasonpass.mod': id: 'PublicGetUserSeasonParams@go.seasonpass.mod' name: 'PublicGetUserSeasonParams' type: 'model' fields: 'Namespace': type: 'string' required: true description: |- Namespace 'SeasonID': type: 'string' required: true 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/public_get_user_season_parameters.go' 'PublishSeasonParams@go.seasonpass.mod': id: 'PublishSeasonParams@go.seasonpass.mod' name: 'PublishSeasonParams' type: 'model' fields: 'Namespace': type: 'string' required: true 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/publish_season_parameters.go' 'QueryPassesParams@go.seasonpass.mod': id: 'QueryPassesParams@go.seasonpass.mod' name: 'QueryPassesParams' type: 'model' fields: 'Namespace': type: 'string' required: true 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/pass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/pass/query_passes_parameters.go' 'QueryRewardsParams@go.seasonpass.mod': id: 'QueryRewardsParams@go.seasonpass.mod' name: 'QueryRewardsParams' type: 'model' fields: 'Namespace': type: 'string' required: true 'Q': type: 'string' required: false 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/reward' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/reward/query_rewards_parameters.go' 'QuerySeasonsParams@go.seasonpass.mod': id: 'QuerySeasonsParams@go.seasonpass.mod' name: 'QuerySeasonsParams' type: 'model' fields: 'Limit': type: 'int32' required: false description: |- limit 'Namespace': type: 'string' required: true 'Offset': type: 'int32' required: false description: |- offset 'Status': type: '[]string' required: false imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/query_seasons_parameters.go' 'QueryTiersParams@go.seasonpass.mod': id: 'QueryTiersParams@go.seasonpass.mod' name: 'QueryTiersParams' type: 'model' fields: 'Limit': type: 'int32' required: false description: |- limit 'Namespace': type: 'string' required: true 'Offset': type: 'int32' required: false description: |- offset 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/tier' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/tier/query_tiers_parameters.go' 'QueryUserExpGrantHistoryParams@go.seasonpass.mod': id: 'QueryUserExpGrantHistoryParams@go.seasonpass.mod' name: 'QueryUserExpGrantHistoryParams' type: 'model' fields: '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: 'int32' required: false description: |- limit 'Namespace': type: 'string' required: true description: |- Namespace 'Offset': type: 'int32' 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: '[]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 imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/query_user_exp_grant_history_parameters.go' 'QueryUserExpGrantHistoryTagParams@go.seasonpass.mod': id: 'QueryUserExpGrantHistoryTagParams@go.seasonpass.mod' name: 'QueryUserExpGrantHistoryTagParams' type: 'model' fields: '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 imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/query_user_exp_grant_history_tag_parameters.go' 'ReorderTierParams@go.seasonpass.mod': id: 'ReorderTierParams@go.seasonpass.mod' name: 'ReorderTierParams' type: 'model' fields: 'Body': type: '*TierReorder' required: false 'ID': type: 'string' required: true 'Namespace': type: 'string' required: true 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/tier' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/tier/reorder_tier_parameters.go' 'ResetUserSeasonParams@go.seasonpass.mod': id: 'ResetUserSeasonParams@go.seasonpass.mod' name: 'ResetUserSeasonParams' type: 'model' fields: 'Namespace': type: 'string' required: true description: |- Namespace 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/reset_user_season_parameters.go' 'RetireSeasonParams@go.seasonpass.mod': id: 'RetireSeasonParams@go.seasonpass.mod' name: 'RetireSeasonParams' type: 'model' fields: 'Force': type: 'bool' required: false 'Namespace': type: 'string' required: true 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/retire_season_parameters.go' 'UnpublishSeasonParams@go.seasonpass.mod': id: 'UnpublishSeasonParams@go.seasonpass.mod' name: 'UnpublishSeasonParams' type: 'model' fields: 'Force': type: 'bool' required: false 'Namespace': type: 'string' required: true 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/unpublish_season_parameters.go' 'UpdatePassParams@go.seasonpass.mod': id: 'UpdatePassParams@go.seasonpass.mod' name: 'UpdatePassParams' type: 'model' fields: 'Body': type: '*PassUpdate' required: false 'Code': type: 'string' required: true 'Namespace': type: 'string' required: true 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/pass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/pass/update_pass_parameters.go' 'UpdateRewardParams@go.seasonpass.mod': id: 'UpdateRewardParams@go.seasonpass.mod' name: 'UpdateRewardParams' type: 'model' fields: 'Body': type: '*RewardUpdate' required: false 'Code': type: 'string' required: true 'Namespace': type: 'string' required: true 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/reward' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/reward/update_reward_parameters.go' 'UpdateSeasonParams@go.seasonpass.mod': id: 'UpdateSeasonParams@go.seasonpass.mod' name: 'UpdateSeasonParams' type: 'model' fields: 'Body': type: '*SeasonUpdate' required: false 'Namespace': type: 'string' required: true 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/season/update_season_parameters.go' 'UpdateTierParams@go.seasonpass.mod': id: 'UpdateTierParams@go.seasonpass.mod' name: 'UpdateTierParams' type: 'model' fields: 'Body': type: '*TierInput' required: false 'ID': type: 'string' required: true 'Namespace': type: 'string' required: true 'SeasonID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/tier' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclient/tier/update_tier_parameters.go' # endregion params # region models 'BulkUserProgressionRequest@go.seasonpass.mod': id: 'BulkUserProgressionRequest@go.seasonpass.mod' name: 'BulkUserProgressionRequest' type: 'model' fields: 'UserIds': type: '[]string' required: false imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/bulk_user_progression_request.go' 'ClaimableRewards@go.seasonpass.mod': id: 'ClaimableRewards@go.seasonpass.mod' name: 'ClaimableRewards' type: 'model' description: |- A DTO object for claimable rewards. fields: 'ClaimingRewards': type: 'interface{}' required: true description: |- Claiming rewards, zero based tier index as key, rewards per pass as value 'ToClaimRewards': type: 'interface{}' required: true description: |- To claim rewards, zero based tier index as key, rewards per pass as value imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/claimable_rewards.go' 'ClaimableUserSeasonInfo@go.seasonpass.mod': id: 'ClaimableUserSeasonInfo@go.seasonpass.mod' name: 'ClaimableUserSeasonInfo' type: 'model' description: |- A DTO object for claimable user season data. fields: 'ClaimingRewards': type: 'interface{}' 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: 'strfmt.DateTime' required: true description: |- created at 'CurrentExp': type: 'int32' required: true description: |- gained exp for current tier 'CurrentTierIndex': type: 'int32' required: true description: |- current tier index, zero based 'EnrolledAt': type: 'strfmt.DateTime' required: true description: |- enroll date time 'EnrolledPasses': type: '[]string' required: true description: |- enrolled passes 'ID': type: 'string' required: true description: |- id 'LastTierIndex': type: 'int32' required: true description: |- last tier index, zero based 'Namespace': type: 'string' required: true description: |- namespace 'RequiredExp': type: 'int32' required: true description: |- required exp for current tier 'Season': type: '*SeasonSummary' required: false description: |- season summary 'SeasonID': type: 'string' required: true description: |- season id 'ToClaimRewards': type: 'interface{}' required: true description: |- To claim rewards, zero based tier index as key, rewards per pass as value 'TotalExp': type: 'int64' required: false description: |- total exp 'TotalPaidForExp': type: 'int64' required: false description: |- total paid-for exp 'TotalSweatExp': type: 'int64' required: false description: |- total sweat exp 'UpdatedAt': type: 'strfmt.DateTime' required: true description: |- updated at 'UserID': type: 'string' required: true description: |- user id imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/claimable_user_season_info.go' 'ErrorEntity@go.seasonpass.mod': id: 'ErrorEntity@go.seasonpass.mod' name: 'ErrorEntity' type: 'model' fields: 'DevStackTrace': type: 'string' required: false description: |- internal server error stack trace in configured environment 'ErrorCode': type: 'int32' required: true description: |- numeric error code 'ErrorMessage': type: 'string' required: true description: |- error message 'MessageVariables': type: 'map[string]string' required: false description: |- message variables 'RequiredPermission': type: '*Permission' required: false imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/error_entity.go' 'ExcessStrategy@go.seasonpass.mod': id: 'ExcessStrategy@go.seasonpass.mod' name: 'ExcessStrategy' type: 'model' fields: 'Currency': type: 'string' required: false description: |- virtual currency for grant, required while method is CURRENCY 'Method': type: 'string' required: true description: |- method while excess the final tier exp 'PercentPerExp': type: 'int32' required: false description: |- percent per exp, required while method is CURRENCY imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/excess_strategy.go' 'ExpGrantHistoryInfo@go.seasonpass.mod': id: 'ExpGrantHistoryInfo@go.seasonpass.mod' name: 'ExpGrantHistoryInfo' type: 'model' description: |- A DTO object for exp grant history details. fields: 'CreatedAt': type: 'strfmt.DateTime' required: true description: |- acquired at 'GrantExp': type: 'int64' 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 'Source': type: 'string' required: false description: |- id 'Tags': type: '[]string' required: false description: |- id 'UserID': type: 'string' required: true description: |- user id imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/exp_grant_history_info.go' 'ExpGrantHistoryPagingSlicedResult@go.seasonpass.mod': id: 'ExpGrantHistoryPagingSlicedResult@go.seasonpass.mod' name: 'ExpGrantHistoryPagingSlicedResult' type: 'model' fields: 'Data': type: '[]*ExpGrantHistoryInfo' required: true description: |- data 'Paging': type: '*Paging' required: false 'Total': type: 'int64' required: false imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/exp_grant_history_paging_sliced_result.go' 'FieldValidationError@go.seasonpass.mod': id: 'FieldValidationError@go.seasonpass.mod' name: 'FieldValidationError' type: 'model' fields: 'ErrorCode': type: 'string' required: false 'ErrorField': type: 'string' required: false 'ErrorMessage': type: 'string' required: false 'ErrorValue': type: 'string' required: false 'MessageVariables': type: 'map[string]string' required: false imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/field_validation_error.go' 'FullSeasonInfo@go.seasonpass.mod': id: 'FullSeasonInfo@go.seasonpass.mod' name: 'FullSeasonInfo' type: 'model' description: |- A DTO object for season full content. fields: 'ID': type: 'string' required: true description: |- id 'Images': type: '[]*Image' required: false description: |- images 'Localizations': type: 'map[string]Localization' required: true description: |- localization, {language: localization} map 'Name': type: 'string' required: true description: |- name, max length is 127 'Namespace': type: 'string' required: true description: |- namespace 'Passes': type: '[]*PassInfo' required: true description: |- passes info 'Rewards': type: 'map[string]RewardInfo' required: true description: |- rewards info 'Tiers': type: '[]*Tier' required: true description: |- tiers info imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/full_season_info.go' 'Image@go.seasonpass.mod': id: 'Image@go.seasonpass.mod' name: 'Image' type: 'model' fields: 'As': type: 'string' required: false description: |- image for 'Caption': type: 'string' required: false description: |- image caption 'Height': type: 'int32' required: true description: |- height 'ImageURL': type: 'string' required: true description: |- imageUrl 'SmallImageURL': type: 'string' required: false description: |- smallImageUrl 'Width': type: 'int32' required: true description: |- width imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/image.go' 'ItemReference@go.seasonpass.mod': id: 'ItemReference@go.seasonpass.mod' name: 'ItemReference' type: 'model' description: |- A DTO object for item references. fields: 'Module': type: 'string' required: false description: |- module 'References': type: '[]map[string]interface{}' required: false description: |- references imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/item_reference.go' 'ItemReferenceInfo@go.seasonpass.mod': id: 'ItemReferenceInfo@go.seasonpass.mod' name: 'ItemReferenceInfo' type: 'model' description: |- A DTO object for item references info. fields: 'References': type: '[]*ItemReference' required: false description: |- item references imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/item_reference_info.go' 'ListSeasonInfo@go.seasonpass.mod': id: 'ListSeasonInfo@go.seasonpass.mod' name: 'ListSeasonInfo' type: 'model' description: |- A DTO object for listing season info. fields: 'CreatedAt': type: 'strfmt.DateTime' required: true description: |- created at 'DefaultLanguage': type: 'string' required: true description: |- default language, BCP 47 language tag 'End': type: 'strfmt.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 'PassCodes': type: '[]string' required: false description: |- pass codes 'PublishedAt': type: '*strfmt.DateTime' required: false description: |- publishedAt 'Start': type: 'strfmt.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: 'strfmt.DateTime' required: true description: |- updated at imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/list_season_info.go' 'ListSeasonInfoPagingSlicedResult@go.seasonpass.mod': id: 'ListSeasonInfoPagingSlicedResult@go.seasonpass.mod' name: 'ListSeasonInfoPagingSlicedResult' type: 'model' fields: 'Data': type: '[]*ListSeasonInfo' required: true description: |- data 'Paging': type: '*Paging' required: false imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/list_season_info_paging_sliced_result.go' 'ListUserSeasonInfo@go.seasonpass.mod': id: 'ListUserSeasonInfo@go.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: 'int32' required: true description: |- current tier index, zero based 'EnrolledAt': type: 'strfmt.DateTime' required: true description: |- enroll date time 'ID': type: 'string' required: true description: |- id 'LastTierIndex': type: 'int32' required: true description: |- last tier index, zero based 'Namespace': type: 'string' required: true description: |- namespace 'Season': type: '*SeasonSummary' required: false description: |- season summary 'SeasonID': type: 'string' required: true description: |- season id 'UserID': type: 'string' required: true description: |- user id imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/list_user_season_info.go' 'ListUserSeasonInfoPagingSlicedResult@go.seasonpass.mod': id: 'ListUserSeasonInfoPagingSlicedResult@go.seasonpass.mod' name: 'ListUserSeasonInfoPagingSlicedResult' type: 'model' fields: 'Data': type: '[]*ListUserSeasonInfo' required: true description: |- data 'Paging': type: '*Paging' required: false 'Total': type: 'int64' required: false imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/list_user_season_info_paging_sliced_result.go' 'Localization@go.seasonpass.mod': id: 'Localization@go.seasonpass.mod' name: 'Localization' type: 'model' fields: 'Description': type: 'string' required: false description: |- description info 'Title': type: 'string' required: false description: |- title info imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/localization.go' 'LocalizedPassInfo@go.seasonpass.mod': id: 'LocalizedPassInfo@go.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: 'strfmt.DateTime' required: true description: |- created at 'Description': type: 'string' required: false description: |- description info 'DisplayOrder': type: 'string' required: true description: |- displayOrder 'Images': type: '[]*Image' required: false description: |- images '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 'Title': type: 'string' required: false description: |- title info 'UpdatedAt': type: 'strfmt.DateTime' required: true description: |- updated at imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/localized_pass_info.go' 'LocalizedSeasonInfo@go.seasonpass.mod': id: 'LocalizedSeasonInfo@go.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: 'strfmt.DateTime' required: true description: |- created at 'Description': type: 'string' required: false description: |- description info 'End': type: 'strfmt.DateTime' required: true description: |- end date time 'ID': type: 'string' required: true description: |- id 'Images': type: '[]*Image' required: false description: |- images '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 'PassCodes': type: '[]string' required: false description: |- pass codes 'Passes': type: '[]*LocalizedPassInfo' required: true description: |- passes info 'PublishedAt': type: '*strfmt.DateTime' required: false description: |- publishedAt 'Rewards': type: 'map[string]RewardInfo' required: true description: |- rewards info 'Start': type: 'strfmt.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: '[]*Tier' required: true description: |- tiers info 'Title': type: 'string' required: false description: |- title info 'UpdatedAt': type: 'strfmt.DateTime' required: true description: |- updated at imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/localized_season_info.go' 'Ownership@go.seasonpass.mod': id: 'Ownership@go.seasonpass.mod' name: 'Ownership' type: 'model' fields: 'Owned': type: 'bool' required: true description: |- ownership imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/ownership.go' 'Paging@go.seasonpass.mod': id: 'Paging@go.seasonpass.mod' name: 'Paging' type: 'model' fields: 'Next': type: 'string' required: false 'Previous': type: 'string' required: false imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/paging.go' 'PassCreate@go.seasonpass.mod': id: 'PassCreate@go.seasonpass.mod' name: 'PassCreate' type: 'model' description: |- A DTO object for creating pass API call. fields: 'AutoEnroll': type: 'bool' required: false description: |- autoEnroll for free pass, default false 'Code': type: 'string' required: true description: |- code, allowed characters from a-z0-9_:- and start/end in alphanumeric, max length is 255 'DisplayOrder': type: 'int32' required: true description: |- displayOrder for frontend to arrange the pass 'Images': type: '[]*Image' required: false description: |- images 'Localizations': type: 'map[string]Localization' required: true description: |- localization, {language: localization} map 'PassItemID': type: 'string' required: true description: |- pass item id imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/pass_create.go' 'PassInfo@go.seasonpass.mod': id: 'PassInfo@go.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: 'strfmt.DateTime' required: true description: |- created at 'DisplayOrder': type: 'string' required: true description: |- displayOrder 'Images': type: '[]*Image' required: false description: |- images 'Localizations': type: 'map[string]Localization' required: true description: |- localization, {language: localization} map 'Namespace': type: 'string' required: true description: |- namespace 'PassItemID': type: 'string' required: true description: |- pass item id 'PassItemName': type: 'string' required: true description: |- pass item name 'SeasonID': type: 'string' required: true description: |- season id 'UpdatedAt': type: 'strfmt.DateTime' required: true description: |- updated at imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/pass_info.go' 'PassUpdate@go.seasonpass.mod': id: 'PassUpdate@go.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: 'int32' required: false description: |- displayOrder for frontend to arrange the pass 'Images': type: '[]*Image' required: false description: |- images 'Localizations': type: 'map[string]Localization' required: false description: |- localization, {language: localization} map 'PassItemID': type: 'string' required: false description: |- pass item id imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/pass_update.go' 'Permission@go.seasonpass.mod': id: 'Permission@go.seasonpass.mod' name: 'Permission' type: 'model' fields: 'Action': type: 'int32' required: false 'Resource': type: 'string' required: false imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/permission.go' 'ReasonTagsResult@go.seasonpass.mod': id: 'ReasonTagsResult@go.seasonpass.mod' name: 'ReasonTagsResult' type: 'model' description: |- A DTO object for reason tags. fields: 'Tags': type: '[]string' required: true description: |- tags imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/reason_tags_result.go' 'RewardCreate@go.seasonpass.mod': id: 'RewardCreate@go.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 '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: 'int32' required: false description: |- Item quantity or Currency amount, default 1 'Type': type: 'string' required: true description: |- type, at current only support ITEM imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/reward_create.go' 'RewardCurrency@go.seasonpass.mod': id: 'RewardCurrency@go.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: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/reward_currency.go' 'RewardInfo@go.seasonpass.mod': id: 'RewardInfo@go.seasonpass.mod' name: 'RewardInfo' type: 'model' description: |- A DTO object for reward info. fields: 'Code': type: 'string' required: true description: |- code '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 'Namespace': type: 'string' required: true description: |- namespace 'Quantity': type: 'int32' required: false description: |- Item quantity or Currency amount, default 1 'SeasonID': type: 'string' required: true description: |- seasonId 'Type': type: 'string' required: true description: |- type imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/reward_info.go' 'RewardUpdate@go.seasonpass.mod': id: 'RewardUpdate@go.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: '[]string' required: false description: |- nullFields 'Quantity': type: 'int32' required: false description: |- Item quantity or Currency amount, default 1 'Type': type: 'string' required: false description: |- type, at current only support ITEM imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/reward_update.go' 'SeasonCloneRequest@go.seasonpass.mod': id: 'SeasonCloneRequest@go.seasonpass.mod' name: 'SeasonCloneRequest' type: 'model' description: |- A DTO object for clone season API call. fields: 'End': type: 'strfmt.DateTime' required: true description: |- end date time 'Name': type: 'string' required: true description: |- name, max length is 127 'Start': type: 'strfmt.DateTime' required: true description: |- start date time imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/season_clone_request.go' 'SeasonCreate@go.seasonpass.mod': id: 'SeasonCreate@go.seasonpass.mod' name: 'SeasonCreate' type: 'model' description: |- A DTO object for creating season API call. fields: '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 'DefaultRequiredExp': type: 'int32' required: true description: |- default exp required for a tier 'DraftStoreID': type: 'string' required: true description: |- draft store id 'End': type: 'strfmt.DateTime' required: true description: |- end date time 'ExcessStrategy': type: '*ExcessStrategy' required: false description: |- strategy while exceed final tier exp, default NONE 'Images': type: '[]*Image' required: false description: |- images 'Localizations': type: 'map[string]Localization' required: true description: |- localization, {language: localization} map 'Name': type: 'string' required: true description: |- name, max length is 127 'Start': type: 'strfmt.DateTime' required: true description: |- start date time 'TierItemID': type: 'string' required: true description: |- tier item id imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/season_create.go' 'SeasonInfo@go.seasonpass.mod': id: 'SeasonInfo@go.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: 'strfmt.DateTime' required: true description: |- created at 'DefaultLanguage': type: 'string' required: true description: |- default language, BCP 47 language tag 'DefaultRequiredExp': type: 'int32' required: true description: |- default required exp for a tier 'DraftStoreID': type: 'string' required: true description: |- draft store id 'End': type: 'strfmt.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 'Images': type: '[]*Image' required: false description: |- images 'Localizations': type: 'map[string]Localization' required: true description: |- localization, {language: localization} map 'Name': type: 'string' required: true description: |- name, max length is 127 'Namespace': type: 'string' required: true description: |- namespace 'PassCodes': type: '[]string' required: false description: |- pass codes 'PublishedAt': type: '*strfmt.DateTime' required: false description: |- publishedAt 'Start': type: 'strfmt.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: 'strfmt.DateTime' required: true description: |- updated at imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/season_info.go' 'SeasonSummary@go.seasonpass.mod': id: 'SeasonSummary@go.seasonpass.mod' name: 'SeasonSummary' type: 'model' description: |- A DTO object for season summary. fields: 'End': type: 'strfmt.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 'PassCodes': type: '[]string' required: false description: |- season pass codes 'Previous': type: '*SeasonSummary' required: false description: |- previous season, only present in some situation 'PublishedAt': type: '*strfmt.DateTime' required: false description: |- publishedAt 'Start': type: 'strfmt.DateTime' required: true description: |- start date time 'Status': type: 'string' required: true description: |- status imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/season_summary.go' 'SeasonUpdate@go.seasonpass.mod': id: 'SeasonUpdate@go.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: 'int32' required: false description: |- default exp required for a tier 'DraftStoreID': type: 'string' required: false description: |- draft store id 'End': type: '*strfmt.DateTime' required: false description: |- end date time 'ExcessStrategy': type: '*ExcessStrategy' required: false description: |- strategy while exceed final tier exp 'Images': type: '[]*Image' required: false description: |- images 'Localizations': type: 'map[string]Localization' required: false description: |- localization, {language: localization} map 'Name': type: 'string' required: false description: |- name, max length is 127 'Start': type: '*strfmt.DateTime' required: false description: |- start date time 'TierItemID': type: 'string' required: false description: |- tier item id imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/season_update.go' 'Tier@go.seasonpass.mod': id: 'Tier@go.seasonpass.mod' name: 'Tier' type: 'model' fields: 'ID': type: 'string' required: false description: |- tier id, auto generated. 'RequiredExp': type: 'int32' required: false description: |- required exp for tier, it will automatically use season defaultRequiredExp if not set 'Rewards': type: 'map[string][]string' required: false description: |- rewards map, passCode as key, rewardCode list as value imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/tier.go' 'TierCreate@go.seasonpass.mod': id: 'TierCreate@go.seasonpass.mod' name: 'TierCreate' type: 'model' description: |- A DTO object for creating tier API call. fields: 'Index': type: 'int32' required: false description: |- zero based tier index to be inserted at, -1 means appending to the end, default -1 'Quantity': type: 'int32' required: false description: |- create tier quantity, default 1 'Tier': type: '*TierInput' required: false description: |- tier content, default null tier imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/tier_create.go' 'TierInput@go.seasonpass.mod': id: 'TierInput@go.seasonpass.mod' name: 'TierInput' type: 'model' description: |- A DTO object for tier input. fields: 'RequiredExp': type: 'int32' required: false description: |- required exp for tier, it will automatically use season defaultRequiredExp if not set 'Rewards': type: 'map[string][]string' required: false description: |- rewards map, passCode as key, rewardCode list as value imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/tier_input.go' 'TierPagingSlicedResult@go.seasonpass.mod': id: 'TierPagingSlicedResult@go.seasonpass.mod' name: 'TierPagingSlicedResult' type: 'model' fields: 'Data': type: '[]*Tier' required: true description: |- data 'Paging': type: '*Paging' required: false 'Total': type: 'int64' required: false imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/tier_paging_sliced_result.go' 'TierReorder@go.seasonpass.mod': id: 'TierReorder@go.seasonpass.mod' name: 'TierReorder' type: 'model' fields: 'NewIndex': type: 'int32' required: false description: |- new index tier should be moved to, zero based, -1 means appending to the end imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/tier_reorder.go' 'UserExpGrant@go.seasonpass.mod': id: 'UserExpGrant@go.seasonpass.mod' name: 'UserExpGrant' type: 'model' description: |- A DTO object for granting user exp. fields: 'Exp': type: 'int32' required: false description: |- exp to grant 'Source': type: 'string' required: false description: |- source 'Tags': type: '[]string' required: false description: |- tags imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/user_exp_grant.go' 'UserPassGrant@go.seasonpass.mod': id: 'UserPassGrant@go.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: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/user_pass_grant.go' 'UserPurchasable@go.seasonpass.mod': id: 'UserPurchasable@go.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: 'int32' required: false description: |- tier item count, default 1 'TierItemID': type: 'string' required: false description: |- tier item id imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/user_purchasable.go' 'UserRewardClaim@go.seasonpass.mod': id: 'UserRewardClaim@go.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: 'int32' required: true description: |- tier index imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/user_reward_claim.go' 'UserSeasonSummary@go.seasonpass.mod': id: 'UserSeasonSummary@go.seasonpass.mod' name: 'UserSeasonSummary' type: 'model' description: |- A DTO object for user season summary. fields: 'Cleared': type: 'bool' required: false description: |- whether cleared all tiers 'CreatedAt': type: '*strfmt.DateTime' required: false description: |- created at 'CurrentExp': type: 'int32' required: false description: |- gained exp for current tier 'CurrentTierIndex': type: 'int32' required: false description: |- current tier index, zero based 'EnrolledAt': type: '*strfmt.DateTime' required: false description: |- enroll date time 'EnrolledPasses': type: '[]string' required: false description: |- enrolled passes 'ID': type: 'string' required: false description: |- id 'LastTierIndex': type: 'int32' required: false description: |- last tier index, zero based 'Namespace': type: 'string' required: true description: |- namespace 'RequiredExp': type: 'int32' required: false description: |- required exp for current tier 'SeasonID': type: 'string' required: false description: |- season id 'UpdatedAt': type: '*strfmt.DateTime' required: false description: |- updated at 'UserID': type: 'string' required: true description: |- user id imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/user_season_summary.go' 'UserTierGrant@go.seasonpass.mod': id: 'UserTierGrant@go.seasonpass.mod' name: 'UserTierGrant' type: 'model' description: |- A DTO object for granting user tier. fields: 'Count': type: 'int32' required: false description: |- count to grant 'Source': type: 'string' required: false description: |- source 'Tags': type: '[]string' required: false description: |- tags imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/user_tier_grant.go' 'ValidationErrorEntity@go.seasonpass.mod': id: 'ValidationErrorEntity@go.seasonpass.mod' name: 'ValidationErrorEntity' type: 'model' fields: 'ErrorCode': type: 'int32' required: true description: |- numeric error code 'ErrorMessage': type: 'string' required: true description: |- error message 'Errors': type: '[]*FieldValidationError' required: false imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/seasonpass-sdk/pkg/seasonpassclientmodels/validation_error_entity.go' # endregion models # region functions 'BulkGetUserSeasonProgressionShort@go.seasonpass.fun': id: 'BulkGetUserSeasonProgressionShort@go.seasonpass.fun' name: 'BulkGetUserSeasonProgressionShort' 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 struct: 'SeasonService' arguments: params: type: '*season.BulkGetUserSeasonProgressionParams' required: true return_type: '(*season.BulkGetUserSeasonProgressionResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.BulkGetUserSeasonProgressionParams{ ... } res, err := seasonService.BulkGetUserSeasonProgressionShort(params) if err != nil { // handleError(err) } tags: - 'bulk' - 'get' - 'progression' - 'season' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]' 'CheckSeasonPurchasableShort@go.seasonpass.fun': id: 'CheckSeasonPurchasableShort@go.seasonpass.fun' name: 'CheckSeasonPurchasableShort' type: 'function' description: |- This API is used to check pass or tier purchasable, season only located in non-publisher namespace. struct: 'SeasonService' arguments: params: type: '*season.CheckSeasonPurchasableParams' required: true return_type: 'error' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.CheckSeasonPurchasableParams{ ... } res, err := seasonService.CheckSeasonPurchasableShort(params) if err != nil { // handleError(err) } tags: - 'check' - 'purchasable' - 'season' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]' 'CloneSeasonShort@go.seasonpass.fun': id: 'CloneSeasonShort@go.seasonpass.fun' name: 'CloneSeasonShort' type: 'function' description: |- This API is used to clone a season. Other detail info: * Returns : cloned season info struct: 'SeasonService' arguments: params: type: '*season.CloneSeasonParams' required: true return_type: '(*season.CloneSeasonResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.CloneSeasonParams{ ... } res, err := seasonService.CloneSeasonShort(params) if err != nil { // handleError(err) } tags: - 'clone' - 'season' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]' 'CreatePassShort@go.seasonpass.fun': id: 'CreatePassShort@go.seasonpass.fun' name: 'CreatePassShort' type: 'function' description: |- This API is used to create a pass for a draft season. Other detail info: * Returns : created pass struct: 'PassService' arguments: params: type: '*pass.CreatePassParams' required: true return_type: '(*pass.CreatePassResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/pass' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/pass.go' example: |- passService := seasonpass.PassService{ ... } params := pass.CreatePassParams{ ... } res, err := passService.CreatePassShort(params) if err != nil { // handleError(err) } tags: - 'create' - 'pass' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]' 'CreateRewardShort@go.seasonpass.fun': id: 'CreateRewardShort@go.seasonpass.fun' name: 'CreateRewardShort' type: 'function' description: |- This API is used to create a reward for a draft season. Other detail info: * Returns : created reward struct: 'RewardService' arguments: params: type: '*reward.CreateRewardParams' required: true return_type: '(*reward.CreateRewardResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/reward' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/reward.go' example: |- rewardService := seasonpass.RewardService{ ... } params := reward.CreateRewardParams{ ... } res, err := rewardService.CreateRewardShort(params) if err != nil { // handleError(err) } tags: - 'create' - 'reward' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]' 'CreateSeasonShort@go.seasonpass.fun': id: 'CreateSeasonShort@go.seasonpass.fun' name: 'CreateSeasonShort' type: 'function' description: |- This API is used to create a season, season only allowed in non-publisher namespace. Other detail info: * Returns : created season struct: 'SeasonService' arguments: params: type: '*season.CreateSeasonParams' required: true return_type: '(*season.CreateSeasonResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.CreateSeasonParams{ ... } res, err := seasonService.CreateSeasonShort(params) if err != nil { // handleError(err) } tags: - 'create' - 'season' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]' 'CreateTierShort@go.seasonpass.fun': id: 'CreateTierShort@go.seasonpass.fun' name: 'CreateTierShort' type: 'function' description: |- This API is used to create tier for a draft season, can create multiple tiers at same time. struct: 'TierService' arguments: params: type: '*tier.CreateTierParams' required: true return_type: '(*tier.CreateTierResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/tier' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/tier.go' example: |- tierService := seasonpass.TierService{ ... } params := tier.CreateTierParams{ ... } res, err := tierService.CreateTierShort(params) if err != nil { // handleError(err) } tags: - 'create' - 'tier' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [CREATE]' 'DeletePassShort@go.seasonpass.fun': id: 'DeletePassShort@go.seasonpass.fun' name: 'DeletePassShort' type: 'function' description: |- This API is used to delete a pass permanently, only draft season pass can be deleted. struct: 'PassService' arguments: params: type: '*pass.DeletePassParams' required: true return_type: 'error' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/pass' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/pass.go' example: |- passService := seasonpass.PassService{ ... } params := pass.DeletePassParams{ ... } res, err := passService.DeletePassShort(params) if err != nil { // handleError(err) } tags: - 'delete' - 'pass' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]' 'DeleteRewardShort@go.seasonpass.fun': id: 'DeleteRewardShort@go.seasonpass.fun' name: 'DeleteRewardShort' type: 'function' description: |- This API is used to delete a reward permanently, only draft season reward can be deleted. Other detail info: struct: 'RewardService' arguments: params: type: '*reward.DeleteRewardParams' required: true return_type: 'error' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/reward' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/reward.go' example: |- rewardService := seasonpass.RewardService{ ... } params := reward.DeleteRewardParams{ ... } res, err := rewardService.DeleteRewardShort(params) if err != nil { // handleError(err) } tags: - 'delete' - 'reward' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]' 'DeleteSeasonShort@go.seasonpass.fun': id: 'DeleteSeasonShort@go.seasonpass.fun' name: 'DeleteSeasonShort' type: 'function' description: |- This API is used to delete a season permanently, only draft season can be deleted. struct: 'SeasonService' arguments: params: type: '*season.DeleteSeasonParams' required: true return_type: 'error' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.DeleteSeasonParams{ ... } res, err := seasonService.DeleteSeasonShort(params) if err != nil { // handleError(err) } tags: - 'delete' - 'season' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]' 'DeleteTierShort@go.seasonpass.fun': id: 'DeleteTierShort@go.seasonpass.fun' name: 'DeleteTierShort' type: 'function' description: |- This API is used to delete a tier permanently, only draft season pass can be deleted. struct: 'TierService' arguments: params: type: '*tier.DeleteTierParams' required: true return_type: 'error' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/tier' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/tier.go' example: |- tierService := seasonpass.TierService{ ... } params := tier.DeleteTierParams{ ... } res, err := tierService.DeleteTierShort(params) if err != nil { // handleError(err) } tags: - 'delete' - 'tier' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [DELETE]' 'ExistsAnyPassByPassCodesShort@go.seasonpass.fun': id: 'ExistsAnyPassByPassCodesShort@go.seasonpass.fun' name: 'ExistsAnyPassByPassCodesShort' 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 struct: 'SeasonService' arguments: params: type: '*season.ExistsAnyPassByPassCodesParams' required: true return_type: '(*season.ExistsAnyPassByPassCodesResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.ExistsAnyPassByPassCodesParams{ ... } res, err := seasonService.ExistsAnyPassByPassCodesShort(params) if err != nil { // handleError(err) } tags: - 'any' - 'by' - 'codes' - 'exists' - 'pass' - 'season' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]' 'ExportSeasonShort@go.seasonpass.fun': id: 'ExportSeasonShort@go.seasonpass.fun' name: 'ExportSeasonShort' type: 'function' description: |- This API is used to export all of season service data files with csv format. struct: 'ExportService' arguments: params: type: '*export.ExportSeasonParams' required: true return_type: '(*export.ExportSeasonResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/export' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/export.go' example: |- exportService := seasonpass.ExportService{ ... } params := export.ExportSeasonParams{ ... } res, err := exportService.ExportSeasonShort(params) if err != nil { // handleError(err) } tags: - 'export' - 'season' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]' 'GetCurrentSeasonShort@go.seasonpass.fun': id: 'GetCurrentSeasonShort@go.seasonpass.fun' name: 'GetCurrentSeasonShort' 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 struct: 'SeasonService' arguments: params: type: '*season.GetCurrentSeasonParams' required: true return_type: '(*season.GetCurrentSeasonResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.GetCurrentSeasonParams{ ... } res, err := seasonService.GetCurrentSeasonShort(params) if err != nil { // handleError(err) } tags: - 'current' - 'get' - 'season' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]' 'GetCurrentUserSeasonProgressionShort@go.seasonpass.fun': id: 'GetCurrentUserSeasonProgressionShort@go.seasonpass.fun' name: 'GetCurrentUserSeasonProgressionShort' 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 struct: 'SeasonService' arguments: params: type: '*season.GetCurrentUserSeasonProgressionParams' required: true return_type: '(*season.GetCurrentUserSeasonProgressionResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.GetCurrentUserSeasonProgressionParams{ ... } res, err := seasonService.GetCurrentUserSeasonProgressionShort(params) if err != nil { // handleError(err) } tags: - 'current' - 'get' - 'progression' - 'season' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]' 'GetFullSeasonShort@go.seasonpass.fun': id: 'GetFullSeasonShort@go.seasonpass.fun' name: 'GetFullSeasonShort' 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 struct: 'SeasonService' arguments: params: type: '*season.GetFullSeasonParams' required: true return_type: '(*season.GetFullSeasonResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.GetFullSeasonParams{ ... } res, err := seasonService.GetFullSeasonShort(params) if err != nil { // handleError(err) } tags: - 'full' - 'get' - 'season' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]' 'GetItemReferencesShort@go.seasonpass.fun': id: 'GetItemReferencesShort@go.seasonpass.fun' name: 'GetItemReferencesShort' type: 'function' description: |- This API is used to get season pass ecommerce item references. Other detail info: * Returns : item references data struct: 'UtilitiesService' arguments: params: type: '*utilities.GetItemReferencesParams' required: true return_type: '(*utilities.GetItemReferencesResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/utilities' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/utilities.go' example: |- utilitiesService := seasonpass.UtilitiesService{ ... } params := utilities.GetItemReferencesParams{ ... } res, err := utilitiesService.GetItemReferencesShort(params) if err != nil { // handleError(err) } tags: - 'get' - 'item' - 'references' - 'utilities' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]' 'GetPassShort@go.seasonpass.fun': id: 'GetPassShort@go.seasonpass.fun' name: 'GetPassShort' type: 'function' description: |- This API is used to get a pass for a season. Other detail info: * Returns : pass data struct: 'PassService' arguments: params: type: '*pass.GetPassParams' required: true return_type: '(*pass.GetPassResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/pass' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/pass.go' example: |- passService := seasonpass.PassService{ ... } params := pass.GetPassParams{ ... } res, err := passService.GetPassShort(params) if err != nil { // handleError(err) } tags: - 'get' - 'pass' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]' 'GetRewardShort@go.seasonpass.fun': id: 'GetRewardShort@go.seasonpass.fun' name: 'GetRewardShort' type: 'function' description: |- This API is used to get a reward for a season. Other detail info: * Returns : reward data struct: 'RewardService' arguments: params: type: '*reward.GetRewardParams' required: true return_type: '(*reward.GetRewardResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/reward' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/reward.go' example: |- rewardService := seasonpass.RewardService{ ... } params := reward.GetRewardParams{ ... } res, err := rewardService.GetRewardShort(params) if err != nil { // handleError(err) } tags: - 'get' - 'reward' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]' 'GetSeasonShort@go.seasonpass.fun': id: 'GetSeasonShort@go.seasonpass.fun' name: 'GetSeasonShort' type: 'function' description: |- This API is used to get a season, season only located in non-publisher namespace. Other detail info: * Returns : season data struct: 'SeasonService' arguments: params: type: '*season.GetSeasonParams' required: true return_type: '(*season.GetSeasonResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.GetSeasonParams{ ... } res, err := seasonService.GetSeasonShort(params) if err != nil { // handleError(err) } tags: - 'get' - 'season' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]' 'GetUserParticipatedSeasonsShort@go.seasonpass.fun': id: 'GetUserParticipatedSeasonsShort@go.seasonpass.fun' name: 'GetUserParticipatedSeasonsShort' 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 struct: 'SeasonService' arguments: params: type: '*season.GetUserParticipatedSeasonsParams' required: true return_type: '(*season.GetUserParticipatedSeasonsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.GetUserParticipatedSeasonsParams{ ... } res, err := seasonService.GetUserParticipatedSeasonsShort(params) if err != nil { // handleError(err) } tags: - 'get' - 'participated' - 'season' - 'seasons' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]' 'GetUserSeasonShort@go.seasonpass.fun': id: 'GetUserSeasonShort@go.seasonpass.fun' name: 'GetUserSeasonShort' 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 struct: 'SeasonService' arguments: params: type: '*season.GetUserSeasonParams' required: true return_type: '(*season.GetUserSeasonResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.GetUserSeasonParams{ ... } res, err := seasonService.GetUserSeasonShort(params) if err != nil { // handleError(err) } tags: - 'get' - 'season' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]' 'GrantUserExpShort@go.seasonpass.fun': id: 'GrantUserExpShort@go.seasonpass.fun' name: 'GrantUserExpShort' 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 struct: 'TierService' arguments: params: type: '*tier.GrantUserExpParams' required: true return_type: '(*tier.GrantUserExpResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/tier' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/tier.go' example: |- tierService := seasonpass.TierService{ ... } params := tier.GrantUserExpParams{ ... } res, err := tierService.GrantUserExpShort(params) if err != nil { // handleError(err) } tags: - 'exp' - 'grant' - 'tier' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]' 'GrantUserPassShort@go.seasonpass.fun': id: 'GrantUserPassShort@go.seasonpass.fun' name: 'GrantUserPassShort' 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 struct: 'PassService' arguments: params: type: '*pass.GrantUserPassParams' required: true return_type: '(*pass.GrantUserPassResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/pass' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/pass.go' example: |- passService := seasonpass.PassService{ ... } params := pass.GrantUserPassParams{ ... } res, err := passService.GrantUserPassShort(params) if err != nil { // handleError(err) } tags: - 'grant' - 'pass' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]' 'GrantUserTierShort@go.seasonpass.fun': id: 'GrantUserTierShort@go.seasonpass.fun' name: 'GrantUserTierShort' 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 struct: 'TierService' arguments: params: type: '*tier.GrantUserTierParams' required: true return_type: '(*tier.GrantUserTierResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/tier' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/tier.go' example: |- tierService := seasonpass.TierService{ ... } params := tier.GrantUserTierParams{ ... } res, err := tierService.GrantUserTierShort(params) if err != nil { // handleError(err) } tags: - 'grant' - 'tier' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]' 'PublicBulkClaimUserRewardsShort@go.seasonpass.fun': id: 'PublicBulkClaimUserRewardsShort@go.seasonpass.fun' name: 'PublicBulkClaimUserRewardsShort' 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 struct: 'RewardService' arguments: params: type: '*reward.PublicBulkClaimUserRewardsParams' required: true return_type: '(*reward.PublicBulkClaimUserRewardsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/reward' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/reward.go' example: |- rewardService := seasonpass.RewardService{ ... } params := reward.PublicBulkClaimUserRewardsParams{ ... } res, err := rewardService.PublicBulkClaimUserRewardsShort(params) if err != nil { // handleError(err) } tags: - 'bulk' - 'claim' - 'public' - 'reward' - 'rewards' - 'user' permissions: - 'NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]' 'PublicClaimUserRewardShort@go.seasonpass.fun': id: 'PublicClaimUserRewardShort@go.seasonpass.fun' name: 'PublicClaimUserRewardShort' type: 'function' description: |- This API is used to claim reward, season only located in non-publisher namespace. Other detail info: * Returns : user season data struct: 'RewardService' arguments: params: type: '*reward.PublicClaimUserRewardParams' required: true return_type: '(*reward.PublicClaimUserRewardResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/reward' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/reward.go' example: |- rewardService := seasonpass.RewardService{ ... } params := reward.PublicClaimUserRewardParams{ ... } res, err := rewardService.PublicClaimUserRewardShort(params) if err != nil { // handleError(err) } tags: - 'claim' - 'public' - 'reward' - 'user' permissions: - 'NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [UPDATE]' 'PublicGetCurrentSeasonShort@go.seasonpass.fun': id: 'PublicGetCurrentSeasonShort@go.seasonpass.fun' name: 'PublicGetCurrentSeasonShort' 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 struct: 'SeasonService' arguments: params: type: '*season.PublicGetCurrentSeasonParams' required: true return_type: '(*season.PublicGetCurrentSeasonResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.PublicGetCurrentSeasonParams{ ... } res, err := seasonService.PublicGetCurrentSeasonShort(params) if err != nil { // handleError(err) } tags: - 'current' - 'get' - 'public' - 'season' 'PublicGetCurrentUserSeasonShort@go.seasonpass.fun': id: 'PublicGetCurrentUserSeasonShort@go.seasonpass.fun' name: 'PublicGetCurrentUserSeasonShort' 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 struct: 'SeasonService' arguments: params: type: '*season.PublicGetCurrentUserSeasonParams' required: true return_type: '(*season.PublicGetCurrentUserSeasonResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.PublicGetCurrentUserSeasonParams{ ... } res, err := seasonService.PublicGetCurrentUserSeasonShort(params) if err != nil { // handleError(err) } tags: - 'current' - 'get' - 'public' - 'season' - 'user' permissions: - 'NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]' 'PublicGetUserSeasonShort@go.seasonpass.fun': id: 'PublicGetUserSeasonShort@go.seasonpass.fun' name: 'PublicGetUserSeasonShort' 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 struct: 'SeasonService' arguments: params: type: '*season.PublicGetUserSeasonParams' required: true return_type: '(*season.PublicGetUserSeasonResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.PublicGetUserSeasonParams{ ... } res, err := seasonService.PublicGetUserSeasonShort(params) if err != nil { // handleError(err) } tags: - 'get' - 'public' - 'season' - 'user' permissions: - 'NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]' 'PublishSeasonShort@go.seasonpass.fun': id: 'PublishSeasonShort@go.seasonpass.fun' name: 'PublishSeasonShort' 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 struct: 'SeasonService' arguments: params: type: '*season.PublishSeasonParams' required: true return_type: '(*season.PublishSeasonResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.PublishSeasonParams{ ... } res, err := seasonService.PublishSeasonShort(params) if err != nil { // handleError(err) } tags: - 'publish' - 'season' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]' 'QueryPassesShort@go.seasonpass.fun': id: 'QueryPassesShort@go.seasonpass.fun' name: 'QueryPassesShort' type: 'function' description: |- This API is used to query all passes for a season. Other detail info: * Returns : the list of passes struct: 'PassService' arguments: params: type: '*pass.QueryPassesParams' required: true return_type: '(*pass.QueryPassesResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/pass' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/pass.go' example: |- passService := seasonpass.PassService{ ... } params := pass.QueryPassesParams{ ... } res, err := passService.QueryPassesShort(params) if err != nil { // handleError(err) } tags: - 'pass' - 'passes' - 'query' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]' 'QueryRewardsShort@go.seasonpass.fun': id: 'QueryRewardsShort@go.seasonpass.fun' name: 'QueryRewardsShort' type: 'function' description: |- This API is used to query rewards for a season. Other detail info: * Returns : the list of rewards struct: 'RewardService' arguments: params: type: '*reward.QueryRewardsParams' required: true return_type: '(*reward.QueryRewardsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/reward' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/reward.go' example: |- rewardService := seasonpass.RewardService{ ... } params := reward.QueryRewardsParams{ ... } res, err := rewardService.QueryRewardsShort(params) if err != nil { // handleError(err) } tags: - 'query' - 'reward' - 'rewards' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]' 'QuerySeasonsShort@go.seasonpass.fun': id: 'QuerySeasonsShort@go.seasonpass.fun' name: 'QuerySeasonsShort' 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 struct: 'SeasonService' arguments: params: type: '*season.QuerySeasonsParams' required: true return_type: '(*season.QuerySeasonsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.QuerySeasonsParams{ ... } res, err := seasonService.QuerySeasonsShort(params) if err != nil { // handleError(err) } tags: - 'query' - 'season' - 'seasons' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]' 'QueryTiersShort@go.seasonpass.fun': id: 'QueryTiersShort@go.seasonpass.fun' name: 'QueryTiersShort' type: 'function' description: |- This API is used to query paginated tiers for a season. Other detail info: * Returns : the list of passes struct: 'TierService' arguments: params: type: '*tier.QueryTiersParams' required: true return_type: '(*tier.QueryTiersResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/tier' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/tier.go' example: |- tierService := seasonpass.TierService{ ... } params := tier.QueryTiersParams{ ... } res, err := tierService.QueryTiersShort(params) if err != nil { // handleError(err) } tags: - 'query' - 'tier' - 'tiers' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [READ]' 'QueryUserExpGrantHistoryShort@go.seasonpass.fun': id: 'QueryUserExpGrantHistoryShort@go.seasonpass.fun' name: 'QueryUserExpGrantHistoryShort' 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 struct: 'SeasonService' arguments: params: type: '*season.QueryUserExpGrantHistoryParams' required: true return_type: '(*season.QueryUserExpGrantHistoryResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.QueryUserExpGrantHistoryParams{ ... } res, err := seasonService.QueryUserExpGrantHistoryShort(params) if err != nil { // handleError(err) } tags: - 'exp' - 'grant' - 'history' - 'query' - 'season' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]' 'QueryUserExpGrantHistoryTagShort@go.seasonpass.fun': id: 'QueryUserExpGrantHistoryTagShort@go.seasonpass.fun' name: 'QueryUserExpGrantHistoryTagShort' 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 struct: 'SeasonService' arguments: params: type: '*season.QueryUserExpGrantHistoryTagParams' required: true return_type: '(*season.QueryUserExpGrantHistoryTagResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.QueryUserExpGrantHistoryTagParams{ ... } res, err := seasonService.QueryUserExpGrantHistoryTagShort(params) if err != nil { // handleError(err) } tags: - 'exp' - 'grant' - 'history' - 'query' - 'season' - 'tag' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [READ]' 'ReorderTierShort@go.seasonpass.fun': id: 'ReorderTierShort@go.seasonpass.fun' name: 'ReorderTierShort' type: 'function' description: |- This API is used to reorder a tier. Only draft season pass can be updated. struct: 'TierService' arguments: params: type: '*tier.ReorderTierParams' required: true return_type: '(*tier.ReorderTierResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/tier' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/tier.go' example: |- tierService := seasonpass.TierService{ ... } params := tier.ReorderTierParams{ ... } res, err := tierService.ReorderTierShort(params) if err != nil { // handleError(err) } tags: - 'reorder' - 'tier' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]' 'ResetUserSeasonShort@go.seasonpass.fun': id: 'ResetUserSeasonShort@go.seasonpass.fun' name: 'ResetUserSeasonShort' 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. struct: 'SeasonService' arguments: params: type: '*season.ResetUserSeasonParams' required: true return_type: 'error' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.ResetUserSeasonParams{ ... } res, err := seasonService.ResetUserSeasonShort(params) if err != nil { // handleError(err) } tags: - 'reset' - 'season' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:SEASONPASS [DELETE]' 'RetireSeasonShort@go.seasonpass.fun': id: 'RetireSeasonShort@go.seasonpass.fun' name: 'RetireSeasonShort' 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 struct: 'SeasonService' arguments: params: type: '*season.RetireSeasonParams' required: true return_type: '(*season.RetireSeasonResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.RetireSeasonParams{ ... } res, err := seasonService.RetireSeasonShort(params) if err != nil { // handleError(err) } tags: - 'retire' - 'season' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]' 'UnpublishSeasonShort@go.seasonpass.fun': id: 'UnpublishSeasonShort@go.seasonpass.fun' name: 'UnpublishSeasonShort' 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 struct: 'SeasonService' arguments: params: type: '*season.UnpublishSeasonParams' required: true return_type: '(*season.UnpublishSeasonResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.UnpublishSeasonParams{ ... } res, err := seasonService.UnpublishSeasonShort(params) if err != nil { // handleError(err) } tags: - 'season' - 'unpublish' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]' 'UpdatePassShort@go.seasonpass.fun': id: 'UpdatePassShort@go.seasonpass.fun' name: 'UpdatePassShort' type: 'function' description: |- This API is used to update a pass. Only draft season pass can be updated. Other detail info: * Returns : updated pass struct: 'PassService' arguments: params: type: '*pass.UpdatePassParams' required: true return_type: '(*pass.UpdatePassResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/pass' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/pass.go' example: |- passService := seasonpass.PassService{ ... } params := pass.UpdatePassParams{ ... } res, err := passService.UpdatePassShort(params) if err != nil { // handleError(err) } tags: - 'pass' - 'update' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]' 'UpdateRewardShort@go.seasonpass.fun': id: 'UpdateRewardShort@go.seasonpass.fun' name: 'UpdateRewardShort' type: 'function' description: |- This API is used to update a reward. Only draft season reward can be updated. Other detail info: * Returns : updated reward struct: 'RewardService' arguments: params: type: '*reward.UpdateRewardParams' required: true return_type: '(*reward.UpdateRewardResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/reward' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/reward.go' example: |- rewardService := seasonpass.RewardService{ ... } params := reward.UpdateRewardParams{ ... } res, err := rewardService.UpdateRewardShort(params) if err != nil { // handleError(err) } tags: - 'reward' - 'update' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]' 'UpdateSeasonShort@go.seasonpass.fun': id: 'UpdateSeasonShort@go.seasonpass.fun' name: 'UpdateSeasonShort' type: 'function' description: |- This API is used to update a season. Only draft season can be updated. Other detail info: * Returns : updated season struct: 'SeasonService' arguments: params: type: '*season.UpdateSeasonParams' required: true return_type: '(*season.UpdateSeasonResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/season' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/season.go' example: |- seasonService := seasonpass.SeasonService{ ... } params := season.UpdateSeasonParams{ ... } res, err := seasonService.UpdateSeasonShort(params) if err != nil { // handleError(err) } tags: - 'season' - 'update' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]' 'UpdateTierShort@go.seasonpass.fun': id: 'UpdateTierShort@go.seasonpass.fun' name: 'UpdateTierShort' type: 'function' description: |- This API is used to update a tier. Only draft season pass can be updated. struct: 'TierService' arguments: params: type: '*tier.UpdateTierParams' required: true return_type: '(*tier.UpdateTierResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/seasonpass-sdk/pkg/seasonpassclient/tier' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/seasonpass' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/seasonpass/tier.go' example: |- tierService := seasonpass.TierService{ ... } params := tier.UpdateTierParams{ ... } res, err := tierService.UpdateTierShort(params) if err != nil { // handleError(err) } tags: - 'tier' - 'update' permissions: - 'ADMIN:NAMESPACE:{namespace}:SEASONPASS [UPDATE]' # endregion functions