client

type AcceptTradeRequestModel struct {
	// AcceptedInventoryInstanceIds items from the accepting player's inventory in exchange for the offered items in the trade. In the case of a gift, this
	// will be null.
	AcceptedInventoryInstanceIds []string `json:"AcceptedInventoryInstanceIds,omitempty"`
	// OfferingPlayerId player who opened the trade.
	OfferingPlayerId string `json:"OfferingPlayerId,omitempty"`
	// TradeId trade identifier.
	TradeId string `json:"TradeId,omitempty"`
}

type AcceptTradeResponseModel struct {
	// Trade details about trade which was just accepted.
	Trade *TradeInfoModel `json:"Trade,omitempty"`
}

type AdActivity string

type AdCampaignAttributionModelModel struct {
	// AttributedAt uTC time stamp of attribution
	AttributedAt time.Time `json:"AttributedAt,omitempty"`
	// CampaignId attribution campaign identifier
	CampaignId string `json:"CampaignId,omitempty"`
	// Platform attribution network name
	Platform string `json:"Platform,omitempty"`
}

type AdPlacementDetailsModel struct {
	// PlacementId placement unique ID
	PlacementId string `json:"PlacementId,omitempty"`
	// PlacementName placement name
	PlacementName string `json:"PlacementName,omitempty"`
	// PlacementViewsRemaining if placement has viewing limits indicates how many views are left
	PlacementViewsRemaining int32 `json:"PlacementViewsRemaining,omitempty"`
	// PlacementViewsResetMinutes if placement has viewing limits indicates when they will next reset
	PlacementViewsResetMinutes float64 `json:"PlacementViewsResetMinutes,omitempty"`
	// RewardAssetUrl optional URL to a reward asset
	RewardAssetUrl string `json:"RewardAssetUrl,omitempty"`
	// RewardDescription reward description
	RewardDescription string `json:"RewardDescription,omitempty"`
	// RewardId reward unique ID
	RewardId string `json:"RewardId,omitempty"`
	// RewardName reward name
	RewardName string `json:"RewardName,omitempty"`
}

type AdRewardItemGrantedModel struct {
	// CatalogId catalog ID
	CatalogId string `json:"CatalogId,omitempty"`
	// DisplayName catalog item display name
	DisplayName string `json:"DisplayName,omitempty"`
	// InstanceId inventory instance ID
	InstanceId string `json:"InstanceId,omitempty"`
	// ItemId item ID
	ItemId string `json:"ItemId,omitempty"`
}

type AdRewardResultsModel struct {
	// GrantedItems array of the items granted to the player
	GrantedItems []AdRewardItemGrantedModel `json:"GrantedItems,omitempty"`
	// GrantedVirtualCurrencies dictionary of virtual currencies that were granted to the player
	GrantedVirtualCurrencies map[string]int32 `json:"GrantedVirtualCurrencies,omitempty"`
	// IncrementedStatistics dictionary of statistics that were modified for the player
	IncrementedStatistics map[string]int32 `json:"IncrementedStatistics,omitempty"`
}

type AddFriendRequestModel struct {
	// FriendEmail email address of the user to attempt to add to the local user's friend list.
	FriendEmail string `json:"FriendEmail,omitempty"`
	// FriendPlayFabId playFab identifier of the user to attempt to add to the local user's friend list.
	FriendPlayFabId string `json:"FriendPlayFabId,omitempty"`
	// FriendTitleDisplayName title-specific display name of the user to attempt to add to the local user's friend list.
	FriendTitleDisplayName string `json:"FriendTitleDisplayName,omitempty"`
	// FriendUsername playFab username of the user to attempt to add to the local user's friend list.
	FriendUsername string `json:"FriendUsername,omitempty"`
}

type AddFriendResultModel struct {
	// Created true if the friend request was processed successfully.
	Created bool `json:"Created"`
}

type AddGenericIDRequestModel struct {
	// GenericId generic service identifier to add to the player account.
	GenericId *GenericServiceIdModel `json:"GenericId,omitempty"`
}

type AddGenericIDResultModel struct {
}

type AddOrUpdateContactEmailRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// EmailAddress the new contact email to associate with the player.
	EmailAddress string `json:"EmailAddress,omitempty"`
}

type AddOrUpdateContactEmailResultModel struct {
}

type AddSharedGroupMembersRequestModel struct {
	// PlayFabIds an array of unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabIds []string `json:"PlayFabIds,omitempty"`
	// SharedGroupId unique identifier for the shared group.
	SharedGroupId string `json:"SharedGroupId,omitempty"`
}

type AddSharedGroupMembersResultModel struct {
}

type AddUserVirtualCurrencyRequestModel struct {
	// Amount amount to be added to the user balance of the specified virtual currency.
	Amount int32 `json:"Amount,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// VirtualCurrency name of the virtual currency which is to be incremented.
	VirtualCurrency string `json:"VirtualCurrency,omitempty"`
}

type AddUsernamePasswordRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// Email user email address attached to their account
	Email string `json:"Email,omitempty"`
	// Password password for the PlayFab account (6-100 characters)
	Password string `json:"Password,omitempty"`
	// Username playFab username for the account (3-20 characters)
	Username string `json:"Username,omitempty"`
}

type AddUsernamePasswordResultModel struct {
	// Username playFab unique user name.
	Username string `json:"Username,omitempty"`
}

type AndroidDevicePushNotificationRegistrationRequestModel struct {
	// ConfirmationMessage message to display when confirming push notification.
	ConfirmationMessage string `json:"ConfirmationMessage,omitempty"`
	// DeviceToken registration ID provided by the Google Cloud Messaging service when the title registered to receive push notifications
	// (see the GCM documentation, here: http://developer.android.com/google/gcm/client.html).
	DeviceToken string `json:"DeviceToken,omitempty"`
	// SendPushNotificationConfirmation if true, send a test push message immediately after sucessful registration. Defaults to false.
	SendPushNotificationConfirmation bool `json:"SendPushNotificationConfirmation"`
}

type AndroidDevicePushNotificationRegistrationResultModel struct {
}

type AttributeInstallRequestModel struct {
	// Adid the adid for this device.
	Adid string `json:"Adid,omitempty"`
	// Idfa the IdentifierForAdvertisers for iOS Devices.
	Idfa string `json:"Idfa,omitempty"`
}

type AttributeInstallResultModel struct {
}

type CancelTradeRequestModel struct {
	// TradeId trade identifier.
	TradeId string `json:"TradeId,omitempty"`
}

type CancelTradeResponseModel struct {
	// Trade details about trade which was just canceled.
	Trade *TradeInfoModel `json:"Trade,omitempty"`
}

type CartItemModel struct {
	// Description description of the catalog item.
	Description string `json:"Description,omitempty"`
	// DisplayName display name for the catalog item.
	DisplayName string `json:"DisplayName,omitempty"`
	// ItemClass class name to which catalog item belongs.
	ItemClass string `json:"ItemClass,omitempty"`
	// ItemId unique identifier for the catalog item.
	ItemId string `json:"ItemId,omitempty"`
	// ItemInstanceId unique instance identifier for this catalog item.
	ItemInstanceId string `json:"ItemInstanceId,omitempty"`
	// RealCurrencyPrices cost of the catalog item for each applicable real world currency.
	RealCurrencyPrices map[string]uint32 `json:"RealCurrencyPrices,omitempty"`
	// VCAmount amount of each applicable virtual currency which will be received as a result of purchasing this catalog item.
	VCAmount map[string]uint32 `json:"VCAmount,omitempty"`
	// VirtualCurrencyPrices cost of the catalog item for each applicable virtual currency.
	VirtualCurrencyPrices map[string]uint32 `json:"VirtualCurrencyPrices,omitempty"`
}

type CatalogItemBundleInfoModel struct {
	// BundledItems unique ItemId values for all items which will be added to the player inventory when the bundle is added
	BundledItems []string `json:"BundledItems,omitempty"`
	// BundledResultTables unique TableId values for all RandomResultTable objects which are part of the bundle (random tables will be resolved and
	// add the relevant items to the player inventory when the bundle is added)
	BundledResultTables []string `json:"BundledResultTables,omitempty"`
	// BundledVirtualCurrencies virtual currency types and balances which will be added to the player inventory when the bundle is added
	BundledVirtualCurrencies map[string]uint32 `json:"BundledVirtualCurrencies,omitempty"`
}

type CatalogItemConsumableInfoModel struct {
	// UsageCount number of times this object can be used, after which it will be removed from the player inventory
	UsageCount uint32 `json:"UsageCount,omitempty"`
	// UsagePeriod duration in seconds for how long the item will remain in the player inventory - once elapsed, the item will be removed
	// (recommended minimum value is 5 seconds, as lower values can cause the item to expire before operations depending on
	// this item's details have completed)
	UsagePeriod uint32 `json:"UsagePeriod,omitempty"`
	// UsagePeriodGroup all inventory item instances in the player inventory sharing a non-null UsagePeriodGroup have their UsagePeriod values
	// added together, and share the result - when that period has elapsed, all the items in the group will be removed
	UsagePeriodGroup string `json:"UsagePeriodGroup,omitempty"`
}

type CatalogItemContainerInfoModel struct {
	// ItemContents unique ItemId values for all items which will be added to the player inventory, once the container has been unlocked
	ItemContents []string `json:"ItemContents,omitempty"`
	// KeyItemId itemId for the catalog item used to unlock the container, if any (if not specified, a call to UnlockContainerItem will
	// open the container, adding the contents to the player inventory and currency balances)
	KeyItemId string `json:"KeyItemId,omitempty"`
	// ResultTableContents unique TableId values for all RandomResultTable objects which are part of the container (once unlocked, random tables
	// will be resolved and add the relevant items to the player inventory)
	ResultTableContents []string `json:"ResultTableContents,omitempty"`
	// VirtualCurrencyContents virtual currency types and balances which will be added to the player inventory when the container is unlocked
	VirtualCurrencyContents map[string]uint32 `json:"VirtualCurrencyContents,omitempty"`
}

type CatalogItemModel struct {
	// Bundle defines the bundle properties for the item - bundles are items which contain other items, including random drop tables
	// and virtual currencies
	Bundle *CatalogItemBundleInfoModel `json:"Bundle,omitempty"`
	// CanBecomeCharacter if true, then an item instance of this type can be used to grant a character to a user.
	CanBecomeCharacter bool `json:"CanBecomeCharacter"`
	// CatalogVersion catalog version for this item
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// Consumable defines the consumable properties (number of uses, timeout) for the item
	Consumable *CatalogItemConsumableInfoModel `json:"Consumable,omitempty"`
	// Container defines the container properties for the item - what items it contains, including random drop tables and virtual
	// currencies, and what item (if any) is required to open it via the UnlockContainerItem API
	Container *CatalogItemContainerInfoModel `json:"Container,omitempty"`
	// CustomData game specific custom data
	CustomData string `json:"CustomData,omitempty"`
	// Description text description of item, to show in-game
	Description string `json:"Description,omitempty"`
	// DisplayName text name for the item, to show in-game
	DisplayName string `json:"DisplayName,omitempty"`
	// InitialLimitedEditionCount if the item has IsLImitedEdition set to true, and this is the first time this ItemId has been defined as a limited
	// edition item, this value determines the total number of instances to allocate for the title. Once this limit has been
	// reached, no more instances of this ItemId can be created, and attempts to purchase or grant it will return a Result of
	// false for that ItemId. If the item has already been defined to have a limited edition count, or if this value is less
	// than zero, it will be ignored.
	InitialLimitedEditionCount int32 `json:"InitialLimitedEditionCount,omitempty"`
	// IsLimitedEdition bETA: If true, then only a fixed number can ever be granted.
	IsLimitedEdition bool `json:"IsLimitedEdition"`
	// IsStackable if true, then only one item instance of this type will exist and its remaininguses will be incremented instead.
	// RemainingUses will cap out at Int32.Max (2,147,483,647). All subsequent increases will be discarded
	IsStackable bool `json:"IsStackable"`
	// IsTradable if true, then an item instance of this type can be traded between players using the trading APIs
	IsTradable bool `json:"IsTradable"`
	// ItemClass class to which the item belongs
	ItemClass string `json:"ItemClass,omitempty"`
	// ItemId unique identifier for this item
	ItemId string `json:"ItemId,omitempty"`
	// ItemImageUrl uRL to the item image. For Facebook purchase to display the image on the item purchase page, this must be set to an HTTP
	// URL.
	ItemImageUrl string `json:"ItemImageUrl,omitempty"`
	// RealCurrencyPrices override prices for this item for specific currencies
	RealCurrencyPrices map[string]uint32 `json:"RealCurrencyPrices,omitempty"`
	// Tags list of item tags
	Tags []string `json:"Tags,omitempty"`
	// VirtualCurrencyPrices price of this item in virtual currencies and "RM" (the base Real Money purchase price, in USD pennies)
	VirtualCurrencyPrices map[string]uint32 `json:"VirtualCurrencyPrices,omitempty"`
}

type CharacterInventoryModel struct {
	// CharacterId the id of this character.
	CharacterId string `json:"CharacterId,omitempty"`
	// Inventory the inventory of this character.
	Inventory []ItemInstanceModel `json:"Inventory,omitempty"`
}

type CharacterLeaderboardEntryModel struct {
	// CharacterId playFab unique identifier of the character that belongs to the user for this leaderboard entry.
	CharacterId string `json:"CharacterId,omitempty"`
	// CharacterName title-specific display name of the character for this leaderboard entry.
	CharacterName string `json:"CharacterName,omitempty"`
	// CharacterType name of the character class for this entry.
	CharacterType string `json:"CharacterType,omitempty"`
	// DisplayName title-specific display name of the user for this leaderboard entry.
	DisplayName string `json:"DisplayName,omitempty"`
	// PlayFabId playFab unique identifier of the user for this leaderboard entry.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// Position user's overall position in the leaderboard.
	Position int32 `json:"Position,omitempty"`
	// StatValue specific value of the user's statistic.
	StatValue int32 `json:"StatValue,omitempty"`
}

type CharacterResultModel struct {
	// CharacterId the id for this character on this player.
	CharacterId string `json:"CharacterId,omitempty"`
	// CharacterName the name of this character.
	CharacterName string `json:"CharacterName,omitempty"`
	// CharacterType the type-string that was given to this character on creation.
	CharacterType string `json:"CharacterType,omitempty"`
}

type CloudScriptRevisionOption string

type CollectionFilterModel struct {
	// Excludes list of Exclude rules, with any of which if a collection matches, it is excluded by the filter.
	Excludes []Container_Dictionary_String_StringModel `json:"Excludes,omitempty"`
	// Includes list of Include rules, with any of which if a collection matches, it is included by the filter, unless it is excluded by
	// one of the Exclude rule
	Includes []Container_Dictionary_String_StringModel `json:"Includes,omitempty"`
}

type ConfirmPurchaseRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// OrderId purchase order identifier returned from StartPurchase.
	OrderId string `json:"OrderId,omitempty"`
}

type ConfirmPurchaseResultModel struct {
	// Items array of items purchased.
	Items []ItemInstanceModel `json:"Items,omitempty"`
	// OrderId purchase order identifier.
	OrderId string `json:"OrderId,omitempty"`
	// PurchaseDate date and time of the purchase.
	PurchaseDate time.Time `json:"PurchaseDate,omitempty"`
}

type ConsumeItemRequestModel struct {
	// CharacterId unique PlayFab assigned ID for a specific character owned by a user
	CharacterId string `json:"CharacterId,omitempty"`
	// ConsumeCount number of uses to consume from the item.
	ConsumeCount int32 `json:"ConsumeCount,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ItemInstanceId unique instance identifier of the item to be consumed.
	ItemInstanceId string `json:"ItemInstanceId,omitempty"`
}

type ConsumeItemResultModel struct {
	// ItemInstanceId unique instance identifier of the item with uses consumed.
	ItemInstanceId string `json:"ItemInstanceId,omitempty"`
	// RemainingUses number of uses remaining on the item.
	RemainingUses int32 `json:"RemainingUses,omitempty"`
}

type ConsumeMicrosoftStoreEntitlementsRequestModel struct {
	// CatalogVersion catalog version to use
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// MarketplaceSpecificData marketplace specific payload containing details to fetch in app purchase transactions
	MarketplaceSpecificData *MicrosoftStorePayloadModel `json:"MarketplaceSpecificData,omitempty"`
}

type ConsumeMicrosoftStoreEntitlementsResponseModel struct {
	// Items details for the items purchased.
	Items []ItemInstanceModel `json:"Items,omitempty"`
}

type ConsumePSNEntitlementsRequestModel struct {
	// CatalogVersion which catalog to match granted entitlements against. If null, defaults to title default catalog
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ServiceLabel id of the PSN service label to consume entitlements from
	ServiceLabel int32 `json:"ServiceLabel,omitempty"`
}

type ConsumePSNEntitlementsResultModel struct {
	// ItemsGranted array of items granted to the player as a result of consuming entitlements.
	ItemsGranted []ItemInstanceModel `json:"ItemsGranted,omitempty"`
}

type ConsumeXboxEntitlementsRequestModel struct {
	// CatalogVersion catalog version to use
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// XboxToken token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", "").
	XboxToken string `json:"XboxToken,omitempty"`
}

type ConsumeXboxEntitlementsResultModel struct {
	// Items details for the items purchased.
	Items []ItemInstanceModel `json:"Items,omitempty"`
}

type ContactEmailInfoModelModel struct {
	// EmailAddress the email address
	EmailAddress string `json:"EmailAddress,omitempty"`
	// Name the name of the email info data
	Name string `json:"Name,omitempty"`
	// VerificationStatus the verification status of the email
	VerificationStatus EmailVerificationStatus `json:"VerificationStatus,omitempty"`
}

type Container_Dictionary_String_StringModel struct {
	// Data content of data
	Data map[string]string `json:"Data,omitempty"`
}

type ContinentCode string

type CountryCode string

type CreateSharedGroupRequestModel struct {
	// SharedGroupId unique identifier for the shared group (a random identifier will be assigned, if one is not specified).
	SharedGroupId string `json:"SharedGroupId,omitempty"`
}

type CreateSharedGroupResultModel struct {
	// SharedGroupId unique identifier for the shared group.
	SharedGroupId string `json:"SharedGroupId,omitempty"`
}

type Currency string

type CurrentGamesRequestModel struct {
	// BuildVersion build to match against.
	BuildVersion string `json:"BuildVersion,omitempty"`
	// GameMode game mode to look for.
	GameMode string `json:"GameMode,omitempty"`
	// Region region to check for Game Server Instances.
	Region Region `json:"Region,omitempty"`
	// StatisticName statistic name to find statistic-based matches.
	StatisticName string `json:"StatisticName,omitempty"`
	// TagFilter filter to include and/or exclude Game Server Instances associated with certain tags.
	TagFilter *CollectionFilterModel `json:"TagFilter,omitempty"`
}

type CurrentGamesResultModel struct {
	// GameCount number of games running
	GameCount int32 `json:"GameCount,omitempty"`
	// Games array of games found
	Games []GameInfoModel `json:"Games,omitempty"`
	// PlayerCount total number of players across all servers
	PlayerCount int32 `json:"PlayerCount,omitempty"`
}

type DeviceInfoRequestModel struct {
	// Info information posted to the PlayStream Event. Currently arbitrary, and specific to the environment sending it.
	Info map[string]interface{} `json:"Info,omitempty"`
}

type EmailVerificationStatus string

type EmptyResponseModel struct {
}

type EmptyResultModel struct {
}

type EntityKeyModel struct {
	// Id unique ID of the entity.
	Id string `json:"Id,omitempty"`
	// Type entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types
	Type string `json:"Type,omitempty"`
}

type EntityTokenResponseModel struct {
	// Entity the entity id and type.
	Entity *EntityKeyModel `json:"Entity,omitempty"`
	// EntityToken the token used to set X-EntityToken for all entity based API calls.
	EntityToken string `json:"EntityToken,omitempty"`
	// TokenExpiration the time the token will expire, if it is an expiring token, in UTC.
	TokenExpiration time.Time `json:"TokenExpiration,omitempty"`
}

type ExecuteCloudScriptRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// FunctionName the name of the CloudScript function to execute
	FunctionName string `json:"FunctionName,omitempty"`
	// FunctionParameter object that is passed in to the function as the first argument
	FunctionParameter interface{} `json:"FunctionParameter,omitempty"`
	// GeneratePlayStreamEvent generate a 'player_executed_cloudscript' PlayStream event containing the results of the function execution and other
	// contextual information. This event will show up in the PlayStream debugger console for the player in Game Manager.
	GeneratePlayStreamEvent bool `json:"GeneratePlayStreamEvent"`
	// RevisionSelection option for which revision of the CloudScript to execute. 'Latest' executes the most recently created revision, 'Live'
	// executes the current live, published revision, and 'Specific' executes the specified revision. The default value is
	// 'Specific', if the SpeificRevision parameter is specified, otherwise it is 'Live'.
	RevisionSelection CloudScriptRevisionOption `json:"RevisionSelection,omitempty"`
	// SpecificRevision the specivic revision to execute, when RevisionSelection is set to 'Specific'
	SpecificRevision int32 `json:"SpecificRevision,omitempty"`
}

type ExecuteCloudScriptResultModel struct {
	// APIRequestsIssued number of PlayFab API requests issued by the CloudScript function
	APIRequestsIssued int32 `json:"APIRequestsIssued,omitempty"`
	// Error information about the error, if any, that occurred during execution
	Error *ScriptExecutionErrorModel `json:"Error,omitempty"`
	// ExecutionTimeSeconds
	ExecutionTimeSeconds float64 `json:"ExecutionTimeSeconds,omitempty"`
	// FunctionName the name of the function that executed
	FunctionName string `json:"FunctionName,omitempty"`
	// FunctionResult the object returned from the CloudScript function, if any
	FunctionResult interface{} `json:"FunctionResult,omitempty"`
	// FunctionResultTooLarge flag indicating if the FunctionResult was too large and was subsequently dropped from this event. This only occurs if
	// the total event size is larger than 350KB.
	FunctionResultTooLarge bool `json:"FunctionResultTooLarge"`
	// HttpRequestsIssued number of external HTTP requests issued by the CloudScript function
	HttpRequestsIssued int32 `json:"HttpRequestsIssued,omitempty"`
	// Logs entries logged during the function execution. These include both entries logged in the function code using log.info()
	// and log.error() and error entries for API and HTTP request failures.
	Logs []LogStatementModel `json:"Logs,omitempty"`
	// LogsTooLarge flag indicating if the logs were too large and were subsequently dropped from this event. This only occurs if the total
	// event size is larger than 350KB after the FunctionResult was removed.
	LogsTooLarge bool `json:"LogsTooLarge"`
	// MemoryConsumedBytes
	MemoryConsumedBytes uint32 `json:"MemoryConsumedBytes,omitempty"`
	// ProcessorTimeSeconds processor time consumed while executing the function. This does not include time spent waiting on API calls or HTTP
	// requests.
	ProcessorTimeSeconds float64 `json:"ProcessorTimeSeconds,omitempty"`
	// Revision the revision of the CloudScript that executed
	Revision int32 `json:"Revision,omitempty"`
}

type FacebookInstantGamesPlayFabIdPairModel struct {
	// FacebookInstantGamesId unique Facebook Instant Games identifier for a user.
	FacebookInstantGamesId string `json:"FacebookInstantGamesId,omitempty"`
	// PlayFabId unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Facebook Instant Games identifier.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type FacebookPlayFabIdPairModel struct {
	// FacebookId unique Facebook identifier for a user.
	FacebookId string `json:"FacebookId,omitempty"`
	// PlayFabId unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Facebook identifier.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type FriendInfoModel struct {
	// FacebookInfo available Facebook information (if the user and PlayFab friend are also connected in Facebook).
	FacebookInfo *UserFacebookInfoModel `json:"FacebookInfo,omitempty"`
	// FriendPlayFabId playFab unique identifier for this friend.
	FriendPlayFabId string `json:"FriendPlayFabId,omitempty"`
	// GameCenterInfo available Game Center information (if the user and PlayFab friend are also connected in Game Center).
	GameCenterInfo *UserGameCenterInfoModel `json:"GameCenterInfo,omitempty"`
	// Profile the profile of the user, if requested.
	Profile *PlayerProfileModelModel `json:"Profile,omitempty"`
	// PSNInfo available PSN information, if the user and PlayFab friend are both connected to PSN.
	PSNInfo *UserPsnInfoModel `json:"PSNInfo,omitempty"`
	// SteamInfo available Steam information (if the user and PlayFab friend are also connected in Steam).
	SteamInfo *UserSteamInfoModel `json:"SteamInfo,omitempty"`
	// Tags tags which have been associated with this friend.
	Tags []string `json:"Tags,omitempty"`
	// TitleDisplayName title-specific display name for this friend.
	TitleDisplayName string `json:"TitleDisplayName,omitempty"`
	// Username playFab unique username for this friend.
	Username string `json:"Username,omitempty"`
	// XboxInfo available Xbox information, if the user and PlayFab friend are both connected to Xbox Live.
	XboxInfo *UserXboxInfoModel `json:"XboxInfo,omitempty"`
}

type GameCenterPlayFabIdPairModel struct {
	// GameCenterId unique Game Center identifier for a user.
	GameCenterId string `json:"GameCenterId,omitempty"`
	// PlayFabId unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Game Center identifier.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type GameInfoModel struct {
	// BuildVersion build version this server is running
	BuildVersion string `json:"BuildVersion,omitempty"`
	// GameMode game mode this server is running
	GameMode string `json:"GameMode,omitempty"`
	// GameServerData game session custom data
	GameServerData string `json:"GameServerData,omitempty"`
	// GameServerStateEnum game specific string denoting server configuration
	GameServerStateEnum GameInstanceState `json:"GameServerStateEnum,omitempty"`
	// LastHeartbeat last heartbeat of the game server instance, used in external game server provider mode
	LastHeartbeat time.Time `json:"LastHeartbeat,omitempty"`
	// LobbyID unique lobby identifier for this game server
	LobbyID string `json:"LobbyID,omitempty"`
	// MaxPlayers maximum players this server can support
	MaxPlayers int32 `json:"MaxPlayers,omitempty"`
	// PlayerUserIds array of current player IDs on this server
	PlayerUserIds []string `json:"PlayerUserIds,omitempty"`
	// Region region to which this server is associated
	Region Region `json:"Region,omitempty"`
	// RunTime duration in seconds this server has been running
	RunTime uint32 `json:"RunTime,omitempty"`
	// ServerIPV4Address iPV4 address of the server
	ServerIPV4Address string `json:"ServerIPV4Address,omitempty"`
	// ServerIPV6Address iPV6 address of the server
	ServerIPV6Address string `json:"ServerIPV6Address,omitempty"`
	// ServerPort port number to use for non-http communications with the server
	ServerPort int32 `json:"ServerPort,omitempty"`
	// ServerPublicDNSName public DNS name (if any) of the server
	ServerPublicDNSName string `json:"ServerPublicDNSName,omitempty"`
	// StatisticName stastic used to match this game in player statistic matchmaking
	StatisticName string `json:"StatisticName,omitempty"`
	// Tags game session tags
	Tags map[string]string `json:"Tags,omitempty"`
}

type GameInstanceState string

type GameServerRegionsRequestModel struct {
	// BuildVersion version of game server for which stats are being requested
	BuildVersion string `json:"BuildVersion,omitempty"`
	// TitleId unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
	// title has been selected.
	TitleId string `json:"TitleId,omitempty"`
}

type GameServerRegionsResultModel struct {
	// Regions array of regions found matching the request parameters
	Regions []RegionInfoModel `json:"Regions,omitempty"`
}

type GenericPlayFabIdPairModel struct {
	// GenericId unique generic service identifier for a user.
	GenericId *GenericServiceIdModel `json:"GenericId,omitempty"`
	// PlayFabId unique PlayFab identifier for a user, or null if no PlayFab account is linked to the given generic identifier.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type GenericServiceIdModel struct {
	// ServiceName name of the service for which the player has a unique identifier.
	ServiceName string `json:"ServiceName,omitempty"`
	// UserId unique identifier of the player in that service.
	UserId string `json:"UserId,omitempty"`
}

type GetAccountInfoRequestModel struct {
	// Email user email address for the account to find (if no Username is specified).
	Email string `json:"Email,omitempty"`
	// PlayFabId unique PlayFab identifier of the user whose info is being requested. Optional, defaults to the authenticated user if no
	// other lookup identifier set.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// TitleDisplayName title-specific username for the account to find (if no Email is set). Note that if the non-unique Title Display Names
	// option is enabled for the title, attempts to look up users by Title Display Name will always return AccountNotFound.
	TitleDisplayName string `json:"TitleDisplayName,omitempty"`
	// Username playFab Username for the account to find (if no PlayFabId is specified).
	Username string `json:"Username,omitempty"`
}

type GetAccountInfoResultModel struct {
	// AccountInfo account information for the local user.
	AccountInfo *UserAccountInfoModel `json:"AccountInfo,omitempty"`
}

type GetAdPlacementsRequestModel struct {
	// AppId the current AppId to use
	AppId string `json:"AppId,omitempty"`
	// Identifier using the name or unique identifier, filter the result for get a specific placement.
	Identifier *NameIdentifierModel `json:"Identifier,omitempty"`
}

type GetAdPlacementsResultModel struct {
	// AdPlacements array of results
	AdPlacements []AdPlacementDetailsModel `json:"AdPlacements,omitempty"`
}

type GetCatalogItemsRequestModel struct {
	// CatalogVersion which catalog is being requested. If null, uses the default catalog.
	CatalogVersion string `json:"CatalogVersion,omitempty"`
}

type GetCatalogItemsResultModel struct {
	// Catalog array of items which can be purchased.
	Catalog []CatalogItemModel `json:"Catalog,omitempty"`
}

type GetCharacterDataRequestModel struct {
	// CharacterId unique PlayFab assigned ID for a specific character owned by a user
	CharacterId string `json:"CharacterId,omitempty"`
	// IfChangedFromDataVersion the version that currently exists according to the caller. The call will return the data for all of the keys if the
	// version in the system is greater than this.
	IfChangedFromDataVersion uint32 `json:"IfChangedFromDataVersion,omitempty"`
	// Keys specific keys to search for in the custom user data.
	Keys []string `json:"Keys,omitempty"`
	// PlayFabId unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type GetCharacterDataResultModel struct {
	// CharacterId unique PlayFab assigned ID for a specific character owned by a user
	CharacterId string `json:"CharacterId,omitempty"`
	// Data user specific data for this title.
	Data map[string]UserDataRecordModel `json:"Data,omitempty"`
	// DataVersion indicates the current version of the data that has been set. This is incremented with every set call for that type of
	// data (read-only, internal, etc). This version can be provided in Get calls to find updated data.
	DataVersion uint32 `json:"DataVersion,omitempty"`
}

type GetCharacterInventoryRequestModel struct {
	// CatalogVersion used to limit results to only those from a specific catalog version.
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// CharacterId unique PlayFab assigned ID for a specific character owned by a user
	CharacterId string `json:"CharacterId,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
}

type GetCharacterInventoryResultModel struct {
	// CharacterId unique identifier of the character for this inventory.
	CharacterId string `json:"CharacterId,omitempty"`
	// Inventory array of inventory items belonging to the character.
	Inventory []ItemInstanceModel `json:"Inventory,omitempty"`
	// VirtualCurrency array of virtual currency balance(s) belonging to the character.
	VirtualCurrency map[string]int32 `json:"VirtualCurrency,omitempty"`
	// VirtualCurrencyRechargeTimes array of remaining times and timestamps for virtual currencies.
	VirtualCurrencyRechargeTimes map[string]VirtualCurrencyRechargeTimeModel `json:"VirtualCurrencyRechargeTimes,omitempty"`
}

type GetCharacterLeaderboardRequestModel struct {
	// CharacterType optional character type on which to filter the leaderboard entries.
	CharacterType string `json:"CharacterType,omitempty"`
	// MaxResultsCount maximum number of entries to retrieve. Default 10, maximum 100.
	MaxResultsCount int32 `json:"MaxResultsCount,omitempty"`
	// StartPosition first entry in the leaderboard to be retrieved.
	StartPosition int32 `json:"StartPosition,omitempty"`
	// StatisticName unique identifier for the title-specific statistic for the leaderboard.
	StatisticName string `json:"StatisticName,omitempty"`
}

type GetCharacterLeaderboardResultModel struct {
	// Leaderboard ordered list of leaderboard entries.
	Leaderboard []CharacterLeaderboardEntryModel `json:"Leaderboard,omitempty"`
}

type GetCharacterStatisticsRequestModel struct {
	// CharacterId unique PlayFab assigned ID for a specific character owned by a user
	CharacterId string `json:"CharacterId,omitempty"`
}

type GetCharacterStatisticsResultModel struct {
	// CharacterStatistics the requested character statistics.
	CharacterStatistics map[string]int32 `json:"CharacterStatistics,omitempty"`
}

type GetContentDownloadUrlRequestModel struct {
	// HttpMethod hTTP method to fetch item - GET or HEAD. Use HEAD when only fetching metadata. Default is GET.
	HttpMethod string `json:"HttpMethod,omitempty"`
	// Key key of the content item to fetch, usually formatted as a path, e.g. images/a.png
	Key string `json:"Key,omitempty"`
	// ThruCDN true to download through CDN. CDN provides higher download bandwidth and lower latency. However, if you want the latest,
	// non-cached version of the content during development, set this to false. Default is true.
	ThruCDN bool `json:"ThruCDN"`
}

type GetContentDownloadUrlResultModel struct {
	// URL uRL for downloading content via HTTP GET or HEAD method. The URL will expire in approximately one hour.
	URL string `json:"URL,omitempty"`
}

type GetFriendLeaderboardAroundPlayerRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// IncludeFacebookFriends indicates whether Facebook friends should be included in the response. Default is true.
	IncludeFacebookFriends bool `json:"IncludeFacebookFriends"`
	// IncludeSteamFriends indicates whether Steam service friends should be included in the response. Default is true.
	IncludeSteamFriends bool `json:"IncludeSteamFriends"`
	// MaxResultsCount maximum number of entries to retrieve. Default 10, maximum 100.
	MaxResultsCount int32 `json:"MaxResultsCount,omitempty"`
	// PlayFabId playFab unique identifier of the user to center the leaderboard around. If null will center on the logged in user.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// ProfileConstraints if non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
	// only the allowed client profile properties for the title may be requested. These allowed properties are configured in
	// the Game Manager "Client Profile Options" tab in the "Settings" section.
	ProfileConstraints *PlayerProfileViewConstraintsModel `json:"ProfileConstraints,omitempty"`
	// StatisticName statistic used to rank players for this leaderboard.
	StatisticName string `json:"StatisticName,omitempty"`
	// Version the version of the leaderboard to get.
	Version int32 `json:"Version,omitempty"`
	// XboxToken xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.
	XboxToken string `json:"XboxToken,omitempty"`
}

type GetFriendLeaderboardAroundPlayerResultModel struct {
	// Leaderboard ordered listing of users and their positions in the requested leaderboard.
	Leaderboard []PlayerLeaderboardEntryModel `json:"Leaderboard,omitempty"`
	// NextReset the time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule.
	NextReset time.Time `json:"NextReset,omitempty"`
	// Version the version of the leaderboard returned.
	Version int32 `json:"Version,omitempty"`
}

type GetFriendLeaderboardRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// IncludeFacebookFriends indicates whether Facebook friends should be included in the response. Default is true.
	IncludeFacebookFriends bool `json:"IncludeFacebookFriends"`
	// IncludeSteamFriends indicates whether Steam service friends should be included in the response. Default is true.
	IncludeSteamFriends bool `json:"IncludeSteamFriends"`
	// MaxResultsCount maximum number of entries to retrieve. Default 10, maximum 100.
	MaxResultsCount int32 `json:"MaxResultsCount,omitempty"`
	// ProfileConstraints if non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
	// only the allowed client profile properties for the title may be requested. These allowed properties are configured in
	// the Game Manager "Client Profile Options" tab in the "Settings" section.
	ProfileConstraints *PlayerProfileViewConstraintsModel `json:"ProfileConstraints,omitempty"`
	// StartPosition position in the leaderboard to start this listing (defaults to the first entry).
	StartPosition int32 `json:"StartPosition,omitempty"`
	// StatisticName statistic used to rank friends for this leaderboard.
	StatisticName string `json:"StatisticName,omitempty"`
	// Version the version of the leaderboard to get.
	Version int32 `json:"Version,omitempty"`
	// XboxToken xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.
	XboxToken string `json:"XboxToken,omitempty"`
}

type GetFriendsListRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// IncludeFacebookFriends indicates whether Facebook friends should be included in the response. Default is true.
	IncludeFacebookFriends bool `json:"IncludeFacebookFriends"`
	// IncludeSteamFriends indicates whether Steam service friends should be included in the response. Default is true.
	IncludeSteamFriends bool `json:"IncludeSteamFriends"`
	// ProfileConstraints if non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
	// only the allowed client profile properties for the title may be requested. These allowed properties are configured in
	// the Game Manager "Client Profile Options" tab in the "Settings" section.
	ProfileConstraints *PlayerProfileViewConstraintsModel `json:"ProfileConstraints,omitempty"`
	// XboxToken xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab.
	XboxToken string `json:"XboxToken,omitempty"`
}

type GetFriendsListResultModel struct {
	// Friends array of friends found.
	Friends []FriendInfoModel `json:"Friends,omitempty"`
}

type GetLeaderboardAroundCharacterRequestModel struct {
	// CharacterId unique PlayFab assigned ID for a specific character on which to center the leaderboard.
	CharacterId string `json:"CharacterId,omitempty"`
	// CharacterType optional character type on which to filter the leaderboard entries.
	CharacterType string `json:"CharacterType,omitempty"`
	// MaxResultsCount maximum number of entries to retrieve. Default 10, maximum 100.
	MaxResultsCount int32 `json:"MaxResultsCount,omitempty"`
	// StatisticName unique identifier for the title-specific statistic for the leaderboard.
	StatisticName string `json:"StatisticName,omitempty"`
}

type GetLeaderboardAroundCharacterResultModel struct {
	// Leaderboard ordered list of leaderboard entries.
	Leaderboard []CharacterLeaderboardEntryModel `json:"Leaderboard,omitempty"`
}

type GetLeaderboardAroundPlayerRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// MaxResultsCount maximum number of entries to retrieve. Default 10, maximum 100.
	MaxResultsCount int32 `json:"MaxResultsCount,omitempty"`
	// PlayFabId playFab unique identifier of the user to center the leaderboard around. If null will center on the logged in user.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// ProfileConstraints if non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
	// only the allowed client profile properties for the title may be requested. These allowed properties are configured in
	// the Game Manager "Client Profile Options" tab in the "Settings" section.
	ProfileConstraints *PlayerProfileViewConstraintsModel `json:"ProfileConstraints,omitempty"`
	// StatisticName statistic used to rank players for this leaderboard.
	StatisticName string `json:"StatisticName,omitempty"`
	// Version the version of the leaderboard to get.
	Version int32 `json:"Version,omitempty"`
}

type GetLeaderboardAroundPlayerResultModel struct {
	// Leaderboard ordered listing of users and their positions in the requested leaderboard.
	Leaderboard []PlayerLeaderboardEntryModel `json:"Leaderboard,omitempty"`
	// NextReset the time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule.
	NextReset time.Time `json:"NextReset,omitempty"`
	// Version the version of the leaderboard returned.
	Version int32 `json:"Version,omitempty"`
}

type GetLeaderboardForUsersCharactersRequestModel struct {
	// MaxResultsCount maximum number of entries to retrieve.
	MaxResultsCount int32 `json:"MaxResultsCount,omitempty"`
	// StatisticName unique identifier for the title-specific statistic for the leaderboard.
	StatisticName string `json:"StatisticName,omitempty"`
}

type GetLeaderboardForUsersCharactersResultModel struct {
	// Leaderboard ordered list of leaderboard entries.
	Leaderboard []CharacterLeaderboardEntryModel `json:"Leaderboard,omitempty"`
}

type GetLeaderboardRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// MaxResultsCount maximum number of entries to retrieve. Default 10, maximum 100.
	MaxResultsCount int32 `json:"MaxResultsCount,omitempty"`
	// ProfileConstraints if non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
	// only the allowed client profile properties for the title may be requested. These allowed properties are configured in
	// the Game Manager "Client Profile Options" tab in the "Settings" section.
	ProfileConstraints *PlayerProfileViewConstraintsModel `json:"ProfileConstraints,omitempty"`
	// StartPosition position in the leaderboard to start this listing (defaults to the first entry).
	StartPosition int32 `json:"StartPosition,omitempty"`
	// StatisticName statistic used to rank players for this leaderboard.
	StatisticName string `json:"StatisticName,omitempty"`
	// Version the version of the leaderboard to get.
	Version int32 `json:"Version,omitempty"`
}

type GetLeaderboardResultModel struct {
	// Leaderboard ordered listing of users and their positions in the requested leaderboard.
	Leaderboard []PlayerLeaderboardEntryModel `json:"Leaderboard,omitempty"`
	// NextReset the time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule.
	NextReset time.Time `json:"NextReset,omitempty"`
	// Version the version of the leaderboard returned.
	Version int32 `json:"Version,omitempty"`
}

type GetPaymentTokenRequestModel struct {
	// TokenProvider the name of service to provide the payment token. Allowed Values are: xsolla
	TokenProvider string `json:"TokenProvider,omitempty"`
}

type GetPaymentTokenResultModel struct {
	// OrderId playFab's purchase order identifier.
	OrderId string `json:"OrderId,omitempty"`
	// ProviderToken the token from provider.
	ProviderToken string `json:"ProviderToken,omitempty"`
}

type GetPhotonAuthenticationTokenRequestModel struct {
	// PhotonApplicationId the Photon applicationId for the game you wish to log into.
	PhotonApplicationId string `json:"PhotonApplicationId,omitempty"`
}

type GetPhotonAuthenticationTokenResultModel struct {
	// PhotonCustomAuthenticationToken the Photon authentication token for this game-session.
	PhotonCustomAuthenticationToken string `json:"PhotonCustomAuthenticationToken,omitempty"`
}

type GetPlayFabIDsFromFacebookIDsRequestModel struct {
	// FacebookIDs array of unique Facebook identifiers for which the title needs to get PlayFab identifiers.
	FacebookIDs []string `json:"FacebookIDs,omitempty"`
}

type GetPlayFabIDsFromFacebookIDsResultModel struct {
	// Data mapping of Facebook identifiers to PlayFab identifiers.
	Data []FacebookPlayFabIdPairModel `json:"Data,omitempty"`
}

type GetPlayFabIDsFromFacebookInstantGamesIdsRequestModel struct {
	// FacebookInstantGamesIds array of unique Facebook Instant Games identifiers for which the title needs to get PlayFab identifiers.
	FacebookInstantGamesIds []string `json:"FacebookInstantGamesIds,omitempty"`
}

type GetPlayFabIDsFromFacebookInstantGamesIdsResultModel struct {
	// Data mapping of Facebook Instant Games identifiers to PlayFab identifiers.
	Data []FacebookInstantGamesPlayFabIdPairModel `json:"Data,omitempty"`
}

type GetPlayFabIDsFromGameCenterIDsRequestModel struct {
	// GameCenterIDs array of unique Game Center identifiers (the Player Identifier) for which the title needs to get PlayFab identifiers.
	GameCenterIDs []string `json:"GameCenterIDs,omitempty"`
}

type GetPlayFabIDsFromGameCenterIDsResultModel struct {
	// Data mapping of Game Center identifiers to PlayFab identifiers.
	Data []GameCenterPlayFabIdPairModel `json:"Data,omitempty"`
}

type GetPlayFabIDsFromGenericIDsRequestModel struct {
	// GenericIDs array of unique generic service identifiers for which the title needs to get PlayFab identifiers. Currently limited to a
	// maximum of 10 in a single request.
	GenericIDs []GenericServiceIdModel `json:"GenericIDs,omitempty"`
}

type GetPlayFabIDsFromGenericIDsResultModel struct {
	// Data mapping of generic service identifiers to PlayFab identifiers.
	Data []GenericPlayFabIdPairModel `json:"Data,omitempty"`
}

type GetPlayFabIDsFromGoogleIDsRequestModel struct {
	// GoogleIDs array of unique Google identifiers (Google+ user IDs) for which the title needs to get PlayFab identifiers.
	GoogleIDs []string `json:"GoogleIDs,omitempty"`
}

type GetPlayFabIDsFromGoogleIDsResultModel struct {
	// Data mapping of Google identifiers to PlayFab identifiers.
	Data []GooglePlayFabIdPairModel `json:"Data,omitempty"`
}

type GetPlayFabIDsFromKongregateIDsRequestModel struct {
	// KongregateIDs array of unique Kongregate identifiers (Kongregate's user_id) for which the title needs to get PlayFab identifiers.
	KongregateIDs []string `json:"KongregateIDs,omitempty"`
}

type GetPlayFabIDsFromKongregateIDsResultModel struct {
	// Data mapping of Kongregate identifiers to PlayFab identifiers.
	Data []KongregatePlayFabIdPairModel `json:"Data,omitempty"`
}

type GetPlayFabIDsFromNintendoSwitchDeviceIdsRequestModel struct {
	// NintendoSwitchDeviceIds array of unique Nintendo Switch Device identifiers for which the title needs to get PlayFab identifiers.
	NintendoSwitchDeviceIds []string `json:"NintendoSwitchDeviceIds,omitempty"`
}

type GetPlayFabIDsFromNintendoSwitchDeviceIdsResultModel struct {
	// Data mapping of Nintendo Switch Device identifiers to PlayFab identifiers.
	Data []NintendoSwitchPlayFabIdPairModel `json:"Data,omitempty"`
}

type GetPlayFabIDsFromPSNAccountIDsRequestModel struct {
	// IssuerId id of the PSN issuer environment. If null, defaults to 256 (production)
	IssuerId int32 `json:"IssuerId,omitempty"`
	// PSNAccountIDs array of unique PlayStation Network identifiers for which the title needs to get PlayFab identifiers.
	PSNAccountIDs []string `json:"PSNAccountIDs,omitempty"`
}

type GetPlayFabIDsFromPSNAccountIDsResultModel struct {
	// Data mapping of PlayStation Network identifiers to PlayFab identifiers.
	Data []PSNAccountPlayFabIdPairModel `json:"Data,omitempty"`
}

type GetPlayFabIDsFromSteamIDsRequestModel struct {
	// SteamStringIDs array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers.
	SteamStringIDs []string `json:"SteamStringIDs,omitempty"`
}

type GetPlayFabIDsFromSteamIDsResultModel struct {
	// Data mapping of Steam identifiers to PlayFab identifiers.
	Data []SteamPlayFabIdPairModel `json:"Data,omitempty"`
}

type GetPlayFabIDsFromTwitchIDsRequestModel struct {
	// TwitchIds array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers.
	TwitchIds []string `json:"TwitchIds,omitempty"`
}

type GetPlayFabIDsFromTwitchIDsResultModel struct {
	// Data mapping of Twitch identifiers to PlayFab identifiers.
	Data []TwitchPlayFabIdPairModel `json:"Data,omitempty"`
}

type GetPlayFabIDsFromXboxLiveIDsRequestModel struct {
	// Sandbox the ID of Xbox Live sandbox.
	Sandbox string `json:"Sandbox,omitempty"`
	// XboxLiveAccountIDs array of unique Xbox Live account identifiers for which the title needs to get PlayFab identifiers.
	XboxLiveAccountIDs []string `json:"XboxLiveAccountIDs,omitempty"`
}

type GetPlayFabIDsFromXboxLiveIDsResultModel struct {
	// Data mapping of PlayStation Network identifiers to PlayFab identifiers.
	Data []XboxLiveAccountPlayFabIdPairModel `json:"Data,omitempty"`
}

type GetPlayerCombinedInfoRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// InfoRequestParameters flags for which pieces of info to return for the user.
	InfoRequestParameters *GetPlayerCombinedInfoRequestParamsModel `json:"InfoRequestParameters,omitempty"`
	// PlayFabId playFabId of the user whose data will be returned. If not filled included, we return the data for the calling player.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type GetPlayerCombinedInfoRequestParamsModel struct {
	// GetCharacterInventories whether to get character inventories. Defaults to false.
	GetCharacterInventories bool `json:"GetCharacterInventories"`
	// GetCharacterList whether to get the list of characters. Defaults to false.
	GetCharacterList bool `json:"GetCharacterList"`
	// GetPlayerProfile whether to get player profile. Defaults to false. Has no effect for a new player.
	GetPlayerProfile bool `json:"GetPlayerProfile"`
	// GetPlayerStatistics whether to get player statistics. Defaults to false.
	GetPlayerStatistics bool `json:"GetPlayerStatistics"`
	// GetTitleData whether to get title data. Defaults to false.
	GetTitleData bool `json:"GetTitleData"`
	// GetUserAccountInfo whether to get the player's account Info. Defaults to false
	GetUserAccountInfo bool `json:"GetUserAccountInfo"`
	// GetUserData whether to get the player's custom data. Defaults to false
	GetUserData bool `json:"GetUserData"`
	// GetUserInventory whether to get the player's inventory. Defaults to false
	GetUserInventory bool `json:"GetUserInventory"`
	// GetUserReadOnlyData whether to get the player's read only data. Defaults to false
	GetUserReadOnlyData bool `json:"GetUserReadOnlyData"`
	// GetUserVirtualCurrency whether to get the player's virtual currency balances. Defaults to false
	GetUserVirtualCurrency bool `json:"GetUserVirtualCurrency"`
	// PlayerStatisticNames specific statistics to retrieve. Leave null to get all keys. Has no effect if GetPlayerStatistics is false
	PlayerStatisticNames []string `json:"PlayerStatisticNames,omitempty"`
	// ProfileConstraints specifies the properties to return from the player profile. Defaults to returning the player's display name.
	ProfileConstraints *PlayerProfileViewConstraintsModel `json:"ProfileConstraints,omitempty"`
	// TitleDataKeys specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetTitleData is false
	TitleDataKeys []string `json:"TitleDataKeys,omitempty"`
	// UserDataKeys specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserData is false
	UserDataKeys []string `json:"UserDataKeys,omitempty"`
	// UserReadOnlyDataKeys specific keys to search for in the custom data. Leave null to get all keys. Has no effect if GetUserReadOnlyData is
	// false
	UserReadOnlyDataKeys []string `json:"UserReadOnlyDataKeys,omitempty"`
}

type GetPlayerCombinedInfoResultModel struct {
	// InfoResultPayload results for requested info.
	InfoResultPayload *GetPlayerCombinedInfoResultPayloadModel `json:"InfoResultPayload,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type GetPlayerCombinedInfoResultPayloadModel struct {
	// AccountInfo account information for the user. This is always retrieved.
	AccountInfo *UserAccountInfoModel `json:"AccountInfo,omitempty"`
	// CharacterInventories inventories for each character for the user.
	CharacterInventories []CharacterInventoryModel `json:"CharacterInventories,omitempty"`
	// CharacterList list of characters for the user.
	CharacterList []CharacterResultModel `json:"CharacterList,omitempty"`
	// PlayerProfile the profile of the players. This profile is not guaranteed to be up-to-date. For a new player, this profile will not
	// exist.
	PlayerProfile *PlayerProfileModelModel `json:"PlayerProfile,omitempty"`
	// PlayerStatistics list of statistics for this player.
	PlayerStatistics []StatisticValueModel `json:"PlayerStatistics,omitempty"`
	// TitleData title data for this title.
	TitleData map[string]string `json:"TitleData,omitempty"`
	// UserData user specific custom data.
	UserData map[string]UserDataRecordModel `json:"UserData,omitempty"`
	// UserDataVersion the version of the UserData that was returned.
	UserDataVersion uint32 `json:"UserDataVersion,omitempty"`
	// UserInventory array of inventory items in the user's current inventory.
	UserInventory []ItemInstanceModel `json:"UserInventory,omitempty"`
	// UserReadOnlyData user specific read-only data.
	UserReadOnlyData map[string]UserDataRecordModel `json:"UserReadOnlyData,omitempty"`
	// UserReadOnlyDataVersion the version of the Read-Only UserData that was returned.
	UserReadOnlyDataVersion uint32 `json:"UserReadOnlyDataVersion,omitempty"`
	// UserVirtualCurrency dictionary of virtual currency balance(s) belonging to the user.
	UserVirtualCurrency map[string]int32 `json:"UserVirtualCurrency,omitempty"`
	// UserVirtualCurrencyRechargeTimes dictionary of remaining times and timestamps for virtual currencies.
	UserVirtualCurrencyRechargeTimes map[string]VirtualCurrencyRechargeTimeModel `json:"UserVirtualCurrencyRechargeTimes,omitempty"`
}

type GetPlayerProfileRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// ProfileConstraints if non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
	// only the allowed client profile properties for the title may be requested. These allowed properties are configured in
	// the Game Manager "Client Profile Options" tab in the "Settings" section.
	ProfileConstraints *PlayerProfileViewConstraintsModel `json:"ProfileConstraints,omitempty"`
}

type GetPlayerProfileResultModel struct {
	// PlayerProfile the profile of the player. This profile is not guaranteed to be up-to-date. For a new player, this profile will not
	// exist.
	PlayerProfile *PlayerProfileModelModel `json:"PlayerProfile,omitempty"`
}

type GetPlayerSegmentsRequestModel struct {
}

type GetPlayerSegmentsResultModel struct {
	// Segments array of segments the requested player currently belongs to.
	Segments []GetSegmentResultModel `json:"Segments,omitempty"`
}

type GetPlayerStatisticVersionsRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// StatisticName unique name of the statistic
	StatisticName string `json:"StatisticName,omitempty"`
}

type GetPlayerStatisticVersionsResultModel struct {
	// StatisticVersions version change history of the statistic
	StatisticVersions []PlayerStatisticVersionModel `json:"StatisticVersions,omitempty"`
}

type GetPlayerStatisticsRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// StatisticNames statistics to return (current version will be returned for each)
	StatisticNames []string `json:"StatisticNames,omitempty"`
	// StatisticNameVersions statistics to return, if StatisticNames is not set (only statistics which have a version matching that provided will be
	// returned)
	StatisticNameVersions []StatisticNameVersionModel `json:"StatisticNameVersions,omitempty"`
}

type GetPlayerStatisticsResultModel struct {
	// Statistics user statistics for the requested user.
	Statistics []StatisticValueModel `json:"Statistics,omitempty"`
}

type GetPlayerTagsRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// Namespace optional namespace to filter results by
	Namespace string `json:"Namespace,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type GetPlayerTagsResultModel struct {
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// Tags canonical tags (including namespace and tag's name) for the requested user
	Tags []string `json:"Tags,omitempty"`
}

type GetPlayerTradesRequestModel struct {
	// StatusFilter returns only trades with the given status. If null, returns all trades.
	StatusFilter TradeStatus `json:"StatusFilter,omitempty"`
}

type GetPlayerTradesResponseModel struct {
	// AcceptedTrades history of trades which this player has accepted.
	AcceptedTrades []TradeInfoModel `json:"AcceptedTrades,omitempty"`
	// OpenedTrades the trades for this player which are currently available to be accepted.
	OpenedTrades []TradeInfoModel `json:"OpenedTrades,omitempty"`
}

type GetPublisherDataRequestModel struct {
	// Keys array of keys to get back data from the Publisher data blob, set by the admin tools
	Keys []string `json:"Keys,omitempty"`
}

type GetPublisherDataResultModel struct {
	// Data a dictionary object of key / value pairs
	Data map[string]string `json:"Data,omitempty"`
}

type GetPurchaseRequestModel struct {
	// OrderId purchase order identifier.
	OrderId string `json:"OrderId,omitempty"`
}

type GetPurchaseResultModel struct {
	// OrderId purchase order identifier.
	OrderId string `json:"OrderId,omitempty"`
	// PaymentProvider payment provider used for transaction (If not VC)
	PaymentProvider string `json:"PaymentProvider,omitempty"`
	// PurchaseDate date and time of the purchase.
	PurchaseDate time.Time `json:"PurchaseDate,omitempty"`
	// TransactionId provider transaction ID (If not VC)
	TransactionId string `json:"TransactionId,omitempty"`
	// TransactionStatus playFab transaction status
	TransactionStatus string `json:"TransactionStatus,omitempty"`
}

type GetSegmentResultModel struct {
	// ABTestParent identifier of the segments AB Test, if it is attached to one.
	ABTestParent string `json:"ABTestParent,omitempty"`
	// Id unique identifier for this segment.
	Id string `json:"Id,omitempty"`
	// Name segment name.
	Name string `json:"Name,omitempty"`
}

type GetSharedGroupDataRequestModel struct {
	// GetMembers if true, return the list of all members of the shared group.
	GetMembers bool `json:"GetMembers"`
	// Keys specific keys to retrieve from the shared group (if not specified, all keys will be returned, while an empty array
	// indicates that no keys should be returned).
	Keys []string `json:"Keys,omitempty"`
	// SharedGroupId unique identifier for the shared group.
	SharedGroupId string `json:"SharedGroupId,omitempty"`
}

type GetSharedGroupDataResultModel struct {
	// Data data for the requested keys.
	Data map[string]SharedGroupDataRecordModel `json:"Data,omitempty"`
	// Members list of PlayFabId identifiers for the members of this group, if requested.
	Members []string `json:"Members,omitempty"`
}

type GetStoreItemsRequestModel struct {
	// CatalogVersion catalog version to store items from. Use default catalog version if null
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// StoreId unqiue identifier for the store which is being requested.
	StoreId string `json:"StoreId,omitempty"`
}

type GetStoreItemsResultModel struct {
	// CatalogVersion the base catalog that this store is a part of.
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// MarketingData additional data about the store.
	MarketingData *StoreMarketingModelModel `json:"MarketingData,omitempty"`
	// Source how the store was last updated (Admin or a third party).
	Source SourceType `json:"Source,omitempty"`
	// Store array of items which can be purchased from this store.
	Store []StoreItemModel `json:"Store,omitempty"`
	// StoreId the ID of this store.
	StoreId string `json:"StoreId,omitempty"`
}

type GetTimeRequestModel struct {
}

type GetTimeResultModel struct {
	// Time current server time when the request was received, in UTC
	Time time.Time `json:"Time,omitempty"`
}

type GetTitleDataRequestModel struct {
	// Keys specific keys to search for in the title data (leave null to get all keys)
	Keys []string `json:"Keys,omitempty"`
	// OverrideLabel optional field that specifies the name of an override. This value is ignored when used by the game client; otherwise,
	// the overrides are applied automatically to the title data.
	OverrideLabel string `json:"OverrideLabel,omitempty"`
}

type GetTitleDataResultModel struct {
	// Data a dictionary object of key / value pairs
	Data map[string]string `json:"Data,omitempty"`
}

type GetTitleNewsRequestModel struct {
	// Count limits the results to the last n entries. Defaults to 10 if not set.
	Count int32 `json:"Count,omitempty"`
}

type GetTitleNewsResultModel struct {
	// News array of news items.
	News []TitleNewsItemModel `json:"News,omitempty"`
}

type GetTitlePublicKeyRequestModel struct {
	// TitleId unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
	// title has been selected.
	TitleId string `json:"TitleId,omitempty"`
	// TitleSharedSecret the shared secret key for this title
	TitleSharedSecret string `json:"TitleSharedSecret,omitempty"`
}

type GetTitlePublicKeyResultModel struct {
	// RSAPublicKey base64 encoded RSA CSP byte array blob containing the title's public RSA key
	RSAPublicKey string `json:"RSAPublicKey,omitempty"`
}

type GetTradeStatusRequestModel struct {
	// OfferingPlayerId player who opened trade.
	OfferingPlayerId string `json:"OfferingPlayerId,omitempty"`
	// TradeId trade identifier as returned by OpenTradeOffer.
	TradeId string `json:"TradeId,omitempty"`
}

type GetTradeStatusResponseModel struct {
	// Trade information about the requested trade.
	Trade *TradeInfoModel `json:"Trade,omitempty"`
}

type GetUserDataRequestModel struct {
	// IfChangedFromDataVersion the version that currently exists according to the caller. The call will return the data for all of the keys if the
	// version in the system is greater than this.
	IfChangedFromDataVersion uint32 `json:"IfChangedFromDataVersion,omitempty"`
	// Keys list of unique keys to load from.
	Keys []string `json:"Keys,omitempty"`
	// PlayFabId unique PlayFab identifier of the user to load data for. Optional, defaults to yourself if not set. When specified to a
	// PlayFab id of another player, then this will only return public keys for that account.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type GetUserDataResultModel struct {
	// Data user specific data for this title.
	Data map[string]UserDataRecordModel `json:"Data,omitempty"`
	// DataVersion indicates the current version of the data that has been set. This is incremented with every set call for that type of
	// data (read-only, internal, etc). This version can be provided in Get calls to find updated data.
	DataVersion uint32 `json:"DataVersion,omitempty"`
}

type GetUserInventoryRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
}

type GetUserInventoryResultModel struct {
	// Inventory array of inventory items belonging to the user.
	Inventory []ItemInstanceModel `json:"Inventory,omitempty"`
	// VirtualCurrency array of virtual currency balance(s) belonging to the user.
	VirtualCurrency map[string]int32 `json:"VirtualCurrency,omitempty"`
	// VirtualCurrencyRechargeTimes array of remaining times and timestamps for virtual currencies.
	VirtualCurrencyRechargeTimes map[string]VirtualCurrencyRechargeTimeModel `json:"VirtualCurrencyRechargeTimes,omitempty"`
}

type GetWindowsHelloChallengeRequestModel struct {
	// PublicKeyHint sHA256 hash of the PublicKey generated by Windows Hello.
	PublicKeyHint string `json:"PublicKeyHint,omitempty"`
	// TitleId unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
	// title has been selected.
	TitleId string `json:"TitleId,omitempty"`
}

type GetWindowsHelloChallengeResponseModel struct {
	// Challenge server generated challenge to be signed by the user.
	Challenge string `json:"Challenge,omitempty"`
}

type GooglePlayFabIdPairModel struct {
	// GoogleId unique Google identifier for a user.
	GoogleId string `json:"GoogleId,omitempty"`
	// PlayFabId unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Google identifier.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type GrantCharacterToUserRequestModel struct {
	// CatalogVersion catalog version from which items are to be granted.
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// CharacterName non-unique display name of the character being granted (1-40 characters in length).
	CharacterName string `json:"CharacterName,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ItemId catalog item identifier of the item in the user's inventory that corresponds to the character in the catalog to be
	// created.
	ItemId string `json:"ItemId,omitempty"`
}

type GrantCharacterToUserResultModel struct {
	// CharacterId unique identifier tagged to this character.
	CharacterId string `json:"CharacterId,omitempty"`
	// CharacterType type of character that was created.
	CharacterType string `json:"CharacterType,omitempty"`
	// Result indicates whether this character was created successfully.
	Result bool `json:"Result"`
}

type ItemInstanceModel struct {
	// Annotation game specific comment associated with this instance when it was added to the user inventory.
	Annotation string `json:"Annotation,omitempty"`
	// BundleContents array of unique items that were awarded when this catalog item was purchased.
	BundleContents []string `json:"BundleContents,omitempty"`
	// BundleParent unique identifier for the parent inventory item, as defined in the catalog, for object which were added from a bundle or
	// container.
	BundleParent string `json:"BundleParent,omitempty"`
	// CatalogVersion catalog version for the inventory item, when this instance was created.
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// CustomData a set of custom key-value pairs on the instance of the inventory item, which is not to be confused with the catalog
	// item's custom data.
	CustomData map[string]string `json:"CustomData,omitempty"`
	// DisplayName catalogItem.DisplayName at the time this item was purchased.
	DisplayName string `json:"DisplayName,omitempty"`
	// Expiration timestamp for when this instance will expire.
	Expiration time.Time `json:"Expiration,omitempty"`
	// ItemClass class name for the inventory item, as defined in the catalog.
	ItemClass string `json:"ItemClass,omitempty"`
	// ItemId unique identifier for the inventory item, as defined in the catalog.
	ItemId string `json:"ItemId,omitempty"`
	// ItemInstanceId unique item identifier for this specific instance of the item.
	ItemInstanceId string `json:"ItemInstanceId,omitempty"`
	// PurchaseDate timestamp for when this instance was purchased.
	PurchaseDate time.Time `json:"PurchaseDate,omitempty"`
	// RemainingUses total number of remaining uses, if this is a consumable item.
	RemainingUses int32 `json:"RemainingUses,omitempty"`
	// UnitCurrency currency type for the cost of the catalog item. Not available when granting items.
	UnitCurrency string `json:"UnitCurrency,omitempty"`
	// UnitPrice cost of the catalog item in the given currency. Not available when granting items.
	UnitPrice uint32 `json:"UnitPrice,omitempty"`
	// UsesIncrementedBy the number of uses that were added or removed to this item in this call.
	UsesIncrementedBy int32 `json:"UsesIncrementedBy,omitempty"`
}

type ItemPurchaseRequestModel struct {
	// Annotation title-specific text concerning this purchase.
	Annotation string `json:"Annotation,omitempty"`
	// ItemId unique ItemId of the item to purchase.
	ItemId string `json:"ItemId,omitempty"`
	// Quantity how many of this item to purchase. Min 1, maximum 25.
	Quantity uint32 `json:"Quantity,omitempty"`
	// UpgradeFromItems items to be upgraded as a result of this purchase (upgraded items are hidden, as they are "replaced" by the new items).
	UpgradeFromItems []string `json:"UpgradeFromItems,omitempty"`
}

type KongregatePlayFabIdPairModel struct {
	// KongregateId unique Kongregate identifier for a user.
	KongregateId string `json:"KongregateId,omitempty"`
	// PlayFabId unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Kongregate identifier.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type LinkAndroidDeviceIDRequestModel struct {
	// AndroidDevice specific model of the user's device.
	AndroidDevice string `json:"AndroidDevice,omitempty"`
	// AndroidDeviceId android device identifier for the user's device.
	AndroidDeviceId string `json:"AndroidDeviceId,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ForceLink if another user is already linked to the device, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
	// OS specific Operating System version for the user's device.
	OS string `json:"OS,omitempty"`
}

type LinkAndroidDeviceIDResultModel struct {
}

type LinkAppleRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ForceLink if another user is already linked to a specific Apple account, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
	// IdentityToken the JSON Web token (JWT) returned by Apple after login. Represented as the identityToken field in the authorization
	// credential payload. Used to validate the request and find the user ID (Apple subject) to link with.
	IdentityToken string `json:"IdentityToken,omitempty"`
}

type LinkCustomIDRequestModel struct {
	// CustomId custom unique identifier for the user, generated by the title.
	CustomId string `json:"CustomId,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ForceLink if another user is already linked to the custom ID, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
}

type LinkCustomIDResultModel struct {
}

type LinkFacebookAccountRequestModel struct {
	// AccessToken unique identifier from Facebook for the user.
	AccessToken string `json:"AccessToken,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ForceLink if another user is already linked to the account, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
}

type LinkFacebookAccountResultModel struct {
}

type LinkFacebookInstantGamesIdRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// FacebookInstantGamesSignature facebook Instant Games signature for the user.
	FacebookInstantGamesSignature string `json:"FacebookInstantGamesSignature,omitempty"`
	// ForceLink if another user is already linked to the Facebook Instant Games ID, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
}

type LinkFacebookInstantGamesIdResultModel struct {
}

type LinkGameCenterAccountRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ForceLink if another user is already linked to the account, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
	// GameCenterId game Center identifier for the player account to be linked.
	GameCenterId string `json:"GameCenterId,omitempty"`
	// PublicKeyUrl the URL for the public encryption key that will be used to verify the signature.
	PublicKeyUrl string `json:"PublicKeyUrl,omitempty"`
	// Salt a random value used to compute the hash and keep it randomized.
	Salt string `json:"Salt,omitempty"`
	// Signature the verification signature of the authentication payload.
	Signature string `json:"Signature,omitempty"`
	// Timestamp the integer representation of date and time that the signature was created on. PlayFab will reject authentication
	// signatures not within 10 minutes of the server's current time.
	Timestamp string `json:"Timestamp,omitempty"`
}

type LinkGameCenterAccountResultModel struct {
}

type LinkGoogleAccountRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ForceLink if another user is already linked to the account, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
	// ServerAuthCode server authentication code obtained on the client by calling getServerAuthCode()
	// (https://developers.google.com/identity/sign-in/android/offline-access) from Google Play for the user.
	ServerAuthCode string `json:"ServerAuthCode,omitempty"`
}

type LinkGoogleAccountResultModel struct {
}

type LinkIOSDeviceIDRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// DeviceId vendor-specific iOS identifier for the user's device.
	DeviceId string `json:"DeviceId,omitempty"`
	// DeviceModel specific model of the user's device.
	DeviceModel string `json:"DeviceModel,omitempty"`
	// ForceLink if another user is already linked to the device, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
	// OS specific Operating System version for the user's device.
	OS string `json:"OS,omitempty"`
}

type LinkIOSDeviceIDResultModel struct {
}

type LinkKongregateAccountRequestModel struct {
	// AuthTicket valid session auth ticket issued by Kongregate
	AuthTicket string `json:"AuthTicket,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ForceLink if another user is already linked to the account, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
	// KongregateId numeric user ID assigned by Kongregate
	KongregateId string `json:"KongregateId,omitempty"`
}

type LinkKongregateAccountResultModel struct {
}

type LinkNintendoServiceAccountRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ForceLink if another user is already linked to a specific Nintendo Switch account, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
	// IdentityToken the JSON Web token (JWT) returned by Nintendo after login. Used to validate the request and find the user ID (Nintendo
	// Switch subject) to link with.
	IdentityToken string `json:"IdentityToken,omitempty"`
}

type LinkNintendoSwitchDeviceIdRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ForceLink if another user is already linked to the Nintendo Switch Device ID, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
	// NintendoSwitchDeviceId nintendo Switch unique identifier for the user's device.
	NintendoSwitchDeviceId string `json:"NintendoSwitchDeviceId,omitempty"`
}

type LinkNintendoSwitchDeviceIdResultModel struct {
}

type LinkOpenIdConnectRequestModel struct {
	// ConnectionId a name that identifies which configured OpenID Connect provider relationship to use. Maximum 100 characters.
	ConnectionId string `json:"ConnectionId,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ForceLink if another user is already linked to a specific OpenId Connect user, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
	// IdToken the JSON Web token (JWT) returned by the identity provider after login. Represented as the id_token field in the
	// identity provider's response. Used to validate the request and find the user ID (OpenID Connect subject) to link with.
	IdToken string `json:"IdToken,omitempty"`
}

type LinkPSNAccountRequestModel struct {
	// AuthCode authentication code provided by the PlayStation Network.
	AuthCode string `json:"AuthCode,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ForceLink if another user is already linked to the account, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
	// IssuerId id of the PSN issuer environment. If null, defaults to 256 (production)
	IssuerId int32 `json:"IssuerId,omitempty"`
	// RedirectUri redirect URI supplied to PSN when requesting an auth code
	RedirectUri string `json:"RedirectUri,omitempty"`
}

type LinkPSNAccountResultModel struct {
}

type LinkSteamAccountRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ForceLink if another user is already linked to the account, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
	// SteamTicket authentication token for the user, returned as a byte array from Steam, and converted to a string (for example, the byte
	// 0x08 should become "08").
	SteamTicket string `json:"SteamTicket,omitempty"`
}

type LinkSteamAccountResultModel struct {
}

type LinkTwitchAccountRequestModel struct {
	// AccessToken valid token issued by Twitch
	AccessToken string `json:"AccessToken,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ForceLink if another user is already linked to the account, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
}

type LinkTwitchAccountResultModel struct {
}

type LinkWindowsHelloAccountRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// DeviceName device name.
	DeviceName string `json:"DeviceName,omitempty"`
	// ForceLink if another user is already linked to the account, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
	// PublicKey publicKey generated by Windows Hello.
	PublicKey string `json:"PublicKey,omitempty"`
	// UserName player's user named used by Windows Hello.
	UserName string `json:"UserName,omitempty"`
}

type LinkWindowsHelloAccountResponseModel struct {
}

type LinkXboxAccountRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// ForceLink if another user is already linked to the account, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink"`
	// XboxToken token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", "").
	XboxToken string `json:"XboxToken,omitempty"`
}

type LinkXboxAccountResultModel struct {
}

type LinkedPlatformAccountModelModel struct {
	// Email linked account email of the user on the platform, if available
	Email string `json:"Email,omitempty"`
	// Platform authentication platform
	Platform LoginIdentityProvider `json:"Platform,omitempty"`
	// PlatformUserId unique account identifier of the user on the platform
	PlatformUserId string `json:"PlatformUserId,omitempty"`
	// Username linked account username of the user on the platform, if available
	Username string `json:"Username,omitempty"`
}

type ListUsersCharactersRequestModel struct {
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type ListUsersCharactersResultModel struct {
	// Characters the requested list of characters.
	Characters []CharacterResultModel `json:"Characters,omitempty"`
}

type LocationModelModel struct {
	// City city name.
	City string `json:"City,omitempty"`
	// ContinentCode the two-character continent code for this location
	ContinentCode ContinentCode `json:"ContinentCode,omitempty"`
	// CountryCode the two-character ISO 3166-1 country code for the country associated with the location
	CountryCode CountryCode `json:"CountryCode,omitempty"`
	// Latitude latitude coordinate of the geographic location.
	Latitude float64 `json:"Latitude,omitempty"`
	// Longitude longitude coordinate of the geographic location.
	Longitude float64 `json:"Longitude,omitempty"`
}

type LogStatementModel struct {
	// Data optional object accompanying the message as contextual information
	Data interface{} `json:"Data,omitempty"`
	// Level 'Debug', 'Info', or 'Error'
	Level string `json:"Level,omitempty"`
	// Message
	Message string `json:"Message,omitempty"`
}

type LoginIdentityProvider string

type LoginResultModel struct {
	// EntityToken if LoginTitlePlayerAccountEntity flag is set on the login request the title_player_account will also be logged in and
	// returned.
	EntityToken *EntityTokenResponseModel `json:"EntityToken,omitempty"`
	// InfoResultPayload results for requested info.
	InfoResultPayload *GetPlayerCombinedInfoResultPayloadModel `json:"InfoResultPayload,omitempty"`
	// LastLoginTime the time of this user's previous login. If there was no previous login, then it's DateTime.MinValue
	LastLoginTime time.Time `json:"LastLoginTime,omitempty"`
	// NewlyCreated true if the account was newly created on this login.
	NewlyCreated bool `json:"NewlyCreated"`
	// PlayFabId player's unique PlayFabId.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// SessionTicket unique token authorizing the user and game at the server level, for the current session.
	SessionTicket string `json:"SessionTicket,omitempty"`
	// SettingsForUser settings specific to this user.
	SettingsForUser *UserSettingsModel `json:"SettingsForUser,omitempty"`
	// TreatmentAssignment the experimentation treatments for this user at the time of login.
	TreatmentAssignment *TreatmentAssignmentModel `json:"TreatmentAssignment,omitempty"`
}

type LoginWithAndroidDeviceIDRequestModel struct {
	// AndroidDevice specific model of the user's device.
	AndroidDevice string `json:"AndroidDevice,omitempty"`
	// AndroidDeviceId android device identifier for the user's device.
	AndroidDeviceId string `json:"AndroidDeviceId,omitempty"`
	// CreateAccount automatically create a PlayFab account if one is not currently linked to this ID.
	CreateAccount bool `json:"CreateAccount"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// EncryptedRequest base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).
	EncryptedRequest string `json:"EncryptedRequest,omitempty"`
	// InfoRequestParameters flags for which pieces of info to return for the user.
	InfoRequestParameters *GetPlayerCombinedInfoRequestParamsModel `json:"InfoRequestParameters,omitempty"`
	// OS specific Operating System version for the user's device.
	OS string `json:"OS,omitempty"`
	// PlayerSecret player secret that is used to verify API request signatures (Enterprise Only).
	PlayerSecret string `json:"PlayerSecret,omitempty"`
	// TitleId unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
	// title has been selected.
	TitleId string `json:"TitleId,omitempty"`
}

type LoginWithAppleRequestModel struct {
	// CreateAccount automatically create a PlayFab account if one is not currently linked to this ID.
	CreateAccount bool `json:"CreateAccount"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// EncryptedRequest base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).
	EncryptedRequest string `json:"EncryptedRequest,omitempty"`
	// IdentityToken the JSON Web token (JWT) returned by Apple after login. Represented as the identityToken field in the authorization
	// credential payload.
	IdentityToken string `json:"IdentityToken,omitempty"`
	// InfoRequestParameters flags for which pieces of info to return for the user.
	InfoRequestParameters *GetPlayerCombinedInfoRequestParamsModel `json:"InfoRequestParameters,omitempty"`
	// PlayerSecret player secret that is used to verify API request signatures (Enterprise Only).
	PlayerSecret string `json:"PlayerSecret,omitempty"`
	// TitleId unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
	// title has been selected.
	TitleId string `json:"TitleId,omitempty"`
}

type LoginWithCustomIDRequestModel struct {
	// CreateAccount automatically create a PlayFab account if one is not currently linked to this ID.
	CreateAccount bool `json:"CreateAccount"`
	// CustomId custom unique identifier for the user, generated by the title.
	CustomId string `json:"CustomId,omitempty"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// EncryptedRequest base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).
	EncryptedRequest string `json:"EncryptedRequest,omitempty"`
	// InfoRequestParameters flags for which pieces of info to return for the user.
	InfoRequestParameters *GetPlayerCombinedInfoRequestParamsModel `json:"InfoRequestParameters,omitempty"`
	// PlayerSecret player secret that is used to verify API request signatures (Enterprise Only).
	PlayerSecret string `json:"PlayerSecret,omitempty"`
	// TitleId unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
	// title has been selected.
	TitleId string `json:"TitleId,omitempty"`
}

type LoginWithEmailAddressRequestModel struct {
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// Email email address for the account.
	Email string `json:"Email,omitempty"`
	// InfoRequestParameters flags for which pieces of info to return for the user.
	InfoRequestParameters *GetPlayerCombinedInfoRequestParamsModel `json:"InfoRequestParameters,omitempty"`
	// Password password for the PlayFab account (6-100 characters)
	Password string `json:"Password,omitempty"`
	// TitleId unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
	// title has been selected.
	TitleId string `json:"TitleId,omitempty"`
}

type LoginWithFacebookInstantGamesIdRequestModel struct {
	// CreateAccount automatically create a PlayFab account if one is not currently linked to this ID.
	CreateAccount bool `json:"CreateAccount"`
	// CustomTags the optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
	CustomTags map[string]string `json:"CustomTags,omitempty"`
	// EncryptedRequest base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only).
	EncryptedRequest string `json:"EncryptedRequest,omitempty"`
	// FacebookInstantGamesSignature facebook Instant Games signature for the user.
	FacebookInstantGamesSignature string `json:"FacebookInstantGamesSignature,omitempty"`
	// InfoRequestParameters flags for which pieces of info to return for the user.
	InfoRequestParameters *GetPlayerCombinedInfoRequestParamsModel `json:"InfoRequestParameters,omitempty"`
	// PlayerSecret player secret that is used to verify API request signatures (Enterprise Only).
	PlayerSecret string `json:"PlayerSecret,omitempty"`
	// TitleId unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a
	// title has been selected.
	TitleId string `json:"TitleId,omitempty"`
}