hiro.proto

// Copyright 2023 Heroic Labs & Contributors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

syntax = "proto3";

// The request and response objects for Hiro.
package hiro;

import "google/protobuf/descriptor.proto";

option go_package = "github.com/heroiclabs/hiro";

extend google.protobuf.EnumValueOptions {
  // The input proto message to the Nakama RPC.
  optional string input = 1000;
  // The output proto message of the Nakama RPC.
  optional string output = 1001;
}

enum RpcId {
  RPC_ID_UNSPECIFIED = 0;

  // List all inventory items defined in the codex.
  RPC_ID_INVENTORY_LIST = 1 [(input) = "InventoryListRequest", (output) = "InventoryList"];
  // List all inventory items owned by the player.
  RPC_ID_INVENTORY_LIST_INVENTORY = 2 [(input) = "InventoryListRequest", (output) = "InventoryList"];
  // Consume one or more inventory items owned by the player.
  RPC_ID_INVENTORY_CONSUME = 3 [(input) = "InventoryConsumeRequest", (output) = "InventoryConsumeRewards"];
  // Grant one or more inventory items to the player.
  RPC_ID_INVENTORY_GRANT = 4 [(input) = "InventoryGrantRequest", (output) = "InventoryUpdateAck"];
  // Update the properties on one or more inventory items owned by the player.
  RPC_ID_INVENTORY_UPDATE = 5 [(input) = "InventoryUpdateItemsRequest", (output) = "InventoryUpdateAck"];

  // Claim one or more rewards which are partially or full donated by other players.
  RPC_ID_ECONOMY_DONATION_CLAIM = 6 [(input) = "EconomyDonationClaimRequest", (output) = "EconomyDonationClaimRewards"];
  // Donate some resource (currencies, items, etc.) to a user by donation ID.
  RPC_ID_ECONOMY_DONATION_GIVE = 7 [(input) = "EconomyDonationGiveRequest", (output) = "EconomyUpdateAck"];
  // Get progress on one or more donations for a set of players by their IDs.
  RPC_ID_ECONOMY_DONATION_GET = 8 [(input) = "EconomyDonationGetRequest", (output) = "EconomyDonationsByUserList"];
  // Request a donation which other players can contribute into.
  RPC_ID_ECONOMY_DONATION_REQUEST = 9 [(input) = "EconomyDonationRequest", (output) = "EconomyDonationAck"];
  // Get all store items defined in the Virtual Store.
  RPC_ID_ECONOMY_STORE_GET = 10 [(input) = "EconomyListRequest", (output) = "EconomyList"];
  // Grant one or more currencies or reward modifiers to te player.
  RPC_ID_ECONOMY_GRANT = 11 [(input) = "EconomyGrantRequest", (output) = "EconomyUpdateAck"];
  // Send a marker of intent to purchase by the player.
  RPC_ID_ECONOMY_PURCHASE_INTENT = 12 [(input) = "EconomyPurchaseIntentRequest", (output) = ""];
  // Purchase a store item by the player.
  RPC_ID_ECONOMY_PURCHASE_ITEM = 13 [(input) = "EconomyPurchaseRequest", (output) = "EconomyPurchaseAck"];
  // Restore a set of purchases.
  RPC_ID_ECONOMY_PURCHASE_RESTORE = 59 [(input) = "EconomyPurchaseRestoreRequest", (output) = ""];
  // Get the current status on an Ad placement which may have been rewarded.
  RPC_ID_ECONOMY_PLACEMENT_STATUS = 14 [(input) = "EconomyPlacementStatusRequest", (output) = "EconomyPlacementStatus"];
  // Start a new Ad placement by placement ID.
  RPC_ID_ECONOMY_PLACEMENT_START = 15 [(input) = "EconomyPlacementStartRequest", (output) = "EconomyPlacementStatus"];

  // Claim one or more achievements which have completed their progress.
  RPC_ID_ACHIEVEMENTS_CLAIM = 16 [(input) = "AchievementsClaimRequest", (output) = "AchievementsUpdateAck"];
  // Get all achievements with progress accumulated by the player.
  RPC_ID_ACHIEVEMENTS_GET = 17 [(input) = "", (output) = "AchievementList"];
  // Update one or more achievements with the same progress amount.
  RPC_ID_ACHIEVEMENTS_UPDATE = 18 [(input) = "AchievementsUpdateRequest", (output) = "AchievementsUpdateAck"];

  // Get the energies and their current timers for the player.
  RPC_ID_ENERGY_GET = 19 [(input) = "", (output) = "EnergyList"];
  // Spend one or more energies for the player.
  RPC_ID_ENERGY_SPEND = 20 [(input) = "EnergySpendRequest", (output) = "EnergySpendReward"];

  // Get the tutorials and current progress step for the player.
  RPC_ID_TUTORIALS_GET = 21 [(input) = "", (output) = "TutorialList"];
  // Accept an offer to step through a tutorial.
  RPC_ID_TUTORIALS_ACCEPT = 22 [(input) = "TutorialAcceptRequest", (output) = "Tutorial"];
  // Decline an offer to start a tutorial.
  RPC_ID_TUTORIALS_DECLINE = 23 [(input) = "TutorialDeclineRequest", (output) = "Tutorial"];
  // Abandon progress on a tutorial.
  RPC_ID_TUTORIALS_ABANDON = 24 [(input) = "TutorialAbandonRequest", (output) = "Tutorial"];
  // Update the current progress step in the tutorial by ID.
  RPC_ID_TUTORIALS_UPDATE = 25 [(input) = "TutorialUpdateRequest", (output) = "TutorialList"];

  // Create a team which other players can join.
  RPC_ID_TEAMS_CREATE = 26 [(input) = "TeamCreateRequest", (output) = "Team"];
  // List one or more teams which the player can join.
  RPC_ID_TEAMS_LIST = 27 [(input) = "TeamListRequest", (output) = "TeamList"];
  // Search for a team by name or optional short code.
  RPC_ID_TEAMS_SEARCH = 28 [(input) = "TeamSearchRequest", (output) = "TeamList"];
  // Write a chat message to the Team's chat channel.
  RPC_ID_TEAMS_WRITE_CHAT_MESSAGE = 29 [(input) = "TeamWriteChatMessageRequest", (output) = "ChannelMessageAck"];

  // Create a random unlockable to assign to a slot (or overflow) unless there are no slots.
  RPC_ID_UNLOCKABLES_CREATE = 30 [(input) = "", (output) = "UnlockablesList"];
  // Get the unlockables which are currently in progress for the player.
  RPC_ID_UNLOCKABLES_GET = 31 [(input) = "", (output) = "UnlockablesList"];
  // Start the unlock timer for an unlockable in the specified slot.
  RPC_ID_UNLOCKABLES_UNLOCK_START = 32 [(input) = "UnlockablesRequest", (output) = "UnlockablesList"];
  // Purchase an unlockable with soft currency based on the remainder cost calculated by the offset left to wait.
  RPC_ID_UNLOCKABLES_PURCHASE_UNLOCK = 33 [(input) = "UnlockablesRequest", (output) = "UnlockablesList"];
  // Purchase a new slot to be used to store unlockables.
  RPC_ID_UNLOCKABLES_PURCHASE_SLOT = 34 [(input) = "", (output) = "UnlockablesList"];
  // Claim an unlockable whose start timer has completed or completion was fast tracked with a purchase.
  RPC_ID_UNLOCKABLES_CLAIM = 35 [(input) = "UnlockablesRequest", (output) = "UnlockablesReward"];

  // Send feedback to the game's developers over email.
  RPC_ID_BASE_RATE_APP = 36 [(input) = "RateAppRequest", (output) = ""];
  // Update or create the mobile push device tokens and preferences for the player.
  RPC_ID_BASE_SET_DEVICE_PREFS = 37 [(input) = "DevicePrefsRequest", (output) = ""];
  // Sync offline state.
  RPC_ID_BASE_SYNC = 58 [(input) = "SyncRequest", (output) = "SyncResponse"];

  // Get the leaderboards defined for the game.
  RPC_ID_LEADERBOARDS_CONFIG_GET = 38 [(input) = "", (output) = "LeaderboardConfigList"];

  // Get a specified event leaderboard defined for the game.
  RPC_ID_EVENT_LEADERBOARD_GET = 42 [(input) = "EventLeaderboardGet", (output) = "EventLeaderboard"];
  // Update an event leaderboard record for a user.
  RPC_ID_EVENT_LEADERBOARD_UPDATE = 43 [(input) = "EventLeaderboardUpdate", (output) = "EventLeaderboard"];
  // Claim an event leaderboard reward for a user.
  RPC_ID_EVENT_LEADERBOARD_CLAIM = 44 [(input) = "EventLeaderboardClaim", (output) = "EventLeaderboard"];
  // Roll a new cohort for the specified event leaderboard.
  RPC_ID_EVENT_LEADERBOARD_ROLL = 45 [(input) = "EventLeaderboardRoll", (output) = "EventLeaderboard"];

  // Get all stats.
  RPC_ID_STATS_GET = 46 [(input) = "", (output) = "StatList"];
  // Update private stats.
  RPC_ID_STATS_UPDATE = 47 [(input) = "StatUpdateRequest", (output) = "StatList"];

  // Get progressions.
  RPC_ID_PROGRESSIONS_GET = 48 [(input) = "ProgressionGetRequest", (output) = "ProgressionList"];
  // Purchase a progression for permanent unlock, if supported.
  RPC_ID_PROGRESSIONS_PURCHASE = 49 [(input) = "ProgressionPurchaseRequest", (output) = "ProgressionList"];
  // Update a progression to change its count, if supported.
  RPC_ID_PROGRESSIONS_UPDATE = 50 [(input) = "ProgressionUpdateRequest", (output) = "ProgressionList"];

  // List incentives set up by the user.
  RPC_ID_INCENTIVES_SENDER_LIST = 51 [(input) = "", (output) = "IncentiveList"];
  // Create a new incentive set up by the user.
  RPC_ID_INCENTIVES_SENDER_CREATE = 52 [(input) = "IncentiveSenderCreateRequest", (output) = "IncentiveList"];
  // Delete an existing incentive set up by the user.
  RPC_ID_INCENTIVES_SENDER_DELETE = 53 [(input) = "IncentiveSenderDeleteRequest", (output) = "IncentiveList"];
  // Claim rewards for an existing incentive after it has been used by some recipient(s).
  RPC_ID_INCENTIVES_SENDER_CLAIM = 54 [(input) = "IncentiveSenderClaimRequest", (output) = "IncentiveList"];
  // Get information about an existing incentive from a recipient's perspective.
  RPC_ID_INCENTIVES_RECIPIENT_GET = 55 [(input) = "IncentiveRecipientGetRequest", (output) = "IncentiveInfo"];
  // Claim an existing incentive and receive associated rewards.
  RPC_ID_INCENTIVES_RECIPIENT_CLAIM = 56 [(input) = "IncentiveRecipientClaimRequest", (output) = "IncentiveInfo"];

  // Reset progression progress.
  RPC_ID_PROGRESSIONS_RESET = 57 [(input) = "ProgressionResetRequest", (output) = "ProgressionList"];

  //--- Server to server RPCs ---//

  // Webhook RPC to handle Rewarded Video Ad placement success callbacks.
  RPC_ID_ECONOMY_PLACEMENT_SUCCESS = 1001;
  // Webhook RPC to handle Rewarded Video Ad placement failure callbacks.
  RPC_ID_ECONOMY_PLACEMENT_FAIL = 1002;
  // RPC to upload Hiro system configurations for the storage personalizer.
  RPC_ID_STORAGE_PERSONALIZER_UPLOAD = 1003;
}

// The cost(s) associated with permanently unlocking a progression.
message ProgressionCost {
  // The items which will be deducted.
  map<string, int64> items = 1;
  // The currencies which will be deducted.
  map<string, int64> currencies = 2;
}

// Preconditions associated with a progression.
message ProgressionPreconditions {
  // Counts required.
  map<string, int64> counts = 1;
  // Purchase cost paid.
  ProgressionCost cost = 2;
  // Other progressions.
  repeated string progressions = 3;
  // Achievements.
  repeated string achievements = 4;
  // Items with associated minimum counts.
  map<string, int64> items_min = 5;
  // Items with associated maximum counts.
  map<string, int64> items_max = 6;
  // Stats with associated minimum values.
  map<string, int64> stats_min = 7;
  // Stats with associated maximum values.
  map<string, int64> stats_max = 8;
  // Energies with associated minimum counts.
  map<string, int64> energy_min = 9;
  // Energies with associated maximum counts.
  map<string, int64> energy_max = 10;
  // Currencies with associated minimum counts.
  map<string, int64> currency_min = 11;
  // Currencies with associated maximum counts.
  map<string, int64> currency_max = 12;
}

enum ProgressionPreconditionsOperator {
  // Unspecified. Defaults to AND.
  PROGRESSION_PRECONDITIONS_OPERATOR_UNSPECIFIED = 0;
  // Both the direct preconditions and the nested block must be true.
  PROGRESSION_PRECONDITIONS_OPERATOR_AND = 1;
  // Either the direct preconditions or the nested block must be true.
  PROGRESSION_PRECONDITIONS_OPERATOR_OR = 2;
  // Either the direct preconditions or the nested block must be true, but not both.
  PROGRESSION_PRECONDITIONS_OPERATOR_XOR = 3;
  // The direct preconditions must be true, but the nested block must not be.
  PROGRESSION_PRECONDITIONS_OPERATOR_NOT = 4;
}

// A complex set of progression preconditions.
message ProgressionPreconditionsBlock {
  // Direct preconditions.
  ProgressionPreconditions direct = 1;
  // Operator for any nested block.
  ProgressionPreconditionsOperator operator = 2;
  // Nested block of preconditions, if any.
  ProgressionPreconditionsBlock nested = 3;
}

// A progression element which can be unlocked to access further progressions.
message Progression {
  // The ID of the progression.
  string id = 1;
  // The name of the progression. May be an i18n code.
  string name = 2;
  // A description of the progression. May be an i18n code.
  string description = 3;
  // The category to group the progression together with others.
  string category = 4;
  // Current count, if any.
  map<string, int64> counts = 5;
  // Additional metadata properties.
  map<string, string> additional_properties = 6;
  // Flag indicating unlock status.
  bool unlocked = 7;
  // All preconditions.
  ProgressionPreconditionsBlock preconditions = 8;
  // Unmet preconditions.
  ProgressionPreconditionsBlock unmet_preconditions = 9;
}

enum ProgressionDeltaState {
  // Unspecified. Defaults to UNCHANGED.
  PROGRESSION_DELTA_STATE_UNSPECIFIED = 0;
  // Progression unlock state has not changed.
  PROGRESSION_DELTA_STATE_UNCHANGED = 1;
  // Progression was locked, it is now unlocked.
  PROGRESSION_DELTA_STATE_UNLOCKED = 2;
  // Progression was unlocked, it is now locked.
  PROGRESSION_DELTA_STATE_LOCKED = 3;
}

// A change in a given progression, compared to a previously known state.
message ProgressionDelta {
  // The ID of the progression.
  string id = 1;
  // Potential state change.
  ProgressionDeltaState state = 2;
  // Changes to counts, if any.
  map<string, int64> counts = 3;
  // Changes to preconditions, if any.
  ProgressionPreconditionsBlock preconditions = 4;
}

// All or a filtered list of progressions for a user.
message ProgressionList {
  // Progressions keyed by progression ID.
  map<string, Progression> progressions = 1;
  // Progression deltas keyed by progression ID.
  map<string, ProgressionDelta> deltas = 2;
}

// Request progressions for a user, optionally including previously seen state for delta calculations.
message ProgressionGetRequest {
  // Optional last known progressions state, keyed by progression ID.
  map<string, Progression> progressions = 1;
}

// Request to permanently unlock a progression, if supported by that specific progression.
message ProgressionPurchaseRequest {
  // ID of the progression to permanently unlock.
  string id = 1;
}

// Request to update a progression, if supported by that specific progression.
message ProgressionUpdateRequest {
  // ID of the progression to update.
  string id = 1;
  // One or more counts to add to the progression.
  map<string, int64> counts = 2;
}

// Request to reset progression progress.
message ProgressionResetRequest {
  // The progression IDs to reset.
  repeated string ids = 1;
}

// Indicate how a stats update should be handled.
enum StatUpdateOperator {
  // Unspecified. Defaults to Set.
  STAT_UPDATE_OPERATOR_UNSPECIFIED = 0;
  // Set the given value, overwriting any previous one.
  STAT_UPDATE_OPERATOR_SET = 1;
  // Increment or decrement the existing value by the given amount. Equivalent to Set if no previous value existed.
  STAT_UPDATE_OPERATOR_DELTA = 2;
  // Use the new value if it's lower than the existing one. Equivalent to Set if no previous value existed.
  STAT_UPDATE_OPERATOR_MIN = 3;
  // Use the new value if it's higher than the existing one. Equivalent to Set if no previous value existed.
  STAT_UPDATE_OPERATOR_MAX = 4;
}

// Describes a single stat update.
message StatUpdate {
  // Name.
  string name = 1;
  // Value.
  int64 value = 2;
  // Operator.
  StatUpdateOperator operator = 3;
}

// Request an optionally batched stats update.
message StatUpdateRequest {
  // Public stat updates.
  repeated StatUpdate public = 1;
  // Private stat updates.
  repeated StatUpdate private = 2;
}

// A single stat with associated information.
message Stat {
  // Name.
  string name = 1;
  // Indicator if this belongs to public or private stats.
  bool public = 2;
  // Update time in UTC seconds.
  int64 update_time_sec = 3;
  // Current value.
  int64 value = 4;
  // Number of values submitted.
  int64 count = 5;
  // Total of all submitted values.
  int64 total = 6;
  // Smallest value submitted.
  int64 min = 7;
  // Largest value submitted.
  int64 max = 8;
  // First value submitted.
  int64 first = 9;
  // Latest value submitted.
  int64 last = 10;
}

// A list of stats all belonging to one user.
message StatList {
  // Public stat names and their associated data.
  map<string, Stat> public = 1;
  // Private stat names and their associated data.
  map<string, Stat> private = 2;
}

// A receipt reply from a channel message send operation.
message ChannelMessageAck {
  // The channel the message was sent to.
  string channel_id = 1;
  // The unique ID assigned to the message.
  string message_id = 2;
  // The code representing a message type or category.
  int32 code = 3;
  // Username of the message sender.
  string username = 4;
  // The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was created.
  int64 create_time = 5;
  // The UNIX time (for gRPC clients) or ISO string (for REST clients) when the message was last updated.
  int64 update_time = 6;
  // True if the message was persisted to the channel's history, false otherwise.
  bool persistent = 7;
  // The name of the chat room, or an empty string if this message was not sent through a chat room.
  string room_name = 8;
  // The ID of the group, or an empty string if this message was not sent through a group channel.
  string group_id = 9;
  // The ID of the first DM user, or an empty string if this message was not sent through a DM chat.
  string user_id_one = 10;
  // The ID of the second DM user, or an empty string if this message was not sent through a DM chat.
  string user_id_two = 11;
}

// Update or create the mobile push device tokens and preferences.
message DevicePrefsRequest {
  // The device ID to set.
  string device_id = 1;
  // The push token from the Android device. This or 'push_token_ios' must be set.
  string push_token_android = 2;
  // The push token from the iOS device. This or 'push_token_android' must be set.
  string push_token_ios = 3;
  // Additional device preferences for push events. Must be owned by the user.
  map<string, bool> preferences = 4;
}

// The store types supported by the Economy system.
enum EconomyStoreType {
  // Unspecified. Defaults to Apple.
  ECONOMY_STORE_TYPE_UNSPECIFIED = 0;
  // Apple App Store.
  ECONOMY_STORE_TYPE_APPLE_APPSTORE = 1;
  // Google Play.
  ECONOMY_STORE_TYPE_GOOGLE_PLAY = 2;
  // Facebook Instant games.
  ECONOMY_STORE_TYPE_FBINSTANT = 3;
}

// Inventory item granted.
message RewardInventoryItem {
  // The ID of the item.
  string id = 1;
  // The count granted of the item.
  int64 count = 2;
  // The properties with string values.
  map<string, string> string_properties = 3;
  // The properties with numeric values.
  map<string, double> numeric_properties = 4;
  // The instance ID of the item.
  string instance_id = 5;
}

// Energy modifier granted.
message RewardEnergyModifier {
  // The ID of they modifier granted.
  string id = 1;
  // The energy modifier operator.
  string operator = 2;
  // The value to apply. Its behavior depends on the operator.
  int64 value = 3;
  // The duration of the energy modifier in seconds.
  uint64 duration_sec = 4;
  // The weight of the energy modifier, if weighted. Otherwise, -1.
  int64 weight = 5;
}

// A reward modifier temporally adjusts the way all rewards are handled in the economy.
message RewardModifier {
  // The ID of the reward content to modify.
  string id = 1;
  // The type of reward content to modify.
  string type = 2;
  // The operator to apply.
  string operator = 3;
  // The value to apply. Its behavior depends on the operator.
  int64 value = 4;
  // The duration of the item modifier in seconds.
  uint64 duration_sec = 5;
}

// Rewards granted to the player.
message Reward {
  // The items granted. Indexed by item ID.
  map<string, int64> items = 1;
  // The currencies granted.
  map<string, int64> currencies = 2;
  // The energy granted.
  map<string, int32> energies = 3;
  // The energy modifier granted.
  repeated RewardEnergyModifier energy_modifiers = 4;
  // The reward modifiers granted.
  repeated RewardModifier reward_modifiers = 5;
  // When the reward was granted, in UNIX time.
  int64 grant_time_sec = 6;
  // The item instances granted. Indexed by item instance ID.
  map<string, RewardInventoryItem> item_instances = 7;
}

// A list of rewards granted to the player.
message RewardList {
  // The rewards granted.
  repeated Reward rewards = 1;
}

// A range of possible values.
message RewardRangeInt32 {
  // The minimum bound of the range.
  int32 min = 1;
  // The maximum bound of the range.
  int32 max = 2;
  // A number that the result must be a multiple of.
  int32 multiple = 3;
}

// A range of possible values.
message RewardRangeInt64 {
  // The minimum bound of the range.
  int64 min = 1;
  // The maximum bound of the range.
  int64 max = 2;
  // A number that the result must be a multiple of.
  int64 multiple = 3;
}

// A range of possible values.
message RewardRangeUInt64 {
  // The minimum bound of the range.
  uint64 min = 1;
  // The maximum bound of the range.
  uint64 max = 2;
  // A number that the result must be a multiple of.
  uint64 multiple = 3;
}

// A range of possible values.
message RewardRangeDouble {
  // The minimum bound of the range.
  double min = 1;
  // The maximum bound of the range.
  double max = 2;
  // A number that the result must be a multiple of.
  double multiple = 3;
}

// A possible string property option.
message AvailableRewardsStringPropertyOption {
  // The option weight.
  int64 weight = 1;
}

// A possible string property.
message AvailableRewardsStringProperty {
  // The available string property options.
  map<string, AvailableRewardsStringPropertyOption> options = 1;
  // The total weight from which the options are selected.
  int64 total_weight = 2;
}

// A possible item reward.
message AvailableRewardsItem {
  // The possible count of the reward.
  RewardRangeInt64 count = 1;
  // The possible numeric properties of the reward.
  map<string, RewardRangeDouble> numeric_properties = 2;
  // The possible string properties of the reward.
  map<string, AvailableRewardsStringProperty> string_properties = 3;
}

// A possible item reward.
message AvailableRewardsItemSet {
  // The number of items to draw from the set.
  RewardRangeInt64 count = 1;
  // The number of repeat items that may be drawn from the set. Also includes the user's inventory.
  int64 max_repeats = 2;
  // Drawn items must exist in the intersection of these sets.
  repeated string set = 3;
}

// A possible currency reward.
message AvailableRewardsCurrency {
  // The possible count of the currency.
  RewardRangeInt64 count = 1;
}

// A possible energy reward.
message AvailableRewardsEnergy {
  // The possible count of the energy.
  RewardRangeInt32 count = 1;
}

// A possible energy reward.
message AvailableRewardsEnergyModifier {
  // The ID of the energy to modify.
  string id = 1;
  // The operator of the energy modifier.
  string operator = 2;
  // The value of the energy modifier.
  RewardRangeInt64 value = 3;
  // The possible duration of the modifier.
  RewardRangeUInt64 duration_sec = 4;
}

// A possible modifier reward.
message AvailableRewardsRewardModifier {
  // The ID of the reward item, currency, energy, or energy modifier to modify.
  string id = 1;
  // The type of reward content to modify.
  string type = 2;
  // The operator of the modifier.
  string operator = 3;
  // The value of the modifier.
  RewardRangeInt64 value = 4;
  // The possible duration of the modifier.
  RewardRangeUInt64 duration_sec = 5;
}

// The reward contents for available rewards.
message AvailableRewardsContents {
  // All possible items from this particular reward.
  map<string, AvailableRewardsItem> items = 1;
  // All possible item sets from this particular reward.
  repeated AvailableRewardsItemSet item_sets = 2;
  // All possible currencies from this particular reward.
  map<string, AvailableRewardsCurrency> currencies = 3;
  // All possible energies from this particular reward.
  map<string, AvailableRewardsEnergy> energies = 4;
  // All possible energy reward modifiers from this particular reward.
  repeated AvailableRewardsEnergyModifier energy_modifiers = 5;
  // All reward modifiers from this particular reward.
  repeated AvailableRewardsRewardModifier reward_modifiers = 6;
  // The weight of the reward contents.
  int64 weight = 7;
}

// The available rewards and their probabilistic weights.
message AvailableRewards {
  // The guaranteed contents to grant.
  AvailableRewardsContents guaranteed = 1;
  // The weighted contents to grant.
  repeated AvailableRewardsContents weighted = 2;
  // The number of weighted reward contents to select from among the possibilities.
  int64 max_rolls = 3;
  /* The total weight that all weighted reward contents are calculated against. Auto calculated if set to 0 but can be
     set to a higher value to introduce a chance of a "none" reward. */
  int64 total_weight = 4;
  // The maximum number of repeats of any given weighted reward.
  int64 max_repeat_rolls = 5;
}

// Types of incentives.
enum IncentiveType {
  // Unspecified. Defaults to INVITE.
  INCENTIVE_TYPE_UNSPECIFIED = 0;
  // An invite with an associated incentive reward.
  INCENTIVE_TYPE_INVITE = 1;
}

// The result of claiming an incentive.
message IncentiveClaim {
  // Reward granted.
  Reward reward = 1;
  // Claim time in UTC seconds.
  int64 claim_time_sec = 2;
}

// An incentive set up by a user.
message Incentive {
  // The ID of the incentive.
  string id = 1;
  // Name.
  string name = 2;
  // Description.
  string description = 3;
  // Shareable incentive code.
  string code = 4;
  // The type of the incentive.
  IncentiveType type = 5;
  // Create time in UTC seconds.
  int64 create_time_sec = 6;
  // Update time in UTC seconds.
  int64 update_time_sec = 7;
  // Expiry time in UTC seconds.
  int64 expiry_time_sec = 8;
  // Available reward.
  AvailableRewards recipient_rewards = 9;
  // Sender reward.
  AvailableRewards sender_rewards = 10;
  // Recipient user IDs for which the owner of the incentive has not yet claimed their sender reward.
  repeated string unclaimed_recipients = 11;
  // Sender rewards so far collected for this incentive.
  repeated Reward rewards = 12;
  // Max claims.
  int64 max_claims = 13;
  // Current user IDs that have claimed, and their outcomes.
  map<string, IncentiveClaim> claims = 14;
}

// A list of incentives set up by a user.
message IncentiveList {
  // Incentives set up by a single user.
  repeated Incentive incentives = 1;
}

// An incentive claimant's view of a single incentive.
message IncentiveInfo {
  // The ID of the incentive.
  string id = 1;
  // Name.
  string name = 2;
  // Description.
  string description = 3;
  // Unique shareable incentive code.
  string code = 4;
  // The type of the incentive.
  IncentiveType type = 5;
  // Incentive sender user ID.
  string sender = 6;
  // Available rewards that the caller can claim.
  AvailableRewards available_rewards = 7;
  // Indicator if the caller can claim rewards.
  bool can_claim = 8;
  // Reward that was granted.
  Reward reward = 9;
  // Create time in UTC seconds.
  int64 create_time_sec = 10;
  // Update time in UTC seconds.
  int64 update_time_sec = 11;
  // Expiry time in UTC seconds.
  int64 expiry_time_sec = 12;
  // Claim time in UTC seconds.
  int64 claim_time_sec = 13;
}

// Request by a user to set up a new incentive.
message IncentiveSenderCreateRequest {
  // The incentive configuration ID.
  string id = 1;
}

// Request by a user to delete an incentive they had set up.
message IncentiveSenderDeleteRequest {
  // The unique incentive code.
  string code = 1;
}

// Request by a user to claim rewards from an incentive they had set up.
message IncentiveSenderClaimRequest {
  // The unique incentive code.
  string code = 1;
  // The recipient ID(s) to claim for, or empty for all.
  repeated string recipient_ids = 2;
}

// Request by a potential incentive claimant to view incentive information.
message IncentiveRecipientGetRequest {
  // The unique incentive code.
  string code = 1;
}

// Request by a potential incentive claimant to claim an incentive.
message IncentiveRecipientClaimRequest {
  // The unique incentive code.
  string code = 1;
}

// Find and retrieve an event leaderboard by ID, automatically joining the event if necessary.
message EventLeaderboardGet {
  // Event leaderboard ID to get, and join if necessary/possible.
  string id = 1;
}

// Submit a score to an event leaderboard.
message EventLeaderboardUpdate {
  // Event leaderboard ID.
  string id = 1;
  // Score.
  int64 score = 2;
  // Subscore.
  int64 subscore = 3;
}

// Claim the available reward for an event leaderboard by ID.
message EventLeaderboardClaim {
  // Event leaderboard ID to claim.
  string id = 1;
}

// Roll a new cohort for the specified event leaderboard.
message EventLeaderboardRoll {
  // Event leaderboard ID to roll.
  string id = 1;
}

// A single participant entry to an event leaderboard.
message EventLeaderboardScore {
  // User ID.
  string id = 1;
  // Username.
  string username = 2;
  // Display name.
  string display_name = 3;
  // Avatar URL.
  string avatar_url = 4;
  // Time when the user joined the event leaderboard.
  int64 create_time_sec = 5;
  // Time when the user last submitted a score.
  int64 update_time_sec = 6;
  // Rank within the event leaderboard.
  int64 rank = 7;
  // Score.
  int64 score = 8;
  // Subscore.
  int64 subscore = 9;
  // Number of score submissions.
  int64 num_scores = 10;
}

// A reward range within a specific tier based on ranks.
message EventLeaderboardRewardTier {
  // Name for this tier.
  string name = 1;
  // The maximum rank (inclusive).
  int32 rank_max = 2;
  // The minimum rank (inclusive).
  int32 rank_min = 3;
  // The available rewards for this range.
  AvailableRewards available_rewards = 4;
  // Change in tier for this rank range.
  int32 tier_change = 5;
}

// An event leaderboard's tier-specific set of rewards.
message EventLeaderboardRewardTiers {
  // Possible reward tiers.
  repeated EventLeaderboardRewardTier reward_tiers = 1;
}

// An event leaderboard's tier-specific promotion/demotion zones.
message EventLeaderboardChangeZone {
  // Percentage of cohort to promote, expressed in the range of 0.0 to 1.0.
  double promotion = 1;
  // Percentage of cohort to demote, expressed in the range of 0.0 to 1.0.
  double demotion = 2;
  // Whether or not to always demote players that failed to submit a score at all.
  bool demote_idle = 3;
}

// Details about a specific event leaderboard.
message EventLeaderboard {
  // Event leaderboard ID.
  string id = 1;
  // The name of the event leaderboard. May be an i18n code.
  string name = 2;
  // A description of the event leaderboard. May be an i18n code.
  string description = 3;
  // The category to group the event leaderboard together with others.
  string category = 4;
  // Score ordering.
  bool ascending = 5;
  // Score submission operator.
  string operator = 6;
  // The tier of this instance of the event leaderboard.
  int32 tier = 7;
  // Time when the event starts.
  int64 start_time_sec = 8;
  // Time when the event ends.
  int64 end_time_sec = 9;
  // Time when the event expires.
  int64 expiry_time_sec = 10;
  // The available reward and its probabilities.
  AvailableRewards available_rewards = 11;
  // The possible reward tiers for this instance of the event leaderboard, based on its current tier.
  map<int32, EventLeaderboardRewardTiers> reward_tiers = 12;
  // Per-tier promotion/demotion change zones, if configured.
  map<int32, EventLeaderboardChangeZone> change_zones = 13;
  // Claim time, if any.
  int64 claim_time_sec = 14;
  // The outcome (rolled) reward for the event leaderboard.
  Reward reward = 15;
  // Additional metadata properties.
  map<string, string> additional_properties = 16;
  // Current participant count.
  int64 count = 17;
  // Maximum participant count.
  int64 max_count = 18;
  // Maximum number of score submissions per participant.
  int64 max_num_score = 19;
  // Participants and their scores.
  repeated EventLeaderboardScore scores = 20;
  // Indicates if the event is still active, and scores can be submitted.
  bool is_active = 21;
  // Indicates if the event is over and its reward can be claimed.
  bool can_claim = 22;
  // Indicates if the event can be rolled to get a new set of opponents.
  bool can_roll = 23;
}

// A contributor to this donation.
message EconomyDonationContributor {
  // The user ID that contributed.
  string user_id = 1;
  // The amount they've donated.
  int64 count = 2;
}

// A donation for a user.
message EconomyDonation {
  // The user that owns this donation.
  string user_id = 1;
  // The count of how much of the donation has already been claimed.
  int64 claim_count = 2;
  // The count of how much has been contributed by users.
  int64 count = 3;
  // The UNIX timestamp for the current time.
  int64 current_time_sec = 4;
  // The description for the donation, if any. May be an i18n code.
  string description = 5;
  // The UNIX timestamp when the donation expires.
  int64 expire_time_sec = 6;
  // The ID of the donation.
  string id = 7;
  // The maximum "units" which can be collected.
  int64 max_count = 8;
  // The name for the donation, if any. May be an i18n code.
  string name = 9;
  // The configuration for rewards granted to the recipient of the donation.
  AvailableRewards recipient_available_rewards = 10;
  // The maximum number of donations per contributor.
  int64 user_contribution_max_count = 11;
  // The contributors to this donation, if any.
  repeated EconomyDonationContributor contributors = 12;
  // The configuration for rewards granted to the contributor of the donation.
  AvailableRewards contributor_available_rewards = 13;
  // All rewards claimed by the recipient of this donation.
  repeated Reward recipient_rewards = 14;
  // Additional metadata properties.
  map<string, string> additional_properties = 15;
}

// An acknowledgement of the idempotent creation of a donation for a user.
message EconomyDonationAck {
  // True if the donation is newly created.
  bool created = 1;
  // The donation requested which may already be active or newly created.
  EconomyDonation donation = 2;
}

// A list of active donations returned for some set of users.
message EconomyDonationsList {
  // The active donations for a set of users.
  repeated EconomyDonation donations = 1;
}

// Request to claim one or more donations.
message EconomyDonationClaimRequest {
  // The donation IDs to claim.
  repeated string donation_ids = 1;
}

// Response to claiming one or more donations.
message EconomyDonationClaimRewards {
  // All active donations for the user.
  EconomyDonationsList donations = 1;
  // The rewards from this particular claim.
  map<string, RewardList> claimed_rewards = 2;
}

// Request to give a donation to a user.
message EconomyDonationGiveRequest {
  // The user ID who receives the donation.
  string user_id = 1;
  // The donation ID to give into.
  string donation_id = 2;
}

// Request to get donations for one or more users.
message EconomyDonationGetRequest {
  // The user IDs to get donations for.
  repeated string ids = 1;
}

// Request a new donation.
message EconomyDonationRequest {
  // The donation ID to request, defined on the server.
  string donation_id = 1;
}

// A map of active donations keyed by user ID.
message EconomyDonationsByUserList {
  // The active donations grouped by user ID.
  map<string, EconomyDonationsList> user_donations = 1;
}

// The cost(s) associated with a store item.
message EconomyListStoreItemCost {
  // The virtual currencies, if any.
  map<string, int64> currencies = 1;
  // The required purchase SKU, if any.
  string sku = 2;
}

// Represents an individual available store items.
message EconomyListStoreItem {
  // The category to group the item together with others.
  string category = 1;
  // The cost of the item.
  EconomyListStoreItemCost cost = 2;
  // A description of the item. May be an i18n code.
  string description = 3;
  // The ID of the item.
  string id = 4;
  // The name of the item. May be an i18n code.
  string name = 5;
  // The available rewards in this store item.
  AvailableRewards available_rewards = 6;
  // Additional metadata properties.
  map<string, string> additional_properties = 7;
}

// Represents an available ad placement.
message EconomyListPlacement {
  // The ID of the placement.
  string id = 1;
  // The reward obtained from this placement.
  Reward reward = 2;
  // The available rewards obtained from this placement.
  AvailableRewards available_rewards = 3;
  // Additional metadata properties.
  map<string, string> additional_properties = 4;
}

// The response data with the available store items.
message EconomyList {
  // The list of store items.
  repeated EconomyListStoreItem store_items = 1;
  // The list of placements.
  repeated EconomyListPlacement placements = 2;
  // The set of active donations for the current user.
  map<string, EconomyDonation> donations = 3;
}

// A item owned by the current user.
message InventoryItem {
  // The ID of the item.
  string id = 1;
  // The name of the item. May be an i18n code.
  string name = 2;
  // A description of the item. May be an i18n code.
  string description = 3;
  // The category to group the item together with others.
  string category = 4;
  // The sets the item is grouped into.
  repeated string item_sets = 5;
  // The current count of the item.
  int64 count = 6;
  // The maximum count which can be owned for this item.
  int64 max_count = 7;
  // Whether or not the item is stackable.
  bool stackable = 8;
  // Whether or not the item is consumable.
  bool consumable = 9;
  // The configuration for the reward to grant for consumption.
  AvailableRewards consume_available_rewards = 10;
  // The properties with string values.
  map<string, string> string_properties = 11;
  // The properties with numeric values.
  map<string, double> numeric_properties = 12;
  // A UNIX timestamp when the user acquired this item.
  int64 owned_time_sec = 13;
  // A UNIX timestamp when the item was updated.
  int64 update_time_sec = 14;
  // The instance ID of the item, if any.
  string instance_id = 15;
}

// Request all inventory items in the economy.
message InventoryListRequest {
  // The category for the items to filter for, or empty for all.
  string item_category = 1;
}

// Represents a request to grant items to the user.
message InventoryGrantRequest {
  // The items to grant.
  map<string, int64> items = 1;
}

// The typed properties to update in an instanced inventory item.
message InventoryUpdateItemProperties {
  // The properties with string values.
  map<string, string> string_properties = 1;
  // The properties with numeric values.
  map<string, double> numeric_properties = 2;
}

// Represents a request to update properties of instanced items.
message InventoryUpdateItemsRequest {
  // The item updates to action, keyed by item instance ID.
  map<string, InventoryUpdateItemProperties> item_updates = 1;
}

// The inventory in the economy or owned by user.
message Inventory {
  // The items in the player's inventory.
  map<string, InventoryItem> items = 1;
}

// Request to consume some amount of items.
message InventoryConsumeRequest {
  // Item ID amounts to consume, if any.
  map<string, int64> items = 1;
  // Whether or not to allow overconsumption.
  bool overconsume = 2;
  // Instance ID amounts to consume, if any.
  map<string, int64> instances = 3;
}

// Updated inventory and rewards granted from consumption.
message InventoryConsumeRewards {
  // Updated inventory data, if changed.
  Inventory inventory = 1;
  // Consume rewards by item ID, if any.
  map<string, RewardList> rewards = 2;
  // Consume rewards by instance ID, if any.
  map<string, RewardList> instance_rewards = 3;
}

// Response from granting or purchasing items. This contains updated inventory data, if changed.
message InventoryUpdateAck {
  // Update inventory data, if changed.
  Inventory inventory = 1;
}

// Response for retrieving Inventory system data definitions.
message InventoryList {
  // The inventory items from definitions and the user.
  map<string, InventoryItem> items = 1;
}

// Represents a request to retrieve available store items.
message EconomyListRequest {
  // The game client's store type.
  EconomyStoreType store_type = 1;
}

// Represents a request to grant rewards to the user.
message EconomyGrantRequest {
  // The currencies to grant.
  map<string, int64> currencies = 1;
  // The reward modifiers to grant.
  repeated RewardModifier reward_modifiers = 2;
  // Any items to grant.
  map<string, int64> items = 3;
}

// Request to create a store item purchase intent.
message EconomyPurchaseIntentRequest {
  // An item's ID.
  string item_id = 1;
  // The store type.
  EconomyStoreType store_type = 2;
  // The SKU code, if any.
  string sku = 3;
}

// Request to purchase a particular store item.
message EconomyPurchaseRequest {
  // An item's ID.
  string item_id = 1;
  // The store type.
  EconomyStoreType store_type = 2;
  // The IAP receipt purchased.
  string receipt = 3;
}

// Request to restore a set of purchases.
message EconomyPurchaseRestoreRequest {
  // The store type.
  EconomyStoreType store_type = 1;
  // The IAP receipts to restore.
  repeated string receipts = 2;
}

// Request to retrieve status af a specific placement instance by reward ID.
message EconomyPlacementStatusRequest {
  // The reward ID to check.
  string reward_id = 1;
  // The placement ID to check, will be used if reward ID is not supplied.
  string placement_id = 2;
  // The check attempt counter, optional.
  int32 count = 3;
}

// Request to start a placement reward.
message EconomyPlacementStartRequest {
  // The identifier to start a reward for.
  string placement_id = 1;
}

// The current status of a placement reward.
message EconomyPlacementStatus {
  // The reward ID.
  string reward_id = 1;
  // The placement ID.
  string placement_id = 2;
  // The UNIX timestamp when the placement was created.
  int64 create_time_sec = 3;
  // The UNIX timestamp when the placement was completed.
  int64 complete_time_sec = 4;
  // If completed, was it successful.
  bool success = 5;
  // The reward for completing the placement, if it was autocompleted as part of the status request.
  Reward reward = 6;
}

// Response from granting currencies and/or items.
// Contains updated wallet and inventory data, if changed.
// Contains reward granted, if any.
message EconomyUpdateAck {
  // Updated wallet data, if changed.
  map<string, int64> wallet = 1;
  // Update inventory data, if changed.
  Inventory inventory = 2;
  // Reward, if any.
  Reward reward = 3;
}

// Response from purchasing currencies and/or items.
// Contains updated wallet and inventory data, if changed.
// Contains reward granted, if any.
// Contains indication of whether or not the purchase was a sandbox purchase.
message EconomyPurchaseAck {
  // Updated wallet data, if changed.
  map<string, int64> wallet = 1;
  // Update inventory data, if changed.
  Inventory inventory = 2;
  // Reward, if any.
  Reward reward = 3;
  // Was the purchase a sandbox purchase?
  bool is_sandbox_purchase = 4;
}

// A modifier that may change energy behaviour.
message EnergyModifier {
  // The modifier operator.
  string operator = 1;
  // The modifier value, if applicable.
  int32 value = 2;
  // The UNIX timestamp when the modifier became active.
  int64 start_time_sec = 3;
  // The UNIX timestamp when the modifier ends.
  int64 end_time_sec = 4;
}

// Information about a single energy type.
message Energy {
  // The unique energy identifier.
  string id = 1;
  // The current amount.
  int32 current = 2;
  // The maximum amount.
  int32 max = 3;
  // Amount of energy granted per refill.
  int32 refill = 4;
  // Number of seconds between refills.
  int64 refill_sec = 5;
  // The UNIX timestamp when the count will increase, if it is not at max already.
  int64 next_refill_time_sec = 6;
  // The UNIX timestamp when the count will reach max, if it is not at max already.
  int64 max_refill_time_sec = 7;
  // The UNIX timestamp when the count started filling, if it is not at max already.
  int64 start_refill_time_sec = 8;
  // The modifiers, if any.
  repeated EnergyModifier modifiers = 9;
  // The available rewards, if any.
  AvailableRewards available_rewards = 10;
  // Additional metadata properties.
  map<string, string> additional_properties = 11;
  // The current UNIX timestamp in seconds.
  int64 current_time_sec = 12;
}

// One or more energy values for a user.
message EnergyList {
  // Energy types keyed on the energy identifier.
  map<string, Energy> energies = 1;
}

// Request to spend one or more energy amounts.
message EnergySpendRequest {
  // Energy amounts to spend.
  map<string, int32> amounts = 1;
}

// Request to spend one or more energy amounts.
message EnergySpendReward {
  // The updated list of energy.
  EnergyList energies = 1;
  // The cumulative reward of spending the energies.
  Reward reward = 2;
}

// A leaderboard configuration.
message LeaderboardConfig {
  // The leaderboard id.
  string id = 1;
  // The leaderboard sort order.
  string sort_order = 2;
  // The leaderboard operator.
  string operator = 3;
  // The leaderboard reset schedule.
  string reset_schedule = 4;
  // Whether the leaderboard is authoritative or not.
  bool authoritative = 5;
  // List of regional leaderboards of the leaderboard, if any.
  repeated string regions = 6;
}

// A list of leaderboard configurations.
message LeaderboardConfigList {
  // The list of leaderboard configurations.
  repeated LeaderboardConfig leaderboard_configs = 1;
}

// The states of a Tutorial.
enum TutorialState {
  // The Tutorial has not been accepted/declined by the user yet.
  TUTORIAL_STATE_NONE = 0;
  // The Tutorial was accepted.
  TUTORIAL_STATE_ACCEPTED = 1;
  // The Tutorial was declined.
  TUTORIAL_STATE_DECLINED = 2;
  // The Tutorial is in progress.
  TUTORIAL_STATE_IN_PROGRESS = 3;
  // The Tutorial has been completed.
  TUTORIAL_STATE_COMPLETED = 4;
  // The Tutorial has been abandoned.
  TUTORIAL_STATE_ABANDONED = 5;
}

// An individual set of tutorial steps.
message Tutorial {
  // The unique tutorial identifier.
  string id = 1;
  // The current step in the tutorial.
  int32 current = 2;
  // The maximum step in the tutorial based on configuration.
  int32 max = 3;
  // The accepted state of the tutorial.
  TutorialState state = 4;
  // The UNIX timestamp when the tutorial was last updated.
  int64 update_time_sec = 5;
  // The UNIX timestamp when the tutorial was completed, if it is completed.
  int64 complete_time_sec = 6;
  // Additional metadata properties.
  map<string, string> additional_properties = 7;
}

// The full tutorial statuses for a given user.
message TutorialList {
  // All available tutorials.
  map<string, Tutorial> tutorials = 1;
}

// A request to accept a tutorial.
message TutorialAcceptRequest {
  // The tutorial to accept.
  string id = 1;
}

// A request to decline a tutorial.
message TutorialDeclineRequest {
  // The tutorial to decline.
  string id = 1;
}

// A request to abandon a tutorial.
message TutorialAbandonRequest {
  // The tutorial to abandon.
  string id = 1;
}

// A request to update a tutorial.
message TutorialUpdateRequest {
  // The tutorial to update.
  string id = 1;
  // The latest step that should be marked completed. All previous steps will also be marked as completed.
  int32 step = 2;
}

// The input message when the user rates the app.
message RateAppRequest {
  // The score given by the user. Above zero values indicate a positive review.
  uint32 score = 1;
  // The message about the reason for their score. May be blank.
  string message = 2;
}

// A Team represents a group of users who play together.
message Team {
  // The ID of a team.
  string id = 1;
  // The ID of the user who created the team.
  string creator_id = 2;
  // The unique name of the team.
  string name = 3;
  // A description for the team.
  string description = 4;
  // The language expected to be a tag which follows the BCP-47 spec.
  string lang_tag = 5;
  // Additional information stored as a JSON object.
  string metadata = 6;
  // A URL for an avatar image.
  string avatar_url = 7;
  // Anyone can join open groups, otherwise only admins can accept members.
  bool open = 8;
  // The current count of all members in the group.
  int32 edge_count = 9;
  // The maximum number of members allowed.
  int32 max_count = 10;
  // The UNIX timestamp when the group was created.
  int64 create_time_sec = 11;
  // The UNIX timestamp when the group was last updated.
  int64 update_time_sec = 12;
  // The icon artwork reference ID for the team, if any.
  string icon = 13;
}

// A request to create a team.
message TeamCreateRequest {
  // The name of the team to be created.
  string name = 1;
  // The description of the team to be created.
  string desc = 2;
  // True if the team is open to join by any user.
  bool open = 3;
  // The icon artwork reference ID for the team, if any.
  string icon = 4;
  // The language expected to be a tag which follows the BCP-47 spec.
  string lang_tag = 5;
  // The starting metadata passed in as part of creating the team.
  string setup_metadata = 6;
}

// A request to list teams which a user can join.
message TeamListRequest {
  // An optional cursor used to get the next page.
  string cursor = 1;
  // The optional location filter.
  string location = 2;
  // An optional limit on how many results are returned. Defaults to 10.
  int32 limit = 3;
}

// A list of teams.
message TeamList {
  // The current page of teams returned in the list.
  repeated Team teams = 1;
  // A cursor used to get the next page.
  string cursor = 2;
}

// A request to search for teams which the user wants to join.
message TeamSearchRequest {
  // The search term(s) passed in by the user.
  string input = 1;
  // An optional limit on how many results are returned. Defaults to 10.
  int32 limit = 2;
}

// A request to write a chat message to the channel for a team the user is part of.
message TeamWriteChatMessageRequest {
  // The ID of the team.
  string id = 1;
  // The content of the chat message. Usually an escaped JSON object.
  string content = 2;
}

// The unlockable cost, may relate to starting an unlock, or fully completing it.
message UnlockableCost {
  // The items which will be deducted.
  map<string, int64> items = 1;
  // The currencies which will be deducted.
  map<string, int64> currencies = 2;
}

// A single unlockable object.
message Unlockable {
  // The unlockable definition ID, eg. "bronze-chest".
  string id = 1;
  // The instance ID.
  string instance_id = 2;
  // The category the unlockable is part of.
  string category = 3;
  // The cost to begin unlocking this particular unlockable.
  UnlockableCost start_cost = 4;
  // The cost to fully unlock this unlockable, accounting for any time already spent.
  UnlockableCost cost = 5;
  // The description, if any. May be an i18n code.
  string description = 6;
  // The name. May be an i18n code.
  string name = 7;
  // The reward already granted when the unlockable has been claimed.
  Reward reward = 8;
  // The available rewards for when the unlockable is claimed.
  AvailableRewards available_rewards = 9;
  // Total time this unlockable will take to unlock once activated.
  int32 wait_time_sec = 10;
  // The UNIX timestamp when this unlockable was granted to the user.
  int64 create_time_sec = 11;
  // The UNIX timestamp when this unlockable began unlocking, or 0 if it is not active.
  int64 unlock_start_time_sec = 12;
  // The UNIX timestamp when this unlockable will complete unlocking and become claimable, or 0 if it is not active.
  int64 unlock_complete_time_sec = 13;
  // If the unlock process has completed (either by time elapsed or purchase) and the unlockable reward can be claimed.
  bool can_claim = 14;
  // Additional metadata properties.
  map<string, string> additional_properties = 15;
}

// The cost to purchase an additional unlockable active slot.
message UnlockableSlotCost {
  // The items which will be deducted.
  map<string, int64> items = 1;
  // The currencies which will be deducted.
  map<string, int64> currencies = 2;
}

// A list of unlockables currently owned by a user.
message UnlockablesList {
  // The list of unlockables owned by a user.
  repeated Unlockable unlockables = 1;
  // The unlockable overflow slot.
  Unlockable overflow = 2;
  // The total number of non-overflow slots.
  int32 slots = 3;
  // The current number of active slots.
  int32 active_slots = 4;
  // The max number of active slots the user can ever obtain.
  int32 max_active_slots = 5;
  // The cost to purchase the next active slot, if another is available for purchase.
  UnlockableSlotCost slot_cost = 6;
  // The newly granted unlockable, if any.
  string instance_id = 7;
}

// A reward that was granted upon unlock, and a new state of all unlockables.
message UnlockablesReward {
  // The updated state of remaining unlockables.
  UnlockablesList unlockables = 1;
  // The reward granted from the unlockable.
  Reward reward = 2;
  // The available rewards active for the unlockable.
  AvailableRewards available_rewards = 3;
}

// Request body for interacting with a specific unlockable.
message UnlockablesRequest {
  // The unlockable instance ID.
  string instance_id = 1;
}

// A sub-achievement is an achievement which belongs as part of a parent achievement.
message SubAchievement {
  // The category to group the sub-achievement together with others.
  string category = 1;
  // The UNIX timestamp for when the sub-achievement reward was claimed, or zero if unclaimed.
  int64 claim_time_sec = 2;
  // The count of the sub-achievement.
  int64 count = 3;
  // The UNIX timestamp for the current server time.
  int64 current_time_sec = 4;
  // A description of the sub-achievement. May be an i18n code.
  string description = 5;
  // The UNIX timestamp when this sub-achievement will expire. This may be before its next reset. A zero means it does not expire.
  int64 expire_time_sec = 6;
  // The ID of the sub-achievement.
  string id = 7;
  // The maximum count of the sub-achievement.
  int64 max_count = 8;
  // The name of the sub-achievement. May be an i18n code.
  string name = 9;
  // The IDs which are a precondition on the progress to be made on this sub-achievement.
  repeated string precondition_ids = 10;
  // The UNIX timestamp when this sub-achievement will reset.
  int64 reset_time_sec = 11;
  // The outcome (rolled) reward for the achievement, if any.
  Reward reward = 12;
  // The available reward and its probabilities.
  AvailableRewards available_rewards = 13;
  // Additional metadata properties.
  map<string, string> additional_properties = 14;
}

// An achievement which is a numeric task which can be unlocked and has an optional reward.
message Achievement {
  // The category to group the achievement together with others.
  string category = 1;
  // The UNIX timestamp for when the achievement reward was claimed, or zero if unclaimed.
  int64 claim_time_sec = 2;
  // The UNIX timestamp for when the achievement total reward was claimed, or zero if unclaimed.
  int64 total_claim_time_sec = 3;
  // The count of the achievement.
  int64 count = 4;
  // The UNIX timestamp for the current server time.
  int64 current_time_sec = 5;
  // A description of the achievement. May be an i18n code.
  string description = 6;
  // The UNIX timestamp when this achievement will expire. This may be before its next reset. A zero means it does not expire.
  int64 expire_time_sec = 7;
  // The ID of the achievement.
  string id = 8;
  // The maximum count of the achievement.
  int64 max_count = 9;
  // The name of the achievement. May be an i18n code.
  string name = 10;
  // The IDs which are a precondition on the progress to be made on this achievement.
  repeated string precondition_ids = 11;
  // The UNIX timestamp when this achievement will reset.
  int64 reset_time_sec = 12;
  // The available reward and its probabilities.
  AvailableRewards available_rewards = 13;
  // The outcome (rolled) reward for the achievement.
  Reward reward = 14;
  // The available reward and its probabilities for the total completion of the achievement, if any.
  AvailableRewards available_total_reward = 15;
  // The outcome (rolled) reward for the total completion of the achievement, if any.
  Reward total_reward = 16;
  // The sub-achievements for this achievement, if any.
  map<string, SubAchievement> sub_achievements = 17;
  // Additional metadata properties.
  map<string, string> additional_properties = 18;
}

// The achievements returned by the server.
message AchievementList {
  // The one off achievements which can be progressed or are unlocked by the user alongside all on the server.
  map<string, Achievement> achievements = 1;
  // The repeat achievements which can be progressed or are unlocked by the user alongside all on the server.
  map<string, Achievement> repeat_achievements = 2;
}

// Claim rewards with one or more achievement on the server.
message AchievementsClaimRequest {
  // The set of achievement IDs to claim.
  repeated string ids = 1;
  // Whether or not to claim the total reward as well, if available.
  bool claim_total_reward = 2;
}

// Get all achievements for the user alongside all on the server.
message AchievementsGetRequest {}

// A response when an achievements update is acknowledged by the server.
message AchievementsUpdateAck {
  // The one off achievements which can be progressed or are unlocked by the user.
  map<string, Achievement> achievements = 1;
  // The repeat achievements which can be progressed or are unlocked by the user.
  map<string, Achievement> repeat_achievements = 2;
}

// Update progress on one or more achievements on the server.
message AchievementsUpdateRequest {
  // The set of achievement IDs to progress.
  repeated string ids = 1;
  // The amount of progress to increment on the achievements.
  int64 amount = 2;
  // Achievements with different amounts.
  map<string, int64> achievements = 3;
}

// Sync operation for a single inventory item.
message SyncInventoryItem {
  // Item identifier from config mapping.
  string item_id = 1;
  // Number of items to add or remove.
  int64 delta = 2;
  // Item properties with string values.
  map<string, string> string_properties = 3;
  // Item properties with numeric values.
  map<string, double> numeric_properties = 4;
}

// Input for an offline state sync operation for the inventory system.
message SyncInventory {
  // Map of instance IDs to update operation data.
  map<string, SyncInventoryItem> items = 1;
}

// Single economy reward modifier data.
message SyncEconomyModifier {
  // The full reward modifier to apply.
  RewardModifier modifier = 1;
  // Time when this applied from.
  int64 create_time_sec = 2;
}

// Input for an offline state sync operation for the economy system.
message SyncEconomy {
  // Currencies deltas.
  map<string, int64> currencies = 1;
  // Economy modifiers to add.
  repeated SyncEconomyModifier modifiers = 2;
}

// Sync operation for a single achievement.
message SyncAchievementsUpdate {
  // Count to add.
  int64 count = 1;
  // Time when the achievement first recorded progress.
  int64 create_time_sec = 2;
  // Time when the achievement update was generated on the client.
  int64 update_time_sec = 3;
  // Claim time, if claimed offline.
  int64 claim_time_sec = 4;
  // Total claim time, if claimed offline.
  int64 total_claim_time_sec = 5;
}

// Input for an offline state sync operation for the achievements system.
message SyncAchievements {
  // Achievement updates and associated metadata.
  map<string, SyncAchievementsUpdate> achievements = 1;
}

// Full state (not delta) for an energy.
message SyncEnergyState {
  // Current count.
  int64 count = 1;
  // Last spend time.
  int64 last_spend_time_sec = 2;
}

// Input for an offline state sync operation for the energy system.
message SyncEnergy {
  // Energies and associated full sync data.
  map<string, SyncEnergyState> energies = 1;
  // Energy modifiers to add.
  repeated EnergyModifier modifiers = 2;
}

// Single event leaderboard update.
message SyncEventLeaderboardUpdate {
  // Score.
  int64 score = 1;
  // Subscore.
  int64 subscore = 2;
  // Time when the score was generated on the client.
  int64 update_time_sec = 3;
}

// Input for an offline state sync of event leaderboard updates.
message SyncEventLeaderboards {
  // Updates for various event leaderboards, keyed by event leaderboard identifier.
  map<string, SyncEventLeaderboardUpdate> event_leaderboards = 1;
}

// Single progression update.
message SyncProgressionUpdate {
  // The counts to set.
  map<string, int64> counts = 1;
  // Time when the progression was first updated on the client, if new.
  int64 create_time_sec = 2;
  // Time when the progression update was generated on the client.
  int64 update_time_sec = 3;
  // Cost paid to unlock the progression.
  ProgressionCost cost = 4;
}

// Input for an offline state sync of progressions updates.
message SyncProgressions {
  // Updates for various progressions, keyed by progression identifier.
  map<string, SyncProgressionUpdate> progressions = 1;
}

// Input for an offline state sync of tutorials updates.
message SyncTutorials {
  // Accept list.
  repeated string accepts = 1;
  // Decline list.
  repeated string declines = 2;
  // Abandon list.
  repeated string abandons = 3;
  // Updates to tutorial steps. Implicitly counts as accepting these tutorials, if not accepted already.
  map<string, int64> updates = 4;
}

// Single unlockable update, either grant or unlock start.
message SyncUnlockableUpdate {
  // Unlockable identifier from config.
  string unlockable_id = 1;
  // Time this unlockabled was granted.
  int64 create_time_sec = 2;
  // Unlock start time, if any.
  int64 start_time_sec = 3;
  // Unlock completion time, if any.
  int64 unlock_time_sec = 4;
}

// Input for an offline state sync of unlockables updates.
message SyncUnlockables {
  // Unlockable instance IDs to remove.
  repeated string removes = 1;
  // Unlockable updates keyed by instance identifier, such as new grants or unlock starts.
  map<string, SyncUnlockableUpdate> updates = 2;
}

// Input for an offline state sync operation.
message SyncRequest {
  // Inventory.
  SyncInventory inventory = 1;
  // Economy.
  SyncEconomy economy = 2;
  // Achievements.
  SyncAchievements achievements = 3;
  // Energy.
  SyncEnergy energy = 4;
  // Event leaderboards.
  SyncEventLeaderboards event_leaderboards = 5;
  // Progressions.
  SyncProgressions progressions = 6;
  // Stats. Message reused from standard synchronous stats updates.
  StatUpdateRequest stats = 7;
  // Tutorials.
  SyncTutorials tutorials = 8;
  // Unlockables.
  SyncUnlockables unlockables = 9;
}

// Resulting updates after an offline state sync operation.
// Fields are only populated if the corresponding updated was requested via the sync.
message SyncResponse {
  // Updated wallet data, if any.
  map<string, int64> wallet = 1;
  // Inventory.
  Inventory inventory = 2;
  // Achievements.
  AchievementList achievements = 3;
  // Energies.
  EnergyList energy = 4;
  // Event leaderboards.
  repeated EventLeaderboard event_leaderboards = 5;
  // Progressions.
  ProgressionList progressions = 6;
  // Stats.
  StatList stats = 7;
  // Tutorials.
  TutorialList tutorials = 8;
  // Unlockables.
  UnlockablesList unlockables = 9;
}