AGS Extend SDK MCP Server

symbols: 'NewAchievementClient@go.achievement.fun': id: 'NewAchievementClient@go.achievement.fun' name: 'NewAchievementClient' type: 'function' arguments: configRepository: type: 'repository.ConfigRepository' return_type: '*achievementclient.JusticeAchievementService' 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/achievement-sdk/pkg/achievementclient' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/justice_achievement_service_client.go' - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/factory/achievementclientfactory.go' example: |- achievementClient := factory.NewAchievementClient(configRepo) # region wrappers 'AchievementsService@go.achievement.mod': id: 'AchievementsService@go.achievement.mod' name: 'AchievementsService' type: 'model' fields: Client: type: '*achievementclient.JusticeAchievementService' 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/achievement-sdk/pkg/achievementclient' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/achievements.go' example: |- achievementClient := factory.NewAchievementClient(configRepo) // re-use if it exists already achievementsService := AchievementsService{ Client: achievementClient, ConfigRepository: configRepo, TokenRepository: tokenRepo, } 'AnonymizationService@go.achievement.mod': id: 'AnonymizationService@go.achievement.mod' name: 'AnonymizationService' type: 'model' fields: Client: type: '*achievementclient.JusticeAchievementService' 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/achievement-sdk/pkg/achievementclient' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/anonymization.go' example: |- achievementClient := factory.NewAchievementClient(configRepo) // re-use if it exists already anonymizationService := AnonymizationService{ Client: achievementClient, ConfigRepository: configRepo, TokenRepository: tokenRepo, } 'GlobalAchievementsService@go.achievement.mod': id: 'GlobalAchievementsService@go.achievement.mod' name: 'GlobalAchievementsService' type: 'model' fields: Client: type: '*achievementclient.JusticeAchievementService' 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/achievement-sdk/pkg/achievementclient' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/globalAchievements.go' example: |- achievementClient := factory.NewAchievementClient(configRepo) // re-use if it exists already globalAchievementsService := GlobalAchievementsService{ Client: achievementClient, ConfigRepository: configRepo, TokenRepository: tokenRepo, } 'PlatformAchievementService@go.achievement.mod': id: 'PlatformAchievementService@go.achievement.mod' name: 'PlatformAchievementService' type: 'model' fields: Client: type: '*achievementclient.JusticeAchievementService' 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/achievement-sdk/pkg/achievementclient' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/platformAchievement.go' example: |- achievementClient := factory.NewAchievementClient(configRepo) // re-use if it exists already platformAchievementService := PlatformAchievementService{ Client: achievementClient, ConfigRepository: configRepo, TokenRepository: tokenRepo, } 'TagsService@go.achievement.mod': id: 'TagsService@go.achievement.mod' name: 'TagsService' type: 'model' fields: Client: type: '*achievementclient.JusticeAchievementService' 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/achievement-sdk/pkg/achievementclient' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/tags.go' example: |- achievementClient := factory.NewAchievementClient(configRepo) // re-use if it exists already tagsService := TagsService{ Client: achievementClient, ConfigRepository: configRepo, TokenRepository: tokenRepo, } 'UserAchievementsService@go.achievement.mod': id: 'UserAchievementsService@go.achievement.mod' name: 'UserAchievementsService' type: 'model' fields: Client: type: '*achievementclient.JusticeAchievementService' 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/achievement-sdk/pkg/achievementclient' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/userAchievements.go' example: |- achievementClient := factory.NewAchievementClient(configRepo) // re-use if it exists already userAchievementsService := UserAchievementsService{ Client: achievementClient, ConfigRepository: configRepo, TokenRepository: tokenRepo, } # endregion wrappers # region params 'AdminAnonymizeUserAchievementParams@go.achievement.mod': id: 'AdminAnonymizeUserAchievementParams@go.achievement.mod' name: 'AdminAnonymizeUserAchievementParams' type: 'model' fields: 'Namespace': type: 'string' required: true description: |- namespace of the game 'UserID': type: 'string' required: true description: |- user id imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/anonymization' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/anonymization/admin_anonymize_user_achievement_parameters.go' 'AdminBulkUnlockAchievementParams@go.achievement.mod': id: 'AdminBulkUnlockAchievementParams@go.achievement.mod' name: 'AdminBulkUnlockAchievementParams' type: 'model' fields: 'Body': type: '*ModelsBulkUnlockAchievementRequest' required: true 'Namespace': type: 'string' required: true description: |- namespace of the game 'UserID': type: 'string' required: true description: |- user id imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/user_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/user_achievements/admin_bulk_unlock_achievement_parameters.go' 'AdminCreateNewAchievementParams@go.achievement.mod': id: 'AdminCreateNewAchievementParams@go.achievement.mod' name: 'AdminCreateNewAchievementParams' type: 'model' fields: 'Body': type: '*ModelsAchievementRequest' required: true 'Namespace': type: 'string' required: true description: |- namespace of the game imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/achievements/admin_create_new_achievement_parameters.go' 'AdminDeleteAchievementParams@go.achievement.mod': id: 'AdminDeleteAchievementParams@go.achievement.mod' name: 'AdminDeleteAchievementParams' type: 'model' fields: 'AchievementCode': type: 'string' required: true description: |- achievement code 'Namespace': type: 'string' required: true description: |- namespace of the game imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/achievements/admin_delete_achievement_parameters.go' 'AdminGetAchievementParams@go.achievement.mod': id: 'AdminGetAchievementParams@go.achievement.mod' name: 'AdminGetAchievementParams' type: 'model' fields: 'AchievementCode': type: 'string' required: true description: |- achievement code 'Namespace': type: 'string' required: true description: |- namespace of the game imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/achievements/admin_get_achievement_parameters.go' 'AdminListAchievementsParams@go.achievement.mod': id: 'AdminListAchievementsParams@go.achievement.mod' name: 'AdminListAchievementsParams' type: 'model' fields: 'Global': type: 'bool' required: false description: |- filter by global achievement flag 'Limit': type: 'int64' required: false description: |- the maximum number of data that may be returned (1...100) 'Namespace': type: 'string' required: true description: |- namespace of the game 'Offset': type: 'int64' required: false description: |- offset 'SortBy': type: 'string' required: false description: |- sort by, default is 'listOrder:asc', allow values: [listOrder, listOrder:asc, listOrder:desc, createdAt, createdAt:asc, createdAt:desc, updatedAt, updatedAt:asc, updatedAt:desc] 'Tags': type: '[]string' required: false description: |- tags imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/achievements/admin_list_achievements_parameters.go' 'AdminListGlobalAchievementContributorsParams@go.achievement.mod': id: 'AdminListGlobalAchievementContributorsParams@go.achievement.mod' name: 'AdminListGlobalAchievementContributorsParams' type: 'model' fields: 'AchievementCode': type: 'string' required: true description: |- achievement code 'Limit': type: 'int64' required: false description: |- the maximum number of data that may be returned (1...100) 'Namespace': type: 'string' required: true description: |- namespace of the game 'Offset': type: 'int64' required: false description: |- offset 'SortBy': type: 'string' required: false description: |- sort by, default is 'contributedValue:desc', allow values: [contributedValue, contributedValue:asc, contributedValue:desc] imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/global_achievements/admin_list_global_achievement_contributors_parameters.go' 'AdminListGlobalAchievementsParams@go.achievement.mod': id: 'AdminListGlobalAchievementsParams@go.achievement.mod' name: 'AdminListGlobalAchievementsParams' type: 'model' fields: 'AchievementCodes': type: 'string' required: false description: |- filter by achievement codes. multiple value separated by comma 'Limit': type: 'int64' required: false description: |- the maximum number of data that may be returned (1...100) 'Namespace': type: 'string' required: true description: |- namespace of the game 'Offset': type: 'int64' required: false description: |- offset 'SortBy': type: 'string' required: false description: |- sort by, allow values: [achievedAt, achievedAt:asc, achievedAt:desc, createdAt, createdAt:asc, createdAt:desc] 'Status': type: 'string' required: false description: |- filter by status. available value: [in_progress, unlocked] 'Tags': type: '[]string' required: false description: |- tags imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/global_achievements/admin_list_global_achievements_parameters.go' 'AdminListTagsParams@go.achievement.mod': id: 'AdminListTagsParams@go.achievement.mod' name: 'AdminListTagsParams' type: 'model' fields: 'Limit': type: 'int64' required: false description: |- the maximum number of data that may be returned (1...100) 'Name': type: 'string' required: false description: |- like's query by tag name 'Namespace': type: 'string' required: true description: |- namespace of the game 'Offset': type: 'int64' required: false description: |- offset 'SortBy': type: 'string' required: false description: |- sort by, default is 'name:asc', allow values: [name, name:asc, name:desc, createdAt, createdAt:asc, createdAt:desc] imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/tags' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/tags/admin_list_tags_parameters.go' 'AdminListUserAchievementsParams@go.achievement.mod': id: 'AdminListUserAchievementsParams@go.achievement.mod' name: 'AdminListUserAchievementsParams' type: 'model' fields: 'Limit': type: 'int64' required: false description: |- the maximum number of data that may be returned (1...100) 'Namespace': type: 'string' required: true description: |- namespace of the game 'Offset': type: 'int64' required: false description: |- offset 'PreferUnlocked': type: 'bool' required: false description: |- prefer to query achieved 'SortBy': type: 'string' required: false description: |- sort by, allow values: [achievedAt, achievedAt:asc, achievedAt:desc, createdAt, createdAt:asc, createdAt:desc] 'Tags': type: '[]string' required: false description: |- tags 'UserID': type: 'string' required: true description: |- user id imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/user_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/user_achievements/admin_list_user_achievements_parameters.go' 'AdminListUserContributionsParams@go.achievement.mod': id: 'AdminListUserContributionsParams@go.achievement.mod' name: 'AdminListUserContributionsParams' type: 'model' fields: 'AchievementCodes': type: 'string' required: false description: |- achievement codes. multiple value separated by comma 'Limit': type: 'int64' required: false description: |- the maximum number of data that may be returned (1...100) 'Namespace': type: 'string' required: true description: |- namespace of the game 'Offset': type: 'int64' required: false description: |- offset 'SortBy': type: 'string' required: false description: |- sort by, default is 'contributedValue:desc', allow values: [contributedValue, contributedValue:asc, contributedValue:desc] 'Tags': type: '[]string' required: false description: |- tags 'UserID': type: 'string' required: true description: |- user ID imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/global_achievements/admin_list_user_contributions_parameters.go' 'AdminResetAchievementParams@go.achievement.mod': id: 'AdminResetAchievementParams@go.achievement.mod' name: 'AdminResetAchievementParams' type: 'model' fields: 'AchievementCode': type: 'string' required: true description: |- achievement code 'Namespace': type: 'string' required: true description: |- namespace of the game 'UserID': type: 'string' required: true description: |- user id imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/user_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/user_achievements/admin_reset_achievement_parameters.go' 'AdminUnlockAchievementParams@go.achievement.mod': id: 'AdminUnlockAchievementParams@go.achievement.mod' name: 'AdminUnlockAchievementParams' type: 'model' fields: 'AchievementCode': type: 'string' required: true description: |- achievement code 'Namespace': type: 'string' required: true description: |- namespace of the game 'UserID': type: 'string' required: true description: |- user id imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/user_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/user_achievements/admin_unlock_achievement_parameters.go' 'AdminUpdateAchievementParams@go.achievement.mod': id: 'AdminUpdateAchievementParams@go.achievement.mod' name: 'AdminUpdateAchievementParams' type: 'model' fields: 'AchievementCode': type: 'string' required: true description: |- achievement code 'Body': type: '*ModelsAchievementUpdateRequest' required: true 'Namespace': type: 'string' required: true description: |- namespace of the game imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/achievements/admin_update_achievement_parameters.go' 'AdminUpdateAchievementListOrderParams@go.achievement.mod': id: 'AdminUpdateAchievementListOrderParams@go.achievement.mod' name: 'AdminUpdateAchievementListOrderParams' type: 'model' fields: 'AchievementCode': type: 'string' required: true description: |- achievement code 'Body': type: '*ModelsAchievementOrderUpdateRequest' required: true 'Namespace': type: 'string' required: true description: |- namespace of the game imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/achievements/admin_update_achievement_list_order_parameters.go' 'BulkCreatePSNEventParams@go.achievement.mod': id: 'BulkCreatePSNEventParams@go.achievement.mod' name: 'BulkCreatePSNEventParams' type: 'model' fields: 'Body': type: '*ModelsBulkCreatePSNEvents' required: true 'Namespace': type: 'string' required: true description: |- namespace of the game imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/platform_achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/platform_achievement/bulk_create_p_s_n_event_parameters.go' 'ClaimGlobalAchievementRewardParams@go.achievement.mod': id: 'ClaimGlobalAchievementRewardParams@go.achievement.mod' name: 'ClaimGlobalAchievementRewardParams' type: 'model' fields: 'AchievementCode': type: 'string' required: true description: |- achievement code 'Namespace': type: 'string' required: true description: |- namespace of the game 'UserID': type: 'string' required: true description: |- user ID imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/global_achievements/claim_global_achievement_reward_parameters.go' 'ExportAchievementsParams@go.achievement.mod': id: 'ExportAchievementsParams@go.achievement.mod' name: 'ExportAchievementsParams' type: 'model' fields: 'Namespace': type: 'string' required: true description: |- namespace of the game 'Tags': type: '[]string' required: false description: |- tags imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/achievements/export_achievements_parameters.go' 'ImportAchievementsParams@go.achievement.mod': id: 'ImportAchievementsParams@go.achievement.mod' name: 'ImportAchievementsParams' type: 'model' fields: 'File': type: '[]byte' required: false description: |- file to be imported 'Namespace': type: 'string' required: true description: |- namespace of the game 'Strategy': type: 'string' required: false description: |- strategy for import imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/achievements/import_achievements_parameters.go' 'ListGlobalAchievementContributorsParams@go.achievement.mod': id: 'ListGlobalAchievementContributorsParams@go.achievement.mod' name: 'ListGlobalAchievementContributorsParams' type: 'model' fields: 'AchievementCode': type: 'string' required: true description: |- achievement code 'Limit': type: 'int64' required: false description: |- the maximum number of data that may be returned (1...100) 'Namespace': type: 'string' required: true description: |- namespace of the game 'Offset': type: 'int64' required: false description: |- offset 'SortBy': type: 'string' required: false description: |- sort by, default is 'contributedValue:desc', allow values: [contributedValue, contributedValue:asc, contributedValue:desc] imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/global_achievements/list_global_achievement_contributors_parameters.go' 'ListUserContributionsParams@go.achievement.mod': id: 'ListUserContributionsParams@go.achievement.mod' name: 'ListUserContributionsParams' type: 'model' fields: 'AchievementCodes': type: 'string' required: false description: |- achievement codes. multiple value separated by comma 'Limit': type: 'int64' required: false description: |- the maximum number of data that may be returned (1...100) 'Namespace': type: 'string' required: true description: |- namespace of the game 'Offset': type: 'int64' required: false description: |- offset 'SortBy': type: 'string' required: false description: |- sort by, default is 'contributedValue:desc', allow values: [contributedValue, contributedValue:asc, contributedValue:desc] 'Tags': type: '[]string' required: false description: |- tags 'UserID': type: 'string' required: true description: |- user ID imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/global_achievements/list_user_contributions_parameters.go' 'PublicBulkUnlockAchievementParams@go.achievement.mod': id: 'PublicBulkUnlockAchievementParams@go.achievement.mod' name: 'PublicBulkUnlockAchievementParams' type: 'model' fields: 'Body': type: '*ModelsBulkUnlockAchievementRequest' required: true 'Namespace': type: 'string' required: true description: |- namespace of the game 'UserID': type: 'string' required: true description: |- user id imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/user_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/user_achievements/public_bulk_unlock_achievement_parameters.go' 'PublicGetAchievementParams@go.achievement.mod': id: 'PublicGetAchievementParams@go.achievement.mod' name: 'PublicGetAchievementParams' type: 'model' fields: 'AchievementCode': type: 'string' required: true description: |- achievement code 'Language': type: 'string' required: true description: |- language, if the selected language not exist in achievement,it use default language 'Namespace': type: 'string' required: true description: |- namespace of the game imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/achievements/public_get_achievement_parameters.go' 'PublicListAchievementsParams@go.achievement.mod': id: 'PublicListAchievementsParams@go.achievement.mod' name: 'PublicListAchievementsParams' type: 'model' fields: 'Global': type: 'bool' required: false description: |- filter by global achievement flag 'Language': type: 'string' required: true description: |- language, if the selected language not exist in achievement,it use default language 'Limit': type: 'int64' required: false description: |- the maximum number of data that may be returned (1...100) 'Namespace': type: 'string' required: true description: |- namespace of the game 'Offset': type: 'int64' required: false description: |- offset 'SortBy': type: 'string' required: false description: |- sort by, default is 'listOrder:asc', allow values: [listOrder, listOrder:asc, listOrder:desc, createdAt, createdAt:asc, createdAt:desc, updatedAt, updatedAt:asc, updatedAt:desc] 'Tags': type: '[]string' required: false description: |- tags imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/achievements/public_list_achievements_parameters.go' 'PublicListGlobalAchievementsParams@go.achievement.mod': id: 'PublicListGlobalAchievementsParams@go.achievement.mod' name: 'PublicListGlobalAchievementsParams' type: 'model' fields: 'AchievementCodes': type: 'string' required: false description: |- filter by achievement codes. multiple value separated by comma 'Limit': type: 'int64' required: false description: |- the maximum number of data that may be returned (1...100) 'Namespace': type: 'string' required: true description: |- namespace of the game 'Offset': type: 'int64' required: false description: |- offset 'SortBy': type: 'string' required: false description: |- sort by, allow values: [achievedAt, achievedAt:asc, achievedAt:desc, createdAt, createdAt:asc, createdAt:desc] 'Status': type: 'string' required: false description: |- filter by status. available value: [in_progress, unlocked] 'Tags': type: '[]string' required: false description: |- tags imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/global_achievements/public_list_global_achievements_parameters.go' 'PublicListTagsParams@go.achievement.mod': id: 'PublicListTagsParams@go.achievement.mod' name: 'PublicListTagsParams' type: 'model' fields: 'Limit': type: 'int64' required: false description: |- the maximum number of data that may be returned (1...100) 'Name': type: 'string' required: false description: |- like's query by tag name 'Namespace': type: 'string' required: true description: |- namespace of the game 'Offset': type: 'int64' required: false description: |- offset 'SortBy': type: 'string' required: false description: |- sort by, default is 'name:asc', allow values: [name, name:asc, name:desc, createdAt, createdAt:asc, createdAt:desc] imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/tags' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/tags/public_list_tags_parameters.go' 'PublicListUserAchievementsParams@go.achievement.mod': id: 'PublicListUserAchievementsParams@go.achievement.mod' name: 'PublicListUserAchievementsParams' type: 'model' fields: 'Limit': type: 'int64' required: false description: |- the maximum number of data that may be returned (1...100) 'Namespace': type: 'string' required: true description: |- namespace of the game 'Offset': type: 'int64' required: false description: |- offset 'PreferUnlocked': type: 'bool' required: false description: |- prefer to query achieved 'SortBy': type: 'string' required: false description: |- sort by, allow values: [achievedAt, achievedAt:asc, achievedAt:desc, createdAt, createdAt:asc, createdAt:desc] 'Tags': type: '[]string' required: false description: |- tags 'UserID': type: 'string' required: true description: |- user id imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/user_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/user_achievements/public_list_user_achievements_parameters.go' 'PublicUnlockAchievementParams@go.achievement.mod': id: 'PublicUnlockAchievementParams@go.achievement.mod' name: 'PublicUnlockAchievementParams' type: 'model' fields: 'AchievementCode': type: 'string' required: true description: |- achievement code 'Namespace': type: 'string' required: true description: |- namespace of the game 'UserID': type: 'string' required: true description: |- user id imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/user_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/user_achievements/public_unlock_achievement_parameters.go' 'ResetGlobalAchievementParams@go.achievement.mod': id: 'ResetGlobalAchievementParams@go.achievement.mod' name: 'ResetGlobalAchievementParams' type: 'model' fields: 'AchievementCode': type: 'string' required: true description: |- achievement code 'Namespace': type: 'string' required: true description: |- namespace of the game imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclient/global_achievements/reset_global_achievement_parameters.go' # endregion params # region models 'ModelsAchievementOrderUpdateRequest@go.achievement.mod': id: 'ModelsAchievementOrderUpdateRequest@go.achievement.mod' name: 'ModelsAchievementOrderUpdateRequest' type: 'model' fields: 'TargetOrder': type: 'int32' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_achievement_order_update_request.go' 'ModelsAchievementRequest@go.achievement.mod': id: 'ModelsAchievementRequest@go.achievement.mod' name: 'ModelsAchievementRequest' type: 'model' fields: 'AchievementCode': type: 'string' required: true 'CustomAttributes': type: 'interface{}' required: false 'DefaultLanguage': type: 'string' required: true 'Description': type: 'map[string]string' required: true 'Global': type: 'bool' required: false 'GoalValue': type: 'float64' required: true 'Hidden': type: 'bool' required: true 'Incremental': type: 'bool' required: true 'LockedIcons': type: '[]*ModelsIcon' required: true 'Name': type: 'map[string]string' required: true 'StatCode': type: 'string' required: true 'Tags': type: '[]string' required: true 'UnlockedIcons': type: '[]*ModelsIcon' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_achievement_request.go' 'ModelsAchievementResponse@go.achievement.mod': id: 'ModelsAchievementResponse@go.achievement.mod' name: 'ModelsAchievementResponse' type: 'model' fields: 'AchievementCode': type: 'string' required: true 'CreatedAt': type: 'strfmt.DateTime' required: true 'CustomAttributes': type: 'interface{}' required: false 'DefaultLanguage': type: 'string' required: true 'Description': type: 'map[string]string' required: true 'Global': type: 'bool' required: true 'GoalValue': type: 'float64' required: false 'Hidden': type: 'bool' required: true 'Incremental': type: 'bool' required: true 'ListOrder': type: 'int32' required: true 'LockedIcons': type: '[]*ModelsIcon' required: true 'Name': type: 'map[string]string' required: true 'Namespace': type: 'string' required: true 'StatCode': type: 'string' required: false 'Status': type: 'string' required: false description: |- Achievement progression status: [INIT, TIED] 'Tags': type: '[]string' required: true 'UnlockedIcons': type: '[]*ModelsIcon' required: true 'UpdatedAt': type: 'strfmt.DateTime' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_achievement_response.go' 'ModelsAchievementUpdateRequest@go.achievement.mod': id: 'ModelsAchievementUpdateRequest@go.achievement.mod' name: 'ModelsAchievementUpdateRequest' type: 'model' fields: 'CustomAttributes': type: 'interface{}' required: false 'DefaultLanguage': type: 'string' required: true 'Description': type: 'map[string]string' required: true 'Global': type: 'bool' required: false 'GoalValue': type: 'float64' required: true 'Hidden': type: 'bool' required: true 'Incremental': type: 'bool' required: true 'LockedIcons': type: '[]*ModelsIcon' required: true 'Name': type: 'map[string]string' required: true 'StatCode': type: 'string' required: true 'Tags': type: '[]string' required: true 'UnlockedIcons': type: '[]*ModelsIcon' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_achievement_update_request.go' 'ModelsAdditionalInfo@go.achievement.mod': id: 'ModelsAdditionalInfo@go.achievement.mod' name: 'ModelsAdditionalInfo' type: 'model' fields: 'NumberOfAchievements': type: 'int64' required: true 'NumberOfHiddenAchievements': type: 'int64' required: true 'NumberOfVisibleAchievements': type: 'int64' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_additional_info.go' 'ModelsBulkCreatePSNEventResponse@go.achievement.mod': id: 'ModelsBulkCreatePSNEventResponse@go.achievement.mod' name: 'ModelsBulkCreatePSNEventResponse' type: 'model' fields: 'Data': type: '[]*ModelsPSNEventResult' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_bulk_create_p_s_n_event_response.go' 'ModelsBulkCreatePSNEvents@go.achievement.mod': id: 'ModelsBulkCreatePSNEvents@go.achievement.mod' name: 'ModelsBulkCreatePSNEvents' type: 'model' fields: 'Data': type: '[]*ModelsCreatePSNEvent' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_bulk_create_p_s_n_events.go' 'ModelsBulkUnlockAchievementRequest@go.achievement.mod': id: 'ModelsBulkUnlockAchievementRequest@go.achievement.mod' name: 'ModelsBulkUnlockAchievementRequest' type: 'model' fields: 'AchievementCodes': type: '[]string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_bulk_unlock_achievement_request.go' 'ModelsBulkUnlockAchievementResponse@go.achievement.mod': id: 'ModelsBulkUnlockAchievementResponse@go.achievement.mod' name: 'ModelsBulkUnlockAchievementResponse' type: 'model' fields: 'AchievementCode': type: 'string' required: true 'ErrorDetail': type: '*ModelsErrorDetails' required: false 'Success': type: 'bool' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_bulk_unlock_achievement_response.go' 'ModelsContributorResponse@go.achievement.mod': id: 'ModelsContributorResponse@go.achievement.mod' name: 'ModelsContributorResponse' type: 'model' fields: 'AchievementCode': type: 'string' required: true 'ContributedValue': type: 'float64' required: true 'CreatedAt': type: 'strfmt.DateTime' required: true 'ID': type: 'string' required: true 'Namespace': type: 'string' required: true 'UpdatedAt': type: '*strfmt.DateTime' required: false 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_contributor_response.go' 'ModelsCreatePSNEvent@go.achievement.mod': id: 'ModelsCreatePSNEvent@go.achievement.mod' name: 'ModelsCreatePSNEvent' type: 'model' fields: 'Events': type: '[]*ModelsPSNEvent' required: true 'ThirdPartyUserID': type: 'string' required: true 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_create_p_s_n_event.go' 'ModelsErrorDetails@go.achievement.mod': id: 'ModelsErrorDetails@go.achievement.mod' name: 'ModelsErrorDetails' type: 'model' fields: 'ErrorCode': type: 'int32' required: true 'ErrorMessage': type: 'string' required: true 'ThirdPartyReferenceID': type: 'string' required: false imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_error_details.go' 'ModelsGlobalAchievementResponse@go.achievement.mod': id: 'ModelsGlobalAchievementResponse@go.achievement.mod' name: 'ModelsGlobalAchievementResponse' type: 'model' fields: 'AchievedAt': type: '*strfmt.DateTime' required: false 'AchievementCode': type: 'string' required: true 'CreatedAt': type: 'strfmt.DateTime' required: true 'ID': type: 'string' required: true 'LatestValue': type: 'float64' required: true 'Name': type: 'map[string]string' required: true 'Namespace': type: 'string' required: true 'Status': type: 'int32' required: true 'UpdatedAt': type: '*strfmt.DateTime' required: false imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_global_achievement_response.go' 'ModelsIcon@go.achievement.mod': id: 'ModelsIcon@go.achievement.mod' name: 'ModelsIcon' type: 'model' fields: 'Slug': type: 'string' required: true 'URL': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_icon.go' 'ModelsPaginatedAchievementResponse@go.achievement.mod': id: 'ModelsPaginatedAchievementResponse@go.achievement.mod' name: 'ModelsPaginatedAchievementResponse' type: 'model' fields: 'Data': type: '[]*ModelsAchievementResponse' required: true 'Paging': type: '*ModelsPagination' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_paginated_achievement_response.go' 'ModelsPaginatedContributorResponse@go.achievement.mod': id: 'ModelsPaginatedContributorResponse@go.achievement.mod' name: 'ModelsPaginatedContributorResponse' type: 'model' fields: 'Data': type: '[]*ModelsContributorResponse' required: true 'Paging': type: '*ModelsPagination' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_paginated_contributor_response.go' 'ModelsPaginatedGlobalAchievementResponse@go.achievement.mod': id: 'ModelsPaginatedGlobalAchievementResponse@go.achievement.mod' name: 'ModelsPaginatedGlobalAchievementResponse' type: 'model' fields: 'Data': type: '[]*ModelsGlobalAchievementResponse' required: true 'Paging': type: '*ModelsPagination' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_paginated_global_achievement_response.go' 'ModelsPaginatedTagResponse@go.achievement.mod': id: 'ModelsPaginatedTagResponse@go.achievement.mod' name: 'ModelsPaginatedTagResponse' type: 'model' fields: 'Data': type: '[]*ModelsTagResponse' required: true 'Paging': type: '*ModelsPagination' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_paginated_tag_response.go' 'ModelsPaginatedUserAchievementResponse@go.achievement.mod': id: 'ModelsPaginatedUserAchievementResponse@go.achievement.mod' name: 'ModelsPaginatedUserAchievementResponse' type: 'model' fields: 'CountInfo': type: '*ModelsAdditionalInfo' required: true 'Data': type: '[]*ModelsUserAchievementResponse' required: true 'Paging': type: '*ModelsPagination' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_paginated_user_achievement_response.go' 'ModelsPaginatedUserContributionResponse@go.achievement.mod': id: 'ModelsPaginatedUserContributionResponse@go.achievement.mod' name: 'ModelsPaginatedUserContributionResponse' type: 'model' fields: 'Data': type: '[]*ModelsUserContributionResponse' required: true 'Paging': type: '*ModelsPagination' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_paginated_user_contribution_response.go' 'ModelsPagination@go.achievement.mod': id: 'ModelsPagination@go.achievement.mod' name: 'ModelsPagination' type: 'model' fields: 'Next': type: 'string' required: true 'Previous': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_pagination.go' 'ModelsPSNEvent@go.achievement.mod': id: 'ModelsPSNEvent@go.achievement.mod' name: 'ModelsPSNEvent' type: 'model' fields: 'DateTime': type: 'string' required: true 'EventData': type: '*ModelsPSNEventData' required: true 'EventID': type: 'string' required: true 'Version': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_p_s_n_event.go' 'ModelsPSNEventData@go.achievement.mod': id: 'ModelsPSNEventData@go.achievement.mod' name: 'ModelsPSNEventData' type: 'model' fields: 'EventName': type: 'string' required: true 'Properties': type: 'interface{}' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_p_s_n_event_data.go' 'ModelsPSNEventResult@go.achievement.mod': id: 'ModelsPSNEventResult@go.achievement.mod' name: 'ModelsPSNEventResult' type: 'model' fields: 'ErrorDetail': type: '*ModelsErrorDetails' required: false 'IsSuccess': type: 'bool' required: true 'ThirdPartyUserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_p_s_n_event_result.go' 'ModelsPublicAchievementResponse@go.achievement.mod': id: 'ModelsPublicAchievementResponse@go.achievement.mod' name: 'ModelsPublicAchievementResponse' type: 'model' fields: 'AchievementCode': type: 'string' required: true 'CreatedAt': type: 'strfmt.DateTime' required: true 'CustomAttributes': type: 'interface{}' required: false 'Description': type: 'string' required: true 'Global': type: 'bool' required: true 'GoalValue': type: 'float64' required: false 'Hidden': type: 'bool' required: true 'Incremental': type: 'bool' required: true 'ListOrder': type: 'int32' required: true 'LockedIcons': type: '[]*ModelsIcon' required: true 'Name': type: 'string' required: true 'Namespace': type: 'string' required: true 'StatCode': type: 'string' required: false 'Status': type: 'string' required: false description: |- Achievement progression status: [INIT, TIED] 'Tags': type: '[]string' required: true 'UnlockedIcons': type: '[]*ModelsIcon' required: true 'UpdatedAt': type: 'strfmt.DateTime' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_public_achievement_response.go' 'ModelsPublicAchievementsResponse@go.achievement.mod': id: 'ModelsPublicAchievementsResponse@go.achievement.mod' name: 'ModelsPublicAchievementsResponse' type: 'model' fields: 'Data': type: '[]*ModelsPublicAchievementResponse' required: true 'Paging': type: '*ModelsPagination' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_public_achievements_response.go' 'ModelsTagResponse@go.achievement.mod': id: 'ModelsTagResponse@go.achievement.mod' name: 'ModelsTagResponse' type: 'model' fields: 'CreatedAt': type: 'strfmt.DateTime' required: true 'Name': type: 'string' required: true 'Namespace': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_tag_response.go' 'ModelsUserAchievementResponse@go.achievement.mod': id: 'ModelsUserAchievementResponse@go.achievement.mod' name: 'ModelsUserAchievementResponse' type: 'model' fields: 'AchievedAt': type: 'strfmt.DateTime' required: true 'AchievementCode': type: 'string' required: true 'ID': type: 'string' required: true 'LatestValue': type: 'float64' required: true 'Name': type: 'map[string]string' required: true 'Status': type: 'int32' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_user_achievement_response.go' 'ModelsUserContributionResponse@go.achievement.mod': id: 'ModelsUserContributionResponse@go.achievement.mod' name: 'ModelsUserContributionResponse' type: 'model' fields: 'AchievementCode': type: 'string' required: true 'CanClaimReward': type: 'bool' required: true description: |- CanClaimReward is a flag whether the user can claim the reward of not 'ContributedValue': type: 'float64' required: true 'ID': type: 'string' required: true 'Name': type: 'map[string]string' required: true description: |- Name is achievement name 'Namespace': type: 'string' required: true 'UserID': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/models_user_contribution_response.go' 'ResponseError@go.achievement.mod': id: 'ResponseError@go.achievement.mod' name: 'ResponseError' type: 'model' fields: 'ErrorCode': type: 'int32' required: true 'ErrorMessage': type: 'string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/response_error.go' 'ServiceImportConfigResponse@go.achievement.mod': id: 'ServiceImportConfigResponse@go.achievement.mod' name: 'ServiceImportConfigResponse' type: 'model' fields: 'FailedConfigs': type: '[]string' required: true 'IgnoredConfigs': type: '[]string' required: true 'NewConfigs': type: '[]string' required: true 'ReplacedConfigs': type: '[]string' required: true imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/achievement-sdk/pkg/achievementclientmodels/service_import_config_response.go' # endregion models # region functions 'AdminAnonymizeUserAchievementShort@go.achievement.fun': id: 'AdminAnonymizeUserAchievementShort@go.achievement.fun' name: 'AdminAnonymizeUserAchievementShort' type: 'function' description: |- This API will delete specified user achievement Required permission `ADMIN:NAMESPACE:{namespace}:USER:{userId}:ANONYMIZATION [DELETE]` struct: 'AnonymizationService' arguments: params: type: '*anonymization.AdminAnonymizeUserAchievementParams' required: true return_type: 'error' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/anonymization' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/anonymization.go' example: |- anonymizationService := achievement.AnonymizationService{ ... } params := anonymization.AdminAnonymizeUserAchievementParams{ ... } res, err := anonymizationService.AdminAnonymizeUserAchievementShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'admin' - 'anonymization' - 'anonymize' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ANONYMIZATION [DELETE]' 'AdminBulkUnlockAchievementShort@go.achievement.fun': id: 'AdminBulkUnlockAchievementShort@go.achievement.fun' name: 'AdminBulkUnlockAchievementShort' type: 'function' description: |- Required permission `ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social` struct: 'UserAchievementsService' arguments: params: type: '*user_achievements.AdminBulkUnlockAchievementParams' required: true return_type: '(*user_achievements.AdminBulkUnlockAchievementResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/user_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/userAchievements.go' example: |- userAchievementsService := achievement.UserAchievementsService{ ... } params := user_achievements.AdminBulkUnlockAchievementParams{ ... } res, err := userAchievementsService.AdminBulkUnlockAchievementShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'admin' - 'bulk' - 'unlock' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]' scopes: - 'social' 'AdminCreateNewAchievementShort@go.achievement.fun': id: 'AdminCreateNewAchievementShort@go.achievement.fun' name: 'AdminCreateNewAchievementShort' type: 'function' description: |- Required permission `ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [CREATE]` and scope `social` Other detail info: - achievementCode: Human readable unique code to indentify the achievement. Must be lowercase and maximum length is 32 - incremental: If the achievement is not incremental, it does not need to store a goal value of a stat to be unlocked. If the achievement is incremental, it needs to set statCode and goalValue - statCode: Selected statistic code, from the published statistic code event.Human readable unique code to indentify the achievement. Must be lowercase and maximum length is 32 - goalValue: Statistics value required to unlock the achievement. - defaultLanguage: localozation for achievement name and achievement description. Allowed format : en, en-US - slug: specify the image they want to use, it can be file image name or something to define the achievement icon. struct: 'AchievementsService' arguments: params: type: '*achievements.AdminCreateNewAchievementParams' required: true return_type: '(*achievements.AdminCreateNewAchievementResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/achievements.go' example: |- achievementsService := achievement.AchievementsService{ ... } params := achievements.AdminCreateNewAchievementParams{ ... } res, err := achievementsService.AdminCreateNewAchievementShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'admin' - 'create' - 'new' permissions: - 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [CREATE]' scopes: - 'social' 'AdminDeleteAchievementShort@go.achievement.fun': id: 'AdminDeleteAchievementShort@go.achievement.fun' name: 'AdminDeleteAchievementShort' type: 'function' description: |- Required permission `ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [DELETE]` and scope `social` struct: 'AchievementsService' arguments: params: type: '*achievements.AdminDeleteAchievementParams' required: true return_type: 'error' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/achievements.go' example: |- achievementsService := achievement.AchievementsService{ ... } params := achievements.AdminDeleteAchievementParams{ ... } res, err := achievementsService.AdminDeleteAchievementShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'admin' - 'delete' permissions: - 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [DELETE]' scopes: - 'social' 'AdminGetAchievementShort@go.achievement.fun': id: 'AdminGetAchievementShort@go.achievement.fun' name: 'AdminGetAchievementShort' type: 'function' description: |- Required permission `ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social` struct: 'AchievementsService' arguments: params: type: '*achievements.AdminGetAchievementParams' required: true return_type: '(*achievements.AdminGetAchievementResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/achievements.go' example: |- achievementsService := achievement.AchievementsService{ ... } params := achievements.AdminGetAchievementParams{ ... } res, err := achievementsService.AdminGetAchievementShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'admin' - 'get' permissions: - 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]' scopes: - 'social' 'AdminListAchievementsShort@go.achievement.fun': id: 'AdminListAchievementsShort@go.achievement.fun' name: 'AdminListAchievementsShort' type: 'function' description: |- Required permission `ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social` struct: 'AchievementsService' arguments: params: type: '*achievements.AdminListAchievementsParams' required: true return_type: '(*achievements.AdminListAchievementsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/achievements.go' example: |- achievementsService := achievement.AchievementsService{ ... } params := achievements.AdminListAchievementsParams{ ... } res, err := achievementsService.AdminListAchievementsShort(params) if err != nil { // handleError(err) } tags: - 'achievements' - 'admin' - 'list' permissions: - 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]' scopes: - 'social' 'AdminListGlobalAchievementContributorsShort@go.achievement.fun': id: 'AdminListGlobalAchievementContributorsShort@go.achievement.fun' name: 'AdminListGlobalAchievementContributorsShort' type: 'function' description: |- Required permission `ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social` struct: 'GlobalAchievementsService' arguments: params: type: '*global_achievements.AdminListGlobalAchievementContributorsParams' required: true return_type: '(*global_achievements.AdminListGlobalAchievementContributorsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/globalAchievements.go' example: |- globalAchievementsService := achievement.GlobalAchievementsService{ ... } params := global_achievements.AdminListGlobalAchievementContributorsParams{ ... } res, err := globalAchievementsService.AdminListGlobalAchievementContributorsShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'admin' - 'contributors' - 'global' - 'list' permissions: - 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]' scopes: - 'social' 'AdminListGlobalAchievementsShort@go.achievement.fun': id: 'AdminListGlobalAchievementsShort@go.achievement.fun' name: 'AdminListGlobalAchievementsShort' type: 'function' description: |- Required permission `ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social` Note: Global achievement status value mean: `status = 1 (in progress)` and `status = 2 (unlocked)` struct: 'GlobalAchievementsService' arguments: params: type: '*global_achievements.AdminListGlobalAchievementsParams' required: true return_type: '(*global_achievements.AdminListGlobalAchievementsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/globalAchievements.go' example: |- globalAchievementsService := achievement.GlobalAchievementsService{ ... } params := global_achievements.AdminListGlobalAchievementsParams{ ... } res, err := globalAchievementsService.AdminListGlobalAchievementsShort(params) if err != nil { // handleError(err) } tags: - 'achievements' - 'admin' - 'global' - 'list' permissions: - 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]' scopes: - 'social' 'AdminListTagsShort@go.achievement.fun': id: 'AdminListTagsShort@go.achievement.fun' name: 'AdminListTagsShort' type: 'function' description: |- Required permission `ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social` struct: 'TagsService' arguments: params: type: '*tags.AdminListTagsParams' required: true return_type: '(*tags.AdminListTagsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/tags' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/tags.go' example: |- tagsService := achievement.TagsService{ ... } params := tags.AdminListTagsParams{ ... } res, err := tagsService.AdminListTagsShort(params) if err != nil { // handleError(err) } tags: - 'admin' - 'list' - 'tags' permissions: - 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]' scopes: - 'social' 'AdminListUserAchievementsShort@go.achievement.fun': id: 'AdminListUserAchievementsShort@go.achievement.fun' name: 'AdminListUserAchievementsShort' type: 'function' description: |- Required permission `ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]` and scope `social` Note: User Achievement status value mean: `status = 1 (in progress)` and `status = 2 (unlocked)` `achievedAt` value will return default value: `0001-01-01T00:00:00Z` for user achievement that locked or in progress struct: 'UserAchievementsService' arguments: params: type: '*user_achievements.AdminListUserAchievementsParams' required: true return_type: '(*user_achievements.AdminListUserAchievementsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/user_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/userAchievements.go' example: |- userAchievementsService := achievement.UserAchievementsService{ ... } params := user_achievements.AdminListUserAchievementsParams{ ... } res, err := userAchievementsService.AdminListUserAchievementsShort(params) if err != nil { // handleError(err) } tags: - 'achievements' - 'admin' - 'list' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]' scopes: - 'social' 'AdminListUserContributionsShort@go.achievement.fun': id: 'AdminListUserContributionsShort@go.achievement.fun' name: 'AdminListUserContributionsShort' type: 'function' description: |- Required permission `ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]` and scope `social` struct: 'GlobalAchievementsService' arguments: params: type: '*global_achievements.AdminListUserContributionsParams' required: true return_type: '(*global_achievements.AdminListUserContributionsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/globalAchievements.go' example: |- globalAchievementsService := achievement.GlobalAchievementsService{ ... } params := global_achievements.AdminListUserContributionsParams{ ... } res, err := globalAchievementsService.AdminListUserContributionsShort(params) if err != nil { // handleError(err) } tags: - 'achievements' - 'admin' - 'contributions' - 'global' - 'list' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]' scopes: - 'social' 'AdminResetAchievementShort@go.achievement.fun': id: 'AdminResetAchievementShort@go.achievement.fun' name: 'AdminResetAchievementShort' type: 'function' description: |- [TEST FACILITY ONLY] Required permission `ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [DELETE]` and scope `social` struct: 'UserAchievementsService' arguments: params: type: '*user_achievements.AdminResetAchievementParams' required: true return_type: 'error' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/user_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/userAchievements.go' example: |- userAchievementsService := achievement.UserAchievementsService{ ... } params := user_achievements.AdminResetAchievementParams{ ... } res, err := userAchievementsService.AdminResetAchievementShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'admin' - 'reset' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [DELETE]' scopes: - 'social' 'AdminUnlockAchievementShort@go.achievement.fun': id: 'AdminUnlockAchievementShort@go.achievement.fun' name: 'AdminUnlockAchievementShort' type: 'function' description: |- Required permission `ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social` struct: 'UserAchievementsService' arguments: params: type: '*user_achievements.AdminUnlockAchievementParams' required: true return_type: 'error' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/user_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/userAchievements.go' example: |- userAchievementsService := achievement.UserAchievementsService{ ... } params := user_achievements.AdminUnlockAchievementParams{ ... } res, err := userAchievementsService.AdminUnlockAchievementShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'admin' - 'unlock' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]' scopes: - 'social' 'AdminUpdateAchievementShort@go.achievement.fun': id: 'AdminUpdateAchievementShort@go.achievement.fun' name: 'AdminUpdateAchievementShort' type: 'function' description: |- Required permission `ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]` and scope `social` struct: 'AchievementsService' arguments: params: type: '*achievements.AdminUpdateAchievementParams' required: true return_type: '(*achievements.AdminUpdateAchievementResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/achievements.go' example: |- achievementsService := achievement.AchievementsService{ ... } params := achievements.AdminUpdateAchievementParams{ ... } res, err := achievementsService.AdminUpdateAchievementShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'admin' - 'update' permissions: - 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]' scopes: - 'social' 'AdminUpdateAchievementListOrderShort@go.achievement.fun': id: 'AdminUpdateAchievementListOrderShort@go.achievement.fun' name: 'AdminUpdateAchievementListOrderShort' type: 'function' description: |- Required permission `ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]` and scope `social` struct: 'AchievementsService' arguments: params: type: '*achievements.AdminUpdateAchievementListOrderParams' required: true return_type: 'error' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/achievements.go' example: |- achievementsService := achievement.AchievementsService{ ... } params := achievements.AdminUpdateAchievementListOrderParams{ ... } res, err := achievementsService.AdminUpdateAchievementListOrderShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'admin' - 'list' - 'order' - 'update' permissions: - 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]' scopes: - 'social' 'BulkCreatePSNEventShort@go.achievement.fun': id: 'BulkCreatePSNEventShort@go.achievement.fun' name: 'BulkCreatePSNEventShort' type: 'function' description: |- Create PSN UDS events. Player need to login first using playstation token to IAM service. struct: 'PlatformAchievementService' arguments: params: type: '*platform_achievement.BulkCreatePSNEventParams' required: true return_type: '(*platform_achievement.BulkCreatePSNEventResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/platform_achievement' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/platformAchievement.go' example: |- platformAchievementService := achievement.PlatformAchievementService{ ... } params := platform_achievement.BulkCreatePSNEventParams{ ... } res, err := platformAchievementService.BulkCreatePSNEventShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'bulk' - 'create' - 'event' - 'platform' - 'psn' permissions: - 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT:PLATFORM [CREATE]' scopes: - 'social' 'ClaimGlobalAchievementRewardShort@go.achievement.fun': id: 'ClaimGlobalAchievementRewardShort@go.achievement.fun' name: 'ClaimGlobalAchievementRewardShort' type: 'function' description: |- Required permission `NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social` Note: Global achievement should be unlocked to claim the reward. Only contributor of global achievement are eligible for rewards struct: 'GlobalAchievementsService' arguments: params: type: '*global_achievements.ClaimGlobalAchievementRewardParams' required: true return_type: 'error' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/globalAchievements.go' example: |- globalAchievementsService := achievement.GlobalAchievementsService{ ... } params := global_achievements.ClaimGlobalAchievementRewardParams{ ... } res, err := globalAchievementsService.ClaimGlobalAchievementRewardShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'claim' - 'global' - 'reward' permissions: - 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]' scopes: - 'social' 'ExportAchievementsShort@go.achievement.fun': id: 'ExportAchievementsShort@go.achievement.fun' name: 'ExportAchievementsShort' type: 'function' description: |- Required permission `ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]` Required Scope: `social` Successful response header will contain: `content-disposition: attachment; filename=achievement__config.json` struct: 'AchievementsService' arguments: params: type: '*achievements.ExportAchievementsParams' required: true return_type: '(*achievements.ExportAchievementsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/achievements.go' example: |- achievementsService := achievement.AchievementsService{ ... } params := achievements.ExportAchievementsParams{ ... } res, err := achievementsService.ExportAchievementsShort(params) if err != nil { // handleError(err) } tags: - 'achievements' - 'export' permissions: - 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [READ]' scopes: - 'social' 'ImportAchievementsShort@go.achievement.fun': id: 'ImportAchievementsShort@go.achievement.fun' name: 'ImportAchievementsShort' type: 'function' description: |- Required permission ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE] Required Scope: social Import achievement configuration from file. It will merge with existing achievement. Available import strategy: - leaveOut: if achievement with same key exist, the existing will be used and imported one will be ignored (default) - replace: if achievement with same key exist, the imported achievement will be used and existing one will be removed struct: 'AchievementsService' arguments: params: type: '*achievements.ImportAchievementsParams' required: true return_type: '(*achievements.ImportAchievementsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/achievements.go' example: |- achievementsService := achievement.AchievementsService{ ... } params := achievements.ImportAchievementsParams{ ... } res, err := achievementsService.ImportAchievementsShort(params) if err != nil { // handleError(err) } tags: - 'achievements' - 'import' permissions: - 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [UPDATE]' scopes: - 'social' 'ListGlobalAchievementContributorsShort@go.achievement.fun': id: 'ListGlobalAchievementContributorsShort@go.achievement.fun' name: 'ListGlobalAchievementContributorsShort' type: 'function' description: |- Required permission `NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social` struct: 'GlobalAchievementsService' arguments: params: type: '*global_achievements.ListGlobalAchievementContributorsParams' required: true return_type: '(*global_achievements.ListGlobalAchievementContributorsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/globalAchievements.go' example: |- globalAchievementsService := achievement.GlobalAchievementsService{ ... } params := global_achievements.ListGlobalAchievementContributorsParams{ ... } res, err := globalAchievementsService.ListGlobalAchievementContributorsShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'contributors' - 'global' - 'list' permissions: - 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]' scopes: - 'social' 'ListUserContributionsShort@go.achievement.fun': id: 'ListUserContributionsShort@go.achievement.fun' name: 'ListUserContributionsShort' type: 'function' description: |- Required permission `NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]` and scope `social` struct: 'GlobalAchievementsService' arguments: params: type: '*global_achievements.ListUserContributionsParams' required: true return_type: '(*global_achievements.ListUserContributionsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/globalAchievements.go' example: |- globalAchievementsService := achievement.GlobalAchievementsService{ ... } params := global_achievements.ListUserContributionsParams{ ... } res, err := globalAchievementsService.ListUserContributionsShort(params) if err != nil { // handleError(err) } tags: - 'achievements' - 'contributions' - 'global' - 'list' - 'user' permissions: - 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]' scopes: - 'social' 'PublicBulkUnlockAchievementShort@go.achievement.fun': id: 'PublicBulkUnlockAchievementShort@go.achievement.fun' name: 'PublicBulkUnlockAchievementShort' type: 'function' description: |- Required permission `NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social` struct: 'UserAchievementsService' arguments: params: type: '*user_achievements.PublicBulkUnlockAchievementParams' required: true return_type: '(*user_achievements.PublicBulkUnlockAchievementResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/user_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/userAchievements.go' example: |- userAchievementsService := achievement.UserAchievementsService{ ... } params := user_achievements.PublicBulkUnlockAchievementParams{ ... } res, err := userAchievementsService.PublicBulkUnlockAchievementShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'bulk' - 'public' - 'unlock' - 'user' permissions: - 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]' scopes: - 'social' 'PublicGetAchievementShort@go.achievement.fun': id: 'PublicGetAchievementShort@go.achievement.fun' name: 'PublicGetAchievementShort' type: 'function' description: |- Required permission `NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social` struct: 'AchievementsService' arguments: params: type: '*achievements.PublicGetAchievementParams' required: true return_type: '(*achievements.PublicGetAchievementResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/achievements.go' example: |- achievementsService := achievement.AchievementsService{ ... } params := achievements.PublicGetAchievementParams{ ... } res, err := achievementsService.PublicGetAchievementShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'get' - 'public' permissions: - 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]' scopes: - 'social' 'PublicListAchievementsShort@go.achievement.fun': id: 'PublicListAchievementsShort@go.achievement.fun' name: 'PublicListAchievementsShort' type: 'function' description: |- Required permission `NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social` struct: 'AchievementsService' arguments: params: type: '*achievements.PublicListAchievementsParams' required: true return_type: '(*achievements.PublicListAchievementsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/achievements.go' example: |- achievementsService := achievement.AchievementsService{ ... } params := achievements.PublicListAchievementsParams{ ... } res, err := achievementsService.PublicListAchievementsShort(params) if err != nil { // handleError(err) } tags: - 'achievements' - 'list' - 'public' permissions: - 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]' scopes: - 'social' 'PublicListGlobalAchievementsShort@go.achievement.fun': id: 'PublicListGlobalAchievementsShort@go.achievement.fun' name: 'PublicListGlobalAchievementsShort' type: 'function' description: |- Required permission `NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social` Note: Global achievement status value mean: `status = 1 (in progress)` and `status = 2 (unlocked)` struct: 'GlobalAchievementsService' arguments: params: type: '*global_achievements.PublicListGlobalAchievementsParams' required: true return_type: '(*global_achievements.PublicListGlobalAchievementsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/globalAchievements.go' example: |- globalAchievementsService := achievement.GlobalAchievementsService{ ... } params := global_achievements.PublicListGlobalAchievementsParams{ ... } res, err := globalAchievementsService.PublicListGlobalAchievementsShort(params) if err != nil { // handleError(err) } tags: - 'achievements' - 'global' - 'list' - 'public' permissions: - 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]' scopes: - 'social' 'PublicListTagsShort@go.achievement.fun': id: 'PublicListTagsShort@go.achievement.fun' name: 'PublicListTagsShort' type: 'function' description: |- Required permission `NAMESPACE:{namespace}:ACHIEVEMENT [READ]` and scope `social` struct: 'TagsService' arguments: params: type: '*tags.PublicListTagsParams' required: true return_type: '(*tags.PublicListTagsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/tags' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/tags.go' example: |- tagsService := achievement.TagsService{ ... } params := tags.PublicListTagsParams{ ... } res, err := tagsService.PublicListTagsShort(params) if err != nil { // handleError(err) } tags: - 'list' - 'public' - 'tags' permissions: - 'NAMESPACE:{namespace}:ACHIEVEMENT [READ]' scopes: - 'social' 'PublicListUserAchievementsShort@go.achievement.fun': id: 'PublicListUserAchievementsShort@go.achievement.fun' name: 'PublicListUserAchievementsShort' type: 'function' description: |- Required permission `NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]` and scope `social` Note: User Achievement status value mean: `status = 1 (in progress)` and `status = 2 (unlocked)` `achievedAt` value will return default value: `0001-01-01T00:00:00Z` for user achievement that locked or in progress struct: 'UserAchievementsService' arguments: params: type: '*user_achievements.PublicListUserAchievementsParams' required: true return_type: '(*user_achievements.PublicListUserAchievementsResponse, error)' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/user_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/userAchievements.go' example: |- userAchievementsService := achievement.UserAchievementsService{ ... } params := user_achievements.PublicListUserAchievementsParams{ ... } res, err := userAchievementsService.PublicListUserAchievementsShort(params) if err != nil { // handleError(err) } tags: - 'achievements' - 'list' - 'public' - 'user' permissions: - 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [READ]' scopes: - 'social' 'PublicUnlockAchievementShort@go.achievement.fun': id: 'PublicUnlockAchievementShort@go.achievement.fun' name: 'PublicUnlockAchievementShort' type: 'function' description: |- Required permission `NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]` and scope `social` struct: 'UserAchievementsService' arguments: params: type: '*user_achievements.PublicUnlockAchievementParams' required: true return_type: 'error' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/user_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/userAchievements.go' example: |- userAchievementsService := achievement.UserAchievementsService{ ... } params := user_achievements.PublicUnlockAchievementParams{ ... } res, err := userAchievementsService.PublicUnlockAchievementShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'public' - 'unlock' - 'user' permissions: - 'NAMESPACE:{namespace}:USER:{userId}:ACHIEVEMENT [UPDATE]' scopes: - 'social' 'ResetGlobalAchievementShort@go.achievement.fun': id: 'ResetGlobalAchievementShort@go.achievement.fun' name: 'ResetGlobalAchievementShort' type: 'function' description: |- [TEST FACILITY ONLY] Required permission `ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [DELETE]` and scope `social` struct: 'GlobalAchievementsService' arguments: params: type: '*global_achievements.ResetGlobalAchievementParams' required: true return_type: 'error' imports: - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclientmodels' - 'github.com/AccelByte/accelbyte-go-sdk/achievement-sdk/pkg/achievementclient/global_achievements' - 'github.com/AccelByte/accelbyte-go-sdk/services-api/pkg/service/achievement' files: - 'https://github.com/AccelByte/accelbyte-go-sdk/blob/main/services-api/pkg/service/achievement/globalAchievements.go' example: |- globalAchievementsService := achievement.GlobalAchievementsService{ ... } params := global_achievements.ResetGlobalAchievementParams{ ... } res, err := globalAchievementsService.ResetGlobalAchievementShort(params) if err != nil { // handleError(err) } tags: - 'achievement' - 'achievements' - 'global' - 'reset' permissions: - 'ADMIN:NAMESPACE:{namespace}:ACHIEVEMENT [DELETE]' scopes: - 'social' # endregion functions