server

type AdCampaignAttributionModel 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 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 AddCharacterVirtualCurrencyRequestModel struct {
	// Amount amount to be added to the character balance of the specified virtual currency. Maximum VC balance is Int32
	// (2,147,483,647). Any increase over this value will be discarded.
	Amount int32 `json:"Amount,omitempty"`
	// CharacterId unique PlayFab assigned ID for a specific character owned by a user
	CharacterId string `json:"CharacterId,omitempty"`
	// PlayFabId playFab unique identifier of the user whose virtual currency balance is to be incremented.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// VirtualCurrency name of the virtual currency which is to be incremented.
	VirtualCurrency string `json:"VirtualCurrency,omitempty"`
}

type AddFriendRequestModel struct {
	// FriendEmail email address of the user being added.
	FriendEmail string `json:"FriendEmail,omitempty"`
	// FriendPlayFabId the PlayFab identifier of the user being added.
	FriendPlayFabId string `json:"FriendPlayFabId,omitempty"`
	// FriendTitleDisplayName title-specific display name of the user to being added.
	FriendTitleDisplayName string `json:"FriendTitleDisplayName,omitempty"`
	// FriendUsername the PlayFab username of the user being added
	FriendUsername string `json:"FriendUsername,omitempty"`
	// PlayFabId playFab identifier of the player to add a new friend.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type AddGenericIDRequestModel struct {
	// GenericId generic service identifier to add to the player account.
	GenericId GenericServiceIdModel `json:"GenericId,omitempty"`
	// PlayFabId playFabId of the user to link.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type AddPlayerTagRequestModel struct {
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// TagName unique tag for player profile.
	TagName string `json:"TagName,omitempty"`
}

type AddPlayerTagResultModel 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. Maximum VC balance is Int32 (2,147,483,647).
	// Any increase over this value will be discarded.
	Amount int32 `json:"Amount,omitempty"`
	// PlayFabId playFab unique identifier of the user whose virtual currency balance is to be increased.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// VirtualCurrency name of the virtual currency which is to be incremented.
	VirtualCurrency string `json:"VirtualCurrency,omitempty"`
}

type AdvancedPushPlatformMsgModel struct {
	// Json the Json the platform should receive.
	Json string `json:"Json,omitempty"`
	// Platform the platform that should receive the Json.
	Platform PushNotificationPlatform `json:"Platform,omitempty"`
}

type AuthenticateSessionTicketRequestModel struct {
	// SessionTicket session ticket as issued by a PlayFab client login API.
	SessionTicket string `json:"SessionTicket,omitempty"`
}

type AuthenticateSessionTicketResultModel struct {
	// UserInfo account info for the user whose session ticket was supplied.
	UserInfo UserAccountInfoModel `json:"UserInfo,omitempty"`
}

type AwardSteamAchievementItemModel struct {
	// AchievementName unique Steam achievement name.
	AchievementName string `json:"AchievementName,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// Result result of the award attempt (only valid on response, not on request).
	Result bool `json:"Result,omitempty"`
}

type AwardSteamAchievementRequestModel struct {
	// Achievements array of achievements to grant and the users to whom they are to be granted.
	Achievements []AwardSteamAchievementItemModel `json:"Achievements,omitempty"`
}

type AwardSteamAchievementResultModel struct {
	// AchievementResults array of achievements granted.
	AchievementResults []AwardSteamAchievementItemModel `json:"AchievementResults,omitempty"`
}

type BanInfoModel struct {
	// Active the active state of this ban. Expired bans may still have this value set to true but they will have no effect.
	Active bool `json:"Active,omitempty"`
	// BanId the unique Ban Id associated with this ban.
	BanId string `json:"BanId,omitempty"`
	// Created the time when this ban was applied.
	Created time.Time `json:"Created,omitempty"`
	// Expires the time when this ban expires. Permanent bans do not have expiration date.
	Expires time.Time `json:"Expires,omitempty"`
	// IPAddress the IP address on which the ban was applied. May affect multiple players.
	IPAddress string `json:"IPAddress,omitempty"`
	// MACAddress the MAC address on which the ban was applied. May affect multiple players.
	MACAddress string `json:"MACAddress,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// Reason the reason why this ban was applied.
	Reason string `json:"Reason,omitempty"`
}

type BanRequestModel struct {
	// DurationInHours the duration in hours for the ban. Leave this blank for a permanent ban.
	DurationInHours uint32 `json:"DurationInHours,omitempty"`
	// IPAddress iP address to be banned. May affect multiple players.
	IPAddress string `json:"IPAddress,omitempty"`
	// MACAddress mAC address to be banned. May affect multiple players.
	MACAddress string `json:"MACAddress,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// Reason the reason for this ban. Maximum 140 characters.
	Reason string `json:"Reason,omitempty"`
}

type BanUsersRequestModel struct {
	// Bans list of ban requests to be applied. Maximum 100.
	Bans []BanRequestModel `json:"Bans,omitempty"`
}

type BanUsersResultModel struct {
	// BanData information on the bans that were applied
	BanData []BanInfoModel `json:"BanData,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,omitempty"`
	// 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,omitempty"`
	// 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,omitempty"`
	// IsTradable if true, then an item instance of this type can be traded between players using the trading APIs
	IsTradable bool `json:"IsTradable,omitempty"`
	// 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 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"`
	// ItemInstanceId unique instance identifier of the item to be consumed.
	ItemInstanceId string `json:"ItemInstanceId,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,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 ContactEmailInfoModel 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 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 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 DeleteCharacterFromUserRequestModel struct {
	// CharacterId unique PlayFab assigned ID for a specific character owned by a user
	CharacterId string `json:"CharacterId,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// SaveCharacterInventory if true, the character's inventory will be transferred up to the owning user; otherwise, this request will purge those
	// items.
	SaveCharacterInventory bool `json:"SaveCharacterInventory,omitempty"`
}

type DeleteCharacterFromUserResultModel struct {
}

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

type DeletePlayerResultModel struct {
}

type DeletePushNotificationTemplateRequestModel struct {
	// PushNotificationTemplateId id of the push notification template to be deleted.
	PushNotificationTemplateId string `json:"PushNotificationTemplateId,omitempty"`
}

type DeletePushNotificationTemplateResultModel struct {
}

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

type DeregisterGameRequestModel struct {
	// LobbyId unique identifier for the Game Server Instance that is being deregistered.
	LobbyId string `json:"LobbyId,omitempty"`
}

type DeregisterGameResponseModel struct {
}

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://api.playfab.com/docs/tutorials/entities/entitytypes
	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 EvaluateRandomResultTableRequestModel struct {
	// CatalogVersion specifies the catalog version that should be used to evaluate the Random Result Table. If unspecified, uses
	// default/primary catalog.
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// TableId the unique identifier of the Random Result Table to use.
	TableId string `json:"TableId,omitempty"`
}

type EvaluateRandomResultTableResultModel struct {
	// ResultItemId unique identifier for the item returned from the Random Result Table evaluation, for the given catalog.
	ResultItemId string `json:"ResultItemId,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,omitempty"`
	// 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,omitempty"`
	// 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 ExecuteCloudScriptServerRequestModel struct {
	// 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,omitempty"`
	// PlayFabId the unique user identifier for the player on whose behalf the script is being run
	PlayFabId string `json:"PlayFabId,omitempty"`
	// 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 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 GameInstanceState string

type GenericErrorCodes string

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 GetAllSegmentsRequestModel struct {
}

type GetAllSegmentsResultModel struct {
	// Segments array of segments for this title.
	Segments []GetSegmentResultModel `json:"Segments,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 assigned ID of the user on whom the operation will be performed.
	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"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,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"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,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"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,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.
	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"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type GetCharacterStatisticsResultModel struct {
	// CharacterId unique identifier of the character for the statistics.
	CharacterId string `json:"CharacterId,omitempty"`
	// CharacterStatistics character statistics for the requested user.
	CharacterStatistics map[string]int32 `json:"CharacterStatistics,omitempty"`
	// PlayFabId playFab unique identifier of the user whose character statistics are being returned.
	PlayFabId string `json:"PlayFabId,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,omitempty"`
}

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 GetFriendLeaderboardRequestModel struct {
	// IncludeFacebookFriends indicates whether Facebook friends should be included in the response. Default is true.
	IncludeFacebookFriends bool `json:"IncludeFacebookFriends,omitempty"`
	// IncludeSteamFriends indicates whether Steam service friends should be included in the response. Default is true.
	IncludeSteamFriends bool `json:"IncludeSteamFriends,omitempty"`
	// MaxResultsCount maximum number of entries to retrieve.
	MaxResultsCount int32 `json:"MaxResultsCount,omitempty"`
	// PlayFabId the player whose friend leaderboard to get
	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"`
	// 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 {
	// IncludeFacebookFriends indicates whether Facebook friends should be included in the response. Default is true.
	IncludeFacebookFriends bool `json:"IncludeFacebookFriends,omitempty"`
	// IncludeSteamFriends indicates whether Steam service friends should be included in the response. Default is true.
	IncludeSteamFriends bool `json:"IncludeSteamFriends,omitempty"`
	// PlayFabId playFab identifier of the player whose friend list to get.
	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"`
	// 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 owned by a user
	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.
	MaxResultsCount int32 `json:"MaxResultsCount,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,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 GetLeaderboardAroundUserRequestModel struct {
	// MaxResultsCount maximum number of entries to retrieve.
	MaxResultsCount int32 `json:"MaxResultsCount,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"`
	// StatisticName unique identifier for the title-specific statistic for the leaderboard.
	StatisticName string `json:"StatisticName,omitempty"`
	// Version the version of the leaderboard to get.
	Version int32 `json:"Version,omitempty"`
}

type GetLeaderboardAroundUserResultModel 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"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,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 {
	// MaxResultsCount maximum number of entries to retrieve.
	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 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"`
	// 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 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 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 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 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 {
	// 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
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type GetPlayerCombinedInfoRequestParamsModel struct {
	// GetCharacterInventories whether to get character inventories. Defaults to false.
	GetCharacterInventories bool `json:"GetCharacterInventories,omitempty"`
	// GetCharacterList whether to get the list of characters. Defaults to false.
	GetCharacterList bool `json:"GetCharacterList,omitempty"`
	// GetPlayerProfile whether to get player profile. Defaults to false. Has no effect for a new player.
	GetPlayerProfile bool `json:"GetPlayerProfile,omitempty"`
	// GetPlayerStatistics whether to get player statistics. Defaults to false.
	GetPlayerStatistics bool `json:"GetPlayerStatistics,omitempty"`
	// GetTitleData whether to get title data. Defaults to false.
	GetTitleData bool `json:"GetTitleData,omitempty"`
	// GetUserAccountInfo whether to get the player's account Info. Defaults to false
	GetUserAccountInfo bool `json:"GetUserAccountInfo,omitempty"`
	// GetUserData whether to get the player's custom data. Defaults to false
	GetUserData bool `json:"GetUserData,omitempty"`
	// GetUserInventory whether to get the player's inventory. Defaults to false
	GetUserInventory bool `json:"GetUserInventory,omitempty"`
	// GetUserReadOnlyData whether to get the player's read only data. Defaults to false
	GetUserReadOnlyData bool `json:"GetUserReadOnlyData,omitempty"`
	// GetUserVirtualCurrency whether to get the player's virtual currency balances. Defaults to false
	GetUserVirtualCurrency bool `json:"GetUserVirtualCurrency,omitempty"`
	// 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 {
	// 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 GetPlayerSegmentsResultModel struct {
	// Segments array of segments the requested player currently belongs to.
	Segments []GetSegmentResultModel `json:"Segments,omitempty"`
}

type GetPlayerStatisticVersionsRequestModel struct {
	// 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 {
	// PlayFabId user for whom statistics are being requested
	PlayFabId string `json:"PlayFabId,omitempty"`
	// StatisticNames statistics to return
	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 {
	// PlayFabId playFab unique identifier of the user whose statistics are being returned
	PlayFabId string `json:"PlayFabId,omitempty"`
	// Statistics user statistics for the requested user.
	Statistics []StatisticValueModel `json:"Statistics,omitempty"`
}

type GetPlayerTagsRequestModel struct {
	// 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 GetPlayersInSegmentRequestModel struct {
	// ContinuationToken continuation token if retrieving subsequent pages of results.
	ContinuationToken string `json:"ContinuationToken,omitempty"`
	// MaxBatchSize maximum number of profiles to load. Default is 1,000. Maximum is 10,000.
	MaxBatchSize uint32 `json:"MaxBatchSize,omitempty"`
	// SecondsToLive number of seconds to keep the continuation token active. After token expiration it is not possible to continue paging
	// results. Default is 300 (5 minutes). Maximum is 1,800 (30 minutes).
	SecondsToLive uint32 `json:"SecondsToLive,omitempty"`
	// SegmentId unique identifier for this segment.
	SegmentId string `json:"SegmentId,omitempty"`
}

type GetPlayersInSegmentResultModel struct {
	// ContinuationToken continuation token to use to retrieve subsequent pages of results. If token returns null there are no more results.
	ContinuationToken string `json:"ContinuationToken,omitempty"`
	// PlayerProfiles array of player profiles in this segment.
	PlayerProfiles []PlayerProfileModel `json:"PlayerProfiles,omitempty"`
	// ProfilesInSegment count of profiles matching this segment.
	ProfilesInSegment int32 `json:"ProfilesInSegment,omitempty"`
}

type GetPlayersSegmentsRequestModel struct {
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,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 GetRandomResultTablesRequestModel struct {
	// CatalogVersion specifies the catalog version that should be used to retrieve the Random Result Tables. If unspecified, uses
	// default/primary catalog.
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// TableIDs the unique identifier of the Random Result Table to use.
	TableIDs []string `json:"TableIDs,omitempty"`
}

type GetRandomResultTablesResultModel struct {
	// Tables array of random result tables currently available
	Tables map[string]RandomResultTableListingModel `json:"Tables,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 GetServerCustomIDsFromPlayFabIDsRequestModel struct {
	// PlayFabIDs array of unique PlayFab player identifiers for which the title needs to get server custom identifiers. Cannot contain
	// more than 25 identifiers.
	PlayFabIDs []string `json:"PlayFabIDs,omitempty"`
}

type GetServerCustomIDsFromPlayFabIDsResultModel struct {
	// Data mapping of server custom player identifiers to PlayFab identifiers.
	Data []ServerCustomIDPlayFabIDPairModel `json:"Data,omitempty"`
}

type GetSharedGroupDataRequestModel struct {
	// GetMembers if true, return the list of all members of the shared group.
	GetMembers bool `json:"GetMembers,omitempty"`
	// 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 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"`
}

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 localized news items.
	News []TitleNewsItemModel `json:"News,omitempty"`
}

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

type GetUserAccountInfoResultModel struct {
	// UserInfo account details for the user whose information was requested.
	UserInfo UserAccountInfoModel `json:"UserInfo,omitempty"`
}

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

type GetUserBansResultModel struct {
	// BanData information about the bans
	BanData []BanInfoModel `json:"BanData,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 specific keys to search for in the custom user data.
	Keys []string `json:"Keys,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	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"`
	// PlayFabId playFab unique identifier of the user whose custom data is being returned.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

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

type GetUserInventoryResultModel struct {
	// Inventory array of inventory items belonging to the user.
	Inventory []ItemInstanceModel `json:"Inventory,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,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 GrantCharacterToUserRequestModel struct {
	// CharacterName non-unique display name of the character being granted (1-20 characters in length).
	CharacterName string `json:"CharacterName,omitempty"`
	// CharacterType type of the character being granted; statistics can be sliced based on this value.
	CharacterType string `json:"CharacterType,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type GrantCharacterToUserResultModel struct {
	// CharacterId unique identifier tagged to this character.
	CharacterId string `json:"CharacterId,omitempty"`
}

type GrantItemsToCharacterRequestModel struct {
	// Annotation string detailing any additional information concerning this operation.
	Annotation string `json:"Annotation,omitempty"`
	// CatalogVersion catalog version from which items are to be granted.
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// CharacterId unique PlayFab assigned ID for a specific character owned by a user
	CharacterId string `json:"CharacterId,omitempty"`
	// ItemIds array of itemIds to grant to the user.
	ItemIds []string `json:"ItemIds,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type GrantItemsToCharacterResultModel struct {
	// ItemGrantResults array of items granted to users.
	ItemGrantResults []GrantedItemInstanceModel `json:"ItemGrantResults,omitempty"`
}

type GrantItemsToUserRequestModel struct {
	// Annotation string detailing any additional information concerning this operation.
	Annotation string `json:"Annotation,omitempty"`
	// CatalogVersion catalog version from which items are to be granted.
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// ItemIds array of itemIds to grant to the user.
	ItemIds []string `json:"ItemIds,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type GrantItemsToUserResultModel struct {
	// ItemGrantResults array of items granted to users.
	ItemGrantResults []GrantedItemInstanceModel `json:"ItemGrantResults,omitempty"`
}

type GrantItemsToUsersRequestModel struct {
	// CatalogVersion catalog version from which items are to be granted.
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// ItemGrants array of items to grant and the users to whom the items are to be granted.
	ItemGrants []ItemGrantModel `json:"ItemGrants,omitempty"`
}

type GrantItemsToUsersResultModel struct {
	// ItemGrantResults array of items granted to users.
	ItemGrantResults []GrantedItemInstanceModel `json:"ItemGrantResults,omitempty"`
}

type GrantedItemInstanceModel 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"`
	// CharacterId unique PlayFab assigned ID for a specific character owned by a user
	CharacterId string `json:"CharacterId,omitempty"`
	// CustomData a set of custom key-value pairs on the inventory item.
	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"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,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"`
	// Result result of this operation.
	Result bool `json:"Result,omitempty"`
	// UnitCurrency currency type for the cost of the catalog item.
	UnitCurrency string `json:"UnitCurrency,omitempty"`
	// UnitPrice cost of the catalog item in the given currency.
	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 ItemGrantModel struct {
	// Annotation string detailing any additional information concerning this operation.
	Annotation string `json:"Annotation,omitempty"`
	// CharacterId unique PlayFab assigned ID for a specific character owned by a user
	CharacterId string `json:"CharacterId,omitempty"`
	// Data key-value pairs to be written to the custom data. Note that keys are trimmed of whitespace, are limited in size, and may
	// not begin with a '!' character or be null.
	Data map[string]string `json:"Data,omitempty"`
	// ItemId unique identifier of the catalog item to be granted to the user.
	ItemId string `json:"ItemId,omitempty"`
	// KeysToRemove optional list of Data-keys to remove from UserData. Some SDKs cannot insert null-values into Data due to language
	// constraints. Use this to delete the keys directly.
	KeysToRemove []string `json:"KeysToRemove,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

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 inventory item.
	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.
	UnitCurrency string `json:"UnitCurrency,omitempty"`
	// UnitPrice cost of the catalog item in the given currency.
	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 LinkServerCustomIdRequestModel struct {
	// ForceLink if another user is already linked to the custom ID, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink,omitempty"`
	// PlayFabId unique PlayFab identifier.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// ServerCustomId unique server custom identifier for this player.
	ServerCustomId string `json:"ServerCustomId,omitempty"`
}

type LinkServerCustomIdResultModel struct {
}

type LinkXboxAccountRequestModel struct {
	// ForceLink if another user is already linked to the account, unlink the other user and re-link.
	ForceLink bool `json:"ForceLink,omitempty"`
	// PlayFabId unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// 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 LocalizedPushNotificationPropertiesModel struct {
	// Message message of the localized push notification template.
	Message string `json:"Message,omitempty"`
	// Subject subject of the localized push notification template.
	Subject string `json:"Subject,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 LoginWithServerCustomIdRequestModel struct {
	// CreateAccount automatically create a PlayFab account if one is not currently linked to this ID.
	CreateAccount bool `json:"CreateAccount,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"`
	// ServerCustomId the backend server identifier for this player.
	ServerCustomId string `json:"ServerCustomId,omitempty"`
}

type LoginWithXboxRequestModel struct {
	// CreateAccount automatically create a PlayFab account if one is not currently linked to this ID.
	CreateAccount bool `json:"CreateAccount,omitempty"`
	// InfoRequestParameters flags for which pieces of info to return for the user.
	InfoRequestParameters GetPlayerCombinedInfoRequestParamsModel `json:"InfoRequestParameters,omitempty"`
	// XboxToken token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com", "").
	XboxToken string `json:"XboxToken,omitempty"`
}

type MembershipModelModel struct {
	// IsActive whether this membership is active. That is, whether the MembershipExpiration time has been reached.
	IsActive bool `json:"IsActive,omitempty"`
	// MembershipExpiration the time this membership expires
	MembershipExpiration time.Time `json:"MembershipExpiration,omitempty"`
	// MembershipId the id of the membership
	MembershipId string `json:"MembershipId,omitempty"`
	// OverrideExpiration membership expirations can be explicitly overridden (via game manager or the admin api). If this membership has been
	// overridden, this will be the new expiration time.
	OverrideExpiration time.Time `json:"OverrideExpiration,omitempty"`
	// Subscriptions the list of subscriptions that this player has for this membership
	Subscriptions []SubscriptionModelModel `json:"Subscriptions,omitempty"`
}

type ModifyCharacterVirtualCurrencyResultModel struct {
	// Balance balance of the virtual currency after modification.
	Balance int32 `json:"Balance,omitempty"`
	// VirtualCurrency name of the virtual currency which was modified.
	VirtualCurrency string `json:"VirtualCurrency,omitempty"`
}

type ModifyItemUsesRequestModel struct {
	// ItemInstanceId unique instance identifier of the item to be modified.
	ItemInstanceId string `json:"ItemInstanceId,omitempty"`
	// PlayFabId playFab unique identifier of the user whose item is being modified.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// UsesToAdd number of uses to add to the item. Can be negative to remove uses.
	UsesToAdd int32 `json:"UsesToAdd,omitempty"`
}

type ModifyItemUsesResultModel 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 ModifyUserVirtualCurrencyResultModel struct {
	// Balance balance of the virtual currency after modification.
	Balance int32 `json:"Balance,omitempty"`
	// BalanceChange amount added or subtracted from the user's virtual currency. Maximum VC balance is Int32 (2,147,483,647). Any increase
	// over this value will be discarded.
	BalanceChange int32 `json:"BalanceChange,omitempty"`
	// PlayFabId user currency was subtracted from.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// VirtualCurrency name of the virtual currency which was modified.
	VirtualCurrency string `json:"VirtualCurrency,omitempty"`
}

type MoveItemToCharacterFromCharacterRequestModel struct {
	// GivingCharacterId unique identifier of the character that currently has the item.
	GivingCharacterId string `json:"GivingCharacterId,omitempty"`
	// ItemInstanceId unique PlayFab assigned instance identifier of the item
	ItemInstanceId string `json:"ItemInstanceId,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
	// ReceivingCharacterId unique identifier of the character that will be receiving the item.
	ReceivingCharacterId string `json:"ReceivingCharacterId,omitempty"`
}

type MoveItemToCharacterFromCharacterResultModel struct {
}

type MoveItemToCharacterFromUserRequestModel struct {
	// CharacterId unique PlayFab assigned ID for a specific character owned by a user
	CharacterId string `json:"CharacterId,omitempty"`
	// ItemInstanceId unique PlayFab assigned instance identifier of the item
	ItemInstanceId string `json:"ItemInstanceId,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type MoveItemToCharacterFromUserResultModel struct {
}

type MoveItemToUserFromCharacterRequestModel struct {
	// CharacterId unique PlayFab assigned ID for a specific character owned by a user
	CharacterId string `json:"CharacterId,omitempty"`
	// ItemInstanceId unique PlayFab assigned instance identifier of the item
	ItemInstanceId string `json:"ItemInstanceId,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type MoveItemToUserFromCharacterResultModel struct {
}

type NintendoSwitchPlayFabIdPairModel struct {
	// NintendoSwitchDeviceId unique Nintendo Switch Device identifier for a user.
	NintendoSwitchDeviceId string `json:"NintendoSwitchDeviceId,omitempty"`
	// PlayFabId unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Nintendo Switch Device identifier.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type NotifyMatchmakerPlayerLeftRequestModel struct {
	// LobbyId unique identifier of the Game Instance the user is leaving.
	LobbyId string `json:"LobbyId,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type NotifyMatchmakerPlayerLeftResultModel struct {
	// PlayerState state of user leaving the Game Server Instance.
	PlayerState PlayerConnectionState `json:"PlayerState,omitempty"`
}

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

type PlayerConnectionState string

type PlayerLeaderboardEntryModel struct {
	// 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"`
	// Profile the profile of the user, if requested.
	Profile PlayerProfileModelModel `json:"Profile,omitempty"`
	// StatValue specific value of the user's statistic.
	StatValue int32 `json:"StatValue,omitempty"`
}

type PlayerLinkedAccountModel struct {
	// Email linked account's email
	Email string `json:"Email,omitempty"`
	// Platform authentication platform
	Platform LoginIdentityProvider `json:"Platform,omitempty"`
	// PlatformUserId platform user identifier
	PlatformUserId string `json:"PlatformUserId,omitempty"`
	// Username linked account's username
	Username string `json:"Username,omitempty"`
}

type PlayerLocationModel struct {
	// City city of the player's geographic location.
	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 player's geographic location.
	Latitude float64 `json:"Latitude,omitempty"`
	// Longitude longitude coordinate of the player's geographic location.
	Longitude float64 `json:"Longitude,omitempty"`
}

type PlayerProfileModel struct {
	// AdCampaignAttributions array of ad campaigns player has been attributed to
	AdCampaignAttributions []AdCampaignAttributionModel `json:"AdCampaignAttributions,omitempty"`
	// AvatarUrl image URL of the player's avatar.
	AvatarUrl string `json:"AvatarUrl,omitempty"`
	// BannedUntil banned until UTC Date. If permanent ban this is set for 20 years after the original ban date.
	BannedUntil time.Time `json:"BannedUntil,omitempty"`
	// ContactEmailAddresses array of contact email addresses associated with the player
	ContactEmailAddresses []ContactEmailInfoModel `json:"ContactEmailAddresses,omitempty"`
	// Created player record created
	Created time.Time `json:"Created,omitempty"`
	// DisplayName player Display Name
	DisplayName string `json:"DisplayName,omitempty"`
	// LastLogin last login
	LastLogin time.Time `json:"LastLogin,omitempty"`
	// LinkedAccounts array of third party accounts linked to this player
	LinkedAccounts []PlayerLinkedAccountModel `json:"LinkedAccounts,omitempty"`
	// Locations dictionary of player's locations by type.
	Locations map[string]PlayerLocationModel `json:"Locations,omitempty"`
	// Origination player account origination
	Origination LoginIdentityProvider `json:"Origination,omitempty"`
	// PlayerId playFab Player ID
	PlayerId string `json:"PlayerId,omitempty"`
	// PlayerStatistics array of player statistics
	PlayerStatistics []PlayerStatisticModel `json:"PlayerStatistics,omitempty"`
	// PublisherId publisher this player belongs to
	PublisherId string `json:"PublisherId,omitempty"`
	// PushNotificationRegistrations array of configured push notification end points
	PushNotificationRegistrations []PushNotificationRegistrationModel `json:"PushNotificationRegistrations,omitempty"`
	// Statistics dictionary of player's statistics using only the latest version's value
	Statistics map[string]int32 `json:"Statistics,omitempty"`
	// Tags list of player's tags for segmentation.
	Tags []string `json:"Tags,omitempty"`
	// TitleId title ID this profile applies to
	TitleId string `json:"TitleId,omitempty"`
	// TotalValueToDateInUSD a sum of player's total purchases in USD across all currencies.
	TotalValueToDateInUSD uint32 `json:"TotalValueToDateInUSD,omitempty"`
	// ValuesToDate dictionary of player's total purchases by currency.
	ValuesToDate map[string]uint32 `json:"ValuesToDate,omitempty"`
	// VirtualCurrencyBalances dictionary of player's virtual currency balances
	VirtualCurrencyBalances map[string]int32 `json:"VirtualCurrencyBalances,omitempty"`
}

type PlayerProfileModelModel struct {
	// AdCampaignAttributions list of advertising campaigns the player has been attributed to
	AdCampaignAttributions []AdCampaignAttributionModelModel `json:"AdCampaignAttributions,omitempty"`
	// AvatarUrl uRL of the player's avatar image
	AvatarUrl string `json:"AvatarUrl,omitempty"`
	// BannedUntil if the player is currently banned, the UTC Date when the ban expires
	BannedUntil time.Time `json:"BannedUntil,omitempty"`
	// ContactEmailAddresses list of all contact email info associated with the player account
	ContactEmailAddresses []ContactEmailInfoModelModel `json:"ContactEmailAddresses,omitempty"`
	// Created player record created
	Created time.Time `json:"Created,omitempty"`
	// DisplayName player display name
	DisplayName string `json:"DisplayName,omitempty"`
	// LastLogin uTC time when the player most recently logged in to the title
	LastLogin time.Time `json:"LastLogin,omitempty"`
	// LinkedAccounts list of all authentication systems linked to this player account
	LinkedAccounts []LinkedPlatformAccountModelModel `json:"LinkedAccounts,omitempty"`
	// Locations list of geographic locations from which the player has logged in to the title
	Locations []LocationModelModel `json:"Locations,omitempty"`
	// Memberships list of memberships for the player, along with whether are expired.
	Memberships []MembershipModelModel `json:"Memberships,omitempty"`
	// Origination player account origination
	Origination LoginIdentityProvider `json:"Origination,omitempty"`
	// PlayerId playFab player account unique identifier
	PlayerId string `json:"PlayerId,omitempty"`
	// PublisherId publisher this player belongs to
	PublisherId string `json:"PublisherId,omitempty"`
	// PushNotificationRegistrations list of configured end points registered for sending the player push notifications
	PushNotificationRegistrations []PushNotificationRegistrationModelModel `json:"PushNotificationRegistrations,omitempty"`
	// Statistics list of leaderboard statistic values for the player
	Statistics []StatisticModelModel `json:"Statistics,omitempty"`
	// Tags list of player's tags for segmentation
	Tags []TagModelModel `json:"Tags,omitempty"`
	// TitleId title ID this player profile applies to
	TitleId string `json:"TitleId,omitempty"`
	// TotalValueToDateInUSD sum of the player's purchases made with real-money currencies, converted to US dollars equivalent and represented as a
	// whole number of cents (1/100 USD). For example, 999 indicates nine dollars and ninety-nine cents.
	TotalValueToDateInUSD uint32 `json:"TotalValueToDateInUSD,omitempty"`
	// ValuesToDate list of the player's lifetime purchase totals, summed by real-money currency
	ValuesToDate []ValueToDateModelModel `json:"ValuesToDate,omitempty"`
}

type PlayerProfileViewConstraintsModel struct {
	// ShowAvatarUrl whether to show player's avatar URL. Defaults to false
	ShowAvatarUrl bool `json:"ShowAvatarUrl,omitempty"`
	// ShowBannedUntil whether to show the banned until time. Defaults to false
	ShowBannedUntil bool `json:"ShowBannedUntil,omitempty"`
	// ShowCampaignAttributions whether to show campaign attributions. Defaults to false
	ShowCampaignAttributions bool `json:"ShowCampaignAttributions,omitempty"`
	// ShowContactEmailAddresses whether to show contact email addresses. Defaults to false
	ShowContactEmailAddresses bool `json:"ShowContactEmailAddresses,omitempty"`
	// ShowCreated whether to show the created date. Defaults to false
	ShowCreated bool `json:"ShowCreated,omitempty"`
	// ShowDisplayName whether to show the display name. Defaults to false
	ShowDisplayName bool `json:"ShowDisplayName,omitempty"`
	// ShowLastLogin whether to show the last login time. Defaults to false
	ShowLastLogin bool `json:"ShowLastLogin,omitempty"`
	// ShowLinkedAccounts whether to show the linked accounts. Defaults to false
	ShowLinkedAccounts bool `json:"ShowLinkedAccounts,omitempty"`
	// ShowLocations whether to show player's locations. Defaults to false
	ShowLocations bool `json:"ShowLocations,omitempty"`
	// ShowMemberships whether to show player's membership information. Defaults to false
	ShowMemberships bool `json:"ShowMemberships,omitempty"`
	// ShowOrigination whether to show origination. Defaults to false
	ShowOrigination bool `json:"ShowOrigination,omitempty"`
	// ShowPushNotificationRegistrations whether to show push notification registrations. Defaults to false
	ShowPushNotificationRegistrations bool `json:"ShowPushNotificationRegistrations,omitempty"`
	// ShowStatistics reserved for future development
	ShowStatistics bool `json:"ShowStatistics,omitempty"`
	// ShowTags whether to show tags. Defaults to false
	ShowTags bool `json:"ShowTags,omitempty"`
	// ShowTotalValueToDateInUsd whether to show the total value to date in usd. Defaults to false
	ShowTotalValueToDateInUsd bool `json:"ShowTotalValueToDateInUsd,omitempty"`
	// ShowValuesToDate whether to show the values to date. Defaults to false
	ShowValuesToDate bool `json:"ShowValuesToDate,omitempty"`
}

type PlayerStatisticModel struct {
	// Id statistic ID
	Id string `json:"Id,omitempty"`
	// Name statistic name
	Name string `json:"Name,omitempty"`
	// StatisticValue current statistic value
	StatisticValue int32 `json:"StatisticValue,omitempty"`
	// StatisticVersion statistic version (0 if not a versioned statistic)
	StatisticVersion int32 `json:"StatisticVersion,omitempty"`
}

type PlayerStatisticVersionModel struct {
	// ActivationTime time when the statistic version became active
	ActivationTime time.Time `json:"ActivationTime,omitempty"`
	// DeactivationTime time when the statistic version became inactive due to statistic version incrementing
	DeactivationTime time.Time `json:"DeactivationTime,omitempty"`
	// ScheduledActivationTime time at which the statistic version was scheduled to become active, based on the configured ResetInterval
	ScheduledActivationTime time.Time `json:"ScheduledActivationTime,omitempty"`
	// ScheduledDeactivationTime time at which the statistic version was scheduled to become inactive, based on the configured ResetInterval
	ScheduledDeactivationTime time.Time `json:"ScheduledDeactivationTime,omitempty"`
	// StatisticName name of the statistic when the version became active
	StatisticName string `json:"StatisticName,omitempty"`
	// Version version of the statistic
	Version uint32 `json:"Version,omitempty"`
}

type PushNotificationPackageModel struct {
	// Badge numerical badge to display on App icon (iOS only)
	Badge int32 `json:"Badge,omitempty"`
	// CustomData this must be a JSON formatted object. For use with developer-created custom Push Notification plugins
	CustomData string `json:"CustomData,omitempty"`
	// Icon icon file to display with the message (Not supported for iOS)
	Icon string `json:"Icon,omitempty"`
	// Message content of the message (all platforms)
	Message string `json:"Message,omitempty"`
	// Sound sound file to play with the message (all platforms)
	Sound string `json:"Sound,omitempty"`
	// Title title/Subject of the message. Not supported for iOS
	Title string `json:"Title,omitempty"`
}

type PushNotificationPlatform string

type PushNotificationRegistrationModel struct {
	// NotificationEndpointARN notification configured endpoint
	NotificationEndpointARN string `json:"NotificationEndpointARN,omitempty"`
	// Platform push notification platform
	Platform PushNotificationPlatform `json:"Platform,omitempty"`
}

type PushNotificationRegistrationModelModel struct {
	// NotificationEndpointARN notification configured endpoint
	NotificationEndpointARN string `json:"NotificationEndpointARN,omitempty"`
	// Platform push notification platform
	Platform PushNotificationPlatform `json:"Platform,omitempty"`
}

type RandomResultTableListingModel struct {
	// CatalogVersion catalog version this table is associated with
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// Nodes child nodes that indicate what kind of drop table item this actually is.
	Nodes []ResultTableNodeModel `json:"Nodes,omitempty"`
	// TableId unique name for this drop table
	TableId string `json:"TableId,omitempty"`
}

type RedeemCouponRequestModel struct {
	// CatalogVersion catalog version of the coupon.
	CatalogVersion string `json:"CatalogVersion,omitempty"`
	// CharacterId optional identifier for the Character that should receive the item. If null, item is added to the player
	CharacterId string `json:"CharacterId,omitempty"`
	// CouponCode generated coupon code to redeem.
	CouponCode string `json:"CouponCode,omitempty"`
	// PlayFabId unique PlayFab assigned ID of the user on whom the operation will be performed.
	PlayFabId string `json:"PlayFabId,omitempty"`
}

type RedeemCouponResultModel struct {
	// GrantedItems items granted to the player as a result of redeeming the coupon.
	GrantedItems []ItemInstanceModel `json:"GrantedItems,omitempty"`
}