diff --git a/PlayFabSdk/package.json b/PlayFabSdk/package.json index 836ce5af..817f859b 100644 --- a/PlayFabSdk/package.json +++ b/PlayFabSdk/package.json @@ -1,6 +1,6 @@ { "name": "playfab-web-sdk", - "version": "1.178.240816", + "version": "1.222.260922", "description": "Playfab SDK for JS client applications", "license": "Apache-2.0", "repository": { diff --git a/PlayFabSdk/src/PlayFab/PlayFabAddonApi.js b/PlayFabSdk/src/PlayFab/PlayFabAddonApi.js index e3a39cfa..24cba57f 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabAddonApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabAddonApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -241,6 +241,10 @@ PlayFab.AddonApi = { PlayFab._internalSettings.entityToken = null; }, + ConfigurePSNEventStreams: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/ConfigurePSNEventStreams", request, "X-EntityToken", callback, customData, extraHeaders); + }, + CreateOrUpdateApple: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/CreateOrUpdateApple", request, "X-EntityToken", callback, customData, extraHeaders); }, @@ -273,6 +277,10 @@ PlayFab.AddonApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/CreateOrUpdateSteam", request, "X-EntityToken", callback, customData, extraHeaders); }, + CreateOrUpdateToxMod: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/CreateOrUpdateToxMod", request, "X-EntityToken", callback, customData, extraHeaders); + }, + CreateOrUpdateTwitch: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/CreateOrUpdateTwitch", request, "X-EntityToken", callback, customData, extraHeaders); }, @@ -309,6 +317,10 @@ PlayFab.AddonApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/DeleteSteam", request, "X-EntityToken", callback, customData, extraHeaders); }, + DeleteToxMod: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/DeleteToxMod", request, "X-EntityToken", callback, customData, extraHeaders); + }, + DeleteTwitch: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/DeleteTwitch", request, "X-EntityToken", callback, customData, extraHeaders); }, @@ -345,6 +357,10 @@ PlayFab.AddonApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/GetSteam", request, "X-EntityToken", callback, customData, extraHeaders); }, + GetToxMod: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/GetToxMod", request, "X-EntityToken", callback, customData, extraHeaders); + }, + GetTwitch: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/GetTwitch", request, "X-EntityToken", callback, customData, extraHeaders); }, diff --git a/PlayFabSdk/src/PlayFab/PlayFabAdminApi.js b/PlayFabSdk/src/PlayFab/PlayFabAdminApi.js index 51f0bbe8..b543d7be 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabAdminApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabAdminApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -285,6 +285,10 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/CreateInsightsScheduledScalingTask", request, "X-SecretKey", callback, customData, extraHeaders); }, + CreateIPBan: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/CreateIPBan", request, "X-SecretKey", callback, customData, extraHeaders); + }, + CreateOpenIdConnection: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/CreateOpenIdConnection", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -325,6 +329,10 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/DeletePlayer", request, "X-SecretKey", callback, customData, extraHeaders); }, + DeletePlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/DeletePlayerCustomProperties", request, "X-SecretKey", callback, customData, extraHeaders); + }, + DeletePlayerSharedSecret: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/DeletePlayerSharedSecret", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -393,10 +401,22 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetDataReport", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetIPBansForIP: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetIPBansForIP", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + GetIPBansForTitle: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetIPBansForTitle", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetPlayedTitleList: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetPlayedTitleList", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetPlayerCustomProperty: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetPlayerCustomProperty", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetPlayerIdFromAuthToken: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetPlayerIdFromAuthToken", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -413,10 +433,6 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetPlayerSharedSecrets", request, "X-SecretKey", callback, customData, extraHeaders); }, - GetPlayersInSegment: function (request, callback, customData, extraHeaders) { - return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetPlayersInSegment", request, "X-SecretKey", callback, customData, extraHeaders); - }, - GetPlayerStatisticDefinitions: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetPlayerStatisticDefinitions", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -445,6 +461,10 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetSegmentExport", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetSegmentPlayerCount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetSegmentPlayerCount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetSegments: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetSegments", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -521,6 +541,10 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/ListOpenIdConnection", request, "X-SecretKey", callback, customData, extraHeaders); }, + ListPlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/ListPlayerCustomProperties", request, "X-SecretKey", callback, customData, extraHeaders); + }, + ListVirtualCurrencyTypes: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/ListVirtualCurrencyTypes", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -569,6 +593,10 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/RevokeInventoryItems", request, "X-SecretKey", callback, customData, extraHeaders); }, + RevokeIPBan: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/RevokeIPBan", request, "X-SecretKey", callback, customData, extraHeaders); + }, + RunTask: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/RunTask", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -633,10 +661,18 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/UpdateCloudScript", request, "X-SecretKey", callback, customData, extraHeaders); }, + UpdateIPBan: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/UpdateIPBan", request, "X-SecretKey", callback, customData, extraHeaders); + }, + UpdateOpenIdConnection: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/UpdateOpenIdConnection", request, "X-SecretKey", callback, customData, extraHeaders); }, + UpdatePlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/UpdatePlayerCustomProperties", request, "X-SecretKey", callback, customData, extraHeaders); + }, + UpdatePlayerSharedSecret: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/UpdatePlayerSharedSecret", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -693,6 +729,10 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/UpdateUserTitleDisplayName", request, "X-SecretKey", callback, customData, extraHeaders); }, + ValidateApiPolicy: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/ValidateApiPolicy", request, "X-SecretKey", callback, customData, extraHeaders); + }, + }; var PlayFabAdminSDK = PlayFab.AdminApi; diff --git a/PlayFabSdk/src/PlayFab/PlayFabAuthenticationApi.js b/PlayFabSdk/src/PlayFab/PlayFabAuthenticationApi.js index 218ca150..8ac1c155 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabAuthenticationApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabAuthenticationApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabSdk/src/PlayFab/PlayFabClientApi.js b/PlayFabSdk/src/PlayFab/PlayFabClientApi.js index 9ee11d86..f66af485 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabClientApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabClientApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -313,6 +313,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/CreateSharedGroup", request, "X-Authorization", callback, customData, extraHeaders); }, + DeletePlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/DeletePlayerCustomProperties", request, "X-Authorization", callback, customData, extraHeaders); + }, + ExecuteCloudScript: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/ExecuteCloudScript", request, "X-Authorization", callback, customData, extraHeaders); }, @@ -397,6 +401,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayerCombinedInfo", request, "X-Authorization", callback, customData, extraHeaders); }, + GetPlayerCustomProperty: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayerCustomProperty", request, "X-Authorization", callback, customData, extraHeaders); + }, + GetPlayerProfile: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayerProfile", request, "X-Authorization", callback, customData, extraHeaders); }, @@ -421,6 +429,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayerTrades", request, "X-Authorization", callback, customData, extraHeaders); }, + GetPlayFabIDsFromBattleNetAccountIds: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromBattleNetAccountIds", request, "X-Authorization", callback, customData, extraHeaders); + }, + GetPlayFabIDsFromFacebookIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromFacebookIDs", request, "X-Authorization", callback, customData, extraHeaders); }, @@ -457,6 +469,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromNintendoSwitchDeviceIds", request, "X-Authorization", callback, customData, extraHeaders); }, + GetPlayFabIDsFromOpenIdSubjectIdentifiers: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromOpenIdSubjectIdentifiers", request, "X-Authorization", callback, customData, extraHeaders); + }, + GetPlayFabIDsFromPSNAccountIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromPSNAccountIDs", request, "X-Authorization", callback, customData, extraHeaders); }, @@ -469,6 +485,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromSteamIDs", request, "X-Authorization", callback, customData, extraHeaders); }, + GetPlayFabIDsFromSteamNames: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromSteamNames", request, "X-Authorization", callback, customData, extraHeaders); + }, + GetPlayFabIDsFromTwitchIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromTwitchIDs", request, "X-Authorization", callback, customData, extraHeaders); }, @@ -545,6 +565,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/LinkApple", request, "X-Authorization", callback, customData, extraHeaders); }, + LinkBattleNetAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/LinkBattleNetAccount", request, "X-Authorization", callback, customData, extraHeaders); + }, + LinkCustomID: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/LinkCustomID", request, "X-Authorization", callback, customData, extraHeaders); }, @@ -605,6 +629,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/LinkXboxAccount", request, "X-Authorization", callback, customData, extraHeaders); }, + ListPlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/ListPlayerCustomProperties", request, "X-Authorization", callback, customData, extraHeaders); + }, + LoginWithAndroidDeviceID: function (request, callback, customData, extraHeaders) { request.TitleId = PlayFab.settings.titleId ? PlayFab.settings.titleId : request.TitleId; if (!request.TitleId) throw PlayFab._internalSettings.errorTitleId; // PlayFab._internalSettings.authenticationContext can be modified by other asynchronous login attempts @@ -653,6 +681,30 @@ PlayFab.ClientApi = { return new Promise(function(resolve){resolve(authenticationContext);}); }, + LoginWithBattleNet: function (request, callback, customData, extraHeaders) { + request.TitleId = PlayFab.settings.titleId ? PlayFab.settings.titleId : request.TitleId; if (!request.TitleId) throw PlayFab._internalSettings.errorTitleId; + // PlayFab._internalSettings.authenticationContext can be modified by other asynchronous login attempts + // Deep-copy the authenticationContext here to safely update it + var authenticationContext = JSON.parse(JSON.stringify(PlayFab._internalSettings.authenticationContext)); + var overloadCallback = function (result, error) { + if (result != null) { + if(result.data.SessionTicket != null) { + PlayFab._internalSettings.sessionTicket = result.data.SessionTicket; + } + if (result.data.EntityToken != null) { + PlayFab._internalSettings.entityToken = result.data.EntityToken.EntityToken; + } + // Apply the updates for the AuthenticationContext returned to the client + authenticationContext = PlayFab._internalSettings.UpdateAuthenticationContext(authenticationContext, result); + } + if (callback != null && typeof (callback) === "function") + callback(result, error); + }; + PlayFab._internalSettings.ExecuteRequestWrapper("/Client/LoginWithBattleNet", request, null, overloadCallback, customData, extraHeaders); + // Return a Promise so that multiple asynchronous calls to this method can be handled simultaneously with Promise.all() + return new Promise(function(resolve){resolve(authenticationContext);}); + }, + LoginWithCustomID: function (request, callback, customData, extraHeaders) { request.TitleId = PlayFab.settings.titleId ? PlayFab.settings.titleId : request.TitleId; if (!request.TitleId) throw PlayFab._internalSettings.errorTitleId; // PlayFab._internalSettings.authenticationContext can be modified by other asynchronous login attempts @@ -1171,6 +1223,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/UnlinkApple", request, "X-Authorization", callback, customData, extraHeaders); }, + UnlinkBattleNetAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/UnlinkBattleNetAccount", request, "X-Authorization", callback, customData, extraHeaders); + }, + UnlinkCustomID: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/UnlinkCustomID", request, "X-Authorization", callback, customData, extraHeaders); }, @@ -1251,6 +1307,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/UpdateCharacterStatistics", request, "X-Authorization", callback, customData, extraHeaders); }, + UpdatePlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/UpdatePlayerCustomProperties", request, "X-Authorization", callback, customData, extraHeaders); + }, + UpdatePlayerStatistics: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/UpdatePlayerStatistics", request, "X-Authorization", callback, customData, extraHeaders); }, diff --git a/PlayFabSdk/src/PlayFab/PlayFabCloudScriptApi.js b/PlayFabSdk/src/PlayFab/PlayFabCloudScriptApi.js index b70fcb4a..17c11b0f 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabCloudScriptApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabCloudScriptApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabSdk/src/PlayFab/PlayFabDataApi.js b/PlayFabSdk/src/PlayFab/PlayFabDataApi.js index bce8b796..49e60dfc 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabDataApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabDataApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabSdk/src/PlayFab/PlayFabEconomyApi.js b/PlayFabSdk/src/PlayFab/PlayFabEconomyApi.js index 46d5f780..013d5ea7 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabEconomyApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabEconomyApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -337,10 +337,6 @@ PlayFab.EconomyApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Catalog/GetItems", request, "X-EntityToken", callback, customData, extraHeaders); }, - GetMicrosoftStoreAccessTokens: function (request, callback, customData, extraHeaders) { - return PlayFab._internalSettings.ExecuteRequestWrapper("/Inventory/GetMicrosoftStoreAccessTokens", request, "X-EntityToken", callback, customData, extraHeaders); - }, - GetTransactionHistory: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Inventory/GetTransactionHistory", request, "X-EntityToken", callback, customData, extraHeaders); }, @@ -357,6 +353,10 @@ PlayFab.EconomyApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Inventory/RedeemAppleAppStoreInventoryItems", request, "X-EntityToken", callback, customData, extraHeaders); }, + RedeemAppleAppStoreWithJwsInventoryItems: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Inventory/RedeemAppleAppStoreWithJwsInventoryItems", request, "X-EntityToken", callback, customData, extraHeaders); + }, + RedeemGooglePlayInventoryItems: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Inventory/RedeemGooglePlayInventoryItems", request, "X-EntityToken", callback, customData, extraHeaders); }, diff --git a/PlayFabSdk/src/PlayFab/PlayFabEventsApi.js b/PlayFabSdk/src/PlayFab/PlayFabEventsApi.js index 22bceb71..c8ed22b3 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabEventsApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabEventsApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -245,18 +245,38 @@ PlayFab.EventsApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/CreateTelemetryKey", request, "X-EntityToken", callback, customData, extraHeaders); }, + DeleteDataConnection: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/DeleteDataConnection", request, "X-EntityToken", callback, customData, extraHeaders); + }, + DeleteTelemetryKey: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/DeleteTelemetryKey", request, "X-EntityToken", callback, customData, extraHeaders); }, + GetDataConnection: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/GetDataConnection", request, "X-EntityToken", callback, customData, extraHeaders); + }, + GetTelemetryKey: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/GetTelemetryKey", request, "X-EntityToken", callback, customData, extraHeaders); }, + ListDataConnections: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/ListDataConnections", request, "X-EntityToken", callback, customData, extraHeaders); + }, + ListTelemetryKeys: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/ListTelemetryKeys", request, "X-EntityToken", callback, customData, extraHeaders); }, + SetDataConnection: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/SetDataConnection", request, "X-EntityToken", callback, customData, extraHeaders); + }, + + SetDataConnectionActive: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/SetDataConnectionActive", request, "X-EntityToken", callback, customData, extraHeaders); + }, + SetTelemetryKeyActive: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/SetTelemetryKeyActive", request, "X-EntityToken", callback, customData, extraHeaders); }, diff --git a/PlayFabSdk/src/PlayFab/PlayFabExperimentationApi.js b/PlayFabSdk/src/PlayFab/PlayFabExperimentationApi.js index 17e4f297..06fe7806 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabExperimentationApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabExperimentationApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabSdk/src/PlayFab/PlayFabGroupsApi.js b/PlayFabSdk/src/PlayFab/PlayFabGroupsApi.js index 4d43ec4b..5ff17e41 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabGroupsApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabGroupsApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabSdk/src/PlayFab/PlayFabInsightsApi.js b/PlayFabSdk/src/PlayFab/PlayFabInsightsApi.js index 5656202b..4751a9f5 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabInsightsApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabInsightsApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabSdk/src/PlayFab/PlayFabLocalizationApi.js b/PlayFabSdk/src/PlayFab/PlayFabLocalizationApi.js index fa497963..f2b8672f 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabLocalizationApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabLocalizationApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabSdk/src/PlayFab/PlayFabMatchmakerApi.js b/PlayFabSdk/src/PlayFab/PlayFabMatchmakerApi.js deleted file mode 100644 index 3698e8f7..00000000 --- a/PlayFabSdk/src/PlayFab/PlayFabMatchmakerApi.js +++ /dev/null @@ -1,247 +0,0 @@ -/// - -var PlayFab = typeof PlayFab != "undefined" ? PlayFab : {}; - -if(!PlayFab.settings) { - PlayFab.settings = { - titleId: null, // You must set this value for PlayFabSdk to work properly (Found in the Game Manager for your title, at the PlayFab Website) - developerSecretKey: null, // For security reasons you must never expose this value to the client or players - You must set this value for Server-APIs to work properly (Found in the Game Manager for your title, at the PlayFab Website) - GlobalHeaderInjection: null, - productionServerUrl: ".playfabapi.com" - } -} - -if(!PlayFab._internalSettings) { - PlayFab._internalSettings = { - entityToken: null, - sdkVersion: "1.178.240816", - requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" - }, - sessionTicket: null, - verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this - errorTitleId: "Must be have PlayFab.settings.titleId set to call this method", - errorLoggedIn: "Must be logged in to call this method", - errorEntityToken: "You must successfully call GetEntityToken before calling this", - errorSecretKey: "Must have PlayFab.settings.developerSecretKey set to call this method", - - GetServerUrl: function () { - if (!(PlayFab.settings.productionServerUrl.substring(0, 4) === "http")) { - if (PlayFab._internalSettings.verticalName) { - return "https://" + PlayFab._internalSettings.verticalName + PlayFab.settings.productionServerUrl; - } else { - return "https://" + PlayFab.settings.titleId + PlayFab.settings.productionServerUrl; - } - } else { - return PlayFab.settings.productionServerUrl; - } - }, - - InjectHeaders: function (xhr, headersObj) { - if (!headersObj) - return; - - for (var headerKey in headersObj) - { - try { - xhr.setRequestHeader(gHeaderKey, headersObj[headerKey]); - } catch (e) { - console.log("Failed to append header: " + headerKey + " = " + headersObj[headerKey] + "Error: " + e); - } - } - }, - - ExecuteRequest: function (url, request, authkey, authValue, callback, customData, extraHeaders) { - var resultPromise = new Promise(function (resolve, reject) { - if (callback != null && typeof (callback) !== "function") - throw "Callback must be null or a function"; - - if (request == null) - request = {}; - - var startTime = new Date(); - var requestBody = JSON.stringify(request); - - var urlArr = [url]; - var getParams = PlayFab._internalSettings.requestGetParams; - if (getParams != null) { - var firstParam = true; - for (var key in getParams) { - if (firstParam) { - urlArr.push("?"); - firstParam = false; - } else { - urlArr.push("&"); - } - urlArr.push(key); - urlArr.push("="); - urlArr.push(getParams[key]); - } - } - - var completeUrl = urlArr.join(""); - - var xhr = new XMLHttpRequest(); - // window.console.log("URL: " + completeUrl); - xhr.open("POST", completeUrl, true); - - xhr.setRequestHeader("Content-Type", "application/json"); - xhr.setRequestHeader("X-PlayFabSDK", "JavaScriptSDK-" + PlayFab._internalSettings.sdkVersion); - if (authkey != null) - xhr.setRequestHeader(authkey, authValue); - PlayFab._internalSettings.InjectHeaders(xhr, PlayFab.settings.GlobalHeaderInjection); - PlayFab._internalSettings.InjectHeaders(xhr, extraHeaders); - - xhr.onloadend = function () { - if (callback == null) - return; - - var result = PlayFab._internalSettings.GetPlayFabResponse(request, xhr, startTime, customData); - if (result.code === 200) { - callback(result, null); - } else { - callback(null, result); - } - } - - xhr.onerror = function () { - if (callback == null) - return; - - var result = PlayFab._internalSettings.GetPlayFabResponse(request, xhr, startTime, customData); - callback(null, result); - } - - xhr.send(requestBody); - xhr.onreadystatechange = function () { - if (this.readyState === 4) { - var xhrResult = PlayFab._internalSettings.GetPlayFabResponse(request, this, startTime, customData); - if (this.status === 200) { - resolve(xhrResult); - } else { - reject(xhrResult); - } - } - }; - }); - // Return a Promise so that calls to various API methods can be handled asynchronously - return resultPromise; - }, - - GetPlayFabResponse: function(request, xhr, startTime, customData) { - var result = null; - try { - // window.console.log("parsing json result: " + xhr.responseText); - result = JSON.parse(xhr.responseText); - } catch (e) { - result = { - code: 503, // Service Unavailable - status: "Service Unavailable", - error: "Connection error", - errorCode: 2, // PlayFabErrorCode.ConnectionError - errorMessage: xhr.responseText - }; - } - - result.CallBackTimeMS = new Date() - startTime; - result.Request = request; - result.CustomData = customData; - return result; - }, - - authenticationContext: { - PlayFabId: null, - EntityId: null, - EntityType: null, - SessionTicket: null, - EntityToken: null - }, - - UpdateAuthenticationContext: function (authenticationContext, result) { - var authenticationContextUpdates = {}; - if(result.data.PlayFabId !== null) { - PlayFab._internalSettings.authenticationContext.PlayFabId = result.data.PlayFabId; - authenticationContextUpdates.PlayFabId = result.data.PlayFabId; - } - if(result.data.SessionTicket !== null) { - PlayFab._internalSettings.authenticationContext.SessionTicket = result.data.SessionTicket; - authenticationContextUpdates.SessionTicket = result.data.SessionTicket; - } - if (result.data.EntityToken !== null) { - PlayFab._internalSettings.authenticationContext.EntityId = result.data.EntityToken.Entity.Id; - authenticationContextUpdates.EntityId = result.data.EntityToken.Entity.Id; - PlayFab._internalSettings.authenticationContext.EntityType = result.data.EntityToken.Entity.Type; - authenticationContextUpdates.EntityType = result.data.EntityToken.Entity.Type; - PlayFab._internalSettings.authenticationContext.EntityToken = result.data.EntityToken.EntityToken; - authenticationContextUpdates.EntityToken = result.data.EntityToken.EntityToken; - } - // Update the authenticationContext with values from the result - authenticationContext = Object.assign(authenticationContext, authenticationContextUpdates); - return authenticationContext; - }, - - AuthInfoMap: { - "X-EntityToken": { - authAttr: "entityToken", - authError: "errorEntityToken" - }, - "X-Authorization": { - authAttr: "sessionTicket", - authError: "errorLoggedIn" - }, - "X-SecretKey": { - authAttr: "developerSecretKey", - authError: "errorSecretKey" - } - }, - - GetAuthInfo: function (request, authKey) { - // Use the most-recently saved authKey, unless one was provided in the request via the AuthenticationContext - var authError = PlayFab._internalSettings.AuthInfoMap[authKey].authError; - var authAttr = PlayFab._internalSettings.AuthInfoMap[authKey].authAttr; - var defaultAuthValue = null; - if (authAttr === "entityToken") - defaultAuthValue = PlayFab._internalSettings.entityToken; - else if (authAttr === "sessionTicket") - defaultAuthValue = PlayFab._internalSettings.sessionTicket; - else if (authAttr === "developerSecretKey") - defaultAuthValue = PlayFab.settings.developerSecretKey; - var authValue = request.AuthenticationContext ? request.AuthenticationContext[authAttr] : defaultAuthValue; - return {"authKey": authKey, "authValue": authValue, "authError": authError}; - }, - - ExecuteRequestWrapper: function (apiURL, request, authKey, callback, customData, extraHeaders) { - var authValue = null; - if (authKey !== null){ - var authInfo = PlayFab._internalSettings.GetAuthInfo(request, authKey=authKey); - var authKey = authInfo.authKey, authValue = authInfo.authValue, authError = authInfo.authError; - - if (!authValue) throw authError; - } - return PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + apiURL, request, authKey, authValue, callback, customData, extraHeaders); - } - } -} - -PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; -PlayFab.GenerateErrorReport = function (error) { - if (error == null) - return ""; - var fullErrors = error.errorMessage; - for (var paramName in error.errorDetails) - for (var msgIdx in error.errorDetails[paramName]) - fullErrors += "\n" + paramName + ": " + error.errorDetails[paramName][msgIdx]; - return fullErrors; -}; - -PlayFab.MatchmakerApi = { - ForgetAllCredentials: function () { - PlayFab._internalSettings.sessionTicket = null; - PlayFab._internalSettings.entityToken = null; - }, - -}; - -var PlayFabMatchmakerSDK = PlayFab.MatchmakerApi; - diff --git a/PlayFabSdk/src/PlayFab/PlayFabMultiplayerApi.js b/PlayFabSdk/src/PlayFab/PlayFabMultiplayerApi.js index d6bb7c48..d92785ef 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabMultiplayerApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabMultiplayerApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabSdk/src/PlayFab/PlayFabProfilesApi.js b/PlayFabSdk/src/PlayFab/PlayFabProfilesApi.js index 1ef06b3c..5a1ec15d 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabProfilesApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabProfilesApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -261,6 +261,10 @@ PlayFab.ProfilesApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Profile/GetTitlePlayersFromXboxLiveIDs", request, "X-EntityToken", callback, customData, extraHeaders); }, + SetDisplayName: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Profile/SetDisplayName", request, "X-EntityToken", callback, customData, extraHeaders); + }, + SetGlobalPolicy: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Profile/SetGlobalPolicy", request, "X-EntityToken", callback, customData, extraHeaders); }, diff --git a/PlayFabSdk/src/PlayFab/PlayFabProgressionApi.js b/PlayFabSdk/src/PlayFab/PlayFabProgressionApi.js index 3005ed79..479bc913 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabProgressionApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabProgressionApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -289,10 +289,6 @@ PlayFab.ProgressionApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Statistic/GetStatisticDefinition", request, "X-EntityToken", callback, customData, extraHeaders); }, - GetStatisticDefinitions: function (request, callback, customData, extraHeaders) { - return PlayFab._internalSettings.ExecuteRequestWrapper("/Statistic/GetStatisticDefinitions", request, "X-EntityToken", callback, customData, extraHeaders); - }, - GetStatistics: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Statistic/GetStatistics", request, "X-EntityToken", callback, customData, extraHeaders); }, @@ -317,14 +313,26 @@ PlayFab.ProgressionApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Statistic/ListStatisticDefinitions", request, "X-EntityToken", callback, customData, extraHeaders); }, + UnlinkAggregationSourceFromStatistic: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Statistic/UnlinkAggregationSourceFromStatistic", request, "X-EntityToken", callback, customData, extraHeaders); + }, + UnlinkLeaderboardFromStatistic: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Leaderboard/UnlinkLeaderboardFromStatistic", request, "X-EntityToken", callback, customData, extraHeaders); }, + UpdateLeaderboardDefinition: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Leaderboard/UpdateLeaderboardDefinition", request, "X-EntityToken", callback, customData, extraHeaders); + }, + UpdateLeaderboardEntries: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Leaderboard/UpdateLeaderboardEntries", request, "X-EntityToken", callback, customData, extraHeaders); }, + UpdateStatisticDefinition: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Statistic/UpdateStatisticDefinition", request, "X-EntityToken", callback, customData, extraHeaders); + }, + UpdateStatistics: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Statistic/UpdateStatistics", request, "X-EntityToken", callback, customData, extraHeaders); }, diff --git a/PlayFabSdk/src/PlayFab/PlayFabServerApi.js b/PlayFabSdk/src/PlayFab/PlayFabServerApi.js index d38e393d..a0f01589 100644 --- a/PlayFabSdk/src/PlayFab/PlayFabServerApi.js +++ b/PlayFabSdk/src/PlayFab/PlayFabServerApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -253,6 +253,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/AddGenericID", request, "X-SecretKey", callback, customData, extraHeaders); }, + AddOrUpdateContactEmail: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/AddOrUpdateContactEmail", request, "X-SecretKey", callback, customData, extraHeaders); + }, + AddPlayerTag: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/AddPlayerTag", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -293,6 +297,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/DeletePlayer", request, "X-SecretKey", callback, customData, extraHeaders); }, + DeletePlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/DeletePlayerCustomProperties", request, "X-SecretKey", callback, customData, extraHeaders); + }, + DeletePushNotificationTemplate: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/DeletePushNotificationTemplate", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -309,6 +317,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/ExecuteCloudScript", request, "X-SecretKey", callback, customData, extraHeaders); }, + ExportPlayersInSegment: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/ExportPlayersInSegment", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetAllSegments: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetAllSegments", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -377,6 +389,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayerCombinedInfo", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetPlayerCustomProperty: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayerCustomProperty", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetPlayerProfile: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayerProfile", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -385,10 +401,6 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayerSegments", request, "X-SecretKey", callback, customData, extraHeaders); }, - GetPlayersInSegment: function (request, callback, customData, extraHeaders) { - return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayersInSegment", request, "X-SecretKey", callback, customData, extraHeaders); - }, - GetPlayerStatistics: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayerStatistics", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -401,6 +413,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayerTags", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetPlayFabIDsFromBattleNetAccountIds: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromBattleNetAccountIds", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetPlayFabIDsFromFacebookIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromFacebookIDs", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -421,6 +437,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromNintendoSwitchDeviceIds", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetPlayFabIDsFromOpenIdSubjectIdentifiers: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromOpenIdSubjectIdentifiers", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetPlayFabIDsFromPSNAccountIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromPSNAccountIDs", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -429,10 +449,18 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromPSNOnlineIDs", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetPlayFabIDsFromServerCustomIDs: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromServerCustomIDs", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetPlayFabIDsFromSteamIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromSteamIDs", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetPlayFabIDsFromSteamNames: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromSteamNames", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetPlayFabIDsFromTwitchIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromTwitchIDs", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -449,6 +477,14 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetRandomResultTables", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetSegmentExport: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetSegmentExport", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + GetSegmentPlayerCount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetSegmentPlayerCount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetServerCustomIDsFromPlayFabIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetServerCustomIDsFromPlayFabIDs", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -529,6 +565,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GrantItemsToUsers", request, "X-SecretKey", callback, customData, extraHeaders); }, + LinkBattleNetAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LinkBattleNetAccount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + LinkNintendoServiceAccount: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LinkNintendoServiceAccount", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -557,10 +597,38 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LinkSteamId", request, "X-SecretKey", callback, customData, extraHeaders); }, + LinkTwitchAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LinkTwitchAccount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + LinkXboxAccount: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LinkXboxAccount", request, "X-SecretKey", callback, customData, extraHeaders); }, + LinkXboxId: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LinkXboxId", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + ListPlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/ListPlayerCustomProperties", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + LoginWithAndroidDeviceID: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithAndroidDeviceID", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + LoginWithBattleNet: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithBattleNet", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + LoginWithCustomID: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithCustomID", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + LoginWithIOSDeviceID: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithIOSDeviceID", request, "X-SecretKey", callback, customData, extraHeaders); + }, + LoginWithPSN: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithPSN", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -573,6 +641,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithSteamId", request, "X-SecretKey", callback, customData, extraHeaders); }, + LoginWithTwitch: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithTwitch", request, "X-SecretKey", callback, customData, extraHeaders); + }, + LoginWithXbox: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithXbox", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -685,6 +757,26 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/SubtractUserVirtualCurrency", request, "X-SecretKey", callback, customData, extraHeaders); }, + UnlinkApple: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkApple", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + UnlinkBattleNetAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkBattleNetAccount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + UnlinkFacebookAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkFacebookAccount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + UnlinkFacebookInstantGamesId: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkFacebookInstantGamesId", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + UnlinkGameCenterAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkGameCenterAccount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + UnlinkNintendoServiceAccount: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkNintendoServiceAccount", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -705,6 +797,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkSteamId", request, "X-SecretKey", callback, customData, extraHeaders); }, + UnlinkTwitchAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkTwitchAccount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + UnlinkXboxAccount: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkXboxAccount", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -741,6 +837,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UpdateCharacterStatistics", request, "X-SecretKey", callback, customData, extraHeaders); }, + UpdatePlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UpdatePlayerCustomProperties", request, "X-SecretKey", callback, customData, extraHeaders); + }, + UpdatePlayerStatistics: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UpdatePlayerStatistics", request, "X-SecretKey", callback, customData, extraHeaders); }, diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabAddonApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabAddonApi.d.ts index 3ad358a5..6ec1a36a 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabAddonApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabAddonApi.d.ts @@ -4,139 +4,159 @@ declare module PlayFabAddonModule { export interface IPlayFabAddon { ForgetAllCredentials(): void; + /** + * Configures PSN event streams for an existing PSN addon on a title, without requiring a full addon upsert. + * https://docs.microsoft.com/rest/api/playfab/addon/addon/configurepsneventstreams + */ + ConfigurePSNEventStreams(request: PlayFabAddonModels.ConfigurePSNEventStreamsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Apple addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdateapple + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdateapple */ CreateOrUpdateApple(request: PlayFabAddonModels.CreateOrUpdateAppleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Facebook addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdatefacebook + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatefacebook */ CreateOrUpdateFacebook(request: PlayFabAddonModels.CreateOrUpdateFacebookRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Facebook Instant Games addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdatefacebookinstantgames + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatefacebookinstantgames */ CreateOrUpdateFacebookInstantGames(request: PlayFabAddonModels.CreateOrUpdateFacebookInstantGamesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Google addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdategoogle + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdategoogle */ CreateOrUpdateGoogle(request: PlayFabAddonModels.CreateOrUpdateGoogleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Kongregate addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdatekongregate + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatekongregate */ CreateOrUpdateKongregate(request: PlayFabAddonModels.CreateOrUpdateKongregateRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Nintendo addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdatenintendo + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatenintendo */ CreateOrUpdateNintendo(request: PlayFabAddonModels.CreateOrUpdateNintendoRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the PSN addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdatepsn + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatepsn */ CreateOrUpdatePSN(request: PlayFabAddonModels.CreateOrUpdatePSNRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Steam addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdatesteam + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatesteam */ CreateOrUpdateSteam(request: PlayFabAddonModels.CreateOrUpdateSteamRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Creates the ToxMod addon on a title, or updates it if it already exists. + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatetoxmod + */ + CreateOrUpdateToxMod(request: PlayFabAddonModels.CreateOrUpdateToxModRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Twitch addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdatetwitch + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatetwitch */ CreateOrUpdateTwitch(request: PlayFabAddonModels.CreateOrUpdateTwitchRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Apple addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deleteapple + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deleteapple */ DeleteApple(request: PlayFabAddonModels.DeleteAppleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Facebook addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletefacebook + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebook */ DeleteFacebook(request: PlayFabAddonModels.DeleteFacebookRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Facebook addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletefacebookinstantgames + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebookinstantgames */ DeleteFacebookInstantGames(request: PlayFabAddonModels.DeleteFacebookInstantGamesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Google addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletegoogle + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletegoogle */ DeleteGoogle(request: PlayFabAddonModels.DeleteGoogleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Kongregate addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletekongregate + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletekongregate */ DeleteKongregate(request: PlayFabAddonModels.DeleteKongregateRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Nintendo addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletenintendo + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletenintendo */ DeleteNintendo(request: PlayFabAddonModels.DeleteNintendoRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the PSN addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletepsn + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletepsn */ DeletePSN(request: PlayFabAddonModels.DeletePSNRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Steam addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletesteam + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletesteam */ DeleteSteam(request: PlayFabAddonModels.DeleteSteamRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Deletes the ToxMod addon on a title. + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetoxmod + */ + DeleteToxMod(request: PlayFabAddonModels.DeleteToxModRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Twitch addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletetwitch + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetwitch */ DeleteTwitch(request: PlayFabAddonModels.DeleteTwitchRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Apple addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getapple + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getapple */ GetApple(request: PlayFabAddonModels.GetAppleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Facebook addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getfacebook + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebook */ GetFacebook(request: PlayFabAddonModels.GetFacebookRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Facebook Instant Games addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getfacebookinstantgames + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebookinstantgames */ GetFacebookInstantGames(request: PlayFabAddonModels.GetFacebookInstantGamesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Google addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getgoogle + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getgoogle */ GetGoogle(request: PlayFabAddonModels.GetGoogleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Kongregate addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getkongregate + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getkongregate */ GetKongregate(request: PlayFabAddonModels.GetKongregateRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Nintendo addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getnintendo + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getnintendo */ GetNintendo(request: PlayFabAddonModels.GetNintendoRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the PSN addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getpsn + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getpsn */ GetPSN(request: PlayFabAddonModels.GetPSNRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Steam addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getsteam + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getsteam */ GetSteam(request: PlayFabAddonModels.GetSteamRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Gets information of the ToxMod addon on a title, omits secrets. + * https://docs.microsoft.com/rest/api/playfab/addon/addon/gettoxmod + */ + GetToxMod(request: PlayFabAddonModels.GetToxModRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Twitch addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/gettwitch + * https://docs.microsoft.com/rest/api/playfab/addon/addon/gettwitch */ GetTwitch(request: PlayFabAddonModels.GetTwitchRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -144,9 +164,29 @@ declare module PlayFabAddonModule { } declare module PlayFabAddonModels { + export interface ConfigurePSNEventStreamsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ + Entity?: EntityKey; + /** Title name obtained after setting a back server for PS5. Used for clawback event listeners. */ + TitleName?: string; + + } + + export interface ConfigurePSNEventStreamsResponse extends PlayFabModule.IPlayFabResultCommon { + + } + export interface CreateOrUpdateAppleRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Allow validation of receipts from the Apple production environment. Required for app releases. */ + AllowProduction?: boolean; + /** Allow validation of receipts from the Apple sandbox environment. Typically used while testing. */ + AllowSandbox?: boolean; /** iOS App Bundle ID obtained after setting up your app in the App Store. */ AppBundleId: string; + /** AppId obtained after setting up your app in the App Store. */ + AppId?: string; /** iOS App Shared Secret obtained after setting up your app in the App Store. */ AppSharedSecret?: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ @@ -160,6 +200,12 @@ declare module PlayFabAddonModels { * case where Apple rotates their signing keys. */ IgnoreExpirationDate?: boolean; + /** IssuerId obtained after setting up your app in the App Store. */ + IssuerId?: string; + /** KeyId obtained after setting up your app in the App Store. */ + KeyId?: string; + /** PrivateKey obtained after setting up your app in the App Store. */ + PrivateKey?: string; /** Require secure authentication only for this app. */ RequireSecureAuthentication?: boolean; @@ -234,6 +280,12 @@ declare module PlayFabAddonModels { * Required if using Google Authentication. */ OAuthClientSecret?: string; + /** + * Authorized Redirect Uri obtained through the Google Developer Console. This currently defaults to + * https://oauth.playfab.com/oauth2/google. If you are authenticating players via browser, please update this to your own + * domain. + */ + OAuthCustomRedirectUri?: string; /** Needed to enable pending purchase handling and subscription processing. */ ServiceAccountKey?: string; @@ -270,6 +322,8 @@ declare module PlayFabAddonModels { Environments?: NintendoEnvironment[]; /** If an error should be returned if the addon already exists. */ ErrorIfExists?: boolean; + /** List of Nintendo Subscription Environments, currently supporting up to 4. Needs Catalog enabled. */ + SubscriptionEnvironments?: NintendoEnvironment[]; } @@ -327,6 +381,26 @@ declare module PlayFabAddonModels { } + export interface CreateOrUpdateToxModRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Account ID obtained after creating your ToxMod developer account. */ + AccountId: string; + /** Account Key obtained after creating your ToxMod developer account. */ + AccountKey: string; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Whether ToxMod Addon is Enabled by Title. */ + Enabled: boolean; + /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ + Entity?: EntityKey; + /** If an error should be returned if the addon already exists. */ + ErrorIfExists?: boolean; + + } + + export interface CreateOrUpdateToxModResponse extends PlayFabModule.IPlayFabResultCommon { + + } + export interface CreateOrUpdateTwitchRequest extends PlayFabModule.IPlayFabRequestCommon { /** Client ID obtained after creating your Twitch developer account. */ ClientID?: string; @@ -441,6 +515,18 @@ declare module PlayFabAddonModels { } + export interface DeleteToxModRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ + Entity?: EntityKey; + + } + + export interface DeleteToxModResponse extends PlayFabModule.IPlayFabResultCommon { + + } + export interface DeleteTwitchRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -536,6 +622,12 @@ declare module PlayFabAddonModels { * Required if using Google Authentication. */ OAuthClientID?: string; + /** + * Authorized Redirect Uri obtained through the Google Developer Console. This currently defaults to + * https://oauth.playfab.com/oauth2/google. If you are authenticating players via browser, please update this to your own + * domain. + */ + OauthCustomRedirectUri?: string; } @@ -568,6 +660,10 @@ declare module PlayFabAddonModels { Created: boolean; /** List of Nintendo Environments, currently supporting up to 4. */ Environments?: NintendoEnvironment[]; + /** List of Nintendo Subscription Environments associated to a secondary AppId, currently supporting up to 4. */ + SecondarySubscriptionEnvironments?: NintendoEnvironment[]; + /** List of Nintendo Subscription Environments, currently supporting up to 4. */ + SubscriptionEnvironments?: NintendoEnvironment[]; } @@ -612,6 +708,26 @@ declare module PlayFabAddonModels { } + export interface GetToxModRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ + Entity?: EntityKey; + + } + + export interface GetToxModResponse extends PlayFabModule.IPlayFabResultCommon { + /** Account ID obtained after creating your Twitch developer account. */ + AccountId?: string; + /** Account Key obtained after creating your Twitch developer account. */ + AccountKey?: string; + /** Addon status. */ + Created: boolean; + /** Whether the ToxMod Addon is enabled by the title. */ + Enabled: boolean; + + } + export interface GetTwitchRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabAdminApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabAdminApi.d.ts index f4905f32..46869cef 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabAdminApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabAdminApi.d.ts @@ -38,7 +38,7 @@ declare module PlayFabAdminModule { */ AddVirtualCurrencyTypes(request: PlayFabAdminModels.AddVirtualCurrencyTypesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** - * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game. + * Bans users by PlayFab ID with optional IP address for the provided game. * https://docs.microsoft.com/rest/api/playfab/admin/account-management/banusers */ BanUsers(request: PlayFabAdminModels.BanUsersRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -63,6 +63,11 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createinsightsscheduledscalingtask */ CreateInsightsScheduledScalingTask(request: PlayFabAdminModels.CreateInsightsScheduledScalingTaskRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Bans an IP address or CIDR range for a title. + * https://docs.microsoft.com/rest/api/playfab/admin/account-management/createipban + */ + CreateIPBan(request: PlayFabAdminModels.CreateIPBanRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Registers a relationship between a title and an Open ID Connect provider. * https://docs.microsoft.com/rest/api/playfab/admin/authentication/createopenidconnection @@ -116,6 +121,11 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/account-management/deleteplayer */ DeletePlayer(request: PlayFabAdminModels.DeletePlayerRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Deletes title-specific custom properties for a player + * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/deleteplayercustomproperties + */ + DeletePlayerCustomProperties(request: PlayFabAdminModels.DeletePlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes an existing Player Shared Secret Key. It may take up to 5 minutes for this delete to be reflected after this API * returns. @@ -167,7 +177,8 @@ declare module PlayFabAdminModule { GetActionsOnPlayersInSegmentTaskInstance(request: PlayFabAdminModels.GetTaskInstanceRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as - * GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change. + * ExportPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not + * change. * https://docs.microsoft.com/rest/api/playfab/admin/playstream/getallsegments */ GetAllSegments(request: PlayFabAdminModels.GetAllSegmentsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -210,11 +221,26 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getdatareport */ GetDataReport(request: PlayFabAdminModels.GetDataReportRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Gets all IP bans that apply to a specific IP address. + * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getipbansforip + */ + GetIPBansForIP(request: PlayFabAdminModels.GetIPBanRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Gets all IP bans for a title. + * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getipbansfortitle + */ + GetIPBansForTitle(request: PlayFabAdminModels.GetAllIPBansRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Get the list of titles that the player has played * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayedtitlelist */ GetPlayedTitleList(request: PlayFabAdminModels.GetPlayedTitleListRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves a title-specific custom property value for a player. + * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayercustomproperty + */ + GetPlayerCustomProperty(request: PlayFabAdminModels.GetPlayerCustomPropertyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets a player's ID from an auth token. * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayeridfromauthtoken @@ -235,15 +261,6 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/authentication/getplayersharedsecrets */ GetPlayerSharedSecrets(request: PlayFabAdminModels.GetPlayerSharedSecretsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; - /** - * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match - * the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span - * on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected - * in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being - * called 30 times in one minute. You will be returned an error if you exceed this threshold. - * https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersinsegment - */ - GetPlayersInSegment(request: PlayFabAdminModels.GetPlayersInSegmentRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have * a reset interval. @@ -284,6 +301,11 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/playstream/getsegmentexport */ GetSegmentExport(request: PlayFabAdminModels.GetPlayersInSegmentExportRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Returns the total number of players in a given segment. + * https://docs.microsoft.com/rest/api/playfab/admin/playstream/getsegmentplayercount + */ + GetSegmentPlayerCount(request: PlayFabAdminModels.GetSegmentPlayerCountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Get detail information of a segment and its associated definition(s) and action(s) for a title. * https://docs.microsoft.com/rest/api/playfab/admin/segments/getsegments @@ -383,6 +405,11 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/authentication/listopenidconnection */ ListOpenIdConnection(request: PlayFabAdminModels.ListOpenIdConnectionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves title-specific custom property values for a player. + * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/listplayercustomproperties + */ + ListPlayerCustomProperties(request: PlayFabAdminModels.ListPlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for * version 2._ Retuns the list of all defined virtual currencies for the title @@ -449,6 +476,11 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitems */ RevokeInventoryItems(request: PlayFabAdminModels.RevokeInventoryItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Revokes an active IP ban. + * https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokeipban + */ + RevokeIPBan(request: PlayFabAdminModels.RevokeIPBanRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Run a task immediately regardless of its schedule. * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/runtask @@ -542,11 +574,21 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/updatecloudscript */ UpdateCloudScript(request: PlayFabAdminModels.UpdateCloudScriptRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Updates an existing IP ban. + * https://docs.microsoft.com/rest/api/playfab/admin/account-management/updateipban + */ + UpdateIPBan(request: PlayFabAdminModels.UpdateIPBanRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Modifies data and credentials for an existing relationship between a title and an Open ID Connect provider * https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateopenidconnection */ UpdateOpenIdConnection(request: PlayFabAdminModels.UpdateOpenIdConnectionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Updates the title-specific custom property values for a player + * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayercustomproperties + */ + UpdatePlayerCustomProperties(request: PlayFabAdminModels.UpdatePlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Updates a existing Player Shared Secret Key. It may take up to 5 minutes for this update to become generally available * after this API returns. @@ -620,6 +662,11 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/account-management/updateusertitledisplayname */ UpdateUserTitleDisplayName(request: PlayFabAdminModels.UpdateUserTitleDisplayNameRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Validates the result of a policy update without persisting it. + * https://docs.microsoft.com/rest/api/playfab/admin/authentication/validateapipolicy + */ + ValidateApiPolicy(request: PlayFabAdminModels.ValidateApiPolicyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; } } @@ -697,16 +744,6 @@ declare module PlayFabAdminModels { } - export interface AdCampaignAttribution { - /** UTC time stamp of attribution */ - AttributedAt: string; - /** Attribution campaign identifier */ - CampaignId?: string; - /** Attribution network name */ - Platform?: string; - - } - export interface AdCampaignAttributionModel { /** UTC time stamp of attribution */ AttributedAt: string; @@ -778,6 +815,8 @@ declare module PlayFabAdminModels { Body: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; + /** Optional status for the new news item. If not set, defaults to Published. */ + Status?: string; /** Time this news was published. If not set, defaults to now. */ Timestamp?: string; /** Default title (headline) of the news item. */ @@ -857,7 +896,7 @@ declare module PlayFabAdminModels { PlayFabId?: string; /** The reason why this ban was applied. */ Reason?: string; - /** The family type of the suer that is included in the ban. */ + /** The family type of the user that is included in the ban. */ UserFamilyType?: string; } @@ -1100,16 +1139,6 @@ declare module PlayFabAdminModels { | "True" | "False"; - export interface ContactEmailInfo { - /** The email address */ - EmailAddress?: string; - /** The name of the email info data */ - Name?: string; - /** The verification status of the email */ - VerificationStatus?: string; - - } - export interface ContactEmailInfoModel { /** The email address */ EmailAddress?: string; @@ -1440,6 +1469,27 @@ declare module PlayFabAdminModels { } + export interface CreateIPBanRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** + * The UTC date and time when the IP ban expires. Leave this blank for a permanent ban. Must be later than the current time + * and no more than 100 years in the future. + */ + Expires?: string; + /** The IP address to be banned. */ + IPAddress: string; + /** The reason for the IP ban. Maximum 140 characters. */ + Reason?: string; + + } + + export interface CreateIPBanResult extends PlayFabModule.IPlayFabResultCommon { + /** Information on the ban that was created */ + IPBanData?: IPBanInfo; + + } + export interface CreateOpenIdConnectionRequest extends PlayFabModule.IPlayFabRequestCommon { /** The client ID given by the ID provider. */ ClientId: string; @@ -1677,12 +1727,68 @@ declare module PlayFabAdminModels { | "ZMW" | "ZWD"; + export interface CustomPropertyBooleanSegmentFilter { + /** Custom property comparison. */ + Comparison?: string; + /** Custom property name. */ + PropertyName?: string; + /** Custom property boolean value. */ + PropertyValue: boolean; + + } + + export interface CustomPropertyDateTimeSegmentFilter { + /** Custom property comparison. */ + Comparison?: string; + /** Custom property name. */ + PropertyName?: string; + /** Custom property datetime value. */ + PropertyValue: string; + + } + + export interface CustomPropertyDetails { + /** The custom property's name. */ + Name?: string; + /** The custom property's value. */ + Value?: any; + + } + + export interface CustomPropertyNumericSegmentFilter { + /** Custom property comparison. */ + Comparison?: string; + /** Custom property name. */ + PropertyName?: string; + /** Custom property numeric value. */ + PropertyValue: number; + + } + + export interface CustomPropertyStringSegmentFilter { + /** Custom property comparison. */ + Comparison?: string; + /** Custom property name. */ + PropertyName?: string; + /** Custom property string value. */ + PropertyValue?: string; + + } + export interface DeleteContentRequest extends PlayFabModule.IPlayFabRequestCommon { /** Key of the content item to be deleted */ Key: string; } + export interface DeletedPropertyDetails { + /** The name of the property which was requested to be deleted. */ + Name?: string; + /** Indicates whether or not the property was deleted. If false, no property with that name existed. */ + WasDeleted: boolean; + + } + export interface DeleteInventoryItemsV2SegmentAction { /** The collection id for where the item will be removed from the player inventory */ CollectionId?: string; @@ -1758,6 +1864,34 @@ declare module PlayFabAdminModels { } + export interface DeletePlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** + * Optional field used for concurrency control. One can ensure that the delete operation will only be performed if the + * player's properties have not been updated by any other clients since the last version. + */ + ExpectedPropertiesVersion?: number; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + /** A list of property names denoting which properties should be deleted. */ + PropertyNames: string[]; + + } + + export interface DeletePlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** The list of properties requested to be deleted. */ + DeletedProperties?: DeletedPropertyDetails[]; + /** PlayFab unique identifier of the user whose properties were deleted. */ + PlayFabId?: string; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface DeletePlayerRequest extends PlayFabModule.IPlayFabRequestCommon { /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId: string; @@ -2097,7 +2231,6 @@ declare module PlayFabAdminModels { | "UnableToConnectToDatabase" | "InternalServerError" | "InvalidReportDate" - | "ReportNotAvailable" | "DatabaseThroughputExceeded" | "InvalidGameTicket" | "ExpiredGameTicket" @@ -2473,7 +2606,6 @@ declare module PlayFabAdminModels { | "InsightsManagementGetOperationStatusInvalidParameter" | "DuplicatePurchaseTransactionId" | "EvaluationModePlayerCountExceeded" - | "GetPlayersInSegmentRateLimitExceeded" | "CloudScriptFunctionNameSizeExceeded" | "PaidInsightsFeaturesNotEnabled" | "CloudScriptAzureFunctionsQueueRequestError" @@ -2571,9 +2703,34 @@ declare module PlayFabAdminModels { | "MultipleLinkedStatisticsNotAllowed" | "DuplicateLinkedStatisticColumnNameFound" | "AggregationTypeNotAllowedForMultiColumnStatistic" - | "MaxQueryableVerionsValueNotAllowedForTier" + | "MaxQueryableVersionsValueNotAllowedForTier" | "StatisticDefinitionHasNullOrEmptyVersionConfiguration" | "StatisticColumnLengthMismatch" + | "InvalidExternalEntityId" + | "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" + | "TransactionAlreadyApplied" + | "ReportDataNotRetrievedSuccessfully" + | "ResetIntervalCannotBeModified" + | "VersionIncrementRateExceeded" + | "InvalidSteamUsername" + | "InvalidVersionResetForLinkedLeaderboard" + | "BattleNetNotEnabledForTitle" + | "ReportNotProcessed" + | "DataNotAvailable" + | "InvalidReportName" + | "ResourceNotModified" + | "StudioCreationLimitExceeded" + | "StudioDeletionInitiated" + | "ProductDisabledForTitle" + | "PreconditionFailed" + | "CannotEnableAnonymousPlayerCreation" + | "ParentCustomerAccountNotFound" + | "AccountLinkedToABannedPlayer" + | "AzureSubscriptionNotEligibleForLinking" + | "EntityIsNotAMember" + | "IPAddressNotFound" + | "PSNNextGenNotConfiguredForTitle" + | "InvalidNintendoIssuer" | "MatchmakingEntityInvalid" | "MatchmakingPlayerAttributesInvalid" | "MatchmakingQueueNotFound" @@ -2618,6 +2775,7 @@ declare module PlayFabAdminModels { | "CatalogBadRequest" | "CatalogTooManyRequests" | "InvalidCatalogItemConfiguration" + | "LegacyEconomyDisabled" | "ExportInvalidStatusUpdate" | "ExportInvalidPrefix" | "ExportBlobContainerDoesNotExist" @@ -2688,6 +2846,10 @@ declare module PlayFabAdminModels { | "ExperimentationExclusionGroupCannotDelete" | "ExperimentationExclusionGroupInvalidTrafficAllocation" | "ExperimentationExclusionGroupInvalidName" + | "ExperimentationLegacyExperimentInvalidOperation" + | "ExperimentationExperimentStopFailed" + | "ExperimentationExperimentDeleteFailed" + | "ExperimentationExperimentStartFailed" | "MaxActionDepthExceeded" | "TitleNotOnUpdatedPricingPlan" | "SegmentManagementTitleNotInFlight" @@ -2705,8 +2867,11 @@ declare module PlayFabAdminModels { | "AsyncExportNotFound" | "AsyncExportRateLimitExceeded" | "AnalyticsSegmentCountOverLimit" + | "GetSegmentPlayerCountNotInFlight" + | "GetSegmentPlayerCountRateLimitExceeded" | "SnapshotNotFound" | "InventoryApiNotImplemented" + | "InventoryCollectionDeletionDisallowed" | "LobbyDoesNotExist" | "LobbyRateLimitExceeded" | "LobbyPlayerAlreadyJoined" @@ -2752,6 +2917,13 @@ declare module PlayFabAdminModels { | "EventSinkInsufficientRoleAssignment" | "EventSinkContainerNotFound" | "EventSinkTenantIdInvalid" + | "EventSinkResourceMisconfigured" + | "EventSinkAccessDenied" + | "EventSinkWriteConflict" + | "EventSinkResourceNotFound" + | "EventSinkResourceFeatureNotSupported" + | "EventSinkBucketNameInvalid" + | "EventSinkResourceUnavailable" | "OperationCanceled" | "InvalidDisplayNameRandomSuffixLength" | "AllowNonUniquePlayerDisplayNamesDisableNotAllowed" @@ -2772,8 +2944,6 @@ declare module PlayFabAdminModels { | "PlayerCustomPropertiesPropertyDoesNotExist" | "AddonAlreadyExists" | "AddonDoesntExist" - | "CopilotDisabled" - | "CopilotInvalidRequest" | "TrueSkillUnauthorized" | "TrueSkillInvalidTitleId" | "TrueSkillInvalidScenarioId" @@ -2840,6 +3010,11 @@ declare module PlayFabAdminModels { | "TrueSkillInvalidPlayerId" | "TrueSkillInvalidSquadSize" | "TrueSkillConditionSetNotInModel" + | "TrueSkillModelStateInvalidForOperation" + | "TrueSkillScenarioContainsActiveModel" + | "TrueSkillInvalidConditionRank" + | "TrueSkillTotalScenarioLimitExceeded" + | "TrueSkillInvalidConditionsList" | "GameSaveManifestNotFound" | "GameSaveManifestVersionAlreadyExists" | "GameSaveConflictUpdatingManifest" @@ -2849,6 +3024,33 @@ declare module PlayFabAdminModels { | "GameSaveUnknownFileInManifest" | "GameSaveFileExceededReportedSize" | "GameSaveFileNotUploaded" + | "GameSaveBadRequest" + | "GameSaveOperationNotAllowed" + | "GameSaveDataStorageQuotaExceeded" + | "GameSaveNewerManifestExists" + | "GameSaveBaseVersionNotAvailable" + | "GameSaveManifestVersionQuarantined" + | "GameSaveManifestUploadProgressUpdateNotAllowed" + | "GameSaveNotFinalizedManifestNotEligibleAsKnownGood" + | "GameSaveNoUpdatesRequested" + | "GameSaveTitleDoesNotExist" + | "GameSaveOperationNotAllowedForTitle" + | "GameSaveManifestFilesLimitExceeded" + | "GameSaveManifestDescriptionUpdateNotAllowed" + | "GameSaveTitleConfigNotFound" + | "GameSaveTitleAlreadyOnboarded" + | "GameSaveServiceNotEnabledForTitle" + | "GameSaveServiceOnboardingPending" + | "GameSaveManifestNotEligibleAsConflictingVersion" + | "GameSaveServiceUnavailable" + | "GameSaveConflict" + | "GameSaveManifestNotEligibleForRollback" + | "GameSaveTitleClientAnonymousAccountCreationNotDisabled" + | "GameSaveTitleConfigNoUpdatesRequested" + | "GameSavePlayerNotEligibleForTransfer" + | "GameSaveAlreadyAutoRolledBack" + | "GameSaveManifestNotEligibleForRestore" + | "GameSaveManifestArchived" | "StateShareForbidden" | "StateShareTitleNotInFlight" | "StateShareStateNotFound" @@ -2856,7 +3058,28 @@ declare module PlayFabAdminModels { | "StateShareStateRedemptionLimitExceeded" | "StateShareStateRedemptionLimitNotUpdated" | "StateShareCreatedStatesLimitExceeded" - | "StateShareIdMissingOrMalformed"; + | "StateShareIdMissingOrMalformed" + | "PlayerCreationDisabled" + | "AccountAlreadyExists" + | "TagInvalid" + | "TagTooLong" + | "StatisticColumnAggregationMismatch" + | "StatisticResetIntervalMismatch" + | "VersionConfigurationCannotBeSpecifiedForLinkedStat" + | "VersionConfigurationIsRequired" + | "InvalidEntityTypeForAggregation" + | "MultiLevelAggregationNotAllowed" + | "AggregationTypeNotAllowedForLinkedStat" + | "OperationDeniedDueToDefinitionPolicy" + | "StatisticUpdateNotAllowedWhileLinked" + | "UnsupportedEntityType" + | "EntityTypeSpecifiedRequiresAggregationSource" + | "PlayFabErrorEventNotSupportedForEntityType" + | "MetadataLengthExceeded" + | "MaxQueryableVersionsExceeded" + | "StatisticVersionIncrementNotAllowedWhileLinked" + | "StoreMetricsRequestInvalidInput" + | "StoreMetricsErrorRetrievingMetrics"; export interface GetActionsOnPlayersInSegmentTaskInstanceResult extends PlayFabModule.IPlayFabResultCommon { /** Parameter of this task instance */ @@ -2866,6 +3089,16 @@ declare module PlayFabAdminModels { } + export interface GetAllIPBansRequest extends PlayFabModule.IPlayFabRequestCommon { + + } + + export interface GetAllIPBansResult extends PlayFabModule.IPlayFabResultCommon { + /** Information on all IP bans */ + IPBanData?: IPBanInfo[]; + + } + export interface GetAllSegmentsRequest extends PlayFabModule.IPlayFabRequestCommon { } @@ -2988,6 +3221,18 @@ declare module PlayFabAdminModels { } + export interface GetIPBanRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The IP address of the ban to retrieve information on. */ + IPAddress: string; + + } + + export interface GetIPBanResult extends PlayFabModule.IPlayFabResultCommon { + /** Information on the ban */ + IPBanData?: IPBanInfo[]; + + } + export interface GetPlayedTitleListRequest extends PlayFabModule.IPlayFabRequestCommon { /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId: string; @@ -3000,6 +3245,27 @@ declare module PlayFabAdminModels { } + export interface GetPlayerCustomPropertyRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + /** Specific property name to search for in the player's properties. */ + PropertyName: string; + + } + + export interface GetPlayerCustomPropertyResult extends PlayFabModule.IPlayFabResultCommon { + /** PlayFab unique identifier of the user whose properties are being returned. */ + PlayFabId?: string; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + /** Player specific property and its corresponding value. */ + Property?: CustomPropertyDetails; + + } + export interface GetPlayerIdFromAuthTokenRequest extends PlayFabModule.IPlayFabRequestCommon { /** The auth token of the player requesting the password reset. */ Token: string; @@ -3067,42 +3333,6 @@ declare module PlayFabAdminModels { } - export interface GetPlayersInSegmentRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Continuation token if retrieving subsequent pages of results. */ - ContinuationToken?: string; - /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ - CustomTags?: { [key: string]: string | null }; - /** - * If set to true, the profiles are loaded asynchronously and the response will include a continuation token and - * approximate profile count until the first batch of profiles is loaded. Use this parameter to help avoid network - * timeouts. - */ - GetProfilesAsync?: boolean; - /** - * Maximum is 10,000. The value 0 will prevent loading any profiles and return only the count of profiles matching this - * segment. - */ - MaxBatchSize?: number; - /** - * 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 5,400 (90 minutes). - */ - SecondsToLive?: number; - /** Unique identifier for this segment. */ - SegmentId: string; - - } - - export interface GetPlayersInSegmentResult extends PlayFabModule.IPlayFabResultCommon { - /** Continuation token to use to retrieve subsequent pages of results. If token returns null there are no more results. */ - ContinuationToken?: string; - /** Array of player profiles in this segment. */ - PlayerProfiles?: PlayerProfile[]; - /** Count of profiles matching this segment. */ - ProfilesInSegment: number; - - } - export interface GetPlayersSegmentsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -3154,12 +3384,17 @@ declare module PlayFabAdminModels { } export interface GetPolicyRequest extends PlayFabModule.IPlayFabRequestCommon { - /** The name of the policy to read. Only supported name is 'ApiPolicy'. */ + /** + * The name of the policy to read. Only 'ApiPolicy' is supported. This parameter is optional and defaults to 'ApiPolicy' if + * omitted. + */ PolicyName?: string; } export interface GetPolicyResponse extends PlayFabModule.IPlayFabResultCommon { + /** The UTC date and time when the policy was last updated. Null if the policy has never been customized. */ + LastUpdated?: string; /** The name of the policy read. */ PolicyName?: string; /** Policy version. */ @@ -3193,6 +3428,18 @@ declare module PlayFabAdminModels { } + export interface GetSegmentPlayerCountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique identifier for the requested segment. */ + SegmentId: string; + + } + + export interface GetSegmentPlayerCountResult extends PlayFabModule.IPlayFabResultCommon { + /** Count of profiles matching this segment. */ + ProfilesInSegment: number; + + } + export interface GetSegmentResult { /** Identifier of the segments AB Test, if it is attached to one. */ ABTestParent?: string; @@ -3507,6 +3754,22 @@ declare module PlayFabAdminModels { } + export interface IPBanInfo { + /** The active state of this ban. */ + Active: boolean; + /** PlayFab Developer ID of who issued the ban. Null if ban issued via Title Secret Key. */ + BannedByDeveloperId?: string; + /** The time when this IP ban was applied. */ + Created?: string; + /** The time when this ban expires. Permanent bans do not have expiration date. */ + Expires?: string; + /** The IP address on which the ban was applied. */ + IPAddress?: string; + /** The reason why this IP ban was applied. */ + Reason?: string; + + } + export interface ItemGrant { /** String detailing any additional information concerning this operation. */ Annotation?: string; @@ -3621,6 +3884,25 @@ declare module PlayFabAdminModels { } + export interface ListPlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + + } + + export interface ListPlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** PlayFab unique identifier of the user whose properties are being returned. */ + PlayFabId?: string; + /** Player specific properties and their corresponding values for this title. */ + Properties?: CustomPropertyDetails[]; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface ListVirtualCurrencyTypesRequest extends PlayFabModule.IPlayFabRequestCommon { } @@ -3674,7 +3956,9 @@ declare module PlayFabAdminModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; export interface LogStatement { /** Optional object accompanying the message as contextual information */ @@ -3743,6 +4027,12 @@ declare module PlayFabAdminModels { } + type NewsStatus = "None" + + | "Unpublished" + | "Published" + | "Archived"; + export interface OpenIdConnection { /** The client ID given by the ID provider. */ ClientId?: string; @@ -3774,15 +4064,18 @@ declare module PlayFabAdminModels { } export interface PermissionStatement { - /** The action this statement effects. The only supported action is 'Execute'. */ - Action: string; + /** The action this statement effects. May only be '*'. This parameter is optional and defaults to '*' if omitted. */ + Action?: string; /** Additional conditions to be applied for API Resources. */ ApiConditions?: ApiCondition; /** A comment about the statement. Intended solely for bookkeeping and debugging. */ Comment?: string; /** The effect this statement will have. It could be either Allow or Deny */ Effect: string; - /** The principal this statement will effect. The only supported principal is '*'. */ + /** + * The principal this statement will effect. May be '*' to match all callers, or a JSON object targeting a specific entity + * type, e.g. {"title_player_account":"*"} for players or {"master_player_account":"*"} for master player accounts. + */ Principal: string; /** * The resource this statements effects. The only supported resources look like 'pfrn:api--*' for all apis, or @@ -3816,80 +4109,6 @@ declare module PlayFabAdminModels { } - export interface PlayerLinkedAccount { - /** Linked account's email */ - Email?: string; - /** Authentication platform */ - Platform?: string; - /** Platform user identifier */ - PlatformUserId?: string; - /** Linked account's username */ - Username?: string; - - } - - export interface PlayerLocation { - /** City of the player's geographic location. */ - City?: string; - /** The two-character continent code for this location */ - ContinentCode: string; - /** The two-character ISO 3166-1 country code for the country associated with the location */ - CountryCode: string; - /** Latitude coordinate of the player's geographic location. */ - Latitude?: number; - /** Longitude coordinate of the player's geographic location. */ - Longitude?: number; - - } - - export interface PlayerProfile { - /** Array of ad campaigns player has been attributed to */ - AdCampaignAttributions?: AdCampaignAttribution[]; - /** Image URL of the player's avatar. */ - AvatarUrl?: string; - /** Banned until UTC Date. If permanent ban this is set for 20 years after the original ban date. */ - BannedUntil?: string; - /** The prediction of the player to churn within the next seven days. */ - ChurnPrediction?: string; - /** Array of contact email addresses associated with the player */ - ContactEmailAddresses?: ContactEmailInfo[]; - /** Player record created */ - Created?: string; - /** Player Display Name */ - DisplayName?: string; - /** Last login */ - LastLogin?: string; - /** Array of third party accounts linked to this player */ - LinkedAccounts?: PlayerLinkedAccount[]; - /** Dictionary of player's locations by type. */ - Locations?: { [key: string]: PlayerLocation }; - /** Player account origination */ - Origination?: string; - /** List of player variants for experimentation */ - PlayerExperimentVariants?: string[]; - /** PlayFab Player ID */ - PlayerId?: string; - /** Array of player statistics */ - PlayerStatistics?: PlayerStatistic[]; - /** Publisher this player belongs to */ - PublisherId?: string; - /** Array of configured push notification end points */ - PushNotificationRegistrations?: PushNotificationRegistration[]; - /** Dictionary of player's statistics using only the latest version's value */ - Statistics?: { [key: string]: number }; - /** List of player's tags for segmentation. */ - Tags?: string[]; - /** Title ID this profile applies to */ - TitleId?: string; - /** A sum of player's total purchases in USD across all currencies. */ - TotalValueToDateInUSD?: number; - /** Dictionary of player's total purchases by currency. */ - ValuesToDate?: { [key: string]: number }; - /** Dictionary of player's virtual currency balances */ - VirtualCurrencyBalances?: { [key: string]: number }; - - } - export interface PlayerProfileModel { /** List of advertising campaigns the player has been attributed to */ AdCampaignAttributions?: AdCampaignAttributionModel[]; @@ -3979,18 +4198,6 @@ declare module PlayFabAdminModels { } - export interface PlayerStatistic { - /** Statistic ID */ - Id?: string; - /** Statistic name */ - Name?: string; - /** Current statistic value */ - StatisticValue: number; - /** Statistic version (0 if not a versioned statistic) */ - StatisticVersion: number; - - } - export interface PlayerStatisticDefinition { /** the aggregation method to use in updating the statistic (defaults to last) */ AggregationMethod?: string; @@ -4023,6 +4230,23 @@ declare module PlayFabAdminModels { } + export interface PolicyDiffSummary { + /** Number of new statements that would be added. */ + StatementsAdded: number; + /** Number of existing statements that would be removed. Only applicable when OverwritePolicy is true. */ + StatementsRemoved: number; + /** + * Number of existing statements that would be replaced by functionally equivalent incoming statements (e.g., same + * resource/effect/principal but different comment). + */ + StatementsReplaced: number; + /** Number of existing statements that would remain unchanged. */ + StatementsUnchanged: number; + /** Total number of statements in the resulting policy. */ + TotalResultingStatements: number; + + } + export interface PushNotificationContent { /** Text of message to send. */ Message?: string; @@ -4037,14 +4261,6 @@ declare module PlayFabAdminModels { | "GoogleCloudMessaging"; - export interface PushNotificationRegistration { - /** Notification configured endpoint */ - NotificationEndpointARN?: string; - /** Push notification platform */ - Platform?: string; - - } - export interface PushNotificationRegistrationModel { /** Notification configured endpoint */ NotificationEndpointARN?: string; @@ -4272,6 +4488,18 @@ declare module PlayFabAdminModels { } + export interface RevokeIPBanRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The IP address of the ban to be revoked. */ + IPAddress: string; + + } + + export interface RevokeIPBanResult extends PlayFabModule.IPlayFabResultCommon { + /** Information on the ban that was revoked */ + IPBanData?: IPBanInfo; + + } + export interface RevokeItemError { /** Specific error that was encountered. */ Error?: string; @@ -4348,6 +4576,14 @@ declare module PlayFabAdminModels { AllPlayersFilter?: AllPlayersSegmentFilter; /** Filter property for player churn risk level. */ ChurnPredictionFilter?: ChurnPredictionSegmentFilter; + /** Filter property for boolean custom properties. */ + CustomPropertyBooleanFilter?: CustomPropertyBooleanSegmentFilter; + /** Filter property for datetime custom properties. */ + CustomPropertyDateTimeFilter?: CustomPropertyDateTimeSegmentFilter; + /** Filter property for numeric custom properties. */ + CustomPropertyNumericFilter?: CustomPropertyNumericSegmentFilter; + /** Filter property for string custom properties. */ + CustomPropertyStringFilter?: CustomPropertyStringSegmentFilter; /** Filter property for first login date. */ FirstLoginDateFilter?: FirstLoginDateSegmentFilter; /** Filter property for first login timespan. */ @@ -4930,7 +5166,7 @@ declare module PlayFabAdminModels { } export interface SetPlayerSecretRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId: string; @@ -5335,6 +5571,28 @@ declare module PlayFabAdminModels { } + export interface UpdateIPBanRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The updated active state for the IP ban. Null for no change. */ + Active?: boolean; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The updated expiration date for the IP ban. Null for no change. */ + Expires?: string; + /** The IP address of the ban to be updated. */ + IPAddress: string; + /** Whether to make this IP ban permanent. Set to true to make this IP ban permanent. This will not modify Active state. */ + Permanent?: boolean; + /** The updated reason for the IP ban. Maximum 140 characters. Null for no change. */ + Reason?: string; + + } + + export interface UpdateIPBanResult extends PlayFabModule.IPlayFabResultCommon { + /** Information on the ban that was created */ + IPBanData?: IPBanInfo; + + } + export interface UpdateOpenIdConnectionRequest extends PlayFabModule.IPlayFabRequestCommon { /** The client ID given by the ID provider. */ ClientId?: string; @@ -5353,6 +5611,32 @@ declare module PlayFabAdminModels { } + export interface UpdatePlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** + * Optional field used for concurrency control. One can ensure that the update operation will only be performed if the + * player's properties have not been updated by any other clients since last the version. + */ + ExpectedPropertiesVersion?: number; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + /** Collection of properties to be set for a player. */ + Properties: UpdateProperty[]; + + } + + export interface UpdatePlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** PlayFab unique identifier of the user whose properties were updated. */ + PlayFabId?: string; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface UpdatePlayerSharedSecretRequest extends PlayFabModule.IPlayFabRequestCommon { /** Disable or Enable this key */ Disabled: boolean; @@ -5389,8 +5673,11 @@ declare module PlayFabAdminModels { export interface UpdatePolicyRequest extends PlayFabModule.IPlayFabRequestCommon { /** Whether to overwrite or append to the existing policy. */ OverwritePolicy: boolean; - /** The name of the policy being updated. Only supported name is 'ApiPolicy' */ - PolicyName: string; + /** + * The name of the policy being updated. Only 'ApiPolicy' is supported. This parameter is optional and defaults to + * 'ApiPolicy' if omitted. + */ + PolicyName?: string; /** Version of the policy to update. Must be the latest (as returned by GetPolicy). */ PolicyVersion: number; /** The new statements to include in the policy. */ @@ -5403,6 +5690,19 @@ declare module PlayFabAdminModels { PolicyName?: string; /** The statements included in the new version of the policy. */ Statements?: PermissionStatement[]; + /** + * Optional warnings about policy statements that may not have the intended effect. For example, resource paths that don't + * match any known API endpoint. The policy update still succeeds when warnings are present. + */ + Warnings?: string[]; + + } + + export interface UpdateProperty { + /** Name of the custom property. Can contain Unicode letters and digits. They are limited in size. */ + Name: string; + /** Value of the custom property. Limited to booleans, numbers, and strings. */ + Value: any; } @@ -5543,6 +5843,8 @@ declare module PlayFabAdminModels { AndroidDeviceInfo?: UserAndroidDeviceInfo; /** Sign in with Apple account information, if an Apple account has been linked */ AppleAccountInfo?: UserAppleIdInfo; + /** Battle.net account information, if a Battle.net account has been linked */ + BattleNetAccountInfo?: UserBattleNetInfo; /** Timestamp indicating when the user account was created */ Created: string; /** Custom ID information, if a custom ID has been assigned */ @@ -5600,6 +5902,14 @@ declare module PlayFabAdminModels { } + export interface UserBattleNetInfo { + /** Battle.net identifier */ + BattleNetAccountId?: string; + /** Battle.net display name */ + BattleNetBattleTag?: string; + + } + export interface UserCustomIdInfo { /** Custom ID */ CustomId?: string; @@ -5733,7 +6043,9 @@ declare module PlayFabAdminModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; export interface UserOriginationSegmentFilter { /** User login provider. */ @@ -5748,10 +6060,17 @@ declare module PlayFabAdminModels { } export interface UserPsnInfo { + /** + * Id of the PlayStation :tm: Network issuer environment this account is keyed under. Supply this value as IssuerId when + * looking the account up. + */ + IssuerId?: number; /** PlayStation :tm: Network account ID */ PsnAccountId?: string; /** PlayStation :tm: Network online ID */ PsnOnlineId?: string; + /** PlayStation :tm: Network sandbox ID */ + PsnSandboxId?: string; } @@ -5817,6 +6136,39 @@ declare module PlayFabAdminModels { } + export interface ValidateApiPolicyRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Whether the validation should simulate overwriting or appending to the existing policy. */ + OverwritePolicy: boolean; + /** + * The name of the policy to validate. Only 'ApiPolicy' is supported. This parameter is optional and defaults to + * 'ApiPolicy' if omitted. + */ + PolicyName?: string; + /** Version of the policy to validate against. Must be the latest (as returned by GetPolicy). */ + PolicyVersion: number; + /** The statements to validate. */ + Statements: PermissionStatement[]; + + } + + export interface ValidateApiPolicyResponse extends PlayFabModule.IPlayFabResultCommon { + /** Summary of what would change compared to the current policy. */ + Diff?: PolicyDiffSummary; + /** Whether the proposed policy is valid and would be accepted by UpdatePolicy. */ + IsValid: boolean; + /** The name of the policy validated. */ + PolicyName?: string; + /** Policy version. */ + PolicyVersion: number; + /** The full set of statements that would result from applying this update. */ + ResultingStatements?: PermissionStatement[]; + /** Validation errors that would cause UpdatePolicy to reject this request. Empty if IsValid is true. */ + ValidationErrors?: string[]; + /** Non-blocking warnings about the proposed policy (e.g., near statement limit, duplicate statements). */ + Warnings?: string[]; + + } + export interface ValueToDateModel { /** ISO 4217 code of the currency used in the purchases */ Currency?: string; diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabAuthenticationApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabAuthenticationApi.d.ts index f9dcb3bf..6730e3dc 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabAuthenticationApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabAuthenticationApi.d.ts @@ -98,8 +98,6 @@ declare module PlayFabAuthenticationModels { export interface GetEntityTokenRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ - Entity?: EntityKey; } @@ -148,7 +146,9 @@ declare module PlayFabAuthenticationModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; export interface ValidateEntityTokenRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabClientApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabClientApi.d.ts index 9f4d559f..b75e42e4 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabClientApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabClientApi.d.ts @@ -111,6 +111,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/createsharedgroup */ CreateSharedGroup(request: PlayFabClientModels.CreateSharedGroupRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Deletes title-specific custom properties for a player + * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/deleteplayercustomproperties + */ + DeletePlayerCustomProperties(request: PlayFabClientModels.DeletePlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The * PlayFab ID is the entity ID of the player's master_player_account entity. @@ -233,6 +238,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayercombinedinfo */ GetPlayerCombinedInfo(request: PlayFabClientModels.GetPlayerCombinedInfoRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves a title-specific custom property value for a player. + * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayercustomproperty + */ + GetPlayerCustomProperty(request: PlayFabClientModels.GetPlayerCustomPropertyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the player's profile * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayerprofile @@ -264,6 +274,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/trading/getplayertrades */ GetPlayerTrades(request: PlayFabClientModels.GetPlayerTradesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers. + * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrombattlenetaccountids + */ + GetPlayFabIDsFromBattleNetAccountIds(request: PlayFabClientModels.GetPlayFabIDsFromBattleNetAccountIdsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers. * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookids @@ -317,6 +332,13 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoswitchdeviceids */ GetPlayFabIDsFromNintendoSwitchDeviceIds(request: PlayFabClientModels.GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the unique PlayFab identifiers for the given set of OpenId subject identifiers. A OpenId identifier is the + * service name plus the service-specific ID for the player, as specified by the title when the OpenId identifier was added + * to the player account. + * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromopenidsubjectidentifiers + */ + GetPlayFabIDsFromOpenIdSubjectIdentifiers(request: PlayFabClientModels.GetPlayFabIDsFromOpenIdsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers. * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnaccountids @@ -333,6 +355,12 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamids */ GetPlayFabIDsFromSteamIDs(request: PlayFabClientModels.GetPlayFabIDsFromSteamIDsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona + * names. + * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamnames + */ + GetPlayFabIDsFromSteamNames(request: PlayFabClientModels.GetPlayFabIDsFromSteamNamesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for * the user accounts, available as "_id" from the Twitch API methods (ex: @@ -438,6 +466,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkapple */ LinkApple(request: PlayFabClientModels.LinkAppleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Links the Battle.net account associated with the token to the user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkbattlenetaccount + */ + LinkBattleNetAccount(request: PlayFabClientModels.LinkBattleNetAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Links the custom identifier, generated by the title, to the user's PlayFab account * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkcustomid @@ -518,6 +551,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkxboxaccount */ LinkXboxAccount(request: PlayFabClientModels.LinkXboxAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves title-specific custom property values for a player. + * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/listplayercustomproperties + */ + ListPlayerCustomProperties(request: PlayFabClientModels.ListPlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for * API calls which require an authenticated user @@ -529,6 +567,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithapple */ LoginWithApple(request: PlayFabClientModels.LoginWithAppleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Sign in the user with a Battle.net identity token + * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithbattlenet + */ + LoginWithBattleNet(request: PlayFabClientModels.LoginWithBattleNetRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can * subsequently be used for API calls which require an authenticated user @@ -766,6 +809,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkapple */ UnlinkApple(request: PlayFabClientModels.UnlinkAppleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks the related Battle.net account from the user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkbattlenetaccount + */ + UnlinkBattleNetAccount(request: PlayFabClientModels.UnlinkBattleNetAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Unlinks the related custom identifier from the user's PlayFab account * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkcustomid @@ -875,6 +923,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/characters/updatecharacterstatistics */ UpdateCharacterStatistics(request: PlayFabClientModels.UpdateCharacterStatisticsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Updates the title-specific custom property values for a player + * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayercustomproperties + */ + UpdatePlayerCustomProperties(request: PlayFabClientModels.UpdatePlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to * update statistics. Developers may override this setting in the Game Manager > Settings > API Features. @@ -1138,6 +1191,14 @@ declare module PlayFabClientModels { } + export interface BattleNetAccountPlayFabIdPair { + /** Unique Battle.net account identifier for a user. */ + BattleNetAccountId?: string; + /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Battle.net account identifier. */ + PlayFabId?: string; + + } + export interface CancelTradeRequest extends PlayFabModule.IPlayFabRequestCommon { /** Trade identifier. */ TradeId: string; @@ -1867,6 +1928,46 @@ declare module PlayFabClientModels { | "ZMW" | "ZWD"; + export interface CustomPropertyDetails { + /** The custom property's name. */ + Name?: string; + /** The custom property's value. */ + Value?: any; + + } + + export interface DeletedPropertyDetails { + /** The name of the property which was requested to be deleted. */ + Name?: string; + /** Indicates whether or not the property was deleted. If false, no property with that name existed. */ + WasDeleted: boolean; + + } + + export interface DeletePlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** + * Optional field used for concurrency control. One can ensure that the delete operation will only be performed if the + * player's properties have not been updated by any other clients since the last version. + */ + ExpectedPropertiesVersion?: number; + /** A list of property names denoting which properties should be deleted. */ + PropertyNames: string[]; + + } + + export interface DeletePlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** The list of properties requested to be deleted. */ + DeletedProperties?: DeletedPropertyDetails[]; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface DeviceInfoRequest extends PlayFabModule.IPlayFabRequestCommon { /** Information posted to the PlayStream Event. Currently arbitrary, and specific to the environment sending it. */ Info?: { [key: string]: any }; @@ -1990,20 +2091,23 @@ declare module PlayFabClientModels { } export interface FriendInfo { - /** Available Facebook information (if the user and PlayFab friend are also connected in Facebook). */ + /** Available Facebook information (if the user and connected Facebook friend both have PlayFab Accounts in the same title). */ FacebookInfo?: UserFacebookInfo; /** PlayFab unique identifier for this friend. */ FriendPlayFabId?: string; - /** Available Game Center information (if the user and PlayFab friend are also connected in Game Center). */ + /** + * Available Game Center information (if the user and connected Game Center friend both have PlayFab Accounts in the same + * title). + */ GameCenterInfo?: UserGameCenterInfo; /** The profile of the user, if requested. */ Profile?: PlayerProfileModel; /** - * Available PlayStation :tm: Network information, if the user and PlayFab friend are both connected to PlayStation :tm: - * Network. + * Available PlayStation :tm: Network information, if the user connected PlayStation :tm Network friend both have PlayFab + * Accounts in the same title. */ PSNInfo?: UserPsnInfo; - /** Available Steam information (if the user and PlayFab friend are also connected in Steam). */ + /** Available Steam information (if the user and connected Steam friend both have PlayFab Accounts in the same title). */ SteamInfo?: UserSteamInfo; /** Tags which have been associated with this friend. */ Tags?: string[]; @@ -2011,7 +2115,7 @@ declare module PlayFabClientModels { TitleDisplayName?: string; /** PlayFab unique username for this friend. */ Username?: string; - /** Available Xbox information, if the user and PlayFab friend are both connected to Xbox Live. */ + /** Available Xbox information, (if the user and connected Xbox Live friend both have PlayFab Accounts in the same title). */ XboxInfo?: UserXboxInfo; } @@ -2259,13 +2363,21 @@ declare module PlayFabClientModels { * comma-separated list of platforms. */ ExternalPlatformFriends?: string; + /** + * If true, include friends from the same namespace even if they have not logged in to the current title. Defaults to + * false. + */ + NamespaceWide?: boolean; /** * 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?: PlayerProfileViewConstraints; - /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */ + /** + * Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. When provided, all Xbox Live + * users the caller is following are included regardless of whether they follow the caller back. + */ XboxToken?: string; } @@ -2478,6 +2590,23 @@ declare module PlayFabClientModels { } + export interface GetPlayerCustomPropertyRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Specific property name to search for in the player's properties. */ + PropertyName: string; + + } + + export interface GetPlayerCustomPropertyResult extends PlayFabModule.IPlayFabResultCommon { + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + /** Player specific property and its corresponding value. */ + Property?: CustomPropertyDetails; + + } + export interface GetPlayerProfileRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -2576,10 +2705,25 @@ declare module PlayFabClientModels { } + export interface GetPlayFabIDsFromBattleNetAccountIdsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Array of unique Battle.net account identifiers for which the title needs to get PlayFab identifiers. The array cannot + * exceed 10 in length. + */ + BattleNetAccountIds: string[]; + + } + + export interface GetPlayFabIDsFromBattleNetAccountIdsResult extends PlayFabModule.IPlayFabResultCommon { + /** Mapping of Battle.net account identifiers to PlayFab identifiers. */ + Data?: BattleNetAccountPlayFabIdPair[]; + + } + export interface GetPlayFabIDsFromFacebookIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** - * Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 - * in length. + * Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 25 in + * length. */ FacebookIDs: string[]; @@ -2609,7 +2753,7 @@ declare module PlayFabClientModels { export interface GetPlayFabIDsFromGameCenterIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Game Center identifiers (the Player Identifier) for which the title needs to get PlayFab identifiers. - * The array cannot exceed 2,000 in length. + * The array cannot exceed 25 in length. */ GameCenterIDs: string[]; @@ -2639,7 +2783,7 @@ declare module PlayFabClientModels { export interface GetPlayFabIDsFromGoogleIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Google identifiers (Google+ user IDs) for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ GoogleIDs: string[]; @@ -2654,7 +2798,7 @@ declare module PlayFabClientModels { export interface GetPlayFabIDsFromGooglePlayGamesPlayerIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Google Play Games identifiers (Google+ user IDs) for which the title needs to get PlayFab identifiers. - * The array cannot exceed 2,000 in length. + * The array cannot exceed 25 in length. */ GooglePlayGamesPlayerIDs: string[]; @@ -2669,7 +2813,7 @@ declare module PlayFabClientModels { export interface GetPlayFabIDsFromKongregateIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Kongregate identifiers (Kongregate's user_id) for which the title needs to get PlayFab identifiers. The - * array cannot exceed 2,000 in length. + * array cannot exceed 25 in length. */ KongregateIDs: string[]; @@ -2682,9 +2826,14 @@ declare module PlayFabClientModels { } export interface GetPlayFabIDsFromNintendoServiceAccountIdsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Nintendo NSA issuer URL identifying the environment. When provided, only accounts registered in that environment are + * returned. If null or empty, falls back to the default environment. + */ + Issuer?: string; /** * Array of unique Nintendo Switch Account identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ NintendoAccountIds: string[]; @@ -2699,7 +2848,7 @@ declare module PlayFabClientModels { export interface GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Nintendo Switch Device identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ NintendoSwitchDeviceIds: string[]; @@ -2711,14 +2860,39 @@ declare module PlayFabClientModels { } + export interface GetPlayFabIDsFromOpenIdsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Array of unique OpenId Connect identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed + * 10 in length. + */ + OpenIdSubjectIdentifiers: OpenIdSubjectIdentifier[]; + + } + + export interface GetPlayFabIDsFromOpenIdsResult extends PlayFabModule.IPlayFabResultCommon { + /** Mapping of OpenId Connect identifiers to PlayFab identifiers. */ + Data?: OpenIdSubjectIdentifierPlayFabIdPair[]; + + } + export interface GetPlayFabIDsFromPSNAccountIDsRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */ + /** + * Id of the PlayStation :tm: Network issuer environment. If null, defaults to the production environment. This must match + * the issuer the account signed in under, otherwise the lookup returns a null PlayFabId rather than an error. + */ IssuerId?: number; /** * Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ PSNAccountIDs: string[]; + /** + * The PlayStation :tm: Network sandbox the account is keyed under. Sandbox membership is per account, not per title: + * supply this only for accounts that sign in from a sandbox, and omit it for accounts that do not, including all retail + * accounts. Supplying a sandbox id that an account is not keyed under, or omitting one that it is, returns a null + * PlayFabId rather than an error. + */ + SandboxId?: string; } @@ -2729,13 +2903,23 @@ declare module PlayFabClientModels { } export interface GetPlayFabIDsFromPSNOnlineIDsRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */ + /** + * Id of the PlayStation :tm: Network issuer environment. If null, defaults to the production environment. This must match + * the issuer the account signed in under, otherwise the lookup returns a null PlayFabId rather than an error. + */ IssuerId?: number; /** * Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ PSNOnlineIDs: string[]; + /** + * The PlayStation :tm: Network sandbox the account is keyed under. Sandbox membership is per account, not per title: + * supply this only for accounts that sign in from a sandbox, and omit it for accounts that do not, including all retail + * accounts. Supplying a sandbox id that an account is not keyed under, or omitting one that it is, returns a null + * PlayFabId rather than an error. + */ + SandboxId?: string; } @@ -2748,7 +2932,7 @@ declare module PlayFabClientModels { export interface GetPlayFabIDsFromSteamIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ SteamStringIDs?: string[]; @@ -2760,10 +2944,25 @@ declare module PlayFabClientModels { } + export interface GetPlayFabIDsFromSteamNamesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Array of unique Steam identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 25 in + * length. + */ + SteamNames: string[]; + + } + + export interface GetPlayFabIDsFromSteamNamesResult extends PlayFabModule.IPlayFabResultCommon { + /** Mapping of Steam identifiers to PlayFab identifiers. */ + Data?: SteamNamePlayFabIdPair[]; + + } + export interface GetPlayFabIDsFromTwitchIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot - * exceed 2,000 in length. + * exceed 25 in length. */ TwitchIds: string[]; @@ -2780,7 +2979,7 @@ declare module PlayFabClientModels { Sandbox?: string; /** * Array of unique Xbox Live account identifiers for which the title needs to get PlayFab identifiers. The array cannot - * exceed 2,000 in length. + * exceed 25 in length. */ XboxLiveAccountIDs: string[]; @@ -3122,6 +3321,16 @@ declare module PlayFabClientModels { } + export interface LinkBattleNetAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** If another user is already linked to a specific Battle.net account, unlink the other user and re-link. */ + ForceLink?: boolean; + /** The JSON Web Token (JWT) returned by Battle.net after login */ + IdentityToken: string; + + } + export interface LinkCustomIDRequest extends PlayFabModule.IPlayFabRequestCommon { /** Custom unique identifier for the user, generated by the title. */ CustomId: string; @@ -3150,7 +3359,9 @@ declare module PlayFabClientModels { export interface LinkFacebookAccountRequest extends PlayFabModule.IPlayFabRequestCommon { /** Unique identifier from Facebook for the user. */ - AccessToken: string; + AccessToken?: string; + /** Token used for limited login authentication. */ + AuthenticationToken?: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** If another user is already linked to the account, unlink the other user and re-link. */ @@ -3323,6 +3534,11 @@ declare module PlayFabClientModels { export interface LinkPSNAccountRequest extends PlayFabModule.IPlayFabRequestCommon { /** Authentication code provided by the PlayStation :tm: Network. */ AuthCode: string; + /** + * Optional PlayStation :tm: Network auth version. Controls which PlayStation :tm: Network auth version is used. Accepted + * values are "v2" and "v3". + */ + AuthVersion?: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** If another user is already linked to the account, unlink the other user and re-link. */ @@ -3388,6 +3604,21 @@ declare module PlayFabClientModels { } + export interface ListPlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + + } + + export interface ListPlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** Player specific properties and their corresponding values for this title. */ + Properties?: CustomPropertyDetails[]; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface ListUsersCharactersRequest extends PlayFabModule.IPlayFabRequestCommon { /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId?: string; @@ -3437,7 +3668,9 @@ declare module PlayFabClientModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; export interface LoginResult extends PlayFabModule.IPlayFabResultCommon { /** @@ -3449,7 +3682,7 @@ declare module PlayFabClientModels { InfoResultPayload?: GetPlayerCombinedInfoResultPayload; /** The time of this user's previous login. If there was no previous login, then it's DateTime.MinValue */ LastLoginTime?: string; - /** True if the account was newly created on this login. */ + /** True if the master_player_account was newly created on this login. */ NewlyCreated: boolean; /** Player's unique PlayFabId. */ PlayFabId?: string; @@ -3471,13 +3704,13 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; /** Specific Operating System version for the user's device. */ OS?: string; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3492,7 +3725,7 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** * The JSON Web token (JWT) returned by Apple after login. Represented as the identityToken field in the authorization @@ -3502,7 +3735,28 @@ declare module PlayFabClientModels { IdentityToken: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ + PlayerSecret?: string; + /** + * 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; + + } + + export interface LoginWithBattleNetRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Automatically create a PlayFab account if one is not currently linked to this ID. */ + CreateAccount?: boolean; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ + EncryptedRequest?: string; + /** The JSON Web Token (JWT) returned by Battle.net after login */ + IdentityToken: string; + /** Flags for which pieces of info to return for the user. */ + InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3519,11 +3773,11 @@ declare module PlayFabClientModels { CustomId?: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3555,13 +3809,13 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Facebook Instant Games signature for the user. */ FacebookInstantGamesSignature: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3580,11 +3834,11 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3599,13 +3853,13 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; /** Unique Game Center player id. */ PlayerId?: string; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** The URL for the public encryption key that will be used to verify the signature. */ PublicKeyUrl?: string; @@ -3631,11 +3885,11 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * OAuth 2.0 server authentication code obtained on the client by calling the getServerAuthCode() @@ -3657,11 +3911,11 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * OAuth 2.0 server authentication code obtained on the client by calling the requestServerSideAccess() @@ -3685,13 +3939,13 @@ declare module PlayFabClientModels { DeviceId?: string; /** Specific model of the user's device. */ DeviceModel?: string; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; /** Specific Operating System version for the user's device. */ OS?: string; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3708,13 +3962,13 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; /** Numeric user ID assigned by Kongregate */ KongregateId?: string; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3729,13 +3983,13 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** The JSON Web token (JWT) returned by Nintendo after login. */ IdentityToken: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3750,13 +4004,13 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; /** Nintendo Switch unique identifier for the user's device. */ NintendoSwitchDeviceId?: string; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3773,7 +4027,7 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** * The JSON Web token (JWT) returned by the identity provider after login. Represented as the id_token field in the @@ -3782,7 +4036,7 @@ declare module PlayFabClientModels { IdToken: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3812,17 +4066,22 @@ declare module PlayFabClientModels { export interface LoginWithPSNRequest extends PlayFabModule.IPlayFabRequestCommon { /** Auth code provided by the PlayStation :tm: Network OAuth provider. */ AuthCode?: string; + /** + * Optional PlayStation :tm: Network auth version. Controls which PlayStation :tm: Network auth version is used. Accepted + * values are "v2" and "v3". + */ + AuthVersion?: string; /** Automatically create a PlayFab account if one is not currently linked to this ID. */ CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */ IssuerId?: number; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code */ RedirectUri?: string; @@ -3839,11 +4098,11 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Authentication token for the user, returned as a byte array from Steam, and converted to a string (for example, the byte @@ -3870,11 +4129,11 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3889,11 +4148,11 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3986,6 +4245,22 @@ declare module PlayFabClientModels { } + export interface OpenIdSubjectIdentifier { + /** The issuer URL for the OpenId Connect provider, or the override URL if an override exists. */ + Issuer: string; + /** The unique subject identifier within the context of the issuer. */ + Subject: string; + + } + + export interface OpenIdSubjectIdentifierPlayFabIdPair { + /** Unique OpenId Connect identifier for a user. */ + OpenIdSubjectIdentifier?: OpenIdSubjectIdentifier; + /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the OpenId Connect identifier. */ + PlayFabId?: string; + + } + export interface OpenTradeRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Players who are allowed to accept the trade. If null, the trade may be accepted by any player. If empty, the trade may @@ -4306,13 +4581,13 @@ declare module PlayFabClientModels { DisplayName?: string; /** User email address attached to their account */ Email?: string; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; /** Password for the PlayFab account (6-100 characters) */ Password?: string; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * An optional parameter that specifies whether both the username and email parameters are required. If true, both @@ -4510,9 +4785,9 @@ declare module PlayFabClientModels { } export interface SetPlayerSecretRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; } @@ -4607,6 +4882,14 @@ declare module PlayFabClientModels { } + export interface SteamNamePlayFabIdPair { + /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */ + PlayFabId?: string; + /** Unique Steam identifier for a user, also known as Steam persona name. */ + SteamName?: string; + + } + export interface SteamPlayFabIdPair { /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */ PlayFabId?: string; @@ -4803,6 +5086,12 @@ declare module PlayFabClientModels { } + export interface UnlinkBattleNetAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + + } + export interface UnlinkCustomIDRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Custom unique identifier for the user, generated by the title. If not specified, the most recently signed in Custom ID @@ -5062,6 +5351,28 @@ declare module PlayFabClientModels { } + export interface UpdatePlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** + * Optional field used for concurrency control. One can ensure that the update operation will only be performed if the + * player's properties have not been updated by any other clients since last the version. + */ + ExpectedPropertiesVersion?: number; + /** Collection of properties to be set for a player. */ + Properties: UpdateProperty[]; + + } + + export interface UpdatePlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface UpdatePlayerStatisticsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -5074,6 +5385,14 @@ declare module PlayFabClientModels { } + export interface UpdateProperty { + /** Name of the custom property. Can contain Unicode letters and digits. They are limited in size. */ + Name: string; + /** Value of the custom property. Limited to booleans, numbers, and strings. */ + Value: any; + + } + export interface UpdateSharedGroupDataRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -5147,6 +5466,8 @@ declare module PlayFabClientModels { AndroidDeviceInfo?: UserAndroidDeviceInfo; /** Sign in with Apple account information, if an Apple account has been linked */ AppleAccountInfo?: UserAppleIdInfo; + /** Battle.net account information, if a Battle.net account has been linked */ + BattleNetAccountInfo?: UserBattleNetInfo; /** Timestamp indicating when the user account was created */ Created: string; /** Custom ID information, if a custom ID has been assigned */ @@ -5204,6 +5525,14 @@ declare module PlayFabClientModels { } + export interface UserBattleNetInfo { + /** Battle.net identifier */ + BattleNetAccountId?: string; + /** Battle.net display name */ + BattleNetBattleTag?: string; + + } + export interface UserCustomIdInfo { /** Custom ID */ CustomId?: string; @@ -5332,7 +5661,9 @@ declare module PlayFabClientModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; export interface UserPrivateAccountInfo { /** user email address */ @@ -5341,10 +5672,17 @@ declare module PlayFabClientModels { } export interface UserPsnInfo { + /** + * Id of the PlayStation :tm: Network issuer environment this account is keyed under. Supply this value as IssuerId when + * looking the account up. + */ + IssuerId?: number; /** PlayStation :tm: Network account ID */ PsnAccountId?: string; /** PlayStation :tm: Network online ID */ PsnOnlineId?: string; + /** PlayStation :tm: Network sandbox ID */ + PsnSandboxId?: string; } @@ -5471,10 +5809,12 @@ declare module PlayFabClientModels { CurrencyCode?: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; + /** Base64 encoded receipt data, passed back by the App Store as a result of a successful purchase. */ + JwsReceiptData?: string; /** Amount of the stated currency paid, in centesimal units. */ PurchasePrice: number; /** Base64 encoded receipt data, passed back by the App Store as a result of a successful purchase. */ - ReceiptData: string; + ReceiptData?: string; } diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabCloudScriptApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabCloudScriptApi.d.ts index 496d74f1..38ac8fc3 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabCloudScriptApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabCloudScriptApi.d.ts @@ -489,6 +489,8 @@ declare module PlayFabCloudScriptModels { FunctionName?: string; /** The object returned from the function, if any */ FunctionResult?: any; + /** The size in bytes of the object returned from the function, if any */ + FunctionResultSize?: number; /** Flag indicating if the FunctionResult was too large and was subsequently dropped from this event. */ FunctionResultTooLarge?: boolean; @@ -624,7 +626,9 @@ declare module PlayFabCloudScriptModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; export interface LogStatement { /** Optional object accompanying the message as contextual information */ diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabDataApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabDataApi.d.ts index ec9909ef..287d8c21 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabDataApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabDataApi.d.ts @@ -52,8 +52,11 @@ declare module PlayFabDataModels { /** Names of the files to have their pending uploads aborted. */ FileNames: string[]; /** - * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not - * be performed. + * Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the + * InitiateFileUploads API or other APIs, you can ensure that the file upload abort operation is performed only if the + * profile has not been updated since you last loaded that version. If the profile for the same entity has been updated, + * the operation will fail with an EntityProfileVersionMismatch error. The conflicting update can be caused by any + * operation that modifies the entity profile, including SetObjects, FinalizeFileUploads, and UpdateStatistics. */ ProfileVersion?: number; @@ -75,8 +78,11 @@ declare module PlayFabDataModels { /** Names of the files to be deleted. */ FileNames: string[]; /** - * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not - * be performed. + * Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the + * GetFiles API or other APIs, you can ensure that the file deletion is performed only if the profile has not been updated + * since you last loaded that version. If the profile for the same entity has been updated, the operation will fail with an + * EntityProfileVersionMismatch error. The conflicting update can be caused by any operation that modifies the entity + * profile, including SetObjects, FinalizeFileUploads, and UpdateStatistics. */ ProfileVersion?: number; @@ -105,7 +111,13 @@ declare module PlayFabDataModels { Entity: EntityKey; /** Names of the files to be finalized. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.' */ FileNames: string[]; - /** The current version of the profile, can be used for concurrency control during updates. */ + /** + * Field used for concurrency control. By specifying the previously returned ProfileVersion value from the + * InitiateFileUploads API, you can ensure that the file upload finalization is performed only if the profile has not been + * updated since you last loaded that version. If the profile for the same entity has been updated, the operation will fail + * with an EntityProfileVersionMismatch error. The conflicting update can be caused by any operation that modifies the + * entity profile, including SetObjects, FinalizeFileUploads, and UpdateStatistics. + */ ProfileVersion: number; } @@ -191,8 +203,11 @@ declare module PlayFabDataModels { /** Names of the files to be set. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.' */ FileNames: string[]; /** - * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not - * be performed. + * Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the + * GetFiles API or other APIs, you can ensure that the file upload initiation is performed only if the profile has not been + * updated since you last loaded that version. If the profile for the same entity has been updated, the operation will fail + * with an EntityProfileVersionMismatch error. The conflicting update can be caused by any operation that modifies the + * entity profile, including SetObjects, FinalizeFileUploads, and UpdateStatistics. */ ProfileVersion?: number; @@ -258,9 +273,11 @@ declare module PlayFabDataModels { /** The entity to perform this action on. */ Entity: EntityKey; /** - * Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from - * GetProfile API, you can ensure that the object set will only be performed if the profile has not been updated by any - * other clients since the version you last loaded. + * Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the + * GetObjects API or other APIs, you can ensure that the object update is performed only if the profile has not been + * updated since you last loaded that version. If the profile for the same entity has been updated, the operation will fail + * with an EntityProfileVersionMismatch error. The conflicting update can be caused by any operation that modifies the + * entity profile, including SetObjects, FinalizeFileUploads, and UpdateStatistics. */ ExpectedProfileVersion?: number; /** Collection of objects to set on the profile. */ diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabEconomyApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabEconomyApi.d.ts index 903f2539..733020c5 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabEconomyApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabEconomyApi.d.ts @@ -10,7 +10,7 @@ declare module PlayFabEconomyModule { */ AddInventoryItems(request: PlayFabEconomyModels.AddInventoryItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** - * Creates a new item in the working catalog using provided metadata. + * Creates a new item in the working catalog using provided metadata. Note: SAS tokens provided are valid for 1 hour. * https://docs.microsoft.com/rest/api/playfab/economy/catalog/createdraftitem */ CreateDraftItem(request: PlayFabEconomyModels.CreateDraftItemRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -69,13 +69,15 @@ declare module PlayFabEconomyModule { /** * Retrieves an item from the working catalog. This item represents the current working state of the item. GetDraftItem * does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note - * that item references data is cached and may take a few moments for changes to propagate. + * that item references data is cached and may take a few moments for changes to propagate. Note: SAS tokens provided are + * valid for 1 hour. * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getdraftitem */ GetDraftItem(request: PlayFabEconomyModels.GetDraftItemRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves a paginated list of the items from the draft catalog. Up to 50 IDs can be retrieved in a single request. - * GetDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. + * GetDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. Note: + * SAS tokens provided are valid for 1 hour. * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getdraftitems */ GetDraftItems(request: PlayFabEconomyModels.GetDraftItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -156,14 +158,10 @@ declare module PlayFabEconomyModule { */ GetItems(request: PlayFabEconomyModels.GetItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** - * Gets the access tokens. - * https://docs.microsoft.com/rest/api/playfab/economy/inventory/getmicrosoftstoreaccesstokens - */ - GetMicrosoftStoreAccessTokens(request: PlayFabEconomyModels.GetMicrosoftStoreAccessTokensRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; - /** - * Get transaction history for a player. Up to 250 Events can be returned at once. You can use continuation tokens to - * paginate through results that return greater than the limit. Getting transaction history has a lower RPS limit than - * getting a Player's inventory with Player Entities having a limit of 30 requests in 300 seconds. + * Get transaction history for a player. Up to 50 Events can be returned at once (or 250 with response compression + * enabled). You can use continuation tokens to paginate through results that return greater than the limit. Getting + * transaction history has a lower RPS limit than getting a Player's inventory with Player Entities having a limit of 30 + * requests in 300 seconds. * https://docs.microsoft.com/rest/api/playfab/economy/inventory/gettransactionhistory */ GetTransactionHistory(request: PlayFabEconomyModels.GetTransactionHistoryRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -184,13 +182,18 @@ declare module PlayFabEconomyModule { * https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemappleappstoreinventoryitems */ RedeemAppleAppStoreInventoryItems(request: PlayFabEconomyModels.RedeemAppleAppStoreInventoryItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Redeem items. + * https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemappleappstorewithjwsinventoryitems + */ + RedeemAppleAppStoreWithJwsInventoryItems(request: PlayFabEconomyModels.RedeemAppleAppStoreWithJwsInventoryItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Redeem items. * https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemgoogleplayinventoryitems */ RedeemGooglePlayInventoryItems(request: PlayFabEconomyModels.RedeemGooglePlayInventoryItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** - * Redeem items. + * Redeem items from the Microsoft Store. Supported entitlement types are Developer Manager Consumable and Durable. * https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemmicrosoftstoreinventoryitems */ RedeemMicrosoftStoreInventoryItems(request: PlayFabEconomyModels.RedeemMicrosoftStoreInventoryItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -273,7 +276,7 @@ declare module PlayFabEconomyModule { */ UpdateCatalogConfig(request: PlayFabEconomyModels.UpdateCatalogConfigRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** - * Update the metadata for an item in the working catalog. + * Update the metadata for an item in the working catalog. Note: SAS tokens provided are valid for 1 hour. * https://docs.microsoft.com/rest/api/playfab/economy/catalog/updatedraftitem */ UpdateDraftItem(request: PlayFabEconomyModels.UpdateDraftItemRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -459,6 +462,8 @@ declare module PlayFabEconomyModels { PriceOptions?: CatalogPriceOptions; /** Rating summary for this item. */ Rating?: Rating; + /** The real price the item was purchased for per marketplace. */ + RealMoneyPriceDetails?: RealMoneyPriceDetails; /** The date of when the item will be available. If not provided then the product will appear immediately. */ StartDate?: string; /** Optional details for stores items. */ @@ -594,10 +599,6 @@ declare module PlayFabEconomyModels { } - export interface ContentFeed { - - } - type CountryCode = "AF" | "AX" @@ -1163,6 +1164,13 @@ declare module PlayFabEconomyModels { export interface GetDraftItemsRequest extends PlayFabModule.IPlayFabRequestCommon { /** List of item alternate IDs. */ AlternateIds?: CatalogAlternateId[]; + /** + * An opaque token used to retrieve the next page of items created by the caller, if any are available. Should be null on + * initial request. + */ + ContinuationToken?: string; + /** Number of items to retrieve. This value is optional. Default value is 10. */ + Count?: number; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** The entity to perform this action on. */ @@ -1288,6 +1296,8 @@ declare module PlayFabEconomyModels { CustomTags?: { [key: string]: string | null }; /** The entity to perform this action on. */ Entity?: EntityKey; + /** The token to get the status of the inventory operation. */ + OperationToken?: string; } @@ -1445,29 +1455,15 @@ declare module PlayFabEconomyModels { } - export interface GetMicrosoftStoreAccessTokensRequest extends PlayFabModule.IPlayFabRequestCommon { - /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ - CustomTags?: { [key: string]: string | null }; - - } - - export interface GetMicrosoftStoreAccessTokensResponse extends PlayFabModule.IPlayFabResultCommon { - /** - * The collections access token for calling https://onestore.microsoft.com/b2b/keys/create/collections to obtain a - * CollectionsIdKey for the user - */ - CollectionsAccessToken?: string; - /** The date the collections access token expires */ - CollectionsAccessTokenExpirationDate: string; - - } - export interface GetTransactionHistoryRequest extends PlayFabModule.IPlayFabRequestCommon { /** The id of the entity's collection to perform this action on. (Default="default") */ CollectionId?: string; /** An opaque token used to retrieve the next page of items, if any are available. Should be null on initial request. */ ContinuationToken?: string; - /** Number of items to retrieve. This value is optional. The default value is 10 */ + /** + * Number of items to retrieve. This value is optional. The default value is 10. The maximum value is 50, or 250 if + * response compression is enabled. + */ Count: number; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -1554,6 +1550,8 @@ declare module PlayFabEconomyModels { Id?: string; /** The stack id of the item. */ StackId?: string; + /** Only used for subscriptions. The date of when the item started in UTC. */ + StartDate?: string; /** The type of the item. This should correspond to the item type in the catalog. */ Type?: string; @@ -1607,10 +1605,6 @@ declare module PlayFabEconomyModels { | "Approved" | "Rejected"; - export interface PayoutDetails { - - } - export interface Permissions { /** * The list of ids of Segments that the a player can be in to purchase from the store. When a value is provided, the player @@ -1766,6 +1760,18 @@ declare module PlayFabEconomyModels { } export interface RealMoneyPriceDetails { + /** The 'AppleAppStore' price amount per CurrencyCode. 'USD' supported only. */ + AppleAppStorePrices?: { [key: string]: number }; + /** The 'GooglePlay' price amount per CurrencyCode. 'USD' supported only. */ + GooglePlayPrices?: { [key: string]: number }; + /** The 'MicrosoftStore' price amount per CurrencyCode. 'USD' supported only. */ + MicrosoftStorePrices?: { [key: string]: number }; + /** The 'NintendoEShop' price amount per CurrencyCode. 'USD' supported only. */ + NintendoEShopPrices?: { [key: string]: number }; + /** The 'PlayStationStore' price amount per CurrencyCode. 'USD' supported only. */ + PlayStationStorePrices?: { [key: string]: number }; + /** The 'Steam' price amount per CurrencyCode. 'USD' supported only. */ + SteamPrices?: { [key: string]: number }; } @@ -1791,6 +1797,28 @@ declare module PlayFabEconomyModels { } + export interface RedeemAppleAppStoreWithJwsInventoryItemsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The id of the entity's collection to perform this action on. (Default="default") */ + CollectionId?: string; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The entity to perform this action on. */ + Entity?: EntityKey; + /** The JWS representation of a transaction. */ + JWSTransactions: string[]; + + } + + export interface RedeemAppleAppStoreWithJwsInventoryItemsResponse extends PlayFabModule.IPlayFabResultCommon { + /** The list of failed redemptions from the external marketplace. */ + Failed?: RedemptionFailure[]; + /** The list of successful redemptions from the external marketplace. */ + Succeeded?: RedemptionSuccess[]; + /** The Transaction IDs associated with the inventory modifications */ + TransactionIds?: string[]; + + } + export interface RedeemGooglePlayInventoryItemsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The id of the entity's collection to perform this action on. (Default="default") */ CollectionId?: string; @@ -1816,8 +1844,6 @@ declare module PlayFabEconomyModels { export interface RedeemMicrosoftStoreInventoryItemsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The id of the entity's collection to perform this action on. (Default="default") */ CollectionId?: string; - /** The OneStore Collections Id Key used for AAD authentication. */ - CollectionsIdKey?: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** The entity to perform this action on. */ @@ -1913,18 +1939,20 @@ declare module PlayFabEconomyModels { FailureCode?: string; /** The marketplace error details explaining why the offer failed to redeem. */ FailureDetails?: string; + /** The Marketplace Alternate ID being redeemed. */ + MarketplaceAlternateId?: string; /** The transaction id in the external marketplace. */ MarketplaceTransactionId?: string; - /** The ID of the offer being redeemed. */ - OfferId?: string; } export interface RedemptionSuccess { + /** The timestamp for when the redeem expired. */ + ExpirationTimestamp?: string; + /** The Marketplace Alternate ID being redeemed. */ + MarketplaceAlternateId?: string; /** The transaction id in the external marketplace. */ MarketplaceTransactionId?: string; - /** The ID of the offer being redeemed. */ - OfferId?: string; /** The timestamp for when the redeem was completed. */ SuccessTimestamp: string; @@ -1991,8 +2019,6 @@ declare module PlayFabEconomyModels { Rating: number; /** The ID of the author of the review. */ ReviewerEntity?: EntityKey; - /** Deprecated. Use ReviewerEntity instead. This property will be removed in a future release. */ - ReviewerId?: string; /** The ID of the review. */ ReviewId?: string; /** The full text of this review. */ @@ -2038,12 +2064,6 @@ declare module PlayFabEconomyModels { } - export interface ScanResult { - /** The URL of the item which failed the scan. */ - Url?: string; - - } - export interface SearchItemsRequest extends PlayFabModule.IPlayFabRequestCommon { /** An opaque token used to retrieve the next page of items, if any are available. */ ContinuationToken?: string; @@ -2138,12 +2158,6 @@ declare module PlayFabEconomyModels { } - export interface SubscriptionDetails { - /** The length of time that the subscription will last in seconds. */ - DurationInSeconds: number; - - } - export interface SubtractInventoryItemsOperation { /** The amount to subtract from the current item amount. */ Amount?: number; @@ -2221,6 +2235,10 @@ declare module PlayFabEconomyModels { export interface Transaction { /** The API call that caused this transaction. */ ApiName?: string; + /** Additional details about the transaction. Null if it was not a clawback operation. */ + ClawbackDetails?: TransactionClawbackDetails; + /** The custom tags associated with this transactions. */ + CustomTags?: { [key: string]: string | null }; /** The type of item that the the operation occurred on. */ ItemType?: string; /** The operations that occurred. */ @@ -2240,6 +2258,12 @@ declare module PlayFabEconomyModels { } + export interface TransactionClawbackDetails { + /** The id of the clawed back operation. */ + TransactionIdClawedback?: string; + + } + export interface TransactionOperation { /** The amount of items in this transaction. */ Amount?: number; @@ -2259,6 +2283,10 @@ declare module PlayFabEconomyModels { } export interface TransactionPurchaseDetails { + /** The friendly id of the item that was purchased. */ + ItemFriendlyId?: string; + /** The id of the item that was purchased. */ + ItemId?: string; /** The friendly id of the Store the item was purchased from or null. */ StoreFriendlyId?: string; /** The id of the Store the item was purchased from or null. */ diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabEventsApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabEventsApi.d.ts index ad01e759..6bcc412f 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabEventsApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabEventsApi.d.ts @@ -9,21 +9,46 @@ declare module PlayFabEventsModule { * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/createtelemetrykey */ CreateTelemetryKey(request: PlayFabEventsModels.CreateTelemetryKeyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Deletes a Data Connection from a title. + * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/deletedataconnection + */ + DeleteDataConnection(request: PlayFabEventsModels.DeleteDataConnectionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes a telemetry key configured for the title. * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/deletetelemetrykey */ DeleteTelemetryKey(request: PlayFabEventsModels.DeleteTelemetryKeyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves a single Data Connection associated with a title. + * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/getdataconnection + */ + GetDataConnection(request: PlayFabEventsModels.GetDataConnectionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information about a telemetry key configured for the title. * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/gettelemetrykey */ GetTelemetryKey(request: PlayFabEventsModels.GetTelemetryKeyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the list of Data Connections associated with a title. + * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/listdataconnections + */ + ListDataConnections(request: PlayFabEventsModels.ListDataConnectionsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Lists all telemetry keys configured for the title. * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/listtelemetrykeys */ ListTelemetryKeys(request: PlayFabEventsModels.ListTelemetryKeysRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Creates or updates a Data Connection on a title. + * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/setdataconnection + */ + SetDataConnection(request: PlayFabEventsModels.SetDataConnectionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Sets a Data Connection for the title to either the active or deactivated state. + * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/setdataconnectionactive + */ + SetDataConnectionActive(request: PlayFabEventsModels.SetDataConnectionActiveRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Sets a telemetry key to the active or deactivated state. * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/settelemetrykeyactive @@ -61,6 +86,95 @@ declare module PlayFabEventsModels { } + export interface DataConnectionAzureBlobSettings { + /** Name of the storage account. */ + AccountName?: string; + /** Name of the container. */ + ContainerName?: string; + /** Azure Entra Tenant Id. */ + TenantId?: string; + + } + + export interface DataConnectionAzureDataExplorerSettings { + /** The URI of the ADX cluster. */ + ClusterUri?: string; + /** The database to write to. */ + Database?: string; + /** The table to write to. */ + Table?: string; + + } + + export interface DataConnectionDetails { + /** Settings of the data connection. */ + ConnectionSettings: DataConnectionSettings; + /** Whether or not the connection is currently active. */ + IsActive: boolean; + /** The name of the data connection. */ + Name: string; + /** Current status of the data connection, if any. */ + Status?: DataConnectionStatusDetails; + /** The type of data connection. */ + Type: string; + + } + + type DataConnectionErrorState = "OK" + + | "Error"; + + export interface DataConnectionFabricKQLSettings { + /** The URI of the Fabric cluster. */ + ClusterUri?: string; + /** The database to write to. */ + Database?: string; + /** The table to write to. */ + Table?: string; + + } + + export interface DataConnectionSettings { + /** Settings if the type of connection is AzureBlobStorage. */ + AzureBlobSettings?: DataConnectionAzureBlobSettings; + /** Settings if the type of connection is AzureDataExplorer. */ + AzureDataExplorerSettings?: DataConnectionAzureDataExplorerSettings; + /** Settings if the type of connection is FabricKQL. */ + AzureFabricKQLSettings?: DataConnectionFabricKQLSettings; + + } + + export interface DataConnectionStatusDetails { + /** The name of the error affecting the data connection, if any. */ + Error?: string; + /** A description of the error affecting the data connection, if any. This may be empty for some errors. */ + ErrorMessage?: string; + /** The most recent time of the error affecting the data connection, if any. */ + MostRecentErrorTime?: string; + /** Indicates if the connection is in a normal state or error state. */ + State?: string; + + } + + type DataConnectionType = "AzureBlobStorage" + + | "AzureDataExplorer" + | "FabricKQL"; + + export interface DeleteDataConnectionRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The name of the data connection to delete. */ + Name: string; + + } + + export interface DeleteDataConnectionResponse extends PlayFabModule.IPlayFabResultCommon { + /** Indicates whether or not the connection was deleted as part of the request. */ + WasDeleted: boolean; + + } + export interface DeleteTelemetryKeyRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -118,6 +232,20 @@ declare module PlayFabEventsModels { } + export interface GetDataConnectionRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The name of the data connection to retrieve. */ + Name: string; + + } + + export interface GetDataConnectionResponse extends PlayFabModule.IPlayFabResultCommon { + /** The details of the queried Data Connection. */ + DataConnection?: DataConnectionDetails; + + } + export interface GetTelemetryKeyRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -134,6 +262,18 @@ declare module PlayFabEventsModels { } + export interface ListDataConnectionsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + + } + + export interface ListDataConnectionsResponse extends PlayFabModule.IPlayFabResultCommon { + /** The list of existing Data Connections. */ + DataConnections?: DataConnectionDetails[]; + + } + export interface ListTelemetryKeysRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -148,6 +288,47 @@ declare module PlayFabEventsModels { } + export interface SetDataConnectionActiveRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Whether to set the data connection to active (true) or deactivated (false). */ + Active: boolean; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The name of the data connection to update. */ + Name: string; + + } + + export interface SetDataConnectionActiveResponse extends PlayFabModule.IPlayFabResultCommon { + /** The most current details about the data connection that was to be updated. */ + DataConnection?: DataConnectionDetails; + /** + * Indicates whether or not the data connection was updated. If false, the data connection was already in the desired + * state. + */ + WasUpdated: boolean; + + } + + export interface SetDataConnectionRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Settings of the data connection. */ + ConnectionSettings: DataConnectionSettings; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Whether or not the connection is currently active. */ + IsActive: boolean; + /** The name of the data connection to update or create. */ + Name: string; + /** The type of data connection. */ + Type: string; + + } + + export interface SetDataConnectionResponse extends PlayFabModule.IPlayFabResultCommon { + /** The details of the Data Connection to be created or updated. */ + DataConnection?: DataConnectionDetails; + + } + export interface SetTelemetryKeyActiveRequest extends PlayFabModule.IPlayFabRequestCommon { /** Whether to set the key to active (true) or deactivated (false). */ Active: boolean; diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabGroupsApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabGroupsApi.d.ts index 16f98aba..2ef182c1 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabGroupsApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabGroupsApi.d.ts @@ -600,9 +600,10 @@ declare module PlayFabGroupsModels { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** - * Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from the - * GetGroup API, you can ensure that the group data update will only be performed if the group has not been updated by any - * other clients since the version you last loaded. + * Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the + * GetGroup API, you can ensure that the group data update is performed only if the group has not been updated since you + * last loaded that version. If the same group has been updated, the requested update will not occur and the returned + * SetResult value will be None. */ ExpectedProfileVersion?: number; /** The identifier of the group */ @@ -628,9 +629,10 @@ declare module PlayFabGroupsModels { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** - * Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from the - * GetGroup API, you can ensure that the group data update will only be performed if the group has not been updated by any - * other clients since the version you last loaded. + * Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the + * GetGroup API, you can ensure that the group role update is performed only if the group has not been updated since you + * last loaded that version. If the same group has been updated, the requested update will not occur and the returned + * SetResult value will be None. */ ExpectedProfileVersion?: number; /** The identifier of the group */ diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabInsightsApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabInsightsApi.d.ts index c9389833..bdc18b6b 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabInsightsApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabInsightsApi.d.ts @@ -130,7 +130,7 @@ declare module PlayFabInsightsModels { } export interface InsightsPerformanceLevel { - /** Number of allowed active event exports. */ + /** Number of allowed active event exports. This value is always zero. */ ActiveEventExports: number; /** Maximum cache size. */ CacheSizeMB: number; diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabMatchmakerApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabMatchmakerApi.d.ts deleted file mode 100644 index 985dea57..00000000 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabMatchmakerApi.d.ts +++ /dev/null @@ -1,13 +0,0 @@ -/// - -declare module PlayFabMatchmakerModule { - export interface IPlayFabMatchmaker { - ForgetAllCredentials(): void; - - - } -} - -declare module PlayFabMatchmakerModels { - -} diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabMultiplayerApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabMultiplayerApi.d.ts index 36df0cae..17112934 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabMultiplayerApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabMultiplayerApi.d.ts @@ -521,7 +521,37 @@ declare module PlayFabMultiplayerModels { | "CentralIndia" | "UaeNorth" | "UkSouth" - | "SwedenCentral"; + | "SwedenCentral" + | "CanadaCentral" + | "MexicoCentral" + | "WestUs3" + | "CanadaEast" + | "UkWest" + | "FranceSouth" + | "SouthIndia" + | "SpainCentral" + | "GermanyWestCentral" + | "ItalyNorth" + | "IndonesiaCentral" + | "ChileCentral" + | "PolandCentral" + | "NewZealandNorth" + | "BrazilSoutheast" + | "NorwayEast" + | "SwitzerlandNorth" + | "MalaysiaWest" + | "IsraelCentral" + | "QatarCentral" + | "UaeCentral" + | "GermanyNorth" + | "AustriaEast" + | "BelgiumCentral" + | "DenmarkEast" + | "SwitzerlandWest" + | "SwedenSouth" + | "NorwayWest" + | "SouthAfricaWest" + | "MalaysiaSouth"; type AzureVmFamily = "A" @@ -533,10 +563,14 @@ declare module PlayFabMultiplayerModels { | "Dasv4" | "Dav4" | "Dadsv5" + | "Dadsv6" | "Eav4" | "Easv4" | "Ev4" | "Esv4" + | "Edsv4" + | "Edsv5" + | "Edsv6" | "Dsv3" | "Dsv2" | "NCasT4_v3" @@ -544,7 +578,16 @@ declare module PlayFabMultiplayerModels { | "Ddsv4" | "HBv3" | "Ddv5" - | "Ddsv5"; + | "Ddsv5" + | "Ddsv6" + | "Fasv6" + | "Fasv7" + | "Fadsv7" + | "Eadsv5" + | "Eadsv6" + | "Eadsv7" + | "Dadsv7" + | "Dpdsv6"; type AzureVmSize = "Standard_A1" @@ -573,6 +616,18 @@ declare module PlayFabMultiplayerModels { | "Standard_F4s_v2" | "Standard_F8s_v2" | "Standard_F16s_v2" + | "Standard_F2as_v6" + | "Standard_F4as_v6" + | "Standard_F8as_v6" + | "Standard_F16as_v6" + | "Standard_F2as_v7" + | "Standard_F4as_v7" + | "Standard_F8as_v7" + | "Standard_F16as_v7" + | "Standard_F2ads_v7" + | "Standard_F4ads_v7" + | "Standard_F8ads_v7" + | "Standard_F16ads_v7" | "Standard_D2as_v4" | "Standard_D4as_v4" | "Standard_D8as_v4" @@ -585,6 +640,14 @@ declare module PlayFabMultiplayerModels { | "Standard_D4ads_v5" | "Standard_D8ads_v5" | "Standard_D16ads_v5" + | "Standard_D2ads_v6" + | "Standard_D4ads_v6" + | "Standard_D8ads_v6" + | "Standard_D16ads_v6" + | "Standard_D2ads_v7" + | "Standard_D4ads_v7" + | "Standard_D8ads_v7" + | "Standard_D16ads_v7" | "Standard_E2a_v4" | "Standard_E4a_v4" | "Standard_E8a_v4" @@ -593,6 +656,30 @@ declare module PlayFabMultiplayerModels { | "Standard_E4as_v4" | "Standard_E8as_v4" | "Standard_E16as_v4" + | "Standard_E2ads_v5" + | "Standard_E4ads_v5" + | "Standard_E8ads_v5" + | "Standard_E16ads_v5" + | "Standard_E2ads_v6" + | "Standard_E4ads_v6" + | "Standard_E8ads_v6" + | "Standard_E16ads_v6" + | "Standard_E2ads_v7" + | "Standard_E4ads_v7" + | "Standard_E8ads_v7" + | "Standard_E16ads_v7" + | "Standard_E2ds_v4" + | "Standard_E4ds_v4" + | "Standard_E8ds_v4" + | "Standard_E16ds_v4" + | "Standard_E2ds_v5" + | "Standard_E4ds_v5" + | "Standard_E8ds_v5" + | "Standard_E16ds_v5" + | "Standard_E2ds_v6" + | "Standard_E4ds_v6" + | "Standard_E8ds_v6" + | "Standard_E16ds_v6" | "Standard_D2s_v3" | "Standard_D4s_v3" | "Standard_D8s_v3" @@ -625,7 +712,15 @@ declare module PlayFabMultiplayerModels { | "Standard_D4ds_v5" | "Standard_D8ds_v5" | "Standard_D16ds_v5" - | "Standard_D32ds_v5"; + | "Standard_D32ds_v5" + | "Standard_D2ds_v6" + | "Standard_D4ds_v6" + | "Standard_D8ds_v6" + | "Standard_D16ds_v6" + | "Standard_D2pds_v6" + | "Standard_D4pds_v6" + | "Standard_D8pds_v6" + | "Standard_D16pds_v6"; export interface BuildAliasDetailsResponse extends PlayFabModule.IPlayFabResultCommon { /** The guid string alias Id of the alias to be created or updated. */ @@ -711,7 +806,7 @@ declare module PlayFabMultiplayerModels { export interface CancelAllMatchmakingTicketsForPlayerRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** The entity key of the player whose tickets should be canceled. */ + /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ Entity?: EntityKey; /** The name of the queue from which a player's tickets should be canceled. */ QueueName: string; @@ -725,7 +820,7 @@ declare module PlayFabMultiplayerModels { export interface CancelAllServerBackfillTicketsForPlayerRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** The entity key of the player whose backfill tickets should be canceled. */ + /** The entity to perform this action on. */ Entity: EntityKey; /** The name of the queue from which a player's backfill tickets should be canceled. */ QueueName: string; @@ -871,8 +966,6 @@ declare module PlayFabMultiplayerModels { * Game Server SDK (GSDK).Constraints: Maximum number of keys: 30, Maximum key length: 50, Maximum value length: 100 */ Metadata?: { [key: string]: string | null }; - /** The configuration for the monitoring application on the build */ - MonitoringApplicationConfiguration?: MonitoringApplicationConfigurationParams; /** The number of multiplayer servers to host on a single VM. */ MultiplayerServerCountPerVm: number; /** The ports to map the build on. */ @@ -916,8 +1009,6 @@ declare module PlayFabMultiplayerModels { LinuxInstrumentationConfiguration?: LinuxInstrumentationConfiguration; /** The metadata of the build. */ Metadata?: { [key: string]: string | null }; - /** The configuration for the monitoring application for the build */ - MonitoringApplicationConfiguration?: MonitoringApplicationConfiguration; /** The number of multiplayer servers to host on a single VM of the build. */ MultiplayerServerCountPerVm: number; /** The OS platform used for running the game process. */ @@ -930,11 +1021,6 @@ declare module PlayFabMultiplayerModels { ServerResourceConstraints?: ServerResourceConstraintParams; /** The type of game server being hosted. */ ServerType?: string; - /** - * When true, assets will be downloaded and uncompressed in memory, without the compressedversion being written first to - * disc. - */ - UseStreamingForAssetDownloads?: boolean; /** The VM size the build was created on. */ VmSize?: string; /** The configuration for the VmStartupScript feature for the build */ @@ -972,8 +1058,6 @@ declare module PlayFabMultiplayerModels { * Game Server SDK (GSDK).Constraints: Maximum number of keys: 30, Maximum key length: 50, Maximum value length: 100 */ Metadata?: { [key: string]: string | null }; - /** The configuration for the monitoring application on the build */ - MonitoringApplicationConfiguration?: MonitoringApplicationConfigurationParams; /** The number of multiplayer servers to host on a single VM. */ MultiplayerServerCountPerVm: number; /** The ports to map the build on. */ @@ -1022,8 +1106,6 @@ declare module PlayFabMultiplayerModels { InstrumentationConfiguration?: InstrumentationConfiguration; /** The metadata of the build. */ Metadata?: { [key: string]: string | null }; - /** The configuration for the monitoring application for the build */ - MonitoringApplicationConfiguration?: MonitoringApplicationConfiguration; /** The number of multiplayer servers to host on a single VM of the build. */ MultiplayerServerCountPerVm: number; /** The OS platform used for running the game process. */ @@ -1038,11 +1120,6 @@ declare module PlayFabMultiplayerModels { ServerType?: string; /** The command to run when the multiplayer server has been allocated, including any arguments. */ StartMultiplayerServerCommand?: string; - /** - * When true, assets will be downloaded and uncompressed in memory, without the compressedversion being written first to - * disc. - */ - UseStreamingForAssetDownloads?: boolean; /** The VM size the build was created on. */ VmSize?: string; /** The configuration for the VmStartupScript feature for the build */ @@ -1085,8 +1162,6 @@ declare module PlayFabMultiplayerModels { * Game Server SDK (GSDK).Constraints: Maximum number of keys: 30, Maximum key length: 50, Maximum value length: 100 */ Metadata?: { [key: string]: string | null }; - /** The configuration for the monitoring application on the build */ - MonitoringApplicationConfiguration?: MonitoringApplicationConfigurationParams; /** The number of multiplayer servers to host on a single VM. */ MultiplayerServerCountPerVm: number; /** The OS platform used for running the game process. */ @@ -1143,8 +1218,6 @@ declare module PlayFabMultiplayerModels { LinuxInstrumentationConfiguration?: LinuxInstrumentationConfiguration; /** The metadata of the build. */ Metadata?: { [key: string]: string | null }; - /** The configuration for the monitoring application for the build */ - MonitoringApplicationConfiguration?: MonitoringApplicationConfiguration; /** The number of multiplayer servers to host on a single VM of the build. */ MultiplayerServerCountPerVm: number; /** The OS platform used for running the game process. */ @@ -1160,11 +1233,6 @@ declare module PlayFabMultiplayerModels { * relative to the root asset folder when unzipped. */ StartMultiplayerServerCommand?: string; - /** - * When true, assets will be downloaded and uncompressed in memory, without the compressedversion being written first to - * disc. - */ - UseStreamingForAssetDownloads?: boolean; /** The VM size the build was created on. */ VmSize?: string; /** The configuration for the VmStartupScript feature for the build */ @@ -1207,6 +1275,12 @@ declare module PlayFabMultiplayerModels { * set ownership. The useConnections property can be either true or false. */ OwnerMigrationPolicy?: string; + /** + * A setting that controls whether only the lobby owner can send invites to join the lobby. When true, only the lobby owner + * can send invites. When false or not specified, any member can send invites. Defaults to false if not specified. + * Restricted to client owned lobbies. + */ + RestrictInvitesToLobbyOwner: boolean; /** * The public key-value pairs which allow queries to differentiate between lobbies. Queries will refer to these key-value * pairs in their filter and order by clauses to retrieve lobbies fitting the specified criteria. At most 30 key-value @@ -1593,7 +1667,11 @@ declare module PlayFabMultiplayerModels { OrderBy?: string; /** Request pagination information. */ Pagination?: PaginationRequest; - /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */ + /** + * Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. Only mutual Xbox Live friends + * (where both users follow each other) are included, unlike GetFriendsList which includes all users the caller is + * following. + */ XboxToken?: string; } @@ -1780,6 +1858,8 @@ declare module PlayFabMultiplayerModels { GameAssetReferences?: AssetReference[]; /** The game certificates for the build. */ GameCertificateReferences?: GameCertificateReference[]; + /** The game secrets for the build. */ + GameSecretReferences?: GameSecretReference[]; /** The instrumentation configuration of the build. */ InstrumentationConfiguration?: InstrumentationConfiguration; /** @@ -2168,6 +2248,12 @@ declare module PlayFabMultiplayerModels { * set ownership. The useConnections property can be either true or false. */ OwnerMigrationPolicy?: string; + /** + * A setting that controls whether only the lobby owner can send invites to join the lobby. When true, only the lobby owner + * can send invites. When false or not specified, any member can send invites. Defaults to false if not specified. + * Restricted to client owned lobbies. + */ + RestrictInvitesToLobbyOwner: boolean; /** * A setting to control whether connections are used. Defaults to true. When true, notifications are sent to subscribed * players, disconnect detection removes connectionHandles, only owner migration policies using connections are allowed, @@ -2460,7 +2546,7 @@ declare module PlayFabMultiplayerModels { export interface ListMatchmakingTicketsForPlayerRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** The entity key for which to find the ticket Ids. */ + /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ Entity?: EntityKey; /** The name of the queue to find a match for. */ QueueName: string; @@ -2559,7 +2645,7 @@ declare module PlayFabMultiplayerModels { export interface ListServerBackfillTicketsForPlayerRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** The entity key for which to find the ticket Ids. */ + /** The entity to perform this action on. */ Entity: EntityKey; /** The name of the queue the tickets are in. */ QueueName: string; @@ -2637,6 +2723,11 @@ declare module PlayFabMultiplayerModels { * PubSub. */ PubSubConnectionHandle?: string; + /** + * A setting that controls lobby invites. When true only owners can invite new players, when false all members area allowed + * to invite. + */ + RestrictInvitesToLobbyOwner: boolean; /** Search data. */ SearchData?: { [key: string]: string | null }; /** Preview: Lobby joined server. This is not the server owner, rather the server that has joined a client owned lobby. */ @@ -2803,30 +2894,6 @@ declare module PlayFabMultiplayerModels { | "Locked"; - export interface MonitoringApplicationConfiguration { - /** Asset which contains the monitoring application files and scripts. */ - AssetReference: AssetReference; - /** Execution script name, this will be the main executable for the monitoring application. */ - ExecutionScriptName: string; - /** Installation script name, this will be run before the ExecutionScript. */ - InstallationScriptName?: string; - /** Timespan the monitoring application will be kept alive when running from the start of the VM */ - OnStartRuntimeInMinutes?: number; - - } - - export interface MonitoringApplicationConfigurationParams { - /** Asset which contains the monitoring application files and scripts. */ - AssetReference: AssetReferenceParams; - /** Execution script name, this will be the main executable for the monitoring application. */ - ExecutionScriptName: string; - /** Installation script name, this will be run before the ExecutionScript. */ - InstallationScriptName?: string; - /** Timespan the monitoring application will be kept alive when running from the start of the VM */ - OnStartRuntimeInMinutes?: number; - - } - export interface MultiplayerServerSummary { /** The connected players in the multiplayer server. */ ConnectedPlayers?: ConnectedPlayer[]; @@ -2903,7 +2970,7 @@ declare module PlayFabMultiplayerModels { export interface PartyNetworkConfiguration { /** Controls whether and how to support direct peer-to-peer connection attempts among devices in the network. */ DirectPeerConnectivityOptions?: string; - /** The maximum number of devices allowed to connect to the network. Must be between 1 and 32, inclusive. */ + /** The maximum number of devices allowed to connect to the network. Must be between 1 and 128, inclusive. */ MaxDevices: number; /** The maximum number of devices allowed per user. Must be greater than 0. */ MaxDevicesPerUser: number; @@ -3046,8 +3113,8 @@ declare module PlayFabMultiplayerModels { */ PreferredRegions: string[]; /** - * Data encoded as a string that is passed to the game server when requested. This can be used to to communicate - * information such as game mode or map through the request flow. + * Data encoded as a string that is passed to the game server when requested. This can be used to communicate information + * such as game mode or map through the request flow. Maximum size is 8KB */ SessionCookie?: string; /** A guid string session ID created track the multiplayer server session over its life. */ @@ -3090,6 +3157,8 @@ declare module PlayFabMultiplayerModels { NetworkConfiguration: PartyNetworkConfiguration; /** A guid string party ID created track the party session over its life. */ PartyId?: string; + /** A player entity Id on behalf of whom the request is being made. */ + PlayFabId?: string; /** * The preferred regions to request a party session from. The party service will iterate through the regions in the * specified order and allocate a party session from the first one that is available. @@ -3106,6 +3175,8 @@ declare module PlayFabMultiplayerModels { InvitationId?: string; /** The guid string party ID of the party session. */ PartyId?: string; + /** The region the party session is located in. */ + Region?: string; /** A base-64 encoded string containing the serialized network descriptor for this party. */ SerializedNetworkDescriptor?: string; @@ -3326,11 +3397,18 @@ declare module PlayFabMultiplayerModels { EntityKey: EntityKey; /** Opaque string, given to a client upon creating a connection with PubSub. */ PubSubConnectionHandle: string; - /** The name of the resource to subscribe to. */ + /** + * The name of the resource to subscribe to. For LobbyChange subscriptions this is the lobbyId. For LobbyInvite + * subscriptions this should always be "@me". + */ ResourceId: string; /** Version number for the subscription of this resource. */ SubscriptionVersion: number; - /** Subscription type. */ + /** + * Subscription type. "LobbyChange" subscriptions allow a member or owner to receive notifications of lobby data, member or + * owner changes. "LobbyInvite" subscriptions allow a player to receive invites to lobbies. A player does not need to be a + * member of a lobby to receive lobby invites. + */ Type: string; } @@ -3624,6 +3702,12 @@ declare module PlayFabMultiplayerModels { * server-owned (must be 'Server') - Any server can set ownership. The useConnections property must be true. */ Owner?: EntityKey; + /** + * A setting that controls whether only the lobby owner can send invites to join the lobby. When true, only the lobby owner + * can send invites. When false or not specified, any member can send invites. Will not modify current configuration if not + * specified. Restricted to client owned lobbies. + */ + RestrictInvitesToLobbyOwner?: boolean; /** * The public key-value pairs which allow queries to differentiate between lobbies. Optional. Sets or updates key-value * pairs on the lobby for use with queries. Only the current lobby owner can set search data. New keys will be added with diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabProfilesApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabProfilesApi.d.ts index 96e73a36..ce708bfc 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabProfilesApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabProfilesApi.d.ts @@ -29,6 +29,11 @@ declare module PlayFabProfilesModule { * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/gettitleplayersfromxboxliveids */ GetTitlePlayersFromXboxLiveIDs(request: PlayFabProfilesModels.GetTitlePlayersFromXboxLiveIDsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Update the display name of the entity + * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/setdisplayname + */ + SetDisplayName(request: PlayFabProfilesModels.SetDisplayNameRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Sets the global title access policy * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/setglobalpolicy @@ -135,6 +140,8 @@ declare module PlayFabProfilesModels { Permissions?: EntityPermissionStatement[]; /** The statistics on this profile. */ Statistics?: { [key: string]: EntityStatisticValue }; + /** A mapping of statistic name to the columns defined in the corresponding definition. */ + StatisticsColumnDetails?: { [key: string]: StatisticColumnCollection }; /** * The version number of the profile in persistent storage at the time of the read. Used for optional optimistic * concurrency during update. @@ -177,6 +184,8 @@ declare module PlayFabProfilesModels { DataAsObject?: boolean; /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ Entity?: EntityKey; + /** Determines whether the entity statistics will be returned in the entity profile. Default is false. */ + IncludeStatistics: boolean; } @@ -196,6 +205,8 @@ declare module PlayFabProfilesModels { DataAsObject?: boolean; /** Entity keys of the profiles to load. Must be between 1 and 25 */ Entities: EntityKey[]; + /** Determines whether the entity statistics will be returned in the entity profile. Default is false. */ + IncludeStatistics: boolean; } @@ -264,6 +275,26 @@ declare module PlayFabProfilesModels { | "Deleted" | "None"; + export interface SetDisplayNameRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The new value to be set on Entity Profile's display name */ + DisplayName?: string; + /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ + Entity?: EntityKey; + /** The expected version of a profile to perform this update on */ + ExpectedVersion?: number; + + } + + export interface SetDisplayNameResponse extends PlayFabModule.IPlayFabResultCommon { + /** The type of operation that occured on the profile's display name */ + OperationResult?: string; + /** The updated version of the profile after the display name update */ + VersionNumber?: number; + + } + export interface SetEntityProfilePolicyRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -315,5 +346,25 @@ declare module PlayFabProfilesModels { } + type StatisticAggregationMethod = "Last" + + | "Min" + | "Max" + | "Sum"; + + export interface StatisticColumn { + /** Aggregation method for calculating new value of a statistic. */ + AggregationMethod: string; + /** Name of the statistic column, as originally configured. */ + Name: string; + + } + + export interface StatisticColumnCollection { + /** Columns for the statistic defining the aggregation method for each column. */ + Columns?: StatisticColumn[]; + + } + } diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabProgressionApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabProgressionApi.d.ts index 28e3d4c3..00230005 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabProgressionApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabProgressionApi.d.ts @@ -35,7 +35,7 @@ declare module PlayFabProgressionModule { */ DeleteStatistics(request: PlayFabProgressionModels.DeleteStatisticsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** - * Get the friend leaderboard for the specified entity. A maximum of 100 friend entries are listed in the leaderboard. + * Get the friend leaderboard for the specified entity. A maximum of 25 friend entries are listed in the leaderboard. * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getfriendleaderboardforentity */ GetFriendLeaderboardForEntity(request: PlayFabProgressionModels.GetFriendLeaderboardForEntityRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -64,11 +64,6 @@ declare module PlayFabProgressionModule { * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatisticdefinition */ GetStatisticDefinition(request: PlayFabProgressionModels.GetStatisticDefinitionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; - /** - * Get all current statistic definitions information - * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatisticdefinitions - */ - GetStatisticDefinitions(request: PlayFabProgressionModels.GetStatisticDefinitionsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets statistics for the specified entity. * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatistics @@ -99,16 +94,31 @@ declare module PlayFabProgressionModule { * https://docs.microsoft.com/rest/api/playfab/progression/statistics/liststatisticdefinitions */ ListStatisticDefinitions(request: PlayFabProgressionModels.ListStatisticDefinitionsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks an aggregation source from a statistic definition. + * https://docs.microsoft.com/rest/api/playfab/progression/statistics/unlinkaggregationsourcefromstatistic + */ + UnlinkAggregationSourceFromStatistic(request: PlayFabProgressionModels.UnlinkAggregationSourceFromStatisticRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Unlinks a leaderboard definition from it's linked statistic definition. * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/unlinkleaderboardfromstatistic */ UnlinkLeaderboardFromStatistic(request: PlayFabProgressionModels.UnlinkLeaderboardFromStatisticRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Updates a leaderboard definition. + * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/updateleaderboarddefinition + */ + UpdateLeaderboardDefinition(request: PlayFabProgressionModels.UpdateLeaderboardDefinitionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Adds or updates entries on the specified leaderboard. * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/updateleaderboardentries */ UpdateLeaderboardEntries(request: PlayFabProgressionModels.UpdateLeaderboardEntriesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Update an existing entity statistic definition. + * https://docs.microsoft.com/rest/api/playfab/progression/statistics/updatestatisticdefinition + */ + UpdateStatisticDefinition(request: PlayFabProgressionModels.UpdateStatisticDefinitionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Update statistics on an entity profile. Depending on the statistic definition, this may result in entity being ranked on * various leaderboards. @@ -121,7 +131,10 @@ declare module PlayFabProgressionModule { declare module PlayFabProgressionModels { export interface CreateLeaderboardDefinitionRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Leaderboard columns describing the sort directions, cannot be changed after creation. */ + /** + * Leaderboard columns describing the sort directions, cannot be changed after creation. A maximum of 5 columns are + * allowed. + */ Columns: LeaderboardColumn[]; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -130,23 +143,33 @@ declare module PlayFabProgressionModels { * 'external' as the type. */ EntityType: string; + /** [In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted. */ + EventEmissionConfig?: LeaderboardEventEmissionConfig; /** A name for the leaderboard, unique per title. */ Name: string; /** Maximum number of entries on this leaderboard */ SizeLimit: number; /** The version reset configuration for the leaderboard definition. */ - VersionConfiguration: VersionConfiguration; + VersionConfiguration?: VersionConfiguration; } export interface CreateStatisticDefinitionRequest extends PlayFabModule.IPlayFabRequestCommon { - /** The columns for the statistic defining the aggregation method for each column. */ + /** + * [In Preview]: The list of statistic definition names whose scores must be aggregated towards this stat. If + * AggregationSource is specified, the entityType of this definition MUST be Title (making it a CommunityStat). Currently, + * only one aggregation source can be specified. + */ + AggregationSources?: string[]; + /** The columns for the statistic defining the aggregation method for each column. A maximum of 5 columns are allowed. */ Columns?: StatisticColumn[]; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** The entity type allowed to have score(s) for this statistic. */ EntityType?: string; - /** Name of the statistic. Must be less than 50 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */ + /** [In Preview]: Configurations for different Statistics events that can be emitted by the service. */ + EventEmissionConfig?: StatisticsEventEmissionConfig; + /** Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */ Name: string; /** The version reset configuration for the statistic definition. */ VersionConfiguration?: VersionConfiguration; @@ -224,9 +247,9 @@ declare module PlayFabProgressionModels { } export interface EntityStatistics { - /** Entity key */ + /** The entity for which the statistics are returned. */ EntityKey?: EntityKey; - /** All statistics for the given entitykey */ + /** The statistics for the given entity key. */ Statistics?: EntityStatisticValue[]; } @@ -243,6 +266,11 @@ declare module PlayFabProgressionModels { } + type EventType = "None" + + | "Telemetry" + | "PlayStream"; + type ExternalFriendSources = "None" | "Steam" @@ -256,7 +284,7 @@ declare module PlayFabProgressionModels { CustomTags?: { [key: string]: string | null }; /** Name of the leaderboard. */ LeaderboardName: string; - /** Maximum number of results to return from the leaderboard. Minimum 1, maximum 1,000. */ + /** Maximum number of results to return from the leaderboard. Minimum 1, maximum 100. */ PageSize: number; /** Index position to start from. 1 is beginning of leaderboard. */ StartingPosition?: number; @@ -266,8 +294,12 @@ declare module PlayFabProgressionModels { } export interface GetEntityLeaderboardResponse extends PlayFabModule.IPlayFabResultCommon { - /** Leaderboard columns describing the sort directions, */ + /** Leaderboard columns describing the sort directions. */ Columns?: LeaderboardColumn[]; + /** The number of entries on the leaderboard. */ + EntryCount: number; + /** The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. */ + NextReset?: string; /** Individual entity rankings in the leaderboard, in sorted order by rank. */ Rankings?: EntityLeaderboardEntry[]; /** Version of the leaderboard being returned. */ @@ -332,6 +364,8 @@ declare module PlayFabProgressionModels { * 'external' as the type. */ EntityType: string; + /** [In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted. */ + EventEmissionConfig?: LeaderboardEventEmissionConfig; /** Last time, in UTC, leaderboard version was incremented. */ LastResetTime?: string; /** A name for the leaderboard, unique per title. */ @@ -360,18 +394,28 @@ declare module PlayFabProgressionModels { export interface GetStatisticDefinitionRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Name of the statistic. Must be less than 50 characters. */ + /** Name of the statistic. Must be less than 150 characters. */ Name: string; } export interface GetStatisticDefinitionResponse extends PlayFabModule.IPlayFabResultCommon { + /** The list of statistic definitions names this definition aggregates to. */ + AggregationDestinations?: string[]; + /** + * The list of statistic definitions names whose values must be aggregated towards this stat. If AggregationSource is + * specified, the entityType of this definition MUST be Title (making it a CommunityStat). Currently, only one aggregation + * source can be specified. + */ + AggregationSources?: string[]; /** The columns for the statistic defining the aggregation method for each column. */ Columns?: StatisticColumn[]; /** Created time, in UTC */ Created: string; /** The entity type that can have this statistic. */ EntityType?: string; + /** [In Preview]: Configurations for different Statistics events that can be emitted by the service. */ + EventEmissionConfig?: StatisticsEventEmissionConfig; /** Last time, in UTC, statistic version was incremented. */ LastResetTime?: string; /** The list of leaderboards that are linked to this statistic definition. */ @@ -385,23 +429,13 @@ declare module PlayFabProgressionModels { } - export interface GetStatisticDefinitionsRequest extends PlayFabModule.IPlayFabRequestCommon { - /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ - CustomTags?: { [key: string]: string | null }; - - } - - export interface GetStatisticDefinitionsResponse extends PlayFabModule.IPlayFabResultCommon { - /** List of statistic definitions for the title. */ - StatisticDefinitions?: StatisticDefinition[]; - - } - export interface GetStatisticsForEntitiesRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** Collection of Entity IDs to retrieve statistics for. */ Entities: EntityKey[]; + /** The list of statistics to return for the user. If set to null, the current version of all statistics are returned. */ + StatisticNames?: string[]; } @@ -418,6 +452,8 @@ declare module PlayFabProgressionModels { CustomTags?: { [key: string]: string | null }; /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ Entity?: EntityKey; + /** The list of statistics to return for the user. If set to null, the current version of all statistics are returned. */ + StatisticNames?: string[]; } @@ -482,6 +518,8 @@ declare module PlayFabProgressionModels { * 'external' as the type. */ EntityType: string; + /** [In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted. */ + EventEmissionConfig?: LeaderboardEventEmissionConfig; /** Last time, in UTC, leaderboard version was incremented. */ LastResetTime?: string; /** A name for the leaderboard, unique per title. */ @@ -495,13 +533,18 @@ declare module PlayFabProgressionModels { } + export interface LeaderboardEntityRankOnVersionEndConfig { + /** The type of event to emit when the leaderboard version end. */ + EventType: string; + /** The maximum number of entity to return on leaderboard version end. Range is 1 to 1000. */ + RankLimit: number; + + } + export interface LeaderboardEntryUpdate { /** The unique Id for the entry. If using PlayFab Entities, this would be the entityId of the entity. */ EntityId: string; - /** - * Arbitrary metadata to store along side the leaderboard entry, will be returned by all Leaderboard APIs. Must be less - * than 50 UTF8 encoded characters. - */ + /** Arbitrary metadata to store along side the leaderboard entry, will be returned by all Leaderboard APIs. */ Metadata?: string; /** * The scores for the leaderboard. The number of values provided here must match the number of columns in the Leaderboard @@ -511,10 +554,24 @@ declare module PlayFabProgressionModels { } + export interface LeaderboardEventEmissionConfig { + /** This event emits the top ranks of the leaderboard when the leaderboard version end. */ + EntityRankOnVersionEndConfig?: LeaderboardEntityRankOnVersionEndConfig; + /** This event is emitted when the leaderboard version end. */ + VersionEndConfig?: LeaderboardVersionEndConfig; + + } + type LeaderboardSortDirection = "Descending" | "Ascending"; + export interface LeaderboardVersionEndConfig { + /** The type of event to emit when the leaderboard version end. */ + EventType: string; + + } + export interface LinkedStatisticColumn { /** The name of the statistic column that this leaderboard column is sourced from. */ LinkedStatisticColumnName: string; @@ -526,24 +583,38 @@ declare module PlayFabProgressionModels { export interface ListLeaderboardDefinitionsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; + /** The page size for the request. */ + PageSize?: number; + /** The skip token for the paged request. */ + SkipToken?: string; } export interface ListLeaderboardDefinitionsResponse extends PlayFabModule.IPlayFabResultCommon { /** List of leaderboard definitions for the title. */ LeaderboardDefinitions?: LeaderboardDefinition[]; + /** The page size on the response. */ + PageSize: number; + /** The skip token for the paged response. */ + SkipToken?: string; } export interface ListStatisticDefinitionsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; + /** The page size for the request. */ + PageSize?: number; + /** The skip token for the paged request. */ + SkipToken?: string; } export interface ListStatisticDefinitionsResponse extends PlayFabModule.IPlayFabResultCommon { - /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ - CustomTags?: { [key: string]: string | null }; + /** The page size on the response. */ + PageSize: number; + /** The skip token for the paged response. */ + SkipToken?: string; /** List of statistic definitions for the title. */ StatisticDefinitions?: StatisticDefinition[]; @@ -577,12 +648,22 @@ declare module PlayFabProgressionModels { } export interface StatisticDefinition { + /** The list of statistic definitions names this definition aggregates to. */ + AggregationDestinations?: string[]; + /** + * The list of statistic definitions names whose values must be aggregated towards this stat. If AggregationSource is + * specified, the entityType of this definition MUST be Title (making it a CommunityStat). Currently, only one aggregation + * source can be specified. + */ + AggregationSources?: string[]; /** The columns for the statistic defining the aggregation method for each column. */ Columns?: StatisticColumn[]; /** Created time, in UTC */ Created: string; /** The entity type that can have this statistic. */ EntityType?: string; + /** [In Preview]: Configurations for different Statistics events that can be emitted by the service. */ + EventEmissionConfig?: StatisticsEventEmissionConfig; /** Last time, in UTC, statistic version was incremented. */ LastResetTime?: string; /** The list of leaderboards that are linked to this statistic definition. */ @@ -602,11 +683,27 @@ declare module PlayFabProgressionModels { } + export interface StatisticsEventEmissionConfig { + /** Emitted when statistics are updated. */ + UpdateEventConfig?: StatisticsUpdateEventConfig; + + } + + export interface StatisticsUpdateEventConfig { + /** The event type to emit when statistics are updated. */ + EventType: string; + + } + export interface StatisticUpdate { /** - * Arbitrary metadata to store along side the statistic, will be returned by all Leaderboard APIs. Must be less than 50 - * UTF8 encoded characters. + * A list of entities to which the statistic update must be aggregated to, in addition to the entity being updated. For + * example, for Group stats where the stat value is aggregated based on the group members, this would refer to the Group + * entity. For a community stat that's aggregated at the Title, it is not required to populate this property (Title is the + * default). */ + AggregationTargetEntityKeys?: EntityKey[]; + /** Arbitrary metadata to store along side the statistic, will be returned by all Leaderboard APIs. */ Metadata?: string; /** Name of the statistic, as originally configured. */ Name: string; @@ -622,6 +719,16 @@ declare module PlayFabProgressionModels { } + export interface UnlinkAggregationSourceFromStatisticRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The name of the statistic to unlink. */ + Name: string; + /** The name of the aggregation source statistic to unlink. */ + SourceStatisticName: string; + + } + export interface UnlinkLeaderboardFromStatisticRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -632,6 +739,20 @@ declare module PlayFabProgressionModels { } + export interface UpdateLeaderboardDefinitionRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** [In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted. */ + EventEmissionConfig?: LeaderboardEventEmissionConfig; + /** The name of the leaderboard to update the definition for. */ + Name: string; + /** Maximum number of entries on this leaderboard */ + SizeLimit?: number; + /** The version reset configuration for the leaderboard definition. */ + VersionConfiguration?: VersionConfiguration; + + } + export interface UpdateLeaderboardEntriesRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -642,6 +763,18 @@ declare module PlayFabProgressionModels { } + export interface UpdateStatisticDefinitionRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** [In Preview]: Configurations for different Statistics events that can be emitted by the service. */ + EventEmissionConfig?: StatisticsEventEmissionConfig; + /** Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */ + Name: string; + /** The version reset configuration for the statistic definition. */ + VersionConfiguration?: VersionConfiguration; + + } + export interface UpdateStatisticsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -649,6 +782,8 @@ declare module PlayFabProgressionModels { Entity?: EntityKey; /** Collection of statistics to update, maximum 50. */ Statistics: StatisticUpdate[]; + /** Optional transactionId of this update which can be used to ensure idempotence. */ + TransactionId?: string; } diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabServerApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabServerApi.d.ts index 64b7b5fa..dbde1d7a 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabServerApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabServerApi.d.ts @@ -23,6 +23,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/account-management/addgenericid */ AddGenericID(request: PlayFabServerModels.AddGenericIDRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Adds or updates a contact email to the specified player's profile. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/addorupdatecontactemail + */ + AddOrUpdateContactEmail(request: PlayFabServerModels.AddOrUpdateContactEmailRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag. * https://docs.microsoft.com/rest/api/playfab/server/playstream/addplayertag @@ -53,7 +58,7 @@ declare module PlayFabServerModule { */ AwardSteamAchievement(request: PlayFabServerModels.AwardSteamAchievementRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** - * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game. + * Bans users by PlayFab ID with optional IP address for the provided game. * https://docs.microsoft.com/rest/api/playfab/server/account-management/banusers */ BanUsers(request: PlayFabServerModels.BanUsersRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -82,6 +87,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/account-management/deleteplayer */ DeletePlayer(request: PlayFabServerModels.DeletePlayerRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Deletes title-specific custom properties for a player + * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/deleteplayercustomproperties + */ + DeletePlayerCustomProperties(request: PlayFabServerModels.DeletePlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes push notification template for title * https://docs.microsoft.com/rest/api/playfab/server/account-management/deletepushnotificationtemplate @@ -108,9 +118,17 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/server-side-cloud-script/executecloudscript */ ExecuteCloudScript(request: PlayFabServerModels.ExecuteCloudScriptServerRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Starts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which + * match the segment definition at the time of the API call. Profiles which change while an export is in progress will not + * be reflected in the results. + * https://docs.microsoft.com/rest/api/playfab/server/playstream/exportplayersinsegment + */ + ExportPlayersInSegment(request: PlayFabServerModels.ExportPlayersInSegmentRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as - * GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change. + * ExportPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not + * change. * https://docs.microsoft.com/rest/api/playfab/server/playstream/getallsegments */ GetAllSegments(request: PlayFabServerModels.GetAllSegmentsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -205,6 +223,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercombinedinfo */ GetPlayerCombinedInfo(request: PlayFabServerModels.GetPlayerCombinedInfoRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves a title-specific custom property value for a player. + * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercustomproperty + */ + GetPlayerCustomProperty(request: PlayFabServerModels.GetPlayerCustomPropertyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the player's profile * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayerprofile @@ -215,15 +238,6 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersegments */ GetPlayerSegments(request: PlayFabServerModels.GetPlayersSegmentsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; - /** - * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match - * the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span - * on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected - * in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being - * called 30 times in one minute. You will be returned an error if you exceed this threshold. - * https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersinsegment - */ - GetPlayersInSegment(request: PlayFabServerModels.GetPlayersInSegmentRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the current version and values for the indicated statistics, for the local player. * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatistics @@ -239,6 +253,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayertags */ GetPlayerTags(request: PlayFabServerModels.GetPlayerTagsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrombattlenetaccountids + */ + GetPlayFabIDsFromBattleNetAccountIds(request: PlayFabServerModels.GetPlayFabIDsFromBattleNetAccountIdsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers. * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookids @@ -266,6 +285,13 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoswitchdeviceids */ GetPlayFabIDsFromNintendoSwitchDeviceIds(request: PlayFabServerModels.GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the unique PlayFab identifiers for the given set of OpenId subject identifiers. A OpenId subject identifier is + * the OpenId issuer plus the OpenId subject for the player, as specified by the title when the OpenId identifier was added + * to the player account. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromopenidsubjectidentifiers + */ + GetPlayFabIDsFromOpenIdSubjectIdentifiers(request: PlayFabServerModels.GetPlayFabIDsFromOpenIdsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers. * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnaccountids @@ -276,12 +302,23 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnonlineids */ GetPlayFabIDsFromPSNOnlineIDs(request: PlayFabServerModels.GetPlayFabIDsFromPSNOnlineIDsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the associated PlayFab account identifiers for the given set of server custom player identifiers. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromservercustomids + */ + GetPlayFabIDsFromServerCustomIDs(request: PlayFabServerModels.GetPlayFabIDsFromServerCustomIDsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile * IDs for the user accounts, available as SteamId in the Steamworks Community API calls. * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamids */ GetPlayFabIDsFromSteamIDs(request: PlayFabServerModels.GetPlayFabIDsFromSteamIDsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona + * names. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamnames + */ + GetPlayFabIDsFromSteamNames(request: PlayFabServerModels.GetPlayFabIDsFromSteamNamesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for * the user accounts, available as "_id" from the Twitch API methods (ex: @@ -306,6 +343,19 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getrandomresulttables */ GetRandomResultTables(request: PlayFabServerModels.GetRandomResultTablesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the result of an export started by ExportPlayersInSegment API. If the ExportPlayersInSegment is successful and + * complete, this API returns the IndexUrl from which the index file can be downloaded. The index file has a list of urls + * from which the files containing the player profile data can be downloaded. Otherwise, it returns the current 'State' of + * the export + * https://docs.microsoft.com/rest/api/playfab/server/playstream/getsegmentexport + */ + GetSegmentExport(request: PlayFabServerModels.GetPlayersInSegmentExportRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Returns the total number of players in a given segment. + * https://docs.microsoft.com/rest/api/playfab/server/playstream/getsegmentplayercount + */ + GetSegmentPlayerCount(request: PlayFabServerModels.GetSegmentPlayerCountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers. * https://docs.microsoft.com/rest/api/playfab/server/account-management/getservercustomidsfromplayfabids @@ -415,6 +465,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstousers */ GrantItemsToUsers(request: PlayFabServerModels.GrantItemsToUsersRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Links the Battle.net account associated with the token to the user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkbattlenetaccount + */ + LinkBattleNetAccount(request: PlayFabServerModels.LinkBattleNetAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Links the Nintendo account associated with the token to the user's PlayFab account * https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccount @@ -450,11 +505,49 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/account-management/linksteamid */ LinkSteamId(request: PlayFabServerModels.LinkSteamIdRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Links the Twitch account associated with the token to the user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/linktwitchaccount + */ + LinkTwitchAccount(request: PlayFabServerModels.LinkTwitchAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Links the Xbox Live account associated with the provided access code to the user's PlayFab account * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkxboxaccount */ LinkXboxAccount(request: PlayFabServerModels.LinkXboxAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Links the Xbox Live account associated with the provided Xbox ID and Sandbox to the user's PlayFab account + * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkxboxid + */ + LinkXboxId(request: PlayFabServerModels.LinkXboxIdRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves title-specific custom property values for a player. + * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/listplayercustomproperties + */ + ListPlayerCustomProperties(request: PlayFabServerModels.ListPlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for + * API calls which require an authenticated user + * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithandroiddeviceid + */ + LoginWithAndroidDeviceID(request: PlayFabServerModels.LoginWithAndroidDeviceIDRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Sign in the user with a Battle.net identity token + * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithbattlenet + */ + LoginWithBattleNet(request: PlayFabServerModels.LoginWithBattleNetRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can + * subsequently be used for API calls which require an authenticated user + * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithcustomid + */ + LoginWithCustomID(request: PlayFabServerModels.LoginWithCustomIDRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Signs the user in using the iOS device identifier, returning a session identifier that can subsequently be used for API + * calls which require an authenticated user + * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithiosdeviceid + */ + LoginWithIOSDeviceID(request: PlayFabServerModels.LoginWithIOSDeviceIDRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can * subsequently be used for API calls which require an authenticated user @@ -473,6 +566,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithsteamid */ LoginWithSteamId(request: PlayFabServerModels.LoginWithSteamIdRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Sign in the user with a Twitch access token + * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithtwitch + */ + LoginWithTwitch(request: PlayFabServerModels.LoginWithTwitchRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can * subsequently be used for API calls which require an authenticated user @@ -635,6 +733,31 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractuservirtualcurrency */ SubtractUserVirtualCurrency(request: PlayFabServerModels.SubtractUserVirtualCurrencyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks the related Apple account from the specified user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkapple + */ + UnlinkApple(request: PlayFabServerModels.UnlinkAppleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks the related Battle.net account from the user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkbattlenetaccount + */ + UnlinkBattleNetAccount(request: PlayFabServerModels.UnlinkBattleNetAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks the related Facebook account from the user's PlayFab account + * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkfacebookaccount + */ + UnlinkFacebookAccount(request: PlayFabServerModels.UnlinkFacebookAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks the related Facebook Instant Games identifier from the user's PlayFab account + * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkfacebookinstantgamesid + */ + UnlinkFacebookInstantGamesId(request: PlayFabServerModels.UnlinkFacebookInstantGamesIdRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks the related Game Center account from the specified user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkgamecenteraccount + */ + UnlinkGameCenterAccount(request: PlayFabServerModels.UnlinkGameCenterAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Unlinks the related Nintendo account from the user's PlayFab account * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoserviceaccount @@ -660,6 +783,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinksteamid */ UnlinkSteamId(request: PlayFabServerModels.UnlinkSteamIdRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks the related Twitch account from the user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinktwitchaccount + */ + UnlinkTwitchAccount(request: PlayFabServerModels.UnlinkTwitchAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Unlinks the related Xbox Live account from the user's PlayFab account * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkxboxaccount @@ -712,6 +840,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/characters/updatecharacterstatistics */ UpdateCharacterStatistics(request: PlayFabServerModels.UpdateCharacterStatisticsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Updates the title-specific custom property values for a player + * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayercustomproperties + */ + UpdatePlayerCustomProperties(request: PlayFabServerModels.UpdatePlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Updates the values of the specified title-specific statistics for the user * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayerstatistics @@ -782,16 +915,6 @@ declare module PlayFabServerModule { } declare module PlayFabServerModels { - export interface AdCampaignAttribution { - /** UTC time stamp of attribution */ - AttributedAt: string; - /** Attribution campaign identifier */ - CampaignId?: string; - /** Attribution network name */ - Platform?: string; - - } - export interface AdCampaignAttributionModel { /** UTC time stamp of attribution */ AttributedAt: string; @@ -841,6 +964,20 @@ declare module PlayFabServerModels { } + export interface AddOrUpdateContactEmailRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The new contact email to associate with the player. */ + EmailAddress: string; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + + } + + export interface AddOrUpdateContactEmailResult extends PlayFabModule.IPlayFabResultCommon { + + } + export interface AddPlayerTagRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -946,7 +1083,7 @@ declare module PlayFabServerModels { PlayFabId?: string; /** The reason why this ban was applied. */ Reason?: string; - /** The family type of the suer that is included in the ban. */ + /** The family type of the user that is included in the ban. */ UserFamilyType?: string; } @@ -979,6 +1116,14 @@ declare module PlayFabServerModels { } + export interface BattleNetAccountPlayFabIdPair { + /** Unique Battle.net account identifier for a user. */ + BattleNetAccountId?: string; + /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Battle.net account identifier. */ + PlayFabId?: string; + + } + export interface CatalogItem { /** * defines the bundle properties for the item - bundles are items which contain other items, including random drop tables @@ -1121,12 +1266,6 @@ declare module PlayFabServerModels { } - type ChurnRiskLevel = "NoData" - - | "LowRisk" - | "MediumRisk" - | "HighRisk"; - type CloudScriptRevisionOption = "Live" | "Latest" @@ -1154,16 +1293,6 @@ declare module PlayFabServerModels { } - export interface ContactEmailInfo { - /** The email address */ - EmailAddress?: string; - /** The name of the email info data */ - Name?: string; - /** The verification status of the email */ - VerificationStatus?: string; - - } - export interface ContactEmailInfoModel { /** The email address */ EmailAddress?: string; @@ -1612,6 +1741,14 @@ declare module PlayFabServerModels { | "ZMW" | "ZWD"; + export interface CustomPropertyDetails { + /** The custom property's name. */ + Name?: string; + /** The custom property's value. */ + Value?: any; + + } + export interface DeleteCharacterFromUserRequest extends PlayFabModule.IPlayFabRequestCommon { /** Unique PlayFab assigned ID for a specific character owned by a user */ CharacterId: string; @@ -1631,6 +1768,42 @@ declare module PlayFabServerModels { } + export interface DeletedPropertyDetails { + /** The name of the property which was requested to be deleted. */ + Name?: string; + /** Indicates whether or not the property was deleted. If false, no property with that name existed. */ + WasDeleted: boolean; + + } + + export interface DeletePlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** + * Optional field used for concurrency control. One can ensure that the delete operation will only be performed if the + * player's properties have not been updated by any other clients since the last version. + */ + ExpectedPropertiesVersion?: number; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + /** A list of property names denoting which properties should be deleted. */ + PropertyNames: string[]; + + } + + export interface DeletePlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** The list of properties requested to be deleted. */ + DeletedProperties?: DeletedPropertyDetails[]; + /** PlayFab unique identifier of the user whose properties were deleted. */ + PlayFabId?: string; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface DeletePlayerRequest extends PlayFabModule.IPlayFabRequestCommon { /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId: string; @@ -1768,6 +1941,20 @@ declare module PlayFabServerModels { } + export interface ExportPlayersInSegmentRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique identifier of the requested segment. */ + SegmentId: string; + + } + + export interface ExportPlayersInSegmentResult extends PlayFabModule.IPlayFabResultCommon { + /** Unique identifier of the export for the requested Segment. */ + ExportId?: string; + /** Unique identifier of the requested Segment. */ + SegmentId?: string; + + } + type ExternalFriendSources = "None" | "Steam" @@ -1793,20 +1980,23 @@ declare module PlayFabServerModels { } export interface FriendInfo { - /** Available Facebook information (if the user and PlayFab friend are also connected in Facebook). */ + /** Available Facebook information (if the user and connected Facebook friend both have PlayFab Accounts in the same title). */ FacebookInfo?: UserFacebookInfo; /** PlayFab unique identifier for this friend. */ FriendPlayFabId?: string; - /** Available Game Center information (if the user and PlayFab friend are also connected in Game Center). */ + /** + * Available Game Center information (if the user and connected Game Center friend both have PlayFab Accounts in the same + * title). + */ GameCenterInfo?: UserGameCenterInfo; /** The profile of the user, if requested. */ Profile?: PlayerProfileModel; /** - * Available PlayStation :tm: Network information, if the user and PlayFab friend are both connected to PlayStation :tm: - * Network. + * Available PlayStation :tm: Network information, if the user connected PlayStation :tm Network friend both have PlayFab + * Accounts in the same title. */ PSNInfo?: UserPsnInfo; - /** Available Steam information (if the user and PlayFab friend are also connected in Steam). */ + /** Available Steam information (if the user and connected Steam friend both have PlayFab Accounts in the same title). */ SteamInfo?: UserSteamInfo; /** Tags which have been associated with this friend. */ Tags?: string[]; @@ -1814,7 +2004,7 @@ declare module PlayFabServerModels { TitleDisplayName?: string; /** PlayFab unique username for this friend. */ Username?: string; - /** Available Xbox information, if the user and PlayFab friend are both connected to Xbox Live. */ + /** Available Xbox information, (if the user and connected Xbox Live friend both have PlayFab Accounts in the same title). */ XboxInfo?: UserXboxInfo; } @@ -1924,7 +2114,6 @@ declare module PlayFabServerModels { | "UnableToConnectToDatabase" | "InternalServerError" | "InvalidReportDate" - | "ReportNotAvailable" | "DatabaseThroughputExceeded" | "InvalidGameTicket" | "ExpiredGameTicket" @@ -2300,7 +2489,6 @@ declare module PlayFabServerModels { | "InsightsManagementGetOperationStatusInvalidParameter" | "DuplicatePurchaseTransactionId" | "EvaluationModePlayerCountExceeded" - | "GetPlayersInSegmentRateLimitExceeded" | "CloudScriptFunctionNameSizeExceeded" | "PaidInsightsFeaturesNotEnabled" | "CloudScriptAzureFunctionsQueueRequestError" @@ -2398,9 +2586,34 @@ declare module PlayFabServerModels { | "MultipleLinkedStatisticsNotAllowed" | "DuplicateLinkedStatisticColumnNameFound" | "AggregationTypeNotAllowedForMultiColumnStatistic" - | "MaxQueryableVerionsValueNotAllowedForTier" + | "MaxQueryableVersionsValueNotAllowedForTier" | "StatisticDefinitionHasNullOrEmptyVersionConfiguration" | "StatisticColumnLengthMismatch" + | "InvalidExternalEntityId" + | "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" + | "TransactionAlreadyApplied" + | "ReportDataNotRetrievedSuccessfully" + | "ResetIntervalCannotBeModified" + | "VersionIncrementRateExceeded" + | "InvalidSteamUsername" + | "InvalidVersionResetForLinkedLeaderboard" + | "BattleNetNotEnabledForTitle" + | "ReportNotProcessed" + | "DataNotAvailable" + | "InvalidReportName" + | "ResourceNotModified" + | "StudioCreationLimitExceeded" + | "StudioDeletionInitiated" + | "ProductDisabledForTitle" + | "PreconditionFailed" + | "CannotEnableAnonymousPlayerCreation" + | "ParentCustomerAccountNotFound" + | "AccountLinkedToABannedPlayer" + | "AzureSubscriptionNotEligibleForLinking" + | "EntityIsNotAMember" + | "IPAddressNotFound" + | "PSNNextGenNotConfiguredForTitle" + | "InvalidNintendoIssuer" | "MatchmakingEntityInvalid" | "MatchmakingPlayerAttributesInvalid" | "MatchmakingQueueNotFound" @@ -2445,6 +2658,7 @@ declare module PlayFabServerModels { | "CatalogBadRequest" | "CatalogTooManyRequests" | "InvalidCatalogItemConfiguration" + | "LegacyEconomyDisabled" | "ExportInvalidStatusUpdate" | "ExportInvalidPrefix" | "ExportBlobContainerDoesNotExist" @@ -2515,6 +2729,10 @@ declare module PlayFabServerModels { | "ExperimentationExclusionGroupCannotDelete" | "ExperimentationExclusionGroupInvalidTrafficAllocation" | "ExperimentationExclusionGroupInvalidName" + | "ExperimentationLegacyExperimentInvalidOperation" + | "ExperimentationExperimentStopFailed" + | "ExperimentationExperimentDeleteFailed" + | "ExperimentationExperimentStartFailed" | "MaxActionDepthExceeded" | "TitleNotOnUpdatedPricingPlan" | "SegmentManagementTitleNotInFlight" @@ -2532,8 +2750,11 @@ declare module PlayFabServerModels { | "AsyncExportNotFound" | "AsyncExportRateLimitExceeded" | "AnalyticsSegmentCountOverLimit" + | "GetSegmentPlayerCountNotInFlight" + | "GetSegmentPlayerCountRateLimitExceeded" | "SnapshotNotFound" | "InventoryApiNotImplemented" + | "InventoryCollectionDeletionDisallowed" | "LobbyDoesNotExist" | "LobbyRateLimitExceeded" | "LobbyPlayerAlreadyJoined" @@ -2579,6 +2800,13 @@ declare module PlayFabServerModels { | "EventSinkInsufficientRoleAssignment" | "EventSinkContainerNotFound" | "EventSinkTenantIdInvalid" + | "EventSinkResourceMisconfigured" + | "EventSinkAccessDenied" + | "EventSinkWriteConflict" + | "EventSinkResourceNotFound" + | "EventSinkResourceFeatureNotSupported" + | "EventSinkBucketNameInvalid" + | "EventSinkResourceUnavailable" | "OperationCanceled" | "InvalidDisplayNameRandomSuffixLength" | "AllowNonUniquePlayerDisplayNamesDisableNotAllowed" @@ -2599,8 +2827,6 @@ declare module PlayFabServerModels { | "PlayerCustomPropertiesPropertyDoesNotExist" | "AddonAlreadyExists" | "AddonDoesntExist" - | "CopilotDisabled" - | "CopilotInvalidRequest" | "TrueSkillUnauthorized" | "TrueSkillInvalidTitleId" | "TrueSkillInvalidScenarioId" @@ -2667,6 +2893,11 @@ declare module PlayFabServerModels { | "TrueSkillInvalidPlayerId" | "TrueSkillInvalidSquadSize" | "TrueSkillConditionSetNotInModel" + | "TrueSkillModelStateInvalidForOperation" + | "TrueSkillScenarioContainsActiveModel" + | "TrueSkillInvalidConditionRank" + | "TrueSkillTotalScenarioLimitExceeded" + | "TrueSkillInvalidConditionsList" | "GameSaveManifestNotFound" | "GameSaveManifestVersionAlreadyExists" | "GameSaveConflictUpdatingManifest" @@ -2676,6 +2907,33 @@ declare module PlayFabServerModels { | "GameSaveUnknownFileInManifest" | "GameSaveFileExceededReportedSize" | "GameSaveFileNotUploaded" + | "GameSaveBadRequest" + | "GameSaveOperationNotAllowed" + | "GameSaveDataStorageQuotaExceeded" + | "GameSaveNewerManifestExists" + | "GameSaveBaseVersionNotAvailable" + | "GameSaveManifestVersionQuarantined" + | "GameSaveManifestUploadProgressUpdateNotAllowed" + | "GameSaveNotFinalizedManifestNotEligibleAsKnownGood" + | "GameSaveNoUpdatesRequested" + | "GameSaveTitleDoesNotExist" + | "GameSaveOperationNotAllowedForTitle" + | "GameSaveManifestFilesLimitExceeded" + | "GameSaveManifestDescriptionUpdateNotAllowed" + | "GameSaveTitleConfigNotFound" + | "GameSaveTitleAlreadyOnboarded" + | "GameSaveServiceNotEnabledForTitle" + | "GameSaveServiceOnboardingPending" + | "GameSaveManifestNotEligibleAsConflictingVersion" + | "GameSaveServiceUnavailable" + | "GameSaveConflict" + | "GameSaveManifestNotEligibleForRollback" + | "GameSaveTitleClientAnonymousAccountCreationNotDisabled" + | "GameSaveTitleConfigNoUpdatesRequested" + | "GameSavePlayerNotEligibleForTransfer" + | "GameSaveAlreadyAutoRolledBack" + | "GameSaveManifestNotEligibleForRestore" + | "GameSaveManifestArchived" | "StateShareForbidden" | "StateShareTitleNotInFlight" | "StateShareStateNotFound" @@ -2683,7 +2941,28 @@ declare module PlayFabServerModels { | "StateShareStateRedemptionLimitExceeded" | "StateShareStateRedemptionLimitNotUpdated" | "StateShareCreatedStatesLimitExceeded" - | "StateShareIdMissingOrMalformed"; + | "StateShareIdMissingOrMalformed" + | "PlayerCreationDisabled" + | "AccountAlreadyExists" + | "TagInvalid" + | "TagTooLong" + | "StatisticColumnAggregationMismatch" + | "StatisticResetIntervalMismatch" + | "VersionConfigurationCannotBeSpecifiedForLinkedStat" + | "VersionConfigurationIsRequired" + | "InvalidEntityTypeForAggregation" + | "MultiLevelAggregationNotAllowed" + | "AggregationTypeNotAllowedForLinkedStat" + | "OperationDeniedDueToDefinitionPolicy" + | "StatisticUpdateNotAllowedWhileLinked" + | "UnsupportedEntityType" + | "EntityTypeSpecifiedRequiresAggregationSource" + | "PlayFabErrorEventNotSupportedForEntityType" + | "MetadataLengthExceeded" + | "MaxQueryableVersionsExceeded" + | "StatisticVersionIncrementNotAllowedWhileLinked" + | "StoreMetricsRequestInvalidInput" + | "StoreMetricsErrorRetrievingMetrics"; export interface GenericPlayFabIdPair { /** Unique generic service identifier for a user. */ @@ -2869,6 +3148,11 @@ declare module PlayFabServerModels { * comma-separated list of platforms. */ ExternalPlatformFriends?: string; + /** + * If true, include friends from the same namespace even if they have not logged in to the current title. Defaults to + * false. + */ + NamespaceWide?: boolean; /** PlayFab identifier of the player whose friend list to get. */ PlayFabId: string; /** @@ -2877,7 +3161,10 @@ declare module PlayFabServerModels { * the Game Manager "Client Profile Options" tab in the "Settings" section. */ ProfileConstraints?: PlayerProfileViewConstraints; - /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */ + /** + * Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. When provided, all Xbox Live + * users the caller is following are included regardless of whether they follow the caller back. + */ XboxToken?: string; } @@ -3068,6 +3355,27 @@ declare module PlayFabServerModels { } + export interface GetPlayerCustomPropertyRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + /** Specific property name to search for in the player's properties. */ + PropertyName: string; + + } + + export interface GetPlayerCustomPropertyResult extends PlayFabModule.IPlayFabResultCommon { + /** PlayFab unique identifier of the user whose properties are being returned. */ + PlayFabId?: string; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + /** Player specific property and its corresponding value. */ + Property?: CustomPropertyDetails; + + } + export interface GetPlayerProfileRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -3097,39 +3405,17 @@ declare module PlayFabServerModels { } - export interface GetPlayersInSegmentRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Continuation token if retrieving subsequent pages of results. */ - ContinuationToken?: string; - /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ - CustomTags?: { [key: string]: string | null }; - /** - * If set to true, the profiles are loaded asynchronously and the response will include a continuation token and - * approximate profile count until the first batch of profiles is loaded. Use this parameter to help avoid network - * timeouts. - */ - GetProfilesAsync?: boolean; - /** - * Maximum is 10,000. The value 0 will prevent loading any profiles and return only the count of profiles matching this - * segment. - */ - MaxBatchSize?: number; - /** - * 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 5,400 (90 minutes). - */ - SecondsToLive?: number; - /** Unique identifier for this segment. */ - SegmentId: string; + export interface GetPlayersInSegmentExportRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique identifier of the export for the requested Segment. */ + ExportId: string; } - export interface GetPlayersInSegmentResult extends PlayFabModule.IPlayFabResultCommon { - /** Continuation token to use to retrieve subsequent pages of results. If token returns null there are no more results. */ - ContinuationToken?: string; - /** Array of player profiles in this segment. */ - PlayerProfiles?: PlayerProfile[]; - /** Count of profiles matching this segment. */ - ProfilesInSegment: number; + export interface GetPlayersInSegmentExportResponse extends PlayFabModule.IPlayFabResultCommon { + /** Url from which the index file can be downloaded. */ + IndexUrl?: string; + /** Shows the current status of the export */ + State?: string; } @@ -3196,10 +3482,25 @@ declare module PlayFabServerModels { } + export interface GetPlayFabIDsFromBattleNetAccountIdsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Array of unique Battle.net account identifiers for which the title needs to get PlayFab identifiers. The array cannot + * exceed 10 in length. + */ + BattleNetAccountIds: string[]; + + } + + export interface GetPlayFabIDsFromBattleNetAccountIdsResult extends PlayFabModule.IPlayFabResultCommon { + /** Mapping of Battle.net account identifiers to PlayFab identifiers. */ + Data?: BattleNetAccountPlayFabIdPair[]; + + } + export interface GetPlayFabIDsFromFacebookIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** - * Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 - * in length. + * Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 25 in + * length. */ FacebookIDs: string[]; @@ -3242,9 +3543,14 @@ declare module PlayFabServerModels { } export interface GetPlayFabIDsFromNintendoServiceAccountIdsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Nintendo NSA issuer URL identifying the environment. When provided, only accounts registered in that environment are + * returned. If null or empty, falls back to the default environment. + */ + Issuer?: string; /** * Array of unique Nintendo Switch Account identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ NintendoAccountIds: string[]; @@ -3259,7 +3565,7 @@ declare module PlayFabServerModels { export interface GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Nintendo Switch Device identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ NintendoSwitchDeviceIds: string[]; @@ -3271,14 +3577,39 @@ declare module PlayFabServerModels { } + export interface GetPlayFabIDsFromOpenIdsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Array of unique OpenId Connect identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed + * 10 in length. + */ + OpenIdSubjectIdentifiers: OpenIdSubjectIdentifier[]; + + } + + export interface GetPlayFabIDsFromOpenIdsResult extends PlayFabModule.IPlayFabResultCommon { + /** Mapping of OpenId Connect identifiers to PlayFab identifiers. */ + Data?: OpenIdSubjectIdentifierPlayFabIdPair[]; + + } + export interface GetPlayFabIDsFromPSNAccountIDsRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */ + /** + * Id of the PlayStation :tm: Network issuer environment. If null, defaults to the production environment. This must match + * the issuer the account signed in under, otherwise the lookup returns a null PlayFabId rather than an error. + */ IssuerId?: number; /** * Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ PSNAccountIDs: string[]; + /** + * The PlayStation :tm: Network sandbox the account is keyed under. Sandbox membership is per account, not per title: + * supply this only for accounts that sign in from a sandbox, and omit it for accounts that do not, including all retail + * accounts. Supplying a sandbox id that an account is not keyed under, or omitting one that it is, returns a null + * PlayFabId rather than an error. + */ + SandboxId?: string; } @@ -3289,13 +3620,23 @@ declare module PlayFabServerModels { } export interface GetPlayFabIDsFromPSNOnlineIDsRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */ + /** + * Id of the PlayStation :tm: Network issuer environment. If null, defaults to the production environment. This must match + * the issuer the account signed in under, otherwise the lookup returns a null PlayFabId rather than an error. + */ IssuerId?: number; /** * Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ PSNOnlineIDs: string[]; + /** + * The PlayStation :tm: Network sandbox the account is keyed under. Sandbox membership is per account, not per title: + * supply this only for accounts that sign in from a sandbox, and omit it for accounts that do not, including all retail + * accounts. Supplying a sandbox id that an account is not keyed under, or omitting one that it is, returns a null + * PlayFabId rather than an error. + */ + SandboxId?: string; } @@ -3305,10 +3646,25 @@ declare module PlayFabServerModels { } + export interface GetPlayFabIDsFromServerCustomIDsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Array of unique server custom player identifiers for which the title needs to get PlayFab identifiers. Cannot contain + * more than 25 identifiers. + */ + ServerCustomIds: string[]; + + } + + export interface GetPlayFabIDsFromServerCustomIDsResult extends PlayFabModule.IPlayFabResultCommon { + /** Mapping of server custom identifiers to PlayFab identifiers. */ + Data?: ServerCustomIDPlayFabIDPair[]; + + } + export interface GetPlayFabIDsFromSteamIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ SteamStringIDs?: string[]; @@ -3320,10 +3676,25 @@ declare module PlayFabServerModels { } + export interface GetPlayFabIDsFromSteamNamesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Array of unique Steam identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 25 in + * length. + */ + SteamNames: string[]; + + } + + export interface GetPlayFabIDsFromSteamNamesResult extends PlayFabModule.IPlayFabResultCommon { + /** Mapping of Steam identifiers to PlayFab identifiers. */ + Data?: SteamNamePlayFabIdPair[]; + + } + export interface GetPlayFabIDsFromTwitchIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot - * exceed 2,000 in length. + * exceed 25 in length. */ TwitchIds: string[]; @@ -3340,7 +3711,7 @@ declare module PlayFabServerModels { Sandbox?: string; /** * Array of unique Xbox Live account identifiers for which the title needs to get PlayFab identifiers. The array cannot - * exceed 2,000 in length. + * exceed 25 in length. */ XboxLiveAccountIDs: string[]; @@ -3381,6 +3752,18 @@ declare module PlayFabServerModels { } + export interface GetSegmentPlayerCountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique identifier for the requested segment. */ + SegmentId: string; + + } + + export interface GetSegmentPlayerCountResult extends PlayFabModule.IPlayFabResultCommon { + /** Count of profiles matching this segment. */ + ProfilesInSegment: number; + + } + export interface GetSegmentResult { /** Identifier of the segments AB Test, if it is attached to one. */ ABTestParent?: string; @@ -3749,6 +4132,18 @@ declare module PlayFabServerModels { } + export interface LinkBattleNetAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** If another user is already linked to a specific Battle.net account, unlink the other user and re-link. */ + ForceLink?: boolean; + /** The JSON Web Token (JWT) returned by Battle.net after login */ + IdentityToken: string; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + + } + export interface LinkedPlatformAccountModel { /** Linked account email of the user on the platform, if available */ Email?: string; @@ -3807,6 +4202,11 @@ declare module PlayFabServerModels { export interface LinkPSNAccountRequest extends PlayFabModule.IPlayFabRequestCommon { /** Authentication code provided by the PlayStation :tm: Network. */ AuthCode: string; + /** + * Optional PlayStation :tm: Network auth version. Controls which PlayStation :tm: Network auth version is used. Accepted + * values are "v2" and "v3". + */ + AuthVersion?: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** If another user is already linked to the account, unlink the other user and re-link. */ @@ -3829,12 +4229,21 @@ declare module PlayFabServerModels { CustomTags?: { [key: string]: string | null }; /** If another user is already linked to the account, unlink the other user and re-link. */ ForceLink?: boolean; - /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */ + /** + * Id of the PlayStation :tm: Network issuer environment. If null, defaults to the production environment. This must match + * the issuer the account signs in under, otherwise the link will not be resolved by that sign in. + */ IssuerId?: number; /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId: string; /** Id of the PlayStation :tm: Network user. Also known as the PSN Account Id. */ PSNUserId: string; + /** + * The PlayStation :tm: Network sandbox to key the link under. Sandbox membership is per account, not per title: supply + * this only when the account signs in from a sandbox, and omit it otherwise, including for all retail accounts. This must + * match the sandbox the account signs in from, otherwise the link will not be resolved by that sign in. + */ + SandboxId?: string; } @@ -3863,7 +4272,7 @@ declare module PlayFabServerModels { CustomTags?: { [key: string]: string | null }; /** If another user is already linked to the account, unlink the other user and re-link. */ ForceLink?: boolean; - /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */ + /** PlayFab unique identifier of the user to link. */ PlayFabId: string; /** Unique Steam identifier for a user. */ SteamId: string; @@ -3874,12 +4283,24 @@ declare module PlayFabServerModels { } + export interface LinkTwitchAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Twitch access token for authentication. */ + AccessToken: string; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** If another user is already linked to the account, unlink the other user and re-link. */ + ForceLink?: boolean; + /** PlayFab unique identifier of the user to link. */ + PlayFabId: string; + + } + export interface LinkXboxAccountRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** If another user is already linked to the account, unlink the other user and re-link. */ ForceLink?: boolean; - /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */ + /** PlayFab unique identifier of the user to link. */ PlayFabId: string; /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */ XboxToken: string; @@ -3890,6 +4311,39 @@ declare module PlayFabServerModels { } + export interface LinkXboxIdRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** If another user is already linked to the account, unlink the other user and re-link. */ + ForceLink?: boolean; + /** PlayFab unique identifier of the user to link. */ + PlayFabId: string; + /** The id of Xbox Live sandbox. */ + Sandbox: string; + /** Unique Xbox identifier for a user. */ + XboxId: string; + + } + + export interface ListPlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + + } + + export interface ListPlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** PlayFab unique identifier of the user whose properties are being returned. */ + PlayFabId?: string; + /** Player specific properties and their corresponding values for this title. */ + Properties?: CustomPropertyDetails[]; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface ListUsersCharactersRequest extends PlayFabModule.IPlayFabRequestCommon { /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId: string; @@ -3947,11 +4401,74 @@ declare module PlayFabServerModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; + + export interface LoginWithAndroidDeviceIDRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Specific model of the user's device. */ + AndroidDevice?: string; + /** Android device identifier for the user's device. */ + AndroidDeviceId: string; + /** Automatically create a PlayFab account if one is not currently linked to this ID. */ + CreateAccount?: boolean; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Flags for which pieces of info to return for the user. */ + InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; + /** Specific Operating System version for the user's device. */ + OS?: string; + + } + + export interface LoginWithBattleNetRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Automatically create a PlayFab account if one is not currently linked to this ID. */ + CreateAccount?: boolean; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The JSON Web Token (JWT) returned by Battle.net after login */ + IdentityToken: string; + /** Flags for which pieces of info to return for the user. */ + InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; + + } + + export interface LoginWithCustomIDRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Automatically create a PlayFab account if one is not currently linked to this ID. */ + CreateAccount?: boolean; + /** Custom unique identifier for the user, generated by the title. */ + CustomId: string; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Flags for which pieces of info to return for the user. */ + InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; + + } + + export interface LoginWithIOSDeviceIDRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Automatically create a PlayFab account if one is not currently linked to this ID. */ + CreateAccount?: boolean; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Vendor-specific iOS identifier for the user's device. */ + DeviceId: string; + /** Specific model of the user's device. */ + DeviceModel?: string; + /** Flags for which pieces of info to return for the user. */ + InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; + /** Specific Operating System version for the user's device. */ + OS?: string; + + } export interface LoginWithPSNRequest extends PlayFabModule.IPlayFabRequestCommon { /** Auth code provided by the PlayStation :tm: Network OAuth provider. */ AuthCode: string; + /** + * Optional PlayStation :tm: Network auth version. Controls which PlayStation :tm: Network auth version is used. Accepted + * values are "v2" and "v3". + */ + AuthVersion?: string; /** Automatically create a PlayFab account if one is not currently linked to this ID. */ CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ @@ -3972,7 +4489,7 @@ declare module PlayFabServerModels { CustomTags?: { [key: string]: string | null }; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** The backend server identifier for this player. */ ServerCustomId: string; @@ -3991,6 +4508,22 @@ declare module PlayFabServerModels { } + export interface LoginWithTwitchRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Twitch access token for authentication. */ + AccessToken: string; + /** If true, create a new PlayFab account if one does not exist. */ + CreateAccount?: boolean; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Parameters for requesting additional player info. */ + InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; + /** Player secret for additional authentication. */ + PlayerSecret?: string; + /** PlayFab unique identifier of the user. */ + PlayFabId: string; + + } + export interface LoginWithXboxIdRequest extends PlayFabModule.IPlayFabRequestCommon { /** Automatically create a PlayFab account if one is not currently linked to this ID. */ CreateAccount?: boolean; @@ -4149,6 +4682,22 @@ declare module PlayFabServerModels { } + export interface OpenIdSubjectIdentifier { + /** The issuer URL for the OpenId Connect provider, or the override URL if an override exists. */ + Issuer: string; + /** The unique subject identifier within the context of the issuer. */ + Subject: string; + + } + + export interface OpenIdSubjectIdentifierPlayFabIdPair { + /** Unique OpenId Connect identifier for a user. */ + OpenIdSubjectIdentifier?: OpenIdSubjectIdentifier; + /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the OpenId Connect identifier. */ + PlayFabId?: string; + + } + export interface PlayerLeaderboardEntry { /** Title-specific display name of the user for this leaderboard entry. */ DisplayName?: string; @@ -4163,80 +4712,6 @@ declare module PlayFabServerModels { } - export interface PlayerLinkedAccount { - /** Linked account's email */ - Email?: string; - /** Authentication platform */ - Platform?: string; - /** Platform user identifier */ - PlatformUserId?: string; - /** Linked account's username */ - Username?: string; - - } - - export interface PlayerLocation { - /** City of the player's geographic location. */ - City?: string; - /** The two-character continent code for this location */ - ContinentCode: string; - /** The two-character ISO 3166-1 country code for the country associated with the location */ - CountryCode: string; - /** Latitude coordinate of the player's geographic location. */ - Latitude?: number; - /** Longitude coordinate of the player's geographic location. */ - Longitude?: number; - - } - - export interface PlayerProfile { - /** Array of ad campaigns player has been attributed to */ - AdCampaignAttributions?: AdCampaignAttribution[]; - /** Image URL of the player's avatar. */ - AvatarUrl?: string; - /** Banned until UTC Date. If permanent ban this is set for 20 years after the original ban date. */ - BannedUntil?: string; - /** The prediction of the player to churn within the next seven days. */ - ChurnPrediction?: string; - /** Array of contact email addresses associated with the player */ - ContactEmailAddresses?: ContactEmailInfo[]; - /** Player record created */ - Created?: string; - /** Player Display Name */ - DisplayName?: string; - /** Last login */ - LastLogin?: string; - /** Array of third party accounts linked to this player */ - LinkedAccounts?: PlayerLinkedAccount[]; - /** Dictionary of player's locations by type. */ - Locations?: { [key: string]: PlayerLocation }; - /** Player account origination */ - Origination?: string; - /** List of player variants for experimentation */ - PlayerExperimentVariants?: string[]; - /** PlayFab Player ID */ - PlayerId?: string; - /** Array of player statistics */ - PlayerStatistics?: PlayerStatistic[]; - /** Publisher this player belongs to */ - PublisherId?: string; - /** Array of configured push notification end points */ - PushNotificationRegistrations?: PushNotificationRegistration[]; - /** Dictionary of player's statistics using only the latest version's value */ - Statistics?: { [key: string]: number }; - /** List of player's tags for segmentation. */ - Tags?: string[]; - /** Title ID this profile applies to */ - TitleId?: string; - /** A sum of player's total purchases in USD across all currencies. */ - TotalValueToDateInUSD?: number; - /** Dictionary of player's total purchases by currency. */ - ValuesToDate?: { [key: string]: number }; - /** Dictionary of player's virtual currency balances */ - VirtualCurrencyBalances?: { [key: string]: number }; - - } - export interface PlayerProfileModel { /** List of advertising campaigns the player has been attributed to */ AdCampaignAttributions?: AdCampaignAttributionModel[]; @@ -4326,18 +4801,6 @@ declare module PlayFabServerModels { } - export interface PlayerStatistic { - /** Statistic ID */ - Id?: string; - /** Statistic name */ - Name?: string; - /** Current statistic value */ - StatisticValue: number; - /** Statistic version (0 if not a versioned statistic) */ - StatisticVersion: number; - - } - export interface PlayerStatisticVersion { /** time when the statistic version became active */ ActivationTime: string; @@ -4396,14 +4859,6 @@ declare module PlayFabServerModels { | "GoogleCloudMessaging"; - export interface PushNotificationRegistration { - /** Notification configured endpoint */ - NotificationEndpointARN?: string; - /** Push notification platform */ - Platform?: string; - - } - export interface PushNotificationRegistrationModel { /** Notification configured endpoint */ NotificationEndpointARN?: string; @@ -4703,7 +5158,7 @@ declare module PlayFabServerModels { InfoResultPayload?: GetPlayerCombinedInfoResultPayload; /** The time of this user's previous login. If there was no previous login, then it's DateTime.MinValue */ LastLoginTime?: string; - /** True if the account was newly created on this login. */ + /** True if the master_player_account was newly created on this login. */ NewlyCreated: boolean; /** Player's unique PlayFabId. */ PlayFabId?: string; @@ -4727,7 +5182,7 @@ declare module PlayFabServerModels { } export interface SetPlayerSecretRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId: string; @@ -4830,6 +5285,14 @@ declare module PlayFabServerModels { } + export interface SteamNamePlayFabIdPair { + /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */ + PlayFabId?: string; + /** Unique Steam identifier for a user, also known as Steam persona name. */ + SteamName?: string; + + } + export interface SteamPlayFabIdPair { /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */ PlayFabId?: string; @@ -4960,6 +5423,64 @@ declare module PlayFabServerModels { } + export interface UnlinkAppleRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + + } + + export interface UnlinkAppleResult extends PlayFabModule.IPlayFabResultCommon { + + } + + export interface UnlinkBattleNetAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + + } + + export interface UnlinkFacebookAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** PlayFab unique identifier of the user to unlink. */ + PlayFabId: string; + + } + + export interface UnlinkFacebookAccountResult extends PlayFabModule.IPlayFabResultCommon { + + } + + export interface UnlinkFacebookInstantGamesIdRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Facebook Instant Games identifier for the user. If not specified, the most recently linked identifier will be used. */ + FacebookInstantGamesId?: string; + /** PlayFab unique identifier of the user to unlink. */ + PlayFabId: string; + + } + + export interface UnlinkFacebookInstantGamesIdResult extends PlayFabModule.IPlayFabResultCommon { + + } + + export interface UnlinkGameCenterAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + + } + + export interface UnlinkGameCenterAccountResult extends PlayFabModule.IPlayFabResultCommon { + + } + export interface UnlinkNintendoServiceAccountRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -5020,10 +5541,23 @@ declare module PlayFabServerModels { } + export interface UnlinkTwitchAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Valid token issued by Twitch. Used to specify which twitch account to unlink from the profile. By default it uses the + * one that is present on the profile. + */ + AccessToken?: string; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** PlayFab unique identifier of the user to unlink. */ + PlayFabId: string; + + } + export interface UnlinkXboxAccountRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */ + /** PlayFab unique identifier of the user to unlink. */ PlayFabId: string; } @@ -5168,6 +5702,32 @@ declare module PlayFabServerModels { } + export interface UpdatePlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** + * Optional field used for concurrency control. One can ensure that the update operation will only be performed if the + * player's properties have not been updated by any other clients since last the version. + */ + ExpectedPropertiesVersion?: number; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + /** Collection of properties to be set for a player. */ + Properties: UpdateProperty[]; + + } + + export interface UpdatePlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** PlayFab unique identifier of the user whose properties were updated. */ + PlayFabId?: string; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface UpdatePlayerStatisticsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -5187,6 +5747,14 @@ declare module PlayFabServerModels { } + export interface UpdateProperty { + /** Name of the custom property. Can contain Unicode letters and digits. They are limited in size. */ + Name: string; + /** Value of the custom property. Limited to booleans, numbers, and strings. */ + Value: any; + + } + export interface UpdateSharedGroupDataRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -5285,6 +5853,8 @@ declare module PlayFabServerModels { AndroidDeviceInfo?: UserAndroidDeviceInfo; /** Sign in with Apple account information, if an Apple account has been linked */ AppleAccountInfo?: UserAppleIdInfo; + /** Battle.net account information, if a Battle.net account has been linked */ + BattleNetAccountInfo?: UserBattleNetInfo; /** Timestamp indicating when the user account was created */ Created: string; /** Custom ID information, if a custom ID has been assigned */ @@ -5342,6 +5912,14 @@ declare module PlayFabServerModels { } + export interface UserBattleNetInfo { + /** Battle.net identifier */ + BattleNetAccountId?: string; + /** Battle.net display name */ + BattleNetBattleTag?: string; + + } + export interface UserCustomIdInfo { /** Custom ID */ CustomId?: string; @@ -5475,7 +6053,9 @@ declare module PlayFabServerModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; export interface UserPrivateAccountInfo { /** user email address */ @@ -5484,10 +6064,17 @@ declare module PlayFabServerModels { } export interface UserPsnInfo { + /** + * Id of the PlayStation :tm: Network issuer environment this account is keyed under. Supply this value as IssuerId when + * looking the account up. + */ + IssuerId?: number; /** PlayStation :tm: Network account ID */ PsnAccountId?: string; /** PlayStation :tm: Network online ID */ PsnOnlineId?: string; + /** PlayStation :tm: Network sandbox ID */ + PsnSandboxId?: string; } diff --git a/PlayFabSdk/src/Typings/PlayFab/Playfab.d.ts b/PlayFabSdk/src/Typings/PlayFab/Playfab.d.ts index f2ce678f..441d70ef 100644 --- a/PlayFabSdk/src/Typings/PlayFab/Playfab.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/Playfab.d.ts @@ -13,7 +13,6 @@ /// /// /// -/// /// declare module PlayFabModule { @@ -63,7 +62,6 @@ declare var PlayFab: { LocalizationApi: PlayFabLocalizationModule.IPlayFabLocalization; MultiplayerApi: PlayFabMultiplayerModule.IPlayFabMultiplayer; ProfilesApi: PlayFabProfilesModule.IPlayFabProfiles; - MatchmakerApi: PlayFabMatchmakerModule.IPlayFabMatchmaker; AddonApi: PlayFabAddonModule.IPlayFabAddon; }; @@ -83,6 +81,5 @@ declare var PlayFabProgressionSDK: PlayFabProgressionModule.IPlayFabProgression; declare var PlayFabLocalizationSDK: PlayFabLocalizationModule.IPlayFabLocalization; declare var PlayFabMultiplayerSDK: PlayFabMultiplayerModule.IPlayFabMultiplayer; declare var PlayFabProfilesSDK: PlayFabProfilesModule.IPlayFabProfiles; -declare var PlayFabMatchmakerSDK: PlayFabMatchmakerModule.IPlayFabMatchmaker; declare var PlayFabAddonSDK: PlayFabAddonModule.IPlayFabAddon; diff --git a/PlayFabTestingExample/PlayFabApiTest.csproj b/PlayFabTestingExample/PlayFabApiTest.csproj index 9809f5c8..3d733211 100644 --- a/PlayFabTestingExample/PlayFabApiTest.csproj +++ b/PlayFabTestingExample/PlayFabApiTest.csproj @@ -39,7 +39,6 @@ - @@ -61,7 +60,6 @@ - diff --git a/PlayFabTestingExample/index.html b/PlayFabTestingExample/index.html index a00c6a34..a60aec41 100644 --- a/PlayFabTestingExample/index.html +++ b/PlayFabTestingExample/index.html @@ -25,7 +25,6 @@ - diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabAddonApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabAddonApi.js index e3a39cfa..24cba57f 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabAddonApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabAddonApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -241,6 +241,10 @@ PlayFab.AddonApi = { PlayFab._internalSettings.entityToken = null; }, + ConfigurePSNEventStreams: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/ConfigurePSNEventStreams", request, "X-EntityToken", callback, customData, extraHeaders); + }, + CreateOrUpdateApple: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/CreateOrUpdateApple", request, "X-EntityToken", callback, customData, extraHeaders); }, @@ -273,6 +277,10 @@ PlayFab.AddonApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/CreateOrUpdateSteam", request, "X-EntityToken", callback, customData, extraHeaders); }, + CreateOrUpdateToxMod: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/CreateOrUpdateToxMod", request, "X-EntityToken", callback, customData, extraHeaders); + }, + CreateOrUpdateTwitch: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/CreateOrUpdateTwitch", request, "X-EntityToken", callback, customData, extraHeaders); }, @@ -309,6 +317,10 @@ PlayFab.AddonApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/DeleteSteam", request, "X-EntityToken", callback, customData, extraHeaders); }, + DeleteToxMod: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/DeleteToxMod", request, "X-EntityToken", callback, customData, extraHeaders); + }, + DeleteTwitch: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/DeleteTwitch", request, "X-EntityToken", callback, customData, extraHeaders); }, @@ -345,6 +357,10 @@ PlayFab.AddonApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/GetSteam", request, "X-EntityToken", callback, customData, extraHeaders); }, + GetToxMod: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/GetToxMod", request, "X-EntityToken", callback, customData, extraHeaders); + }, + GetTwitch: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Addon/GetTwitch", request, "X-EntityToken", callback, customData, extraHeaders); }, diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabAdminApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabAdminApi.js index 51f0bbe8..b543d7be 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabAdminApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabAdminApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -285,6 +285,10 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/CreateInsightsScheduledScalingTask", request, "X-SecretKey", callback, customData, extraHeaders); }, + CreateIPBan: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/CreateIPBan", request, "X-SecretKey", callback, customData, extraHeaders); + }, + CreateOpenIdConnection: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/CreateOpenIdConnection", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -325,6 +329,10 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/DeletePlayer", request, "X-SecretKey", callback, customData, extraHeaders); }, + DeletePlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/DeletePlayerCustomProperties", request, "X-SecretKey", callback, customData, extraHeaders); + }, + DeletePlayerSharedSecret: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/DeletePlayerSharedSecret", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -393,10 +401,22 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetDataReport", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetIPBansForIP: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetIPBansForIP", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + GetIPBansForTitle: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetIPBansForTitle", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetPlayedTitleList: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetPlayedTitleList", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetPlayerCustomProperty: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetPlayerCustomProperty", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetPlayerIdFromAuthToken: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetPlayerIdFromAuthToken", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -413,10 +433,6 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetPlayerSharedSecrets", request, "X-SecretKey", callback, customData, extraHeaders); }, - GetPlayersInSegment: function (request, callback, customData, extraHeaders) { - return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetPlayersInSegment", request, "X-SecretKey", callback, customData, extraHeaders); - }, - GetPlayerStatisticDefinitions: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetPlayerStatisticDefinitions", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -445,6 +461,10 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetSegmentExport", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetSegmentPlayerCount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetSegmentPlayerCount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetSegments: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetSegments", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -521,6 +541,10 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/ListOpenIdConnection", request, "X-SecretKey", callback, customData, extraHeaders); }, + ListPlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/ListPlayerCustomProperties", request, "X-SecretKey", callback, customData, extraHeaders); + }, + ListVirtualCurrencyTypes: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/ListVirtualCurrencyTypes", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -569,6 +593,10 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/RevokeInventoryItems", request, "X-SecretKey", callback, customData, extraHeaders); }, + RevokeIPBan: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/RevokeIPBan", request, "X-SecretKey", callback, customData, extraHeaders); + }, + RunTask: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/RunTask", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -633,10 +661,18 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/UpdateCloudScript", request, "X-SecretKey", callback, customData, extraHeaders); }, + UpdateIPBan: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/UpdateIPBan", request, "X-SecretKey", callback, customData, extraHeaders); + }, + UpdateOpenIdConnection: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/UpdateOpenIdConnection", request, "X-SecretKey", callback, customData, extraHeaders); }, + UpdatePlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/UpdatePlayerCustomProperties", request, "X-SecretKey", callback, customData, extraHeaders); + }, + UpdatePlayerSharedSecret: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/UpdatePlayerSharedSecret", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -693,6 +729,10 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/UpdateUserTitleDisplayName", request, "X-SecretKey", callback, customData, extraHeaders); }, + ValidateApiPolicy: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/ValidateApiPolicy", request, "X-SecretKey", callback, customData, extraHeaders); + }, + }; var PlayFabAdminSDK = PlayFab.AdminApi; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabAuthenticationApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabAuthenticationApi.js index 218ca150..8ac1c155 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabAuthenticationApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabAuthenticationApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabClientApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabClientApi.js index 9ee11d86..f66af485 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabClientApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabClientApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -313,6 +313,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/CreateSharedGroup", request, "X-Authorization", callback, customData, extraHeaders); }, + DeletePlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/DeletePlayerCustomProperties", request, "X-Authorization", callback, customData, extraHeaders); + }, + ExecuteCloudScript: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/ExecuteCloudScript", request, "X-Authorization", callback, customData, extraHeaders); }, @@ -397,6 +401,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayerCombinedInfo", request, "X-Authorization", callback, customData, extraHeaders); }, + GetPlayerCustomProperty: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayerCustomProperty", request, "X-Authorization", callback, customData, extraHeaders); + }, + GetPlayerProfile: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayerProfile", request, "X-Authorization", callback, customData, extraHeaders); }, @@ -421,6 +429,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayerTrades", request, "X-Authorization", callback, customData, extraHeaders); }, + GetPlayFabIDsFromBattleNetAccountIds: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromBattleNetAccountIds", request, "X-Authorization", callback, customData, extraHeaders); + }, + GetPlayFabIDsFromFacebookIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromFacebookIDs", request, "X-Authorization", callback, customData, extraHeaders); }, @@ -457,6 +469,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromNintendoSwitchDeviceIds", request, "X-Authorization", callback, customData, extraHeaders); }, + GetPlayFabIDsFromOpenIdSubjectIdentifiers: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromOpenIdSubjectIdentifiers", request, "X-Authorization", callback, customData, extraHeaders); + }, + GetPlayFabIDsFromPSNAccountIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromPSNAccountIDs", request, "X-Authorization", callback, customData, extraHeaders); }, @@ -469,6 +485,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromSteamIDs", request, "X-Authorization", callback, customData, extraHeaders); }, + GetPlayFabIDsFromSteamNames: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromSteamNames", request, "X-Authorization", callback, customData, extraHeaders); + }, + GetPlayFabIDsFromTwitchIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/GetPlayFabIDsFromTwitchIDs", request, "X-Authorization", callback, customData, extraHeaders); }, @@ -545,6 +565,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/LinkApple", request, "X-Authorization", callback, customData, extraHeaders); }, + LinkBattleNetAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/LinkBattleNetAccount", request, "X-Authorization", callback, customData, extraHeaders); + }, + LinkCustomID: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/LinkCustomID", request, "X-Authorization", callback, customData, extraHeaders); }, @@ -605,6 +629,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/LinkXboxAccount", request, "X-Authorization", callback, customData, extraHeaders); }, + ListPlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/ListPlayerCustomProperties", request, "X-Authorization", callback, customData, extraHeaders); + }, + LoginWithAndroidDeviceID: function (request, callback, customData, extraHeaders) { request.TitleId = PlayFab.settings.titleId ? PlayFab.settings.titleId : request.TitleId; if (!request.TitleId) throw PlayFab._internalSettings.errorTitleId; // PlayFab._internalSettings.authenticationContext can be modified by other asynchronous login attempts @@ -653,6 +681,30 @@ PlayFab.ClientApi = { return new Promise(function(resolve){resolve(authenticationContext);}); }, + LoginWithBattleNet: function (request, callback, customData, extraHeaders) { + request.TitleId = PlayFab.settings.titleId ? PlayFab.settings.titleId : request.TitleId; if (!request.TitleId) throw PlayFab._internalSettings.errorTitleId; + // PlayFab._internalSettings.authenticationContext can be modified by other asynchronous login attempts + // Deep-copy the authenticationContext here to safely update it + var authenticationContext = JSON.parse(JSON.stringify(PlayFab._internalSettings.authenticationContext)); + var overloadCallback = function (result, error) { + if (result != null) { + if(result.data.SessionTicket != null) { + PlayFab._internalSettings.sessionTicket = result.data.SessionTicket; + } + if (result.data.EntityToken != null) { + PlayFab._internalSettings.entityToken = result.data.EntityToken.EntityToken; + } + // Apply the updates for the AuthenticationContext returned to the client + authenticationContext = PlayFab._internalSettings.UpdateAuthenticationContext(authenticationContext, result); + } + if (callback != null && typeof (callback) === "function") + callback(result, error); + }; + PlayFab._internalSettings.ExecuteRequestWrapper("/Client/LoginWithBattleNet", request, null, overloadCallback, customData, extraHeaders); + // Return a Promise so that multiple asynchronous calls to this method can be handled simultaneously with Promise.all() + return new Promise(function(resolve){resolve(authenticationContext);}); + }, + LoginWithCustomID: function (request, callback, customData, extraHeaders) { request.TitleId = PlayFab.settings.titleId ? PlayFab.settings.titleId : request.TitleId; if (!request.TitleId) throw PlayFab._internalSettings.errorTitleId; // PlayFab._internalSettings.authenticationContext can be modified by other asynchronous login attempts @@ -1171,6 +1223,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/UnlinkApple", request, "X-Authorization", callback, customData, extraHeaders); }, + UnlinkBattleNetAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/UnlinkBattleNetAccount", request, "X-Authorization", callback, customData, extraHeaders); + }, + UnlinkCustomID: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/UnlinkCustomID", request, "X-Authorization", callback, customData, extraHeaders); }, @@ -1251,6 +1307,10 @@ PlayFab.ClientApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/UpdateCharacterStatistics", request, "X-Authorization", callback, customData, extraHeaders); }, + UpdatePlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/UpdatePlayerCustomProperties", request, "X-Authorization", callback, customData, extraHeaders); + }, + UpdatePlayerStatistics: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Client/UpdatePlayerStatistics", request, "X-Authorization", callback, customData, extraHeaders); }, diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabCloudScriptApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabCloudScriptApi.js index b70fcb4a..17c11b0f 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabCloudScriptApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabCloudScriptApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabDataApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabDataApi.js index bce8b796..49e60dfc 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabDataApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabDataApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabEconomyApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabEconomyApi.js index 46d5f780..013d5ea7 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabEconomyApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabEconomyApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -337,10 +337,6 @@ PlayFab.EconomyApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Catalog/GetItems", request, "X-EntityToken", callback, customData, extraHeaders); }, - GetMicrosoftStoreAccessTokens: function (request, callback, customData, extraHeaders) { - return PlayFab._internalSettings.ExecuteRequestWrapper("/Inventory/GetMicrosoftStoreAccessTokens", request, "X-EntityToken", callback, customData, extraHeaders); - }, - GetTransactionHistory: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Inventory/GetTransactionHistory", request, "X-EntityToken", callback, customData, extraHeaders); }, @@ -357,6 +353,10 @@ PlayFab.EconomyApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Inventory/RedeemAppleAppStoreInventoryItems", request, "X-EntityToken", callback, customData, extraHeaders); }, + RedeemAppleAppStoreWithJwsInventoryItems: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Inventory/RedeemAppleAppStoreWithJwsInventoryItems", request, "X-EntityToken", callback, customData, extraHeaders); + }, + RedeemGooglePlayInventoryItems: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Inventory/RedeemGooglePlayInventoryItems", request, "X-EntityToken", callback, customData, extraHeaders); }, diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabEventsApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabEventsApi.js index 22bceb71..c8ed22b3 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabEventsApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabEventsApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -245,18 +245,38 @@ PlayFab.EventsApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/CreateTelemetryKey", request, "X-EntityToken", callback, customData, extraHeaders); }, + DeleteDataConnection: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/DeleteDataConnection", request, "X-EntityToken", callback, customData, extraHeaders); + }, + DeleteTelemetryKey: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/DeleteTelemetryKey", request, "X-EntityToken", callback, customData, extraHeaders); }, + GetDataConnection: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/GetDataConnection", request, "X-EntityToken", callback, customData, extraHeaders); + }, + GetTelemetryKey: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/GetTelemetryKey", request, "X-EntityToken", callback, customData, extraHeaders); }, + ListDataConnections: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/ListDataConnections", request, "X-EntityToken", callback, customData, extraHeaders); + }, + ListTelemetryKeys: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/ListTelemetryKeys", request, "X-EntityToken", callback, customData, extraHeaders); }, + SetDataConnection: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/SetDataConnection", request, "X-EntityToken", callback, customData, extraHeaders); + }, + + SetDataConnectionActive: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/SetDataConnectionActive", request, "X-EntityToken", callback, customData, extraHeaders); + }, + SetTelemetryKeyActive: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Event/SetTelemetryKeyActive", request, "X-EntityToken", callback, customData, extraHeaders); }, diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabExperimentationApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabExperimentationApi.js index 17e4f297..06fe7806 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabExperimentationApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabExperimentationApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabGroupsApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabGroupsApi.js index 4d43ec4b..5ff17e41 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabGroupsApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabGroupsApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabInsightsApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabInsightsApi.js index 5656202b..4751a9f5 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabInsightsApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabInsightsApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabLocalizationApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabLocalizationApi.js index fa497963..f2b8672f 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabLocalizationApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabLocalizationApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabMatchmakerApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabMatchmakerApi.js deleted file mode 100644 index 3698e8f7..00000000 --- a/PlayFabTestingExample/src/PlayFab/PlayFabMatchmakerApi.js +++ /dev/null @@ -1,247 +0,0 @@ -/// - -var PlayFab = typeof PlayFab != "undefined" ? PlayFab : {}; - -if(!PlayFab.settings) { - PlayFab.settings = { - titleId: null, // You must set this value for PlayFabSdk to work properly (Found in the Game Manager for your title, at the PlayFab Website) - developerSecretKey: null, // For security reasons you must never expose this value to the client or players - You must set this value for Server-APIs to work properly (Found in the Game Manager for your title, at the PlayFab Website) - GlobalHeaderInjection: null, - productionServerUrl: ".playfabapi.com" - } -} - -if(!PlayFab._internalSettings) { - PlayFab._internalSettings = { - entityToken: null, - sdkVersion: "1.178.240816", - requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" - }, - sessionTicket: null, - verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this - errorTitleId: "Must be have PlayFab.settings.titleId set to call this method", - errorLoggedIn: "Must be logged in to call this method", - errorEntityToken: "You must successfully call GetEntityToken before calling this", - errorSecretKey: "Must have PlayFab.settings.developerSecretKey set to call this method", - - GetServerUrl: function () { - if (!(PlayFab.settings.productionServerUrl.substring(0, 4) === "http")) { - if (PlayFab._internalSettings.verticalName) { - return "https://" + PlayFab._internalSettings.verticalName + PlayFab.settings.productionServerUrl; - } else { - return "https://" + PlayFab.settings.titleId + PlayFab.settings.productionServerUrl; - } - } else { - return PlayFab.settings.productionServerUrl; - } - }, - - InjectHeaders: function (xhr, headersObj) { - if (!headersObj) - return; - - for (var headerKey in headersObj) - { - try { - xhr.setRequestHeader(gHeaderKey, headersObj[headerKey]); - } catch (e) { - console.log("Failed to append header: " + headerKey + " = " + headersObj[headerKey] + "Error: " + e); - } - } - }, - - ExecuteRequest: function (url, request, authkey, authValue, callback, customData, extraHeaders) { - var resultPromise = new Promise(function (resolve, reject) { - if (callback != null && typeof (callback) !== "function") - throw "Callback must be null or a function"; - - if (request == null) - request = {}; - - var startTime = new Date(); - var requestBody = JSON.stringify(request); - - var urlArr = [url]; - var getParams = PlayFab._internalSettings.requestGetParams; - if (getParams != null) { - var firstParam = true; - for (var key in getParams) { - if (firstParam) { - urlArr.push("?"); - firstParam = false; - } else { - urlArr.push("&"); - } - urlArr.push(key); - urlArr.push("="); - urlArr.push(getParams[key]); - } - } - - var completeUrl = urlArr.join(""); - - var xhr = new XMLHttpRequest(); - // window.console.log("URL: " + completeUrl); - xhr.open("POST", completeUrl, true); - - xhr.setRequestHeader("Content-Type", "application/json"); - xhr.setRequestHeader("X-PlayFabSDK", "JavaScriptSDK-" + PlayFab._internalSettings.sdkVersion); - if (authkey != null) - xhr.setRequestHeader(authkey, authValue); - PlayFab._internalSettings.InjectHeaders(xhr, PlayFab.settings.GlobalHeaderInjection); - PlayFab._internalSettings.InjectHeaders(xhr, extraHeaders); - - xhr.onloadend = function () { - if (callback == null) - return; - - var result = PlayFab._internalSettings.GetPlayFabResponse(request, xhr, startTime, customData); - if (result.code === 200) { - callback(result, null); - } else { - callback(null, result); - } - } - - xhr.onerror = function () { - if (callback == null) - return; - - var result = PlayFab._internalSettings.GetPlayFabResponse(request, xhr, startTime, customData); - callback(null, result); - } - - xhr.send(requestBody); - xhr.onreadystatechange = function () { - if (this.readyState === 4) { - var xhrResult = PlayFab._internalSettings.GetPlayFabResponse(request, this, startTime, customData); - if (this.status === 200) { - resolve(xhrResult); - } else { - reject(xhrResult); - } - } - }; - }); - // Return a Promise so that calls to various API methods can be handled asynchronously - return resultPromise; - }, - - GetPlayFabResponse: function(request, xhr, startTime, customData) { - var result = null; - try { - // window.console.log("parsing json result: " + xhr.responseText); - result = JSON.parse(xhr.responseText); - } catch (e) { - result = { - code: 503, // Service Unavailable - status: "Service Unavailable", - error: "Connection error", - errorCode: 2, // PlayFabErrorCode.ConnectionError - errorMessage: xhr.responseText - }; - } - - result.CallBackTimeMS = new Date() - startTime; - result.Request = request; - result.CustomData = customData; - return result; - }, - - authenticationContext: { - PlayFabId: null, - EntityId: null, - EntityType: null, - SessionTicket: null, - EntityToken: null - }, - - UpdateAuthenticationContext: function (authenticationContext, result) { - var authenticationContextUpdates = {}; - if(result.data.PlayFabId !== null) { - PlayFab._internalSettings.authenticationContext.PlayFabId = result.data.PlayFabId; - authenticationContextUpdates.PlayFabId = result.data.PlayFabId; - } - if(result.data.SessionTicket !== null) { - PlayFab._internalSettings.authenticationContext.SessionTicket = result.data.SessionTicket; - authenticationContextUpdates.SessionTicket = result.data.SessionTicket; - } - if (result.data.EntityToken !== null) { - PlayFab._internalSettings.authenticationContext.EntityId = result.data.EntityToken.Entity.Id; - authenticationContextUpdates.EntityId = result.data.EntityToken.Entity.Id; - PlayFab._internalSettings.authenticationContext.EntityType = result.data.EntityToken.Entity.Type; - authenticationContextUpdates.EntityType = result.data.EntityToken.Entity.Type; - PlayFab._internalSettings.authenticationContext.EntityToken = result.data.EntityToken.EntityToken; - authenticationContextUpdates.EntityToken = result.data.EntityToken.EntityToken; - } - // Update the authenticationContext with values from the result - authenticationContext = Object.assign(authenticationContext, authenticationContextUpdates); - return authenticationContext; - }, - - AuthInfoMap: { - "X-EntityToken": { - authAttr: "entityToken", - authError: "errorEntityToken" - }, - "X-Authorization": { - authAttr: "sessionTicket", - authError: "errorLoggedIn" - }, - "X-SecretKey": { - authAttr: "developerSecretKey", - authError: "errorSecretKey" - } - }, - - GetAuthInfo: function (request, authKey) { - // Use the most-recently saved authKey, unless one was provided in the request via the AuthenticationContext - var authError = PlayFab._internalSettings.AuthInfoMap[authKey].authError; - var authAttr = PlayFab._internalSettings.AuthInfoMap[authKey].authAttr; - var defaultAuthValue = null; - if (authAttr === "entityToken") - defaultAuthValue = PlayFab._internalSettings.entityToken; - else if (authAttr === "sessionTicket") - defaultAuthValue = PlayFab._internalSettings.sessionTicket; - else if (authAttr === "developerSecretKey") - defaultAuthValue = PlayFab.settings.developerSecretKey; - var authValue = request.AuthenticationContext ? request.AuthenticationContext[authAttr] : defaultAuthValue; - return {"authKey": authKey, "authValue": authValue, "authError": authError}; - }, - - ExecuteRequestWrapper: function (apiURL, request, authKey, callback, customData, extraHeaders) { - var authValue = null; - if (authKey !== null){ - var authInfo = PlayFab._internalSettings.GetAuthInfo(request, authKey=authKey); - var authKey = authInfo.authKey, authValue = authInfo.authValue, authError = authInfo.authError; - - if (!authValue) throw authError; - } - return PlayFab._internalSettings.ExecuteRequest(PlayFab._internalSettings.GetServerUrl() + apiURL, request, authKey, authValue, callback, customData, extraHeaders); - } - } -} - -PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; -PlayFab.GenerateErrorReport = function (error) { - if (error == null) - return ""; - var fullErrors = error.errorMessage; - for (var paramName in error.errorDetails) - for (var msgIdx in error.errorDetails[paramName]) - fullErrors += "\n" + paramName + ": " + error.errorDetails[paramName][msgIdx]; - return fullErrors; -}; - -PlayFab.MatchmakerApi = { - ForgetAllCredentials: function () { - PlayFab._internalSettings.sessionTicket = null; - PlayFab._internalSettings.entityToken = null; - }, - -}; - -var PlayFabMatchmakerSDK = PlayFab.MatchmakerApi; - diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabMultiplayerApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabMultiplayerApi.js index d6bb7c48..d92785ef 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabMultiplayerApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabMultiplayerApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabProfilesApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabProfilesApi.js index 1ef06b3c..5a1ec15d 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabProfilesApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabProfilesApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -261,6 +261,10 @@ PlayFab.ProfilesApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Profile/GetTitlePlayersFromXboxLiveIDs", request, "X-EntityToken", callback, customData, extraHeaders); }, + SetDisplayName: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Profile/SetDisplayName", request, "X-EntityToken", callback, customData, extraHeaders); + }, + SetGlobalPolicy: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Profile/SetGlobalPolicy", request, "X-EntityToken", callback, customData, extraHeaders); }, diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabProgressionApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabProgressionApi.js index 3005ed79..479bc913 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabProgressionApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabProgressionApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -289,10 +289,6 @@ PlayFab.ProgressionApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Statistic/GetStatisticDefinition", request, "X-EntityToken", callback, customData, extraHeaders); }, - GetStatisticDefinitions: function (request, callback, customData, extraHeaders) { - return PlayFab._internalSettings.ExecuteRequestWrapper("/Statistic/GetStatisticDefinitions", request, "X-EntityToken", callback, customData, extraHeaders); - }, - GetStatistics: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Statistic/GetStatistics", request, "X-EntityToken", callback, customData, extraHeaders); }, @@ -317,14 +313,26 @@ PlayFab.ProgressionApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Statistic/ListStatisticDefinitions", request, "X-EntityToken", callback, customData, extraHeaders); }, + UnlinkAggregationSourceFromStatistic: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Statistic/UnlinkAggregationSourceFromStatistic", request, "X-EntityToken", callback, customData, extraHeaders); + }, + UnlinkLeaderboardFromStatistic: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Leaderboard/UnlinkLeaderboardFromStatistic", request, "X-EntityToken", callback, customData, extraHeaders); }, + UpdateLeaderboardDefinition: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Leaderboard/UpdateLeaderboardDefinition", request, "X-EntityToken", callback, customData, extraHeaders); + }, + UpdateLeaderboardEntries: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Leaderboard/UpdateLeaderboardEntries", request, "X-EntityToken", callback, customData, extraHeaders); }, + UpdateStatisticDefinition: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Statistic/UpdateStatisticDefinition", request, "X-EntityToken", callback, customData, extraHeaders); + }, + UpdateStatistics: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Statistic/UpdateStatistics", request, "X-EntityToken", callback, customData, extraHeaders); }, diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabServerApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabServerApi.js index d38e393d..a0f01589 100644 --- a/PlayFabTestingExample/src/PlayFab/PlayFabServerApi.js +++ b/PlayFabTestingExample/src/PlayFab/PlayFabServerApi.js @@ -14,9 +14,9 @@ if(!PlayFab.settings) { if(!PlayFab._internalSettings) { PlayFab._internalSettings = { entityToken: null, - sdkVersion: "1.178.240816", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.178.240816" + sdk: "JavaScriptSDK-1.222.260922" }, sessionTicket: null, verticalName: null, // The name of a customer vertical. This is only for customers running a private cluster. Generally you shouldn't touch this @@ -224,7 +224,7 @@ if(!PlayFab._internalSettings) { } PlayFab.buildIdentifier = "adobuild_javascriptsdk_115"; -PlayFab.sdkVersion = "1.178.240816"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -253,6 +253,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/AddGenericID", request, "X-SecretKey", callback, customData, extraHeaders); }, + AddOrUpdateContactEmail: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/AddOrUpdateContactEmail", request, "X-SecretKey", callback, customData, extraHeaders); + }, + AddPlayerTag: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/AddPlayerTag", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -293,6 +297,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/DeletePlayer", request, "X-SecretKey", callback, customData, extraHeaders); }, + DeletePlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/DeletePlayerCustomProperties", request, "X-SecretKey", callback, customData, extraHeaders); + }, + DeletePushNotificationTemplate: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/DeletePushNotificationTemplate", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -309,6 +317,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/ExecuteCloudScript", request, "X-SecretKey", callback, customData, extraHeaders); }, + ExportPlayersInSegment: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/ExportPlayersInSegment", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetAllSegments: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetAllSegments", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -377,6 +389,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayerCombinedInfo", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetPlayerCustomProperty: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayerCustomProperty", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetPlayerProfile: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayerProfile", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -385,10 +401,6 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayerSegments", request, "X-SecretKey", callback, customData, extraHeaders); }, - GetPlayersInSegment: function (request, callback, customData, extraHeaders) { - return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayersInSegment", request, "X-SecretKey", callback, customData, extraHeaders); - }, - GetPlayerStatistics: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayerStatistics", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -401,6 +413,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayerTags", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetPlayFabIDsFromBattleNetAccountIds: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromBattleNetAccountIds", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetPlayFabIDsFromFacebookIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromFacebookIDs", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -421,6 +437,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromNintendoSwitchDeviceIds", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetPlayFabIDsFromOpenIdSubjectIdentifiers: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromOpenIdSubjectIdentifiers", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetPlayFabIDsFromPSNAccountIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromPSNAccountIDs", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -429,10 +449,18 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromPSNOnlineIDs", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetPlayFabIDsFromServerCustomIDs: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromServerCustomIDs", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetPlayFabIDsFromSteamIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromSteamIDs", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetPlayFabIDsFromSteamNames: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromSteamNames", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetPlayFabIDsFromTwitchIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayFabIDsFromTwitchIDs", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -449,6 +477,14 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetRandomResultTables", request, "X-SecretKey", callback, customData, extraHeaders); }, + GetSegmentExport: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetSegmentExport", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + GetSegmentPlayerCount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetSegmentPlayerCount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + GetServerCustomIDsFromPlayFabIDs: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetServerCustomIDsFromPlayFabIDs", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -529,6 +565,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GrantItemsToUsers", request, "X-SecretKey", callback, customData, extraHeaders); }, + LinkBattleNetAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LinkBattleNetAccount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + LinkNintendoServiceAccount: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LinkNintendoServiceAccount", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -557,10 +597,38 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LinkSteamId", request, "X-SecretKey", callback, customData, extraHeaders); }, + LinkTwitchAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LinkTwitchAccount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + LinkXboxAccount: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LinkXboxAccount", request, "X-SecretKey", callback, customData, extraHeaders); }, + LinkXboxId: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LinkXboxId", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + ListPlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/ListPlayerCustomProperties", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + LoginWithAndroidDeviceID: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithAndroidDeviceID", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + LoginWithBattleNet: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithBattleNet", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + LoginWithCustomID: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithCustomID", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + LoginWithIOSDeviceID: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithIOSDeviceID", request, "X-SecretKey", callback, customData, extraHeaders); + }, + LoginWithPSN: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithPSN", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -573,6 +641,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithSteamId", request, "X-SecretKey", callback, customData, extraHeaders); }, + LoginWithTwitch: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithTwitch", request, "X-SecretKey", callback, customData, extraHeaders); + }, + LoginWithXbox: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/LoginWithXbox", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -685,6 +757,26 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/SubtractUserVirtualCurrency", request, "X-SecretKey", callback, customData, extraHeaders); }, + UnlinkApple: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkApple", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + UnlinkBattleNetAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkBattleNetAccount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + UnlinkFacebookAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkFacebookAccount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + UnlinkFacebookInstantGamesId: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkFacebookInstantGamesId", request, "X-SecretKey", callback, customData, extraHeaders); + }, + + UnlinkGameCenterAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkGameCenterAccount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + UnlinkNintendoServiceAccount: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkNintendoServiceAccount", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -705,6 +797,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkSteamId", request, "X-SecretKey", callback, customData, extraHeaders); }, + UnlinkTwitchAccount: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkTwitchAccount", request, "X-SecretKey", callback, customData, extraHeaders); + }, + UnlinkXboxAccount: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UnlinkXboxAccount", request, "X-SecretKey", callback, customData, extraHeaders); }, @@ -741,6 +837,10 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UpdateCharacterStatistics", request, "X-SecretKey", callback, customData, extraHeaders); }, + UpdatePlayerCustomProperties: function (request, callback, customData, extraHeaders) { + return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UpdatePlayerCustomProperties", request, "X-SecretKey", callback, customData, extraHeaders); + }, + UpdatePlayerStatistics: function (request, callback, customData, extraHeaders) { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/UpdatePlayerStatistics", request, "X-SecretKey", callback, customData, extraHeaders); }, diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFab.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFab.d.ts index f2ce678f..441d70ef 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFab.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFab.d.ts @@ -13,7 +13,6 @@ /// /// /// -/// /// declare module PlayFabModule { @@ -63,7 +62,6 @@ declare var PlayFab: { LocalizationApi: PlayFabLocalizationModule.IPlayFabLocalization; MultiplayerApi: PlayFabMultiplayerModule.IPlayFabMultiplayer; ProfilesApi: PlayFabProfilesModule.IPlayFabProfiles; - MatchmakerApi: PlayFabMatchmakerModule.IPlayFabMatchmaker; AddonApi: PlayFabAddonModule.IPlayFabAddon; }; @@ -83,6 +81,5 @@ declare var PlayFabProgressionSDK: PlayFabProgressionModule.IPlayFabProgression; declare var PlayFabLocalizationSDK: PlayFabLocalizationModule.IPlayFabLocalization; declare var PlayFabMultiplayerSDK: PlayFabMultiplayerModule.IPlayFabMultiplayer; declare var PlayFabProfilesSDK: PlayFabProfilesModule.IPlayFabProfiles; -declare var PlayFabMatchmakerSDK: PlayFabMatchmakerModule.IPlayFabMatchmaker; declare var PlayFabAddonSDK: PlayFabAddonModule.IPlayFabAddon; diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabAddonApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabAddonApi.d.ts index 3ad358a5..6ec1a36a 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabAddonApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabAddonApi.d.ts @@ -4,139 +4,159 @@ declare module PlayFabAddonModule { export interface IPlayFabAddon { ForgetAllCredentials(): void; + /** + * Configures PSN event streams for an existing PSN addon on a title, without requiring a full addon upsert. + * https://docs.microsoft.com/rest/api/playfab/addon/addon/configurepsneventstreams + */ + ConfigurePSNEventStreams(request: PlayFabAddonModels.ConfigurePSNEventStreamsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Apple addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdateapple + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdateapple */ CreateOrUpdateApple(request: PlayFabAddonModels.CreateOrUpdateAppleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Facebook addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdatefacebook + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatefacebook */ CreateOrUpdateFacebook(request: PlayFabAddonModels.CreateOrUpdateFacebookRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Facebook Instant Games addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdatefacebookinstantgames + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatefacebookinstantgames */ CreateOrUpdateFacebookInstantGames(request: PlayFabAddonModels.CreateOrUpdateFacebookInstantGamesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Google addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdategoogle + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdategoogle */ CreateOrUpdateGoogle(request: PlayFabAddonModels.CreateOrUpdateGoogleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Kongregate addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdatekongregate + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatekongregate */ CreateOrUpdateKongregate(request: PlayFabAddonModels.CreateOrUpdateKongregateRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Nintendo addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdatenintendo + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatenintendo */ CreateOrUpdateNintendo(request: PlayFabAddonModels.CreateOrUpdateNintendoRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the PSN addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdatepsn + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatepsn */ CreateOrUpdatePSN(request: PlayFabAddonModels.CreateOrUpdatePSNRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Steam addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdatesteam + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatesteam */ CreateOrUpdateSteam(request: PlayFabAddonModels.CreateOrUpdateSteamRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Creates the ToxMod addon on a title, or updates it if it already exists. + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatetoxmod + */ + CreateOrUpdateToxMod(request: PlayFabAddonModels.CreateOrUpdateToxModRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Creates the Twitch addon on a title, or updates it if it already exists. - * https://docs.microsoft.com/rest/api/playfab/addon/null/createorupdatetwitch + * https://docs.microsoft.com/rest/api/playfab/addon/addon/createorupdatetwitch */ CreateOrUpdateTwitch(request: PlayFabAddonModels.CreateOrUpdateTwitchRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Apple addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deleteapple + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deleteapple */ DeleteApple(request: PlayFabAddonModels.DeleteAppleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Facebook addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletefacebook + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebook */ DeleteFacebook(request: PlayFabAddonModels.DeleteFacebookRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Facebook addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletefacebookinstantgames + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletefacebookinstantgames */ DeleteFacebookInstantGames(request: PlayFabAddonModels.DeleteFacebookInstantGamesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Google addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletegoogle + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletegoogle */ DeleteGoogle(request: PlayFabAddonModels.DeleteGoogleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Kongregate addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletekongregate + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletekongregate */ DeleteKongregate(request: PlayFabAddonModels.DeleteKongregateRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Nintendo addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletenintendo + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletenintendo */ DeleteNintendo(request: PlayFabAddonModels.DeleteNintendoRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the PSN addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletepsn + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletepsn */ DeletePSN(request: PlayFabAddonModels.DeletePSNRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Steam addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletesteam + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletesteam */ DeleteSteam(request: PlayFabAddonModels.DeleteSteamRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Deletes the ToxMod addon on a title. + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetoxmod + */ + DeleteToxMod(request: PlayFabAddonModels.DeleteToxModRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes the Twitch addon on a title. - * https://docs.microsoft.com/rest/api/playfab/addon/null/deletetwitch + * https://docs.microsoft.com/rest/api/playfab/addon/addon/deletetwitch */ DeleteTwitch(request: PlayFabAddonModels.DeleteTwitchRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Apple addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getapple + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getapple */ GetApple(request: PlayFabAddonModels.GetAppleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Facebook addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getfacebook + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebook */ GetFacebook(request: PlayFabAddonModels.GetFacebookRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Facebook Instant Games addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getfacebookinstantgames + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getfacebookinstantgames */ GetFacebookInstantGames(request: PlayFabAddonModels.GetFacebookInstantGamesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Google addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getgoogle + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getgoogle */ GetGoogle(request: PlayFabAddonModels.GetGoogleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Kongregate addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getkongregate + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getkongregate */ GetKongregate(request: PlayFabAddonModels.GetKongregateRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Nintendo addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getnintendo + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getnintendo */ GetNintendo(request: PlayFabAddonModels.GetNintendoRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the PSN addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getpsn + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getpsn */ GetPSN(request: PlayFabAddonModels.GetPSNRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Steam addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/getsteam + * https://docs.microsoft.com/rest/api/playfab/addon/addon/getsteam */ GetSteam(request: PlayFabAddonModels.GetSteamRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Gets information of the ToxMod addon on a title, omits secrets. + * https://docs.microsoft.com/rest/api/playfab/addon/addon/gettoxmod + */ + GetToxMod(request: PlayFabAddonModels.GetToxModRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information of the Twitch addon on a title, omits secrets. - * https://docs.microsoft.com/rest/api/playfab/addon/null/gettwitch + * https://docs.microsoft.com/rest/api/playfab/addon/addon/gettwitch */ GetTwitch(request: PlayFabAddonModels.GetTwitchRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -144,9 +164,29 @@ declare module PlayFabAddonModule { } declare module PlayFabAddonModels { + export interface ConfigurePSNEventStreamsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ + Entity?: EntityKey; + /** Title name obtained after setting a back server for PS5. Used for clawback event listeners. */ + TitleName?: string; + + } + + export interface ConfigurePSNEventStreamsResponse extends PlayFabModule.IPlayFabResultCommon { + + } + export interface CreateOrUpdateAppleRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Allow validation of receipts from the Apple production environment. Required for app releases. */ + AllowProduction?: boolean; + /** Allow validation of receipts from the Apple sandbox environment. Typically used while testing. */ + AllowSandbox?: boolean; /** iOS App Bundle ID obtained after setting up your app in the App Store. */ AppBundleId: string; + /** AppId obtained after setting up your app in the App Store. */ + AppId?: string; /** iOS App Shared Secret obtained after setting up your app in the App Store. */ AppSharedSecret?: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ @@ -160,6 +200,12 @@ declare module PlayFabAddonModels { * case where Apple rotates their signing keys. */ IgnoreExpirationDate?: boolean; + /** IssuerId obtained after setting up your app in the App Store. */ + IssuerId?: string; + /** KeyId obtained after setting up your app in the App Store. */ + KeyId?: string; + /** PrivateKey obtained after setting up your app in the App Store. */ + PrivateKey?: string; /** Require secure authentication only for this app. */ RequireSecureAuthentication?: boolean; @@ -234,6 +280,12 @@ declare module PlayFabAddonModels { * Required if using Google Authentication. */ OAuthClientSecret?: string; + /** + * Authorized Redirect Uri obtained through the Google Developer Console. This currently defaults to + * https://oauth.playfab.com/oauth2/google. If you are authenticating players via browser, please update this to your own + * domain. + */ + OAuthCustomRedirectUri?: string; /** Needed to enable pending purchase handling and subscription processing. */ ServiceAccountKey?: string; @@ -270,6 +322,8 @@ declare module PlayFabAddonModels { Environments?: NintendoEnvironment[]; /** If an error should be returned if the addon already exists. */ ErrorIfExists?: boolean; + /** List of Nintendo Subscription Environments, currently supporting up to 4. Needs Catalog enabled. */ + SubscriptionEnvironments?: NintendoEnvironment[]; } @@ -327,6 +381,26 @@ declare module PlayFabAddonModels { } + export interface CreateOrUpdateToxModRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Account ID obtained after creating your ToxMod developer account. */ + AccountId: string; + /** Account Key obtained after creating your ToxMod developer account. */ + AccountKey: string; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Whether ToxMod Addon is Enabled by Title. */ + Enabled: boolean; + /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ + Entity?: EntityKey; + /** If an error should be returned if the addon already exists. */ + ErrorIfExists?: boolean; + + } + + export interface CreateOrUpdateToxModResponse extends PlayFabModule.IPlayFabResultCommon { + + } + export interface CreateOrUpdateTwitchRequest extends PlayFabModule.IPlayFabRequestCommon { /** Client ID obtained after creating your Twitch developer account. */ ClientID?: string; @@ -441,6 +515,18 @@ declare module PlayFabAddonModels { } + export interface DeleteToxModRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ + Entity?: EntityKey; + + } + + export interface DeleteToxModResponse extends PlayFabModule.IPlayFabResultCommon { + + } + export interface DeleteTwitchRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -536,6 +622,12 @@ declare module PlayFabAddonModels { * Required if using Google Authentication. */ OAuthClientID?: string; + /** + * Authorized Redirect Uri obtained through the Google Developer Console. This currently defaults to + * https://oauth.playfab.com/oauth2/google. If you are authenticating players via browser, please update this to your own + * domain. + */ + OauthCustomRedirectUri?: string; } @@ -568,6 +660,10 @@ declare module PlayFabAddonModels { Created: boolean; /** List of Nintendo Environments, currently supporting up to 4. */ Environments?: NintendoEnvironment[]; + /** List of Nintendo Subscription Environments associated to a secondary AppId, currently supporting up to 4. */ + SecondarySubscriptionEnvironments?: NintendoEnvironment[]; + /** List of Nintendo Subscription Environments, currently supporting up to 4. */ + SubscriptionEnvironments?: NintendoEnvironment[]; } @@ -612,6 +708,26 @@ declare module PlayFabAddonModels { } + export interface GetToxModRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ + Entity?: EntityKey; + + } + + export interface GetToxModResponse extends PlayFabModule.IPlayFabResultCommon { + /** Account ID obtained after creating your Twitch developer account. */ + AccountId?: string; + /** Account Key obtained after creating your Twitch developer account. */ + AccountKey?: string; + /** Addon status. */ + Created: boolean; + /** Whether the ToxMod Addon is enabled by the title. */ + Enabled: boolean; + + } + export interface GetTwitchRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabAdminApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabAdminApi.d.ts index f4905f32..46869cef 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabAdminApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabAdminApi.d.ts @@ -38,7 +38,7 @@ declare module PlayFabAdminModule { */ AddVirtualCurrencyTypes(request: PlayFabAdminModels.AddVirtualCurrencyTypesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** - * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game. + * Bans users by PlayFab ID with optional IP address for the provided game. * https://docs.microsoft.com/rest/api/playfab/admin/account-management/banusers */ BanUsers(request: PlayFabAdminModels.BanUsersRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -63,6 +63,11 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/createinsightsscheduledscalingtask */ CreateInsightsScheduledScalingTask(request: PlayFabAdminModels.CreateInsightsScheduledScalingTaskRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Bans an IP address or CIDR range for a title. + * https://docs.microsoft.com/rest/api/playfab/admin/account-management/createipban + */ + CreateIPBan(request: PlayFabAdminModels.CreateIPBanRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Registers a relationship between a title and an Open ID Connect provider. * https://docs.microsoft.com/rest/api/playfab/admin/authentication/createopenidconnection @@ -116,6 +121,11 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/account-management/deleteplayer */ DeletePlayer(request: PlayFabAdminModels.DeletePlayerRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Deletes title-specific custom properties for a player + * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/deleteplayercustomproperties + */ + DeletePlayerCustomProperties(request: PlayFabAdminModels.DeletePlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes an existing Player Shared Secret Key. It may take up to 5 minutes for this delete to be reflected after this API * returns. @@ -167,7 +177,8 @@ declare module PlayFabAdminModule { GetActionsOnPlayersInSegmentTaskInstance(request: PlayFabAdminModels.GetTaskInstanceRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as - * GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change. + * ExportPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not + * change. * https://docs.microsoft.com/rest/api/playfab/admin/playstream/getallsegments */ GetAllSegments(request: PlayFabAdminModels.GetAllSegmentsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -210,11 +221,26 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getdatareport */ GetDataReport(request: PlayFabAdminModels.GetDataReportRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Gets all IP bans that apply to a specific IP address. + * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getipbansforip + */ + GetIPBansForIP(request: PlayFabAdminModels.GetIPBanRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Gets all IP bans for a title. + * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getipbansfortitle + */ + GetIPBansForTitle(request: PlayFabAdminModels.GetAllIPBansRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Get the list of titles that the player has played * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayedtitlelist */ GetPlayedTitleList(request: PlayFabAdminModels.GetPlayedTitleListRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves a title-specific custom property value for a player. + * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/getplayercustomproperty + */ + GetPlayerCustomProperty(request: PlayFabAdminModels.GetPlayerCustomPropertyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets a player's ID from an auth token. * https://docs.microsoft.com/rest/api/playfab/admin/account-management/getplayeridfromauthtoken @@ -235,15 +261,6 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/authentication/getplayersharedsecrets */ GetPlayerSharedSecrets(request: PlayFabAdminModels.GetPlayerSharedSecretsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; - /** - * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match - * the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span - * on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected - * in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being - * called 30 times in one minute. You will be returned an error if you exceed this threshold. - * https://docs.microsoft.com/rest/api/playfab/admin/playstream/getplayersinsegment - */ - GetPlayersInSegment(request: PlayFabAdminModels.GetPlayersInSegmentRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the configuration information for all player statistics defined in the title, regardless of whether they have * a reset interval. @@ -284,6 +301,11 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/playstream/getsegmentexport */ GetSegmentExport(request: PlayFabAdminModels.GetPlayersInSegmentExportRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Returns the total number of players in a given segment. + * https://docs.microsoft.com/rest/api/playfab/admin/playstream/getsegmentplayercount + */ + GetSegmentPlayerCount(request: PlayFabAdminModels.GetSegmentPlayerCountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Get detail information of a segment and its associated definition(s) and action(s) for a title. * https://docs.microsoft.com/rest/api/playfab/admin/segments/getsegments @@ -383,6 +405,11 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/authentication/listopenidconnection */ ListOpenIdConnection(request: PlayFabAdminModels.ListOpenIdConnectionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves title-specific custom property values for a player. + * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/listplayercustomproperties + */ + ListPlayerCustomProperties(request: PlayFabAdminModels.ListPlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * _NOTE: This is a Legacy Economy API, and is in bugfix-only mode. All new Economy features are being developed only for * version 2._ Retuns the list of all defined virtual currencies for the title @@ -449,6 +476,11 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/player-item-management/revokeinventoryitems */ RevokeInventoryItems(request: PlayFabAdminModels.RevokeInventoryItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Revokes an active IP ban. + * https://docs.microsoft.com/rest/api/playfab/admin/account-management/revokeipban + */ + RevokeIPBan(request: PlayFabAdminModels.RevokeIPBanRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Run a task immediately regardless of its schedule. * https://docs.microsoft.com/rest/api/playfab/admin/scheduledtask/runtask @@ -542,11 +574,21 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/server-side-cloud-script/updatecloudscript */ UpdateCloudScript(request: PlayFabAdminModels.UpdateCloudScriptRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Updates an existing IP ban. + * https://docs.microsoft.com/rest/api/playfab/admin/account-management/updateipban + */ + UpdateIPBan(request: PlayFabAdminModels.UpdateIPBanRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Modifies data and credentials for an existing relationship between a title and an Open ID Connect provider * https://docs.microsoft.com/rest/api/playfab/admin/authentication/updateopenidconnection */ UpdateOpenIdConnection(request: PlayFabAdminModels.UpdateOpenIdConnectionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Updates the title-specific custom property values for a player + * https://docs.microsoft.com/rest/api/playfab/admin/player-data-management/updateplayercustomproperties + */ + UpdatePlayerCustomProperties(request: PlayFabAdminModels.UpdatePlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Updates a existing Player Shared Secret Key. It may take up to 5 minutes for this update to become generally available * after this API returns. @@ -620,6 +662,11 @@ declare module PlayFabAdminModule { * https://docs.microsoft.com/rest/api/playfab/admin/account-management/updateusertitledisplayname */ UpdateUserTitleDisplayName(request: PlayFabAdminModels.UpdateUserTitleDisplayNameRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Validates the result of a policy update without persisting it. + * https://docs.microsoft.com/rest/api/playfab/admin/authentication/validateapipolicy + */ + ValidateApiPolicy(request: PlayFabAdminModels.ValidateApiPolicyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; } } @@ -697,16 +744,6 @@ declare module PlayFabAdminModels { } - export interface AdCampaignAttribution { - /** UTC time stamp of attribution */ - AttributedAt: string; - /** Attribution campaign identifier */ - CampaignId?: string; - /** Attribution network name */ - Platform?: string; - - } - export interface AdCampaignAttributionModel { /** UTC time stamp of attribution */ AttributedAt: string; @@ -778,6 +815,8 @@ declare module PlayFabAdminModels { Body: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; + /** Optional status for the new news item. If not set, defaults to Published. */ + Status?: string; /** Time this news was published. If not set, defaults to now. */ Timestamp?: string; /** Default title (headline) of the news item. */ @@ -857,7 +896,7 @@ declare module PlayFabAdminModels { PlayFabId?: string; /** The reason why this ban was applied. */ Reason?: string; - /** The family type of the suer that is included in the ban. */ + /** The family type of the user that is included in the ban. */ UserFamilyType?: string; } @@ -1100,16 +1139,6 @@ declare module PlayFabAdminModels { | "True" | "False"; - export interface ContactEmailInfo { - /** The email address */ - EmailAddress?: string; - /** The name of the email info data */ - Name?: string; - /** The verification status of the email */ - VerificationStatus?: string; - - } - export interface ContactEmailInfoModel { /** The email address */ EmailAddress?: string; @@ -1440,6 +1469,27 @@ declare module PlayFabAdminModels { } + export interface CreateIPBanRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** + * The UTC date and time when the IP ban expires. Leave this blank for a permanent ban. Must be later than the current time + * and no more than 100 years in the future. + */ + Expires?: string; + /** The IP address to be banned. */ + IPAddress: string; + /** The reason for the IP ban. Maximum 140 characters. */ + Reason?: string; + + } + + export interface CreateIPBanResult extends PlayFabModule.IPlayFabResultCommon { + /** Information on the ban that was created */ + IPBanData?: IPBanInfo; + + } + export interface CreateOpenIdConnectionRequest extends PlayFabModule.IPlayFabRequestCommon { /** The client ID given by the ID provider. */ ClientId: string; @@ -1677,12 +1727,68 @@ declare module PlayFabAdminModels { | "ZMW" | "ZWD"; + export interface CustomPropertyBooleanSegmentFilter { + /** Custom property comparison. */ + Comparison?: string; + /** Custom property name. */ + PropertyName?: string; + /** Custom property boolean value. */ + PropertyValue: boolean; + + } + + export interface CustomPropertyDateTimeSegmentFilter { + /** Custom property comparison. */ + Comparison?: string; + /** Custom property name. */ + PropertyName?: string; + /** Custom property datetime value. */ + PropertyValue: string; + + } + + export interface CustomPropertyDetails { + /** The custom property's name. */ + Name?: string; + /** The custom property's value. */ + Value?: any; + + } + + export interface CustomPropertyNumericSegmentFilter { + /** Custom property comparison. */ + Comparison?: string; + /** Custom property name. */ + PropertyName?: string; + /** Custom property numeric value. */ + PropertyValue: number; + + } + + export interface CustomPropertyStringSegmentFilter { + /** Custom property comparison. */ + Comparison?: string; + /** Custom property name. */ + PropertyName?: string; + /** Custom property string value. */ + PropertyValue?: string; + + } + export interface DeleteContentRequest extends PlayFabModule.IPlayFabRequestCommon { /** Key of the content item to be deleted */ Key: string; } + export interface DeletedPropertyDetails { + /** The name of the property which was requested to be deleted. */ + Name?: string; + /** Indicates whether or not the property was deleted. If false, no property with that name existed. */ + WasDeleted: boolean; + + } + export interface DeleteInventoryItemsV2SegmentAction { /** The collection id for where the item will be removed from the player inventory */ CollectionId?: string; @@ -1758,6 +1864,34 @@ declare module PlayFabAdminModels { } + export interface DeletePlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** + * Optional field used for concurrency control. One can ensure that the delete operation will only be performed if the + * player's properties have not been updated by any other clients since the last version. + */ + ExpectedPropertiesVersion?: number; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + /** A list of property names denoting which properties should be deleted. */ + PropertyNames: string[]; + + } + + export interface DeletePlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** The list of properties requested to be deleted. */ + DeletedProperties?: DeletedPropertyDetails[]; + /** PlayFab unique identifier of the user whose properties were deleted. */ + PlayFabId?: string; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface DeletePlayerRequest extends PlayFabModule.IPlayFabRequestCommon { /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId: string; @@ -2097,7 +2231,6 @@ declare module PlayFabAdminModels { | "UnableToConnectToDatabase" | "InternalServerError" | "InvalidReportDate" - | "ReportNotAvailable" | "DatabaseThroughputExceeded" | "InvalidGameTicket" | "ExpiredGameTicket" @@ -2473,7 +2606,6 @@ declare module PlayFabAdminModels { | "InsightsManagementGetOperationStatusInvalidParameter" | "DuplicatePurchaseTransactionId" | "EvaluationModePlayerCountExceeded" - | "GetPlayersInSegmentRateLimitExceeded" | "CloudScriptFunctionNameSizeExceeded" | "PaidInsightsFeaturesNotEnabled" | "CloudScriptAzureFunctionsQueueRequestError" @@ -2571,9 +2703,34 @@ declare module PlayFabAdminModels { | "MultipleLinkedStatisticsNotAllowed" | "DuplicateLinkedStatisticColumnNameFound" | "AggregationTypeNotAllowedForMultiColumnStatistic" - | "MaxQueryableVerionsValueNotAllowedForTier" + | "MaxQueryableVersionsValueNotAllowedForTier" | "StatisticDefinitionHasNullOrEmptyVersionConfiguration" | "StatisticColumnLengthMismatch" + | "InvalidExternalEntityId" + | "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" + | "TransactionAlreadyApplied" + | "ReportDataNotRetrievedSuccessfully" + | "ResetIntervalCannotBeModified" + | "VersionIncrementRateExceeded" + | "InvalidSteamUsername" + | "InvalidVersionResetForLinkedLeaderboard" + | "BattleNetNotEnabledForTitle" + | "ReportNotProcessed" + | "DataNotAvailable" + | "InvalidReportName" + | "ResourceNotModified" + | "StudioCreationLimitExceeded" + | "StudioDeletionInitiated" + | "ProductDisabledForTitle" + | "PreconditionFailed" + | "CannotEnableAnonymousPlayerCreation" + | "ParentCustomerAccountNotFound" + | "AccountLinkedToABannedPlayer" + | "AzureSubscriptionNotEligibleForLinking" + | "EntityIsNotAMember" + | "IPAddressNotFound" + | "PSNNextGenNotConfiguredForTitle" + | "InvalidNintendoIssuer" | "MatchmakingEntityInvalid" | "MatchmakingPlayerAttributesInvalid" | "MatchmakingQueueNotFound" @@ -2618,6 +2775,7 @@ declare module PlayFabAdminModels { | "CatalogBadRequest" | "CatalogTooManyRequests" | "InvalidCatalogItemConfiguration" + | "LegacyEconomyDisabled" | "ExportInvalidStatusUpdate" | "ExportInvalidPrefix" | "ExportBlobContainerDoesNotExist" @@ -2688,6 +2846,10 @@ declare module PlayFabAdminModels { | "ExperimentationExclusionGroupCannotDelete" | "ExperimentationExclusionGroupInvalidTrafficAllocation" | "ExperimentationExclusionGroupInvalidName" + | "ExperimentationLegacyExperimentInvalidOperation" + | "ExperimentationExperimentStopFailed" + | "ExperimentationExperimentDeleteFailed" + | "ExperimentationExperimentStartFailed" | "MaxActionDepthExceeded" | "TitleNotOnUpdatedPricingPlan" | "SegmentManagementTitleNotInFlight" @@ -2705,8 +2867,11 @@ declare module PlayFabAdminModels { | "AsyncExportNotFound" | "AsyncExportRateLimitExceeded" | "AnalyticsSegmentCountOverLimit" + | "GetSegmentPlayerCountNotInFlight" + | "GetSegmentPlayerCountRateLimitExceeded" | "SnapshotNotFound" | "InventoryApiNotImplemented" + | "InventoryCollectionDeletionDisallowed" | "LobbyDoesNotExist" | "LobbyRateLimitExceeded" | "LobbyPlayerAlreadyJoined" @@ -2752,6 +2917,13 @@ declare module PlayFabAdminModels { | "EventSinkInsufficientRoleAssignment" | "EventSinkContainerNotFound" | "EventSinkTenantIdInvalid" + | "EventSinkResourceMisconfigured" + | "EventSinkAccessDenied" + | "EventSinkWriteConflict" + | "EventSinkResourceNotFound" + | "EventSinkResourceFeatureNotSupported" + | "EventSinkBucketNameInvalid" + | "EventSinkResourceUnavailable" | "OperationCanceled" | "InvalidDisplayNameRandomSuffixLength" | "AllowNonUniquePlayerDisplayNamesDisableNotAllowed" @@ -2772,8 +2944,6 @@ declare module PlayFabAdminModels { | "PlayerCustomPropertiesPropertyDoesNotExist" | "AddonAlreadyExists" | "AddonDoesntExist" - | "CopilotDisabled" - | "CopilotInvalidRequest" | "TrueSkillUnauthorized" | "TrueSkillInvalidTitleId" | "TrueSkillInvalidScenarioId" @@ -2840,6 +3010,11 @@ declare module PlayFabAdminModels { | "TrueSkillInvalidPlayerId" | "TrueSkillInvalidSquadSize" | "TrueSkillConditionSetNotInModel" + | "TrueSkillModelStateInvalidForOperation" + | "TrueSkillScenarioContainsActiveModel" + | "TrueSkillInvalidConditionRank" + | "TrueSkillTotalScenarioLimitExceeded" + | "TrueSkillInvalidConditionsList" | "GameSaveManifestNotFound" | "GameSaveManifestVersionAlreadyExists" | "GameSaveConflictUpdatingManifest" @@ -2849,6 +3024,33 @@ declare module PlayFabAdminModels { | "GameSaveUnknownFileInManifest" | "GameSaveFileExceededReportedSize" | "GameSaveFileNotUploaded" + | "GameSaveBadRequest" + | "GameSaveOperationNotAllowed" + | "GameSaveDataStorageQuotaExceeded" + | "GameSaveNewerManifestExists" + | "GameSaveBaseVersionNotAvailable" + | "GameSaveManifestVersionQuarantined" + | "GameSaveManifestUploadProgressUpdateNotAllowed" + | "GameSaveNotFinalizedManifestNotEligibleAsKnownGood" + | "GameSaveNoUpdatesRequested" + | "GameSaveTitleDoesNotExist" + | "GameSaveOperationNotAllowedForTitle" + | "GameSaveManifestFilesLimitExceeded" + | "GameSaveManifestDescriptionUpdateNotAllowed" + | "GameSaveTitleConfigNotFound" + | "GameSaveTitleAlreadyOnboarded" + | "GameSaveServiceNotEnabledForTitle" + | "GameSaveServiceOnboardingPending" + | "GameSaveManifestNotEligibleAsConflictingVersion" + | "GameSaveServiceUnavailable" + | "GameSaveConflict" + | "GameSaveManifestNotEligibleForRollback" + | "GameSaveTitleClientAnonymousAccountCreationNotDisabled" + | "GameSaveTitleConfigNoUpdatesRequested" + | "GameSavePlayerNotEligibleForTransfer" + | "GameSaveAlreadyAutoRolledBack" + | "GameSaveManifestNotEligibleForRestore" + | "GameSaveManifestArchived" | "StateShareForbidden" | "StateShareTitleNotInFlight" | "StateShareStateNotFound" @@ -2856,7 +3058,28 @@ declare module PlayFabAdminModels { | "StateShareStateRedemptionLimitExceeded" | "StateShareStateRedemptionLimitNotUpdated" | "StateShareCreatedStatesLimitExceeded" - | "StateShareIdMissingOrMalformed"; + | "StateShareIdMissingOrMalformed" + | "PlayerCreationDisabled" + | "AccountAlreadyExists" + | "TagInvalid" + | "TagTooLong" + | "StatisticColumnAggregationMismatch" + | "StatisticResetIntervalMismatch" + | "VersionConfigurationCannotBeSpecifiedForLinkedStat" + | "VersionConfigurationIsRequired" + | "InvalidEntityTypeForAggregation" + | "MultiLevelAggregationNotAllowed" + | "AggregationTypeNotAllowedForLinkedStat" + | "OperationDeniedDueToDefinitionPolicy" + | "StatisticUpdateNotAllowedWhileLinked" + | "UnsupportedEntityType" + | "EntityTypeSpecifiedRequiresAggregationSource" + | "PlayFabErrorEventNotSupportedForEntityType" + | "MetadataLengthExceeded" + | "MaxQueryableVersionsExceeded" + | "StatisticVersionIncrementNotAllowedWhileLinked" + | "StoreMetricsRequestInvalidInput" + | "StoreMetricsErrorRetrievingMetrics"; export interface GetActionsOnPlayersInSegmentTaskInstanceResult extends PlayFabModule.IPlayFabResultCommon { /** Parameter of this task instance */ @@ -2866,6 +3089,16 @@ declare module PlayFabAdminModels { } + export interface GetAllIPBansRequest extends PlayFabModule.IPlayFabRequestCommon { + + } + + export interface GetAllIPBansResult extends PlayFabModule.IPlayFabResultCommon { + /** Information on all IP bans */ + IPBanData?: IPBanInfo[]; + + } + export interface GetAllSegmentsRequest extends PlayFabModule.IPlayFabRequestCommon { } @@ -2988,6 +3221,18 @@ declare module PlayFabAdminModels { } + export interface GetIPBanRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The IP address of the ban to retrieve information on. */ + IPAddress: string; + + } + + export interface GetIPBanResult extends PlayFabModule.IPlayFabResultCommon { + /** Information on the ban */ + IPBanData?: IPBanInfo[]; + + } + export interface GetPlayedTitleListRequest extends PlayFabModule.IPlayFabRequestCommon { /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId: string; @@ -3000,6 +3245,27 @@ declare module PlayFabAdminModels { } + export interface GetPlayerCustomPropertyRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + /** Specific property name to search for in the player's properties. */ + PropertyName: string; + + } + + export interface GetPlayerCustomPropertyResult extends PlayFabModule.IPlayFabResultCommon { + /** PlayFab unique identifier of the user whose properties are being returned. */ + PlayFabId?: string; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + /** Player specific property and its corresponding value. */ + Property?: CustomPropertyDetails; + + } + export interface GetPlayerIdFromAuthTokenRequest extends PlayFabModule.IPlayFabRequestCommon { /** The auth token of the player requesting the password reset. */ Token: string; @@ -3067,42 +3333,6 @@ declare module PlayFabAdminModels { } - export interface GetPlayersInSegmentRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Continuation token if retrieving subsequent pages of results. */ - ContinuationToken?: string; - /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ - CustomTags?: { [key: string]: string | null }; - /** - * If set to true, the profiles are loaded asynchronously and the response will include a continuation token and - * approximate profile count until the first batch of profiles is loaded. Use this parameter to help avoid network - * timeouts. - */ - GetProfilesAsync?: boolean; - /** - * Maximum is 10,000. The value 0 will prevent loading any profiles and return only the count of profiles matching this - * segment. - */ - MaxBatchSize?: number; - /** - * 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 5,400 (90 minutes). - */ - SecondsToLive?: number; - /** Unique identifier for this segment. */ - SegmentId: string; - - } - - export interface GetPlayersInSegmentResult extends PlayFabModule.IPlayFabResultCommon { - /** Continuation token to use to retrieve subsequent pages of results. If token returns null there are no more results. */ - ContinuationToken?: string; - /** Array of player profiles in this segment. */ - PlayerProfiles?: PlayerProfile[]; - /** Count of profiles matching this segment. */ - ProfilesInSegment: number; - - } - export interface GetPlayersSegmentsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -3154,12 +3384,17 @@ declare module PlayFabAdminModels { } export interface GetPolicyRequest extends PlayFabModule.IPlayFabRequestCommon { - /** The name of the policy to read. Only supported name is 'ApiPolicy'. */ + /** + * The name of the policy to read. Only 'ApiPolicy' is supported. This parameter is optional and defaults to 'ApiPolicy' if + * omitted. + */ PolicyName?: string; } export interface GetPolicyResponse extends PlayFabModule.IPlayFabResultCommon { + /** The UTC date and time when the policy was last updated. Null if the policy has never been customized. */ + LastUpdated?: string; /** The name of the policy read. */ PolicyName?: string; /** Policy version. */ @@ -3193,6 +3428,18 @@ declare module PlayFabAdminModels { } + export interface GetSegmentPlayerCountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique identifier for the requested segment. */ + SegmentId: string; + + } + + export interface GetSegmentPlayerCountResult extends PlayFabModule.IPlayFabResultCommon { + /** Count of profiles matching this segment. */ + ProfilesInSegment: number; + + } + export interface GetSegmentResult { /** Identifier of the segments AB Test, if it is attached to one. */ ABTestParent?: string; @@ -3507,6 +3754,22 @@ declare module PlayFabAdminModels { } + export interface IPBanInfo { + /** The active state of this ban. */ + Active: boolean; + /** PlayFab Developer ID of who issued the ban. Null if ban issued via Title Secret Key. */ + BannedByDeveloperId?: string; + /** The time when this IP ban was applied. */ + Created?: string; + /** The time when this ban expires. Permanent bans do not have expiration date. */ + Expires?: string; + /** The IP address on which the ban was applied. */ + IPAddress?: string; + /** The reason why this IP ban was applied. */ + Reason?: string; + + } + export interface ItemGrant { /** String detailing any additional information concerning this operation. */ Annotation?: string; @@ -3621,6 +3884,25 @@ declare module PlayFabAdminModels { } + export interface ListPlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + + } + + export interface ListPlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** PlayFab unique identifier of the user whose properties are being returned. */ + PlayFabId?: string; + /** Player specific properties and their corresponding values for this title. */ + Properties?: CustomPropertyDetails[]; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface ListVirtualCurrencyTypesRequest extends PlayFabModule.IPlayFabRequestCommon { } @@ -3674,7 +3956,9 @@ declare module PlayFabAdminModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; export interface LogStatement { /** Optional object accompanying the message as contextual information */ @@ -3743,6 +4027,12 @@ declare module PlayFabAdminModels { } + type NewsStatus = "None" + + | "Unpublished" + | "Published" + | "Archived"; + export interface OpenIdConnection { /** The client ID given by the ID provider. */ ClientId?: string; @@ -3774,15 +4064,18 @@ declare module PlayFabAdminModels { } export interface PermissionStatement { - /** The action this statement effects. The only supported action is 'Execute'. */ - Action: string; + /** The action this statement effects. May only be '*'. This parameter is optional and defaults to '*' if omitted. */ + Action?: string; /** Additional conditions to be applied for API Resources. */ ApiConditions?: ApiCondition; /** A comment about the statement. Intended solely for bookkeeping and debugging. */ Comment?: string; /** The effect this statement will have. It could be either Allow or Deny */ Effect: string; - /** The principal this statement will effect. The only supported principal is '*'. */ + /** + * The principal this statement will effect. May be '*' to match all callers, or a JSON object targeting a specific entity + * type, e.g. {"title_player_account":"*"} for players or {"master_player_account":"*"} for master player accounts. + */ Principal: string; /** * The resource this statements effects. The only supported resources look like 'pfrn:api--*' for all apis, or @@ -3816,80 +4109,6 @@ declare module PlayFabAdminModels { } - export interface PlayerLinkedAccount { - /** Linked account's email */ - Email?: string; - /** Authentication platform */ - Platform?: string; - /** Platform user identifier */ - PlatformUserId?: string; - /** Linked account's username */ - Username?: string; - - } - - export interface PlayerLocation { - /** City of the player's geographic location. */ - City?: string; - /** The two-character continent code for this location */ - ContinentCode: string; - /** The two-character ISO 3166-1 country code for the country associated with the location */ - CountryCode: string; - /** Latitude coordinate of the player's geographic location. */ - Latitude?: number; - /** Longitude coordinate of the player's geographic location. */ - Longitude?: number; - - } - - export interface PlayerProfile { - /** Array of ad campaigns player has been attributed to */ - AdCampaignAttributions?: AdCampaignAttribution[]; - /** Image URL of the player's avatar. */ - AvatarUrl?: string; - /** Banned until UTC Date. If permanent ban this is set for 20 years after the original ban date. */ - BannedUntil?: string; - /** The prediction of the player to churn within the next seven days. */ - ChurnPrediction?: string; - /** Array of contact email addresses associated with the player */ - ContactEmailAddresses?: ContactEmailInfo[]; - /** Player record created */ - Created?: string; - /** Player Display Name */ - DisplayName?: string; - /** Last login */ - LastLogin?: string; - /** Array of third party accounts linked to this player */ - LinkedAccounts?: PlayerLinkedAccount[]; - /** Dictionary of player's locations by type. */ - Locations?: { [key: string]: PlayerLocation }; - /** Player account origination */ - Origination?: string; - /** List of player variants for experimentation */ - PlayerExperimentVariants?: string[]; - /** PlayFab Player ID */ - PlayerId?: string; - /** Array of player statistics */ - PlayerStatistics?: PlayerStatistic[]; - /** Publisher this player belongs to */ - PublisherId?: string; - /** Array of configured push notification end points */ - PushNotificationRegistrations?: PushNotificationRegistration[]; - /** Dictionary of player's statistics using only the latest version's value */ - Statistics?: { [key: string]: number }; - /** List of player's tags for segmentation. */ - Tags?: string[]; - /** Title ID this profile applies to */ - TitleId?: string; - /** A sum of player's total purchases in USD across all currencies. */ - TotalValueToDateInUSD?: number; - /** Dictionary of player's total purchases by currency. */ - ValuesToDate?: { [key: string]: number }; - /** Dictionary of player's virtual currency balances */ - VirtualCurrencyBalances?: { [key: string]: number }; - - } - export interface PlayerProfileModel { /** List of advertising campaigns the player has been attributed to */ AdCampaignAttributions?: AdCampaignAttributionModel[]; @@ -3979,18 +4198,6 @@ declare module PlayFabAdminModels { } - export interface PlayerStatistic { - /** Statistic ID */ - Id?: string; - /** Statistic name */ - Name?: string; - /** Current statistic value */ - StatisticValue: number; - /** Statistic version (0 if not a versioned statistic) */ - StatisticVersion: number; - - } - export interface PlayerStatisticDefinition { /** the aggregation method to use in updating the statistic (defaults to last) */ AggregationMethod?: string; @@ -4023,6 +4230,23 @@ declare module PlayFabAdminModels { } + export interface PolicyDiffSummary { + /** Number of new statements that would be added. */ + StatementsAdded: number; + /** Number of existing statements that would be removed. Only applicable when OverwritePolicy is true. */ + StatementsRemoved: number; + /** + * Number of existing statements that would be replaced by functionally equivalent incoming statements (e.g., same + * resource/effect/principal but different comment). + */ + StatementsReplaced: number; + /** Number of existing statements that would remain unchanged. */ + StatementsUnchanged: number; + /** Total number of statements in the resulting policy. */ + TotalResultingStatements: number; + + } + export interface PushNotificationContent { /** Text of message to send. */ Message?: string; @@ -4037,14 +4261,6 @@ declare module PlayFabAdminModels { | "GoogleCloudMessaging"; - export interface PushNotificationRegistration { - /** Notification configured endpoint */ - NotificationEndpointARN?: string; - /** Push notification platform */ - Platform?: string; - - } - export interface PushNotificationRegistrationModel { /** Notification configured endpoint */ NotificationEndpointARN?: string; @@ -4272,6 +4488,18 @@ declare module PlayFabAdminModels { } + export interface RevokeIPBanRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The IP address of the ban to be revoked. */ + IPAddress: string; + + } + + export interface RevokeIPBanResult extends PlayFabModule.IPlayFabResultCommon { + /** Information on the ban that was revoked */ + IPBanData?: IPBanInfo; + + } + export interface RevokeItemError { /** Specific error that was encountered. */ Error?: string; @@ -4348,6 +4576,14 @@ declare module PlayFabAdminModels { AllPlayersFilter?: AllPlayersSegmentFilter; /** Filter property for player churn risk level. */ ChurnPredictionFilter?: ChurnPredictionSegmentFilter; + /** Filter property for boolean custom properties. */ + CustomPropertyBooleanFilter?: CustomPropertyBooleanSegmentFilter; + /** Filter property for datetime custom properties. */ + CustomPropertyDateTimeFilter?: CustomPropertyDateTimeSegmentFilter; + /** Filter property for numeric custom properties. */ + CustomPropertyNumericFilter?: CustomPropertyNumericSegmentFilter; + /** Filter property for string custom properties. */ + CustomPropertyStringFilter?: CustomPropertyStringSegmentFilter; /** Filter property for first login date. */ FirstLoginDateFilter?: FirstLoginDateSegmentFilter; /** Filter property for first login timespan. */ @@ -4930,7 +5166,7 @@ declare module PlayFabAdminModels { } export interface SetPlayerSecretRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId: string; @@ -5335,6 +5571,28 @@ declare module PlayFabAdminModels { } + export interface UpdateIPBanRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The updated active state for the IP ban. Null for no change. */ + Active?: boolean; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The updated expiration date for the IP ban. Null for no change. */ + Expires?: string; + /** The IP address of the ban to be updated. */ + IPAddress: string; + /** Whether to make this IP ban permanent. Set to true to make this IP ban permanent. This will not modify Active state. */ + Permanent?: boolean; + /** The updated reason for the IP ban. Maximum 140 characters. Null for no change. */ + Reason?: string; + + } + + export interface UpdateIPBanResult extends PlayFabModule.IPlayFabResultCommon { + /** Information on the ban that was created */ + IPBanData?: IPBanInfo; + + } + export interface UpdateOpenIdConnectionRequest extends PlayFabModule.IPlayFabRequestCommon { /** The client ID given by the ID provider. */ ClientId?: string; @@ -5353,6 +5611,32 @@ declare module PlayFabAdminModels { } + export interface UpdatePlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** + * Optional field used for concurrency control. One can ensure that the update operation will only be performed if the + * player's properties have not been updated by any other clients since last the version. + */ + ExpectedPropertiesVersion?: number; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + /** Collection of properties to be set for a player. */ + Properties: UpdateProperty[]; + + } + + export interface UpdatePlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** PlayFab unique identifier of the user whose properties were updated. */ + PlayFabId?: string; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface UpdatePlayerSharedSecretRequest extends PlayFabModule.IPlayFabRequestCommon { /** Disable or Enable this key */ Disabled: boolean; @@ -5389,8 +5673,11 @@ declare module PlayFabAdminModels { export interface UpdatePolicyRequest extends PlayFabModule.IPlayFabRequestCommon { /** Whether to overwrite or append to the existing policy. */ OverwritePolicy: boolean; - /** The name of the policy being updated. Only supported name is 'ApiPolicy' */ - PolicyName: string; + /** + * The name of the policy being updated. Only 'ApiPolicy' is supported. This parameter is optional and defaults to + * 'ApiPolicy' if omitted. + */ + PolicyName?: string; /** Version of the policy to update. Must be the latest (as returned by GetPolicy). */ PolicyVersion: number; /** The new statements to include in the policy. */ @@ -5403,6 +5690,19 @@ declare module PlayFabAdminModels { PolicyName?: string; /** The statements included in the new version of the policy. */ Statements?: PermissionStatement[]; + /** + * Optional warnings about policy statements that may not have the intended effect. For example, resource paths that don't + * match any known API endpoint. The policy update still succeeds when warnings are present. + */ + Warnings?: string[]; + + } + + export interface UpdateProperty { + /** Name of the custom property. Can contain Unicode letters and digits. They are limited in size. */ + Name: string; + /** Value of the custom property. Limited to booleans, numbers, and strings. */ + Value: any; } @@ -5543,6 +5843,8 @@ declare module PlayFabAdminModels { AndroidDeviceInfo?: UserAndroidDeviceInfo; /** Sign in with Apple account information, if an Apple account has been linked */ AppleAccountInfo?: UserAppleIdInfo; + /** Battle.net account information, if a Battle.net account has been linked */ + BattleNetAccountInfo?: UserBattleNetInfo; /** Timestamp indicating when the user account was created */ Created: string; /** Custom ID information, if a custom ID has been assigned */ @@ -5600,6 +5902,14 @@ declare module PlayFabAdminModels { } + export interface UserBattleNetInfo { + /** Battle.net identifier */ + BattleNetAccountId?: string; + /** Battle.net display name */ + BattleNetBattleTag?: string; + + } + export interface UserCustomIdInfo { /** Custom ID */ CustomId?: string; @@ -5733,7 +6043,9 @@ declare module PlayFabAdminModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; export interface UserOriginationSegmentFilter { /** User login provider. */ @@ -5748,10 +6060,17 @@ declare module PlayFabAdminModels { } export interface UserPsnInfo { + /** + * Id of the PlayStation :tm: Network issuer environment this account is keyed under. Supply this value as IssuerId when + * looking the account up. + */ + IssuerId?: number; /** PlayStation :tm: Network account ID */ PsnAccountId?: string; /** PlayStation :tm: Network online ID */ PsnOnlineId?: string; + /** PlayStation :tm: Network sandbox ID */ + PsnSandboxId?: string; } @@ -5817,6 +6136,39 @@ declare module PlayFabAdminModels { } + export interface ValidateApiPolicyRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Whether the validation should simulate overwriting or appending to the existing policy. */ + OverwritePolicy: boolean; + /** + * The name of the policy to validate. Only 'ApiPolicy' is supported. This parameter is optional and defaults to + * 'ApiPolicy' if omitted. + */ + PolicyName?: string; + /** Version of the policy to validate against. Must be the latest (as returned by GetPolicy). */ + PolicyVersion: number; + /** The statements to validate. */ + Statements: PermissionStatement[]; + + } + + export interface ValidateApiPolicyResponse extends PlayFabModule.IPlayFabResultCommon { + /** Summary of what would change compared to the current policy. */ + Diff?: PolicyDiffSummary; + /** Whether the proposed policy is valid and would be accepted by UpdatePolicy. */ + IsValid: boolean; + /** The name of the policy validated. */ + PolicyName?: string; + /** Policy version. */ + PolicyVersion: number; + /** The full set of statements that would result from applying this update. */ + ResultingStatements?: PermissionStatement[]; + /** Validation errors that would cause UpdatePolicy to reject this request. Empty if IsValid is true. */ + ValidationErrors?: string[]; + /** Non-blocking warnings about the proposed policy (e.g., near statement limit, duplicate statements). */ + Warnings?: string[]; + + } + export interface ValueToDateModel { /** ISO 4217 code of the currency used in the purchases */ Currency?: string; diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabAuthenticationApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabAuthenticationApi.d.ts index f9dcb3bf..6730e3dc 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabAuthenticationApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabAuthenticationApi.d.ts @@ -98,8 +98,6 @@ declare module PlayFabAuthenticationModels { export interface GetEntityTokenRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ - Entity?: EntityKey; } @@ -148,7 +146,9 @@ declare module PlayFabAuthenticationModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; export interface ValidateEntityTokenRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabClientApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabClientApi.d.ts index 9f4d559f..b75e42e4 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabClientApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabClientApi.d.ts @@ -111,6 +111,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/shared-group-data/createsharedgroup */ CreateSharedGroup(request: PlayFabClientModels.CreateSharedGroupRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Deletes title-specific custom properties for a player + * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/deleteplayercustomproperties + */ + DeletePlayerCustomProperties(request: PlayFabClientModels.DeletePlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Executes a CloudScript function, with the 'currentPlayerId' set to the PlayFab ID of the authenticated player. The * PlayFab ID is the entity ID of the player's master_player_account entity. @@ -233,6 +238,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayercombinedinfo */ GetPlayerCombinedInfo(request: PlayFabClientModels.GetPlayerCombinedInfoRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves a title-specific custom property value for a player. + * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/getplayercustomproperty + */ + GetPlayerCustomProperty(request: PlayFabClientModels.GetPlayerCustomPropertyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the player's profile * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayerprofile @@ -264,6 +274,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/trading/getplayertrades */ GetPlayerTrades(request: PlayFabClientModels.GetPlayerTradesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers. + * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrombattlenetaccountids + */ + GetPlayFabIDsFromBattleNetAccountIds(request: PlayFabClientModels.GetPlayFabIDsFromBattleNetAccountIdsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers. * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromfacebookids @@ -317,6 +332,13 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromnintendoswitchdeviceids */ GetPlayFabIDsFromNintendoSwitchDeviceIds(request: PlayFabClientModels.GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the unique PlayFab identifiers for the given set of OpenId subject identifiers. A OpenId identifier is the + * service name plus the service-specific ID for the player, as specified by the title when the OpenId identifier was added + * to the player account. + * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromopenidsubjectidentifiers + */ + GetPlayFabIDsFromOpenIdSubjectIdentifiers(request: PlayFabClientModels.GetPlayFabIDsFromOpenIdsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers. * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfrompsnaccountids @@ -333,6 +355,12 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamids */ GetPlayFabIDsFromSteamIDs(request: PlayFabClientModels.GetPlayFabIDsFromSteamIDsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona + * names. + * https://docs.microsoft.com/rest/api/playfab/client/account-management/getplayfabidsfromsteamnames + */ + GetPlayFabIDsFromSteamNames(request: PlayFabClientModels.GetPlayFabIDsFromSteamNamesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for * the user accounts, available as "_id" from the Twitch API methods (ex: @@ -438,6 +466,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkapple */ LinkApple(request: PlayFabClientModels.LinkAppleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Links the Battle.net account associated with the token to the user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkbattlenetaccount + */ + LinkBattleNetAccount(request: PlayFabClientModels.LinkBattleNetAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Links the custom identifier, generated by the title, to the user's PlayFab account * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkcustomid @@ -518,6 +551,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/account-management/linkxboxaccount */ LinkXboxAccount(request: PlayFabClientModels.LinkXboxAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves title-specific custom property values for a player. + * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/listplayercustomproperties + */ + ListPlayerCustomProperties(request: PlayFabClientModels.ListPlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for * API calls which require an authenticated user @@ -529,6 +567,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithapple */ LoginWithApple(request: PlayFabClientModels.LoginWithAppleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Sign in the user with a Battle.net identity token + * https://docs.microsoft.com/rest/api/playfab/client/authentication/loginwithbattlenet + */ + LoginWithBattleNet(request: PlayFabClientModels.LoginWithBattleNetRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can * subsequently be used for API calls which require an authenticated user @@ -766,6 +809,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkapple */ UnlinkApple(request: PlayFabClientModels.UnlinkAppleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks the related Battle.net account from the user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkbattlenetaccount + */ + UnlinkBattleNetAccount(request: PlayFabClientModels.UnlinkBattleNetAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Unlinks the related custom identifier from the user's PlayFab account * https://docs.microsoft.com/rest/api/playfab/client/account-management/unlinkcustomid @@ -875,6 +923,11 @@ declare module PlayFabClientModule { * https://docs.microsoft.com/rest/api/playfab/client/characters/updatecharacterstatistics */ UpdateCharacterStatistics(request: PlayFabClientModels.UpdateCharacterStatisticsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Updates the title-specific custom property values for a player + * https://docs.microsoft.com/rest/api/playfab/client/player-data-management/updateplayercustomproperties + */ + UpdatePlayerCustomProperties(request: PlayFabClientModels.UpdatePlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Updates the values of the specified title-specific statistics for the user. By default, clients are not permitted to * update statistics. Developers may override this setting in the Game Manager > Settings > API Features. @@ -1138,6 +1191,14 @@ declare module PlayFabClientModels { } + export interface BattleNetAccountPlayFabIdPair { + /** Unique Battle.net account identifier for a user. */ + BattleNetAccountId?: string; + /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Battle.net account identifier. */ + PlayFabId?: string; + + } + export interface CancelTradeRequest extends PlayFabModule.IPlayFabRequestCommon { /** Trade identifier. */ TradeId: string; @@ -1867,6 +1928,46 @@ declare module PlayFabClientModels { | "ZMW" | "ZWD"; + export interface CustomPropertyDetails { + /** The custom property's name. */ + Name?: string; + /** The custom property's value. */ + Value?: any; + + } + + export interface DeletedPropertyDetails { + /** The name of the property which was requested to be deleted. */ + Name?: string; + /** Indicates whether or not the property was deleted. If false, no property with that name existed. */ + WasDeleted: boolean; + + } + + export interface DeletePlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** + * Optional field used for concurrency control. One can ensure that the delete operation will only be performed if the + * player's properties have not been updated by any other clients since the last version. + */ + ExpectedPropertiesVersion?: number; + /** A list of property names denoting which properties should be deleted. */ + PropertyNames: string[]; + + } + + export interface DeletePlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** The list of properties requested to be deleted. */ + DeletedProperties?: DeletedPropertyDetails[]; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface DeviceInfoRequest extends PlayFabModule.IPlayFabRequestCommon { /** Information posted to the PlayStream Event. Currently arbitrary, and specific to the environment sending it. */ Info?: { [key: string]: any }; @@ -1990,20 +2091,23 @@ declare module PlayFabClientModels { } export interface FriendInfo { - /** Available Facebook information (if the user and PlayFab friend are also connected in Facebook). */ + /** Available Facebook information (if the user and connected Facebook friend both have PlayFab Accounts in the same title). */ FacebookInfo?: UserFacebookInfo; /** PlayFab unique identifier for this friend. */ FriendPlayFabId?: string; - /** Available Game Center information (if the user and PlayFab friend are also connected in Game Center). */ + /** + * Available Game Center information (if the user and connected Game Center friend both have PlayFab Accounts in the same + * title). + */ GameCenterInfo?: UserGameCenterInfo; /** The profile of the user, if requested. */ Profile?: PlayerProfileModel; /** - * Available PlayStation :tm: Network information, if the user and PlayFab friend are both connected to PlayStation :tm: - * Network. + * Available PlayStation :tm: Network information, if the user connected PlayStation :tm Network friend both have PlayFab + * Accounts in the same title. */ PSNInfo?: UserPsnInfo; - /** Available Steam information (if the user and PlayFab friend are also connected in Steam). */ + /** Available Steam information (if the user and connected Steam friend both have PlayFab Accounts in the same title). */ SteamInfo?: UserSteamInfo; /** Tags which have been associated with this friend. */ Tags?: string[]; @@ -2011,7 +2115,7 @@ declare module PlayFabClientModels { TitleDisplayName?: string; /** PlayFab unique username for this friend. */ Username?: string; - /** Available Xbox information, if the user and PlayFab friend are both connected to Xbox Live. */ + /** Available Xbox information, (if the user and connected Xbox Live friend both have PlayFab Accounts in the same title). */ XboxInfo?: UserXboxInfo; } @@ -2259,13 +2363,21 @@ declare module PlayFabClientModels { * comma-separated list of platforms. */ ExternalPlatformFriends?: string; + /** + * If true, include friends from the same namespace even if they have not logged in to the current title. Defaults to + * false. + */ + NamespaceWide?: boolean; /** * 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?: PlayerProfileViewConstraints; - /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */ + /** + * Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. When provided, all Xbox Live + * users the caller is following are included regardless of whether they follow the caller back. + */ XboxToken?: string; } @@ -2478,6 +2590,23 @@ declare module PlayFabClientModels { } + export interface GetPlayerCustomPropertyRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Specific property name to search for in the player's properties. */ + PropertyName: string; + + } + + export interface GetPlayerCustomPropertyResult extends PlayFabModule.IPlayFabResultCommon { + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + /** Player specific property and its corresponding value. */ + Property?: CustomPropertyDetails; + + } + export interface GetPlayerProfileRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -2576,10 +2705,25 @@ declare module PlayFabClientModels { } + export interface GetPlayFabIDsFromBattleNetAccountIdsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Array of unique Battle.net account identifiers for which the title needs to get PlayFab identifiers. The array cannot + * exceed 10 in length. + */ + BattleNetAccountIds: string[]; + + } + + export interface GetPlayFabIDsFromBattleNetAccountIdsResult extends PlayFabModule.IPlayFabResultCommon { + /** Mapping of Battle.net account identifiers to PlayFab identifiers. */ + Data?: BattleNetAccountPlayFabIdPair[]; + + } + export interface GetPlayFabIDsFromFacebookIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** - * Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 - * in length. + * Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 25 in + * length. */ FacebookIDs: string[]; @@ -2609,7 +2753,7 @@ declare module PlayFabClientModels { export interface GetPlayFabIDsFromGameCenterIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Game Center identifiers (the Player Identifier) for which the title needs to get PlayFab identifiers. - * The array cannot exceed 2,000 in length. + * The array cannot exceed 25 in length. */ GameCenterIDs: string[]; @@ -2639,7 +2783,7 @@ declare module PlayFabClientModels { export interface GetPlayFabIDsFromGoogleIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Google identifiers (Google+ user IDs) for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ GoogleIDs: string[]; @@ -2654,7 +2798,7 @@ declare module PlayFabClientModels { export interface GetPlayFabIDsFromGooglePlayGamesPlayerIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Google Play Games identifiers (Google+ user IDs) for which the title needs to get PlayFab identifiers. - * The array cannot exceed 2,000 in length. + * The array cannot exceed 25 in length. */ GooglePlayGamesPlayerIDs: string[]; @@ -2669,7 +2813,7 @@ declare module PlayFabClientModels { export interface GetPlayFabIDsFromKongregateIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Kongregate identifiers (Kongregate's user_id) for which the title needs to get PlayFab identifiers. The - * array cannot exceed 2,000 in length. + * array cannot exceed 25 in length. */ KongregateIDs: string[]; @@ -2682,9 +2826,14 @@ declare module PlayFabClientModels { } export interface GetPlayFabIDsFromNintendoServiceAccountIdsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Nintendo NSA issuer URL identifying the environment. When provided, only accounts registered in that environment are + * returned. If null or empty, falls back to the default environment. + */ + Issuer?: string; /** * Array of unique Nintendo Switch Account identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ NintendoAccountIds: string[]; @@ -2699,7 +2848,7 @@ declare module PlayFabClientModels { export interface GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Nintendo Switch Device identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ NintendoSwitchDeviceIds: string[]; @@ -2711,14 +2860,39 @@ declare module PlayFabClientModels { } + export interface GetPlayFabIDsFromOpenIdsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Array of unique OpenId Connect identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed + * 10 in length. + */ + OpenIdSubjectIdentifiers: OpenIdSubjectIdentifier[]; + + } + + export interface GetPlayFabIDsFromOpenIdsResult extends PlayFabModule.IPlayFabResultCommon { + /** Mapping of OpenId Connect identifiers to PlayFab identifiers. */ + Data?: OpenIdSubjectIdentifierPlayFabIdPair[]; + + } + export interface GetPlayFabIDsFromPSNAccountIDsRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */ + /** + * Id of the PlayStation :tm: Network issuer environment. If null, defaults to the production environment. This must match + * the issuer the account signed in under, otherwise the lookup returns a null PlayFabId rather than an error. + */ IssuerId?: number; /** * Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ PSNAccountIDs: string[]; + /** + * The PlayStation :tm: Network sandbox the account is keyed under. Sandbox membership is per account, not per title: + * supply this only for accounts that sign in from a sandbox, and omit it for accounts that do not, including all retail + * accounts. Supplying a sandbox id that an account is not keyed under, or omitting one that it is, returns a null + * PlayFabId rather than an error. + */ + SandboxId?: string; } @@ -2729,13 +2903,23 @@ declare module PlayFabClientModels { } export interface GetPlayFabIDsFromPSNOnlineIDsRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */ + /** + * Id of the PlayStation :tm: Network issuer environment. If null, defaults to the production environment. This must match + * the issuer the account signed in under, otherwise the lookup returns a null PlayFabId rather than an error. + */ IssuerId?: number; /** * Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ PSNOnlineIDs: string[]; + /** + * The PlayStation :tm: Network sandbox the account is keyed under. Sandbox membership is per account, not per title: + * supply this only for accounts that sign in from a sandbox, and omit it for accounts that do not, including all retail + * accounts. Supplying a sandbox id that an account is not keyed under, or omitting one that it is, returns a null + * PlayFabId rather than an error. + */ + SandboxId?: string; } @@ -2748,7 +2932,7 @@ declare module PlayFabClientModels { export interface GetPlayFabIDsFromSteamIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ SteamStringIDs?: string[]; @@ -2760,10 +2944,25 @@ declare module PlayFabClientModels { } + export interface GetPlayFabIDsFromSteamNamesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Array of unique Steam identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 25 in + * length. + */ + SteamNames: string[]; + + } + + export interface GetPlayFabIDsFromSteamNamesResult extends PlayFabModule.IPlayFabResultCommon { + /** Mapping of Steam identifiers to PlayFab identifiers. */ + Data?: SteamNamePlayFabIdPair[]; + + } + export interface GetPlayFabIDsFromTwitchIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot - * exceed 2,000 in length. + * exceed 25 in length. */ TwitchIds: string[]; @@ -2780,7 +2979,7 @@ declare module PlayFabClientModels { Sandbox?: string; /** * Array of unique Xbox Live account identifiers for which the title needs to get PlayFab identifiers. The array cannot - * exceed 2,000 in length. + * exceed 25 in length. */ XboxLiveAccountIDs: string[]; @@ -3122,6 +3321,16 @@ declare module PlayFabClientModels { } + export interface LinkBattleNetAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** If another user is already linked to a specific Battle.net account, unlink the other user and re-link. */ + ForceLink?: boolean; + /** The JSON Web Token (JWT) returned by Battle.net after login */ + IdentityToken: string; + + } + export interface LinkCustomIDRequest extends PlayFabModule.IPlayFabRequestCommon { /** Custom unique identifier for the user, generated by the title. */ CustomId: string; @@ -3150,7 +3359,9 @@ declare module PlayFabClientModels { export interface LinkFacebookAccountRequest extends PlayFabModule.IPlayFabRequestCommon { /** Unique identifier from Facebook for the user. */ - AccessToken: string; + AccessToken?: string; + /** Token used for limited login authentication. */ + AuthenticationToken?: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** If another user is already linked to the account, unlink the other user and re-link. */ @@ -3323,6 +3534,11 @@ declare module PlayFabClientModels { export interface LinkPSNAccountRequest extends PlayFabModule.IPlayFabRequestCommon { /** Authentication code provided by the PlayStation :tm: Network. */ AuthCode: string; + /** + * Optional PlayStation :tm: Network auth version. Controls which PlayStation :tm: Network auth version is used. Accepted + * values are "v2" and "v3". + */ + AuthVersion?: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** If another user is already linked to the account, unlink the other user and re-link. */ @@ -3388,6 +3604,21 @@ declare module PlayFabClientModels { } + export interface ListPlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + + } + + export interface ListPlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** Player specific properties and their corresponding values for this title. */ + Properties?: CustomPropertyDetails[]; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface ListUsersCharactersRequest extends PlayFabModule.IPlayFabRequestCommon { /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId?: string; @@ -3437,7 +3668,9 @@ declare module PlayFabClientModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; export interface LoginResult extends PlayFabModule.IPlayFabResultCommon { /** @@ -3449,7 +3682,7 @@ declare module PlayFabClientModels { InfoResultPayload?: GetPlayerCombinedInfoResultPayload; /** The time of this user's previous login. If there was no previous login, then it's DateTime.MinValue */ LastLoginTime?: string; - /** True if the account was newly created on this login. */ + /** True if the master_player_account was newly created on this login. */ NewlyCreated: boolean; /** Player's unique PlayFabId. */ PlayFabId?: string; @@ -3471,13 +3704,13 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; /** Specific Operating System version for the user's device. */ OS?: string; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3492,7 +3725,7 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** * The JSON Web token (JWT) returned by Apple after login. Represented as the identityToken field in the authorization @@ -3502,7 +3735,28 @@ declare module PlayFabClientModels { IdentityToken: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ + PlayerSecret?: string; + /** + * 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; + + } + + export interface LoginWithBattleNetRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Automatically create a PlayFab account if one is not currently linked to this ID. */ + CreateAccount?: boolean; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ + EncryptedRequest?: string; + /** The JSON Web Token (JWT) returned by Battle.net after login */ + IdentityToken: string; + /** Flags for which pieces of info to return for the user. */ + InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3519,11 +3773,11 @@ declare module PlayFabClientModels { CustomId?: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3555,13 +3809,13 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Facebook Instant Games signature for the user. */ FacebookInstantGamesSignature: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3580,11 +3834,11 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3599,13 +3853,13 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; /** Unique Game Center player id. */ PlayerId?: string; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** The URL for the public encryption key that will be used to verify the signature. */ PublicKeyUrl?: string; @@ -3631,11 +3885,11 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * OAuth 2.0 server authentication code obtained on the client by calling the getServerAuthCode() @@ -3657,11 +3911,11 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * OAuth 2.0 server authentication code obtained on the client by calling the requestServerSideAccess() @@ -3685,13 +3939,13 @@ declare module PlayFabClientModels { DeviceId?: string; /** Specific model of the user's device. */ DeviceModel?: string; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; /** Specific Operating System version for the user's device. */ OS?: string; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3708,13 +3962,13 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; /** Numeric user ID assigned by Kongregate */ KongregateId?: string; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3729,13 +3983,13 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** The JSON Web token (JWT) returned by Nintendo after login. */ IdentityToken: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3750,13 +4004,13 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; /** Nintendo Switch unique identifier for the user's device. */ NintendoSwitchDeviceId?: string; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3773,7 +4027,7 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** * The JSON Web token (JWT) returned by the identity provider after login. Represented as the id_token field in the @@ -3782,7 +4036,7 @@ declare module PlayFabClientModels { IdToken: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3812,17 +4066,22 @@ declare module PlayFabClientModels { export interface LoginWithPSNRequest extends PlayFabModule.IPlayFabRequestCommon { /** Auth code provided by the PlayStation :tm: Network OAuth provider. */ AuthCode?: string; + /** + * Optional PlayStation :tm: Network auth version. Controls which PlayStation :tm: Network auth version is used. Accepted + * values are "v2" and "v3". + */ + AuthVersion?: string; /** Automatically create a PlayFab account if one is not currently linked to this ID. */ CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */ IssuerId?: number; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** Redirect URI supplied to PlayStation :tm: Network when requesting an auth code */ RedirectUri?: string; @@ -3839,11 +4098,11 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Authentication token for the user, returned as a byte array from Steam, and converted to a string (for example, the byte @@ -3870,11 +4129,11 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3889,11 +4148,11 @@ declare module PlayFabClientModels { CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a @@ -3986,6 +4245,22 @@ declare module PlayFabClientModels { } + export interface OpenIdSubjectIdentifier { + /** The issuer URL for the OpenId Connect provider, or the override URL if an override exists. */ + Issuer: string; + /** The unique subject identifier within the context of the issuer. */ + Subject: string; + + } + + export interface OpenIdSubjectIdentifierPlayFabIdPair { + /** Unique OpenId Connect identifier for a user. */ + OpenIdSubjectIdentifier?: OpenIdSubjectIdentifier; + /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the OpenId Connect identifier. */ + PlayFabId?: string; + + } + export interface OpenTradeRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Players who are allowed to accept the trade. If null, the trade may be accepted by any player. If empty, the trade may @@ -4306,13 +4581,13 @@ declare module PlayFabClientModels { DisplayName?: string; /** User email address attached to their account */ Email?: string; - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; /** Password for the PlayFab account (6-100 characters) */ Password?: string; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** * An optional parameter that specifies whether both the username and email parameters are required. If true, both @@ -4510,9 +4785,9 @@ declare module PlayFabClientModels { } export interface SetPlayerSecretRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Base64 encoded body that is encrypted with the Title's public RSA key (Enterprise Only). */ + /** Base64 encoded body that is encrypted with the Title's public RSA key. */ EncryptedRequest?: string; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; } @@ -4607,6 +4882,14 @@ declare module PlayFabClientModels { } + export interface SteamNamePlayFabIdPair { + /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */ + PlayFabId?: string; + /** Unique Steam identifier for a user, also known as Steam persona name. */ + SteamName?: string; + + } + export interface SteamPlayFabIdPair { /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */ PlayFabId?: string; @@ -4803,6 +5086,12 @@ declare module PlayFabClientModels { } + export interface UnlinkBattleNetAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + + } + export interface UnlinkCustomIDRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Custom unique identifier for the user, generated by the title. If not specified, the most recently signed in Custom ID @@ -5062,6 +5351,28 @@ declare module PlayFabClientModels { } + export interface UpdatePlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** + * Optional field used for concurrency control. One can ensure that the update operation will only be performed if the + * player's properties have not been updated by any other clients since last the version. + */ + ExpectedPropertiesVersion?: number; + /** Collection of properties to be set for a player. */ + Properties: UpdateProperty[]; + + } + + export interface UpdatePlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface UpdatePlayerStatisticsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -5074,6 +5385,14 @@ declare module PlayFabClientModels { } + export interface UpdateProperty { + /** Name of the custom property. Can contain Unicode letters and digits. They are limited in size. */ + Name: string; + /** Value of the custom property. Limited to booleans, numbers, and strings. */ + Value: any; + + } + export interface UpdateSharedGroupDataRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -5147,6 +5466,8 @@ declare module PlayFabClientModels { AndroidDeviceInfo?: UserAndroidDeviceInfo; /** Sign in with Apple account information, if an Apple account has been linked */ AppleAccountInfo?: UserAppleIdInfo; + /** Battle.net account information, if a Battle.net account has been linked */ + BattleNetAccountInfo?: UserBattleNetInfo; /** Timestamp indicating when the user account was created */ Created: string; /** Custom ID information, if a custom ID has been assigned */ @@ -5204,6 +5525,14 @@ declare module PlayFabClientModels { } + export interface UserBattleNetInfo { + /** Battle.net identifier */ + BattleNetAccountId?: string; + /** Battle.net display name */ + BattleNetBattleTag?: string; + + } + export interface UserCustomIdInfo { /** Custom ID */ CustomId?: string; @@ -5332,7 +5661,9 @@ declare module PlayFabClientModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; export interface UserPrivateAccountInfo { /** user email address */ @@ -5341,10 +5672,17 @@ declare module PlayFabClientModels { } export interface UserPsnInfo { + /** + * Id of the PlayStation :tm: Network issuer environment this account is keyed under. Supply this value as IssuerId when + * looking the account up. + */ + IssuerId?: number; /** PlayStation :tm: Network account ID */ PsnAccountId?: string; /** PlayStation :tm: Network online ID */ PsnOnlineId?: string; + /** PlayStation :tm: Network sandbox ID */ + PsnSandboxId?: string; } @@ -5471,10 +5809,12 @@ declare module PlayFabClientModels { CurrencyCode?: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; + /** Base64 encoded receipt data, passed back by the App Store as a result of a successful purchase. */ + JwsReceiptData?: string; /** Amount of the stated currency paid, in centesimal units. */ PurchasePrice: number; /** Base64 encoded receipt data, passed back by the App Store as a result of a successful purchase. */ - ReceiptData: string; + ReceiptData?: string; } diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabCloudScriptApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabCloudScriptApi.d.ts index 496d74f1..38ac8fc3 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabCloudScriptApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabCloudScriptApi.d.ts @@ -489,6 +489,8 @@ declare module PlayFabCloudScriptModels { FunctionName?: string; /** The object returned from the function, if any */ FunctionResult?: any; + /** The size in bytes of the object returned from the function, if any */ + FunctionResultSize?: number; /** Flag indicating if the FunctionResult was too large and was subsequently dropped from this event. */ FunctionResultTooLarge?: boolean; @@ -624,7 +626,9 @@ declare module PlayFabCloudScriptModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; export interface LogStatement { /** Optional object accompanying the message as contextual information */ diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabDataApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabDataApi.d.ts index ec9909ef..287d8c21 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabDataApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabDataApi.d.ts @@ -52,8 +52,11 @@ declare module PlayFabDataModels { /** Names of the files to have their pending uploads aborted. */ FileNames: string[]; /** - * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not - * be performed. + * Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the + * InitiateFileUploads API or other APIs, you can ensure that the file upload abort operation is performed only if the + * profile has not been updated since you last loaded that version. If the profile for the same entity has been updated, + * the operation will fail with an EntityProfileVersionMismatch error. The conflicting update can be caused by any + * operation that modifies the entity profile, including SetObjects, FinalizeFileUploads, and UpdateStatistics. */ ProfileVersion?: number; @@ -75,8 +78,11 @@ declare module PlayFabDataModels { /** Names of the files to be deleted. */ FileNames: string[]; /** - * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not - * be performed. + * Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the + * GetFiles API or other APIs, you can ensure that the file deletion is performed only if the profile has not been updated + * since you last loaded that version. If the profile for the same entity has been updated, the operation will fail with an + * EntityProfileVersionMismatch error. The conflicting update can be caused by any operation that modifies the entity + * profile, including SetObjects, FinalizeFileUploads, and UpdateStatistics. */ ProfileVersion?: number; @@ -105,7 +111,13 @@ declare module PlayFabDataModels { Entity: EntityKey; /** Names of the files to be finalized. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.' */ FileNames: string[]; - /** The current version of the profile, can be used for concurrency control during updates. */ + /** + * Field used for concurrency control. By specifying the previously returned ProfileVersion value from the + * InitiateFileUploads API, you can ensure that the file upload finalization is performed only if the profile has not been + * updated since you last loaded that version. If the profile for the same entity has been updated, the operation will fail + * with an EntityProfileVersionMismatch error. The conflicting update can be caused by any operation that modifies the + * entity profile, including SetObjects, FinalizeFileUploads, and UpdateStatistics. + */ ProfileVersion: number; } @@ -191,8 +203,11 @@ declare module PlayFabDataModels { /** Names of the files to be set. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.' */ FileNames: string[]; /** - * The expected version of the profile, if set and doesn't match the current version of the profile the operation will not - * be performed. + * Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the + * GetFiles API or other APIs, you can ensure that the file upload initiation is performed only if the profile has not been + * updated since you last loaded that version. If the profile for the same entity has been updated, the operation will fail + * with an EntityProfileVersionMismatch error. The conflicting update can be caused by any operation that modifies the + * entity profile, including SetObjects, FinalizeFileUploads, and UpdateStatistics. */ ProfileVersion?: number; @@ -258,9 +273,11 @@ declare module PlayFabDataModels { /** The entity to perform this action on. */ Entity: EntityKey; /** - * Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from - * GetProfile API, you can ensure that the object set will only be performed if the profile has not been updated by any - * other clients since the version you last loaded. + * Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the + * GetObjects API or other APIs, you can ensure that the object update is performed only if the profile has not been + * updated since you last loaded that version. If the profile for the same entity has been updated, the operation will fail + * with an EntityProfileVersionMismatch error. The conflicting update can be caused by any operation that modifies the + * entity profile, including SetObjects, FinalizeFileUploads, and UpdateStatistics. */ ExpectedProfileVersion?: number; /** Collection of objects to set on the profile. */ diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabEconomyApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabEconomyApi.d.ts index 903f2539..733020c5 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabEconomyApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabEconomyApi.d.ts @@ -10,7 +10,7 @@ declare module PlayFabEconomyModule { */ AddInventoryItems(request: PlayFabEconomyModels.AddInventoryItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** - * Creates a new item in the working catalog using provided metadata. + * Creates a new item in the working catalog using provided metadata. Note: SAS tokens provided are valid for 1 hour. * https://docs.microsoft.com/rest/api/playfab/economy/catalog/createdraftitem */ CreateDraftItem(request: PlayFabEconomyModels.CreateDraftItemRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -69,13 +69,15 @@ declare module PlayFabEconomyModule { /** * Retrieves an item from the working catalog. This item represents the current working state of the item. GetDraftItem * does not work off a cache of the Catalog and should be used when trying to get recent item updates. However, please note - * that item references data is cached and may take a few moments for changes to propagate. + * that item references data is cached and may take a few moments for changes to propagate. Note: SAS tokens provided are + * valid for 1 hour. * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getdraftitem */ GetDraftItem(request: PlayFabEconomyModels.GetDraftItemRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves a paginated list of the items from the draft catalog. Up to 50 IDs can be retrieved in a single request. - * GetDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. + * GetDraftItems does not work off a cache of the Catalog and should be used when trying to get recent item updates. Note: + * SAS tokens provided are valid for 1 hour. * https://docs.microsoft.com/rest/api/playfab/economy/catalog/getdraftitems */ GetDraftItems(request: PlayFabEconomyModels.GetDraftItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -156,14 +158,10 @@ declare module PlayFabEconomyModule { */ GetItems(request: PlayFabEconomyModels.GetItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** - * Gets the access tokens. - * https://docs.microsoft.com/rest/api/playfab/economy/inventory/getmicrosoftstoreaccesstokens - */ - GetMicrosoftStoreAccessTokens(request: PlayFabEconomyModels.GetMicrosoftStoreAccessTokensRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; - /** - * Get transaction history for a player. Up to 250 Events can be returned at once. You can use continuation tokens to - * paginate through results that return greater than the limit. Getting transaction history has a lower RPS limit than - * getting a Player's inventory with Player Entities having a limit of 30 requests in 300 seconds. + * Get transaction history for a player. Up to 50 Events can be returned at once (or 250 with response compression + * enabled). You can use continuation tokens to paginate through results that return greater than the limit. Getting + * transaction history has a lower RPS limit than getting a Player's inventory with Player Entities having a limit of 30 + * requests in 300 seconds. * https://docs.microsoft.com/rest/api/playfab/economy/inventory/gettransactionhistory */ GetTransactionHistory(request: PlayFabEconomyModels.GetTransactionHistoryRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -184,13 +182,18 @@ declare module PlayFabEconomyModule { * https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemappleappstoreinventoryitems */ RedeemAppleAppStoreInventoryItems(request: PlayFabEconomyModels.RedeemAppleAppStoreInventoryItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Redeem items. + * https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemappleappstorewithjwsinventoryitems + */ + RedeemAppleAppStoreWithJwsInventoryItems(request: PlayFabEconomyModels.RedeemAppleAppStoreWithJwsInventoryItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Redeem items. * https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemgoogleplayinventoryitems */ RedeemGooglePlayInventoryItems(request: PlayFabEconomyModels.RedeemGooglePlayInventoryItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** - * Redeem items. + * Redeem items from the Microsoft Store. Supported entitlement types are Developer Manager Consumable and Durable. * https://docs.microsoft.com/rest/api/playfab/economy/inventory/redeemmicrosoftstoreinventoryitems */ RedeemMicrosoftStoreInventoryItems(request: PlayFabEconomyModels.RedeemMicrosoftStoreInventoryItemsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -273,7 +276,7 @@ declare module PlayFabEconomyModule { */ UpdateCatalogConfig(request: PlayFabEconomyModels.UpdateCatalogConfigRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** - * Update the metadata for an item in the working catalog. + * Update the metadata for an item in the working catalog. Note: SAS tokens provided are valid for 1 hour. * https://docs.microsoft.com/rest/api/playfab/economy/catalog/updatedraftitem */ UpdateDraftItem(request: PlayFabEconomyModels.UpdateDraftItemRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -459,6 +462,8 @@ declare module PlayFabEconomyModels { PriceOptions?: CatalogPriceOptions; /** Rating summary for this item. */ Rating?: Rating; + /** The real price the item was purchased for per marketplace. */ + RealMoneyPriceDetails?: RealMoneyPriceDetails; /** The date of when the item will be available. If not provided then the product will appear immediately. */ StartDate?: string; /** Optional details for stores items. */ @@ -594,10 +599,6 @@ declare module PlayFabEconomyModels { } - export interface ContentFeed { - - } - type CountryCode = "AF" | "AX" @@ -1163,6 +1164,13 @@ declare module PlayFabEconomyModels { export interface GetDraftItemsRequest extends PlayFabModule.IPlayFabRequestCommon { /** List of item alternate IDs. */ AlternateIds?: CatalogAlternateId[]; + /** + * An opaque token used to retrieve the next page of items created by the caller, if any are available. Should be null on + * initial request. + */ + ContinuationToken?: string; + /** Number of items to retrieve. This value is optional. Default value is 10. */ + Count?: number; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** The entity to perform this action on. */ @@ -1288,6 +1296,8 @@ declare module PlayFabEconomyModels { CustomTags?: { [key: string]: string | null }; /** The entity to perform this action on. */ Entity?: EntityKey; + /** The token to get the status of the inventory operation. */ + OperationToken?: string; } @@ -1445,29 +1455,15 @@ declare module PlayFabEconomyModels { } - export interface GetMicrosoftStoreAccessTokensRequest extends PlayFabModule.IPlayFabRequestCommon { - /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ - CustomTags?: { [key: string]: string | null }; - - } - - export interface GetMicrosoftStoreAccessTokensResponse extends PlayFabModule.IPlayFabResultCommon { - /** - * The collections access token for calling https://onestore.microsoft.com/b2b/keys/create/collections to obtain a - * CollectionsIdKey for the user - */ - CollectionsAccessToken?: string; - /** The date the collections access token expires */ - CollectionsAccessTokenExpirationDate: string; - - } - export interface GetTransactionHistoryRequest extends PlayFabModule.IPlayFabRequestCommon { /** The id of the entity's collection to perform this action on. (Default="default") */ CollectionId?: string; /** An opaque token used to retrieve the next page of items, if any are available. Should be null on initial request. */ ContinuationToken?: string; - /** Number of items to retrieve. This value is optional. The default value is 10 */ + /** + * Number of items to retrieve. This value is optional. The default value is 10. The maximum value is 50, or 250 if + * response compression is enabled. + */ Count: number; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -1554,6 +1550,8 @@ declare module PlayFabEconomyModels { Id?: string; /** The stack id of the item. */ StackId?: string; + /** Only used for subscriptions. The date of when the item started in UTC. */ + StartDate?: string; /** The type of the item. This should correspond to the item type in the catalog. */ Type?: string; @@ -1607,10 +1605,6 @@ declare module PlayFabEconomyModels { | "Approved" | "Rejected"; - export interface PayoutDetails { - - } - export interface Permissions { /** * The list of ids of Segments that the a player can be in to purchase from the store. When a value is provided, the player @@ -1766,6 +1760,18 @@ declare module PlayFabEconomyModels { } export interface RealMoneyPriceDetails { + /** The 'AppleAppStore' price amount per CurrencyCode. 'USD' supported only. */ + AppleAppStorePrices?: { [key: string]: number }; + /** The 'GooglePlay' price amount per CurrencyCode. 'USD' supported only. */ + GooglePlayPrices?: { [key: string]: number }; + /** The 'MicrosoftStore' price amount per CurrencyCode. 'USD' supported only. */ + MicrosoftStorePrices?: { [key: string]: number }; + /** The 'NintendoEShop' price amount per CurrencyCode. 'USD' supported only. */ + NintendoEShopPrices?: { [key: string]: number }; + /** The 'PlayStationStore' price amount per CurrencyCode. 'USD' supported only. */ + PlayStationStorePrices?: { [key: string]: number }; + /** The 'Steam' price amount per CurrencyCode. 'USD' supported only. */ + SteamPrices?: { [key: string]: number }; } @@ -1791,6 +1797,28 @@ declare module PlayFabEconomyModels { } + export interface RedeemAppleAppStoreWithJwsInventoryItemsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The id of the entity's collection to perform this action on. (Default="default") */ + CollectionId?: string; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The entity to perform this action on. */ + Entity?: EntityKey; + /** The JWS representation of a transaction. */ + JWSTransactions: string[]; + + } + + export interface RedeemAppleAppStoreWithJwsInventoryItemsResponse extends PlayFabModule.IPlayFabResultCommon { + /** The list of failed redemptions from the external marketplace. */ + Failed?: RedemptionFailure[]; + /** The list of successful redemptions from the external marketplace. */ + Succeeded?: RedemptionSuccess[]; + /** The Transaction IDs associated with the inventory modifications */ + TransactionIds?: string[]; + + } + export interface RedeemGooglePlayInventoryItemsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The id of the entity's collection to perform this action on. (Default="default") */ CollectionId?: string; @@ -1816,8 +1844,6 @@ declare module PlayFabEconomyModels { export interface RedeemMicrosoftStoreInventoryItemsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The id of the entity's collection to perform this action on. (Default="default") */ CollectionId?: string; - /** The OneStore Collections Id Key used for AAD authentication. */ - CollectionsIdKey?: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** The entity to perform this action on. */ @@ -1913,18 +1939,20 @@ declare module PlayFabEconomyModels { FailureCode?: string; /** The marketplace error details explaining why the offer failed to redeem. */ FailureDetails?: string; + /** The Marketplace Alternate ID being redeemed. */ + MarketplaceAlternateId?: string; /** The transaction id in the external marketplace. */ MarketplaceTransactionId?: string; - /** The ID of the offer being redeemed. */ - OfferId?: string; } export interface RedemptionSuccess { + /** The timestamp for when the redeem expired. */ + ExpirationTimestamp?: string; + /** The Marketplace Alternate ID being redeemed. */ + MarketplaceAlternateId?: string; /** The transaction id in the external marketplace. */ MarketplaceTransactionId?: string; - /** The ID of the offer being redeemed. */ - OfferId?: string; /** The timestamp for when the redeem was completed. */ SuccessTimestamp: string; @@ -1991,8 +2019,6 @@ declare module PlayFabEconomyModels { Rating: number; /** The ID of the author of the review. */ ReviewerEntity?: EntityKey; - /** Deprecated. Use ReviewerEntity instead. This property will be removed in a future release. */ - ReviewerId?: string; /** The ID of the review. */ ReviewId?: string; /** The full text of this review. */ @@ -2038,12 +2064,6 @@ declare module PlayFabEconomyModels { } - export interface ScanResult { - /** The URL of the item which failed the scan. */ - Url?: string; - - } - export interface SearchItemsRequest extends PlayFabModule.IPlayFabRequestCommon { /** An opaque token used to retrieve the next page of items, if any are available. */ ContinuationToken?: string; @@ -2138,12 +2158,6 @@ declare module PlayFabEconomyModels { } - export interface SubscriptionDetails { - /** The length of time that the subscription will last in seconds. */ - DurationInSeconds: number; - - } - export interface SubtractInventoryItemsOperation { /** The amount to subtract from the current item amount. */ Amount?: number; @@ -2221,6 +2235,10 @@ declare module PlayFabEconomyModels { export interface Transaction { /** The API call that caused this transaction. */ ApiName?: string; + /** Additional details about the transaction. Null if it was not a clawback operation. */ + ClawbackDetails?: TransactionClawbackDetails; + /** The custom tags associated with this transactions. */ + CustomTags?: { [key: string]: string | null }; /** The type of item that the the operation occurred on. */ ItemType?: string; /** The operations that occurred. */ @@ -2240,6 +2258,12 @@ declare module PlayFabEconomyModels { } + export interface TransactionClawbackDetails { + /** The id of the clawed back operation. */ + TransactionIdClawedback?: string; + + } + export interface TransactionOperation { /** The amount of items in this transaction. */ Amount?: number; @@ -2259,6 +2283,10 @@ declare module PlayFabEconomyModels { } export interface TransactionPurchaseDetails { + /** The friendly id of the item that was purchased. */ + ItemFriendlyId?: string; + /** The id of the item that was purchased. */ + ItemId?: string; /** The friendly id of the Store the item was purchased from or null. */ StoreFriendlyId?: string; /** The id of the Store the item was purchased from or null. */ diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabEventsApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabEventsApi.d.ts index ad01e759..6bcc412f 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabEventsApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabEventsApi.d.ts @@ -9,21 +9,46 @@ declare module PlayFabEventsModule { * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/createtelemetrykey */ CreateTelemetryKey(request: PlayFabEventsModels.CreateTelemetryKeyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Deletes a Data Connection from a title. + * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/deletedataconnection + */ + DeleteDataConnection(request: PlayFabEventsModels.DeleteDataConnectionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes a telemetry key configured for the title. * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/deletetelemetrykey */ DeleteTelemetryKey(request: PlayFabEventsModels.DeleteTelemetryKeyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves a single Data Connection associated with a title. + * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/getdataconnection + */ + GetDataConnection(request: PlayFabEventsModels.GetDataConnectionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets information about a telemetry key configured for the title. * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/gettelemetrykey */ GetTelemetryKey(request: PlayFabEventsModels.GetTelemetryKeyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the list of Data Connections associated with a title. + * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/listdataconnections + */ + ListDataConnections(request: PlayFabEventsModels.ListDataConnectionsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Lists all telemetry keys configured for the title. * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/listtelemetrykeys */ ListTelemetryKeys(request: PlayFabEventsModels.ListTelemetryKeysRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Creates or updates a Data Connection on a title. + * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/setdataconnection + */ + SetDataConnection(request: PlayFabEventsModels.SetDataConnectionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Sets a Data Connection for the title to either the active or deactivated state. + * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/setdataconnectionactive + */ + SetDataConnectionActive(request: PlayFabEventsModels.SetDataConnectionActiveRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Sets a telemetry key to the active or deactivated state. * https://docs.microsoft.com/rest/api/playfab/events/playstream-events/settelemetrykeyactive @@ -61,6 +86,95 @@ declare module PlayFabEventsModels { } + export interface DataConnectionAzureBlobSettings { + /** Name of the storage account. */ + AccountName?: string; + /** Name of the container. */ + ContainerName?: string; + /** Azure Entra Tenant Id. */ + TenantId?: string; + + } + + export interface DataConnectionAzureDataExplorerSettings { + /** The URI of the ADX cluster. */ + ClusterUri?: string; + /** The database to write to. */ + Database?: string; + /** The table to write to. */ + Table?: string; + + } + + export interface DataConnectionDetails { + /** Settings of the data connection. */ + ConnectionSettings: DataConnectionSettings; + /** Whether or not the connection is currently active. */ + IsActive: boolean; + /** The name of the data connection. */ + Name: string; + /** Current status of the data connection, if any. */ + Status?: DataConnectionStatusDetails; + /** The type of data connection. */ + Type: string; + + } + + type DataConnectionErrorState = "OK" + + | "Error"; + + export interface DataConnectionFabricKQLSettings { + /** The URI of the Fabric cluster. */ + ClusterUri?: string; + /** The database to write to. */ + Database?: string; + /** The table to write to. */ + Table?: string; + + } + + export interface DataConnectionSettings { + /** Settings if the type of connection is AzureBlobStorage. */ + AzureBlobSettings?: DataConnectionAzureBlobSettings; + /** Settings if the type of connection is AzureDataExplorer. */ + AzureDataExplorerSettings?: DataConnectionAzureDataExplorerSettings; + /** Settings if the type of connection is FabricKQL. */ + AzureFabricKQLSettings?: DataConnectionFabricKQLSettings; + + } + + export interface DataConnectionStatusDetails { + /** The name of the error affecting the data connection, if any. */ + Error?: string; + /** A description of the error affecting the data connection, if any. This may be empty for some errors. */ + ErrorMessage?: string; + /** The most recent time of the error affecting the data connection, if any. */ + MostRecentErrorTime?: string; + /** Indicates if the connection is in a normal state or error state. */ + State?: string; + + } + + type DataConnectionType = "AzureBlobStorage" + + | "AzureDataExplorer" + | "FabricKQL"; + + export interface DeleteDataConnectionRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The name of the data connection to delete. */ + Name: string; + + } + + export interface DeleteDataConnectionResponse extends PlayFabModule.IPlayFabResultCommon { + /** Indicates whether or not the connection was deleted as part of the request. */ + WasDeleted: boolean; + + } + export interface DeleteTelemetryKeyRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -118,6 +232,20 @@ declare module PlayFabEventsModels { } + export interface GetDataConnectionRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The name of the data connection to retrieve. */ + Name: string; + + } + + export interface GetDataConnectionResponse extends PlayFabModule.IPlayFabResultCommon { + /** The details of the queried Data Connection. */ + DataConnection?: DataConnectionDetails; + + } + export interface GetTelemetryKeyRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -134,6 +262,18 @@ declare module PlayFabEventsModels { } + export interface ListDataConnectionsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + + } + + export interface ListDataConnectionsResponse extends PlayFabModule.IPlayFabResultCommon { + /** The list of existing Data Connections. */ + DataConnections?: DataConnectionDetails[]; + + } + export interface ListTelemetryKeysRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -148,6 +288,47 @@ declare module PlayFabEventsModels { } + export interface SetDataConnectionActiveRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Whether to set the data connection to active (true) or deactivated (false). */ + Active: boolean; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The name of the data connection to update. */ + Name: string; + + } + + export interface SetDataConnectionActiveResponse extends PlayFabModule.IPlayFabResultCommon { + /** The most current details about the data connection that was to be updated. */ + DataConnection?: DataConnectionDetails; + /** + * Indicates whether or not the data connection was updated. If false, the data connection was already in the desired + * state. + */ + WasUpdated: boolean; + + } + + export interface SetDataConnectionRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Settings of the data connection. */ + ConnectionSettings: DataConnectionSettings; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Whether or not the connection is currently active. */ + IsActive: boolean; + /** The name of the data connection to update or create. */ + Name: string; + /** The type of data connection. */ + Type: string; + + } + + export interface SetDataConnectionResponse extends PlayFabModule.IPlayFabResultCommon { + /** The details of the Data Connection to be created or updated. */ + DataConnection?: DataConnectionDetails; + + } + export interface SetTelemetryKeyActiveRequest extends PlayFabModule.IPlayFabRequestCommon { /** Whether to set the key to active (true) or deactivated (false). */ Active: boolean; diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabGroupsApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabGroupsApi.d.ts index 16f98aba..2ef182c1 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabGroupsApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabGroupsApi.d.ts @@ -600,9 +600,10 @@ declare module PlayFabGroupsModels { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** - * Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from the - * GetGroup API, you can ensure that the group data update will only be performed if the group has not been updated by any - * other clients since the version you last loaded. + * Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the + * GetGroup API, you can ensure that the group data update is performed only if the group has not been updated since you + * last loaded that version. If the same group has been updated, the requested update will not occur and the returned + * SetResult value will be None. */ ExpectedProfileVersion?: number; /** The identifier of the group */ @@ -628,9 +629,10 @@ declare module PlayFabGroupsModels { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** - * Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from the - * GetGroup API, you can ensure that the group data update will only be performed if the group has not been updated by any - * other clients since the version you last loaded. + * Optional field used for concurrency control. By specifying the previously returned ProfileVersion value from the + * GetGroup API, you can ensure that the group role update is performed only if the group has not been updated since you + * last loaded that version. If the same group has been updated, the requested update will not occur and the returned + * SetResult value will be None. */ ExpectedProfileVersion?: number; /** The identifier of the group */ diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabInsightsApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabInsightsApi.d.ts index c9389833..bdc18b6b 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabInsightsApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabInsightsApi.d.ts @@ -130,7 +130,7 @@ declare module PlayFabInsightsModels { } export interface InsightsPerformanceLevel { - /** Number of allowed active event exports. */ + /** Number of allowed active event exports. This value is always zero. */ ActiveEventExports: number; /** Maximum cache size. */ CacheSizeMB: number; diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabMatchmakerApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabMatchmakerApi.d.ts deleted file mode 100644 index 985dea57..00000000 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabMatchmakerApi.d.ts +++ /dev/null @@ -1,13 +0,0 @@ -/// - -declare module PlayFabMatchmakerModule { - export interface IPlayFabMatchmaker { - ForgetAllCredentials(): void; - - - } -} - -declare module PlayFabMatchmakerModels { - -} diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabMultiplayerApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabMultiplayerApi.d.ts index 36df0cae..17112934 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabMultiplayerApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabMultiplayerApi.d.ts @@ -521,7 +521,37 @@ declare module PlayFabMultiplayerModels { | "CentralIndia" | "UaeNorth" | "UkSouth" - | "SwedenCentral"; + | "SwedenCentral" + | "CanadaCentral" + | "MexicoCentral" + | "WestUs3" + | "CanadaEast" + | "UkWest" + | "FranceSouth" + | "SouthIndia" + | "SpainCentral" + | "GermanyWestCentral" + | "ItalyNorth" + | "IndonesiaCentral" + | "ChileCentral" + | "PolandCentral" + | "NewZealandNorth" + | "BrazilSoutheast" + | "NorwayEast" + | "SwitzerlandNorth" + | "MalaysiaWest" + | "IsraelCentral" + | "QatarCentral" + | "UaeCentral" + | "GermanyNorth" + | "AustriaEast" + | "BelgiumCentral" + | "DenmarkEast" + | "SwitzerlandWest" + | "SwedenSouth" + | "NorwayWest" + | "SouthAfricaWest" + | "MalaysiaSouth"; type AzureVmFamily = "A" @@ -533,10 +563,14 @@ declare module PlayFabMultiplayerModels { | "Dasv4" | "Dav4" | "Dadsv5" + | "Dadsv6" | "Eav4" | "Easv4" | "Ev4" | "Esv4" + | "Edsv4" + | "Edsv5" + | "Edsv6" | "Dsv3" | "Dsv2" | "NCasT4_v3" @@ -544,7 +578,16 @@ declare module PlayFabMultiplayerModels { | "Ddsv4" | "HBv3" | "Ddv5" - | "Ddsv5"; + | "Ddsv5" + | "Ddsv6" + | "Fasv6" + | "Fasv7" + | "Fadsv7" + | "Eadsv5" + | "Eadsv6" + | "Eadsv7" + | "Dadsv7" + | "Dpdsv6"; type AzureVmSize = "Standard_A1" @@ -573,6 +616,18 @@ declare module PlayFabMultiplayerModels { | "Standard_F4s_v2" | "Standard_F8s_v2" | "Standard_F16s_v2" + | "Standard_F2as_v6" + | "Standard_F4as_v6" + | "Standard_F8as_v6" + | "Standard_F16as_v6" + | "Standard_F2as_v7" + | "Standard_F4as_v7" + | "Standard_F8as_v7" + | "Standard_F16as_v7" + | "Standard_F2ads_v7" + | "Standard_F4ads_v7" + | "Standard_F8ads_v7" + | "Standard_F16ads_v7" | "Standard_D2as_v4" | "Standard_D4as_v4" | "Standard_D8as_v4" @@ -585,6 +640,14 @@ declare module PlayFabMultiplayerModels { | "Standard_D4ads_v5" | "Standard_D8ads_v5" | "Standard_D16ads_v5" + | "Standard_D2ads_v6" + | "Standard_D4ads_v6" + | "Standard_D8ads_v6" + | "Standard_D16ads_v6" + | "Standard_D2ads_v7" + | "Standard_D4ads_v7" + | "Standard_D8ads_v7" + | "Standard_D16ads_v7" | "Standard_E2a_v4" | "Standard_E4a_v4" | "Standard_E8a_v4" @@ -593,6 +656,30 @@ declare module PlayFabMultiplayerModels { | "Standard_E4as_v4" | "Standard_E8as_v4" | "Standard_E16as_v4" + | "Standard_E2ads_v5" + | "Standard_E4ads_v5" + | "Standard_E8ads_v5" + | "Standard_E16ads_v5" + | "Standard_E2ads_v6" + | "Standard_E4ads_v6" + | "Standard_E8ads_v6" + | "Standard_E16ads_v6" + | "Standard_E2ads_v7" + | "Standard_E4ads_v7" + | "Standard_E8ads_v7" + | "Standard_E16ads_v7" + | "Standard_E2ds_v4" + | "Standard_E4ds_v4" + | "Standard_E8ds_v4" + | "Standard_E16ds_v4" + | "Standard_E2ds_v5" + | "Standard_E4ds_v5" + | "Standard_E8ds_v5" + | "Standard_E16ds_v5" + | "Standard_E2ds_v6" + | "Standard_E4ds_v6" + | "Standard_E8ds_v6" + | "Standard_E16ds_v6" | "Standard_D2s_v3" | "Standard_D4s_v3" | "Standard_D8s_v3" @@ -625,7 +712,15 @@ declare module PlayFabMultiplayerModels { | "Standard_D4ds_v5" | "Standard_D8ds_v5" | "Standard_D16ds_v5" - | "Standard_D32ds_v5"; + | "Standard_D32ds_v5" + | "Standard_D2ds_v6" + | "Standard_D4ds_v6" + | "Standard_D8ds_v6" + | "Standard_D16ds_v6" + | "Standard_D2pds_v6" + | "Standard_D4pds_v6" + | "Standard_D8pds_v6" + | "Standard_D16pds_v6"; export interface BuildAliasDetailsResponse extends PlayFabModule.IPlayFabResultCommon { /** The guid string alias Id of the alias to be created or updated. */ @@ -711,7 +806,7 @@ declare module PlayFabMultiplayerModels { export interface CancelAllMatchmakingTicketsForPlayerRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** The entity key of the player whose tickets should be canceled. */ + /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ Entity?: EntityKey; /** The name of the queue from which a player's tickets should be canceled. */ QueueName: string; @@ -725,7 +820,7 @@ declare module PlayFabMultiplayerModels { export interface CancelAllServerBackfillTicketsForPlayerRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** The entity key of the player whose backfill tickets should be canceled. */ + /** The entity to perform this action on. */ Entity: EntityKey; /** The name of the queue from which a player's backfill tickets should be canceled. */ QueueName: string; @@ -871,8 +966,6 @@ declare module PlayFabMultiplayerModels { * Game Server SDK (GSDK).Constraints: Maximum number of keys: 30, Maximum key length: 50, Maximum value length: 100 */ Metadata?: { [key: string]: string | null }; - /** The configuration for the monitoring application on the build */ - MonitoringApplicationConfiguration?: MonitoringApplicationConfigurationParams; /** The number of multiplayer servers to host on a single VM. */ MultiplayerServerCountPerVm: number; /** The ports to map the build on. */ @@ -916,8 +1009,6 @@ declare module PlayFabMultiplayerModels { LinuxInstrumentationConfiguration?: LinuxInstrumentationConfiguration; /** The metadata of the build. */ Metadata?: { [key: string]: string | null }; - /** The configuration for the monitoring application for the build */ - MonitoringApplicationConfiguration?: MonitoringApplicationConfiguration; /** The number of multiplayer servers to host on a single VM of the build. */ MultiplayerServerCountPerVm: number; /** The OS platform used for running the game process. */ @@ -930,11 +1021,6 @@ declare module PlayFabMultiplayerModels { ServerResourceConstraints?: ServerResourceConstraintParams; /** The type of game server being hosted. */ ServerType?: string; - /** - * When true, assets will be downloaded and uncompressed in memory, without the compressedversion being written first to - * disc. - */ - UseStreamingForAssetDownloads?: boolean; /** The VM size the build was created on. */ VmSize?: string; /** The configuration for the VmStartupScript feature for the build */ @@ -972,8 +1058,6 @@ declare module PlayFabMultiplayerModels { * Game Server SDK (GSDK).Constraints: Maximum number of keys: 30, Maximum key length: 50, Maximum value length: 100 */ Metadata?: { [key: string]: string | null }; - /** The configuration for the monitoring application on the build */ - MonitoringApplicationConfiguration?: MonitoringApplicationConfigurationParams; /** The number of multiplayer servers to host on a single VM. */ MultiplayerServerCountPerVm: number; /** The ports to map the build on. */ @@ -1022,8 +1106,6 @@ declare module PlayFabMultiplayerModels { InstrumentationConfiguration?: InstrumentationConfiguration; /** The metadata of the build. */ Metadata?: { [key: string]: string | null }; - /** The configuration for the monitoring application for the build */ - MonitoringApplicationConfiguration?: MonitoringApplicationConfiguration; /** The number of multiplayer servers to host on a single VM of the build. */ MultiplayerServerCountPerVm: number; /** The OS platform used for running the game process. */ @@ -1038,11 +1120,6 @@ declare module PlayFabMultiplayerModels { ServerType?: string; /** The command to run when the multiplayer server has been allocated, including any arguments. */ StartMultiplayerServerCommand?: string; - /** - * When true, assets will be downloaded and uncompressed in memory, without the compressedversion being written first to - * disc. - */ - UseStreamingForAssetDownloads?: boolean; /** The VM size the build was created on. */ VmSize?: string; /** The configuration for the VmStartupScript feature for the build */ @@ -1085,8 +1162,6 @@ declare module PlayFabMultiplayerModels { * Game Server SDK (GSDK).Constraints: Maximum number of keys: 30, Maximum key length: 50, Maximum value length: 100 */ Metadata?: { [key: string]: string | null }; - /** The configuration for the monitoring application on the build */ - MonitoringApplicationConfiguration?: MonitoringApplicationConfigurationParams; /** The number of multiplayer servers to host on a single VM. */ MultiplayerServerCountPerVm: number; /** The OS platform used for running the game process. */ @@ -1143,8 +1218,6 @@ declare module PlayFabMultiplayerModels { LinuxInstrumentationConfiguration?: LinuxInstrumentationConfiguration; /** The metadata of the build. */ Metadata?: { [key: string]: string | null }; - /** The configuration for the monitoring application for the build */ - MonitoringApplicationConfiguration?: MonitoringApplicationConfiguration; /** The number of multiplayer servers to host on a single VM of the build. */ MultiplayerServerCountPerVm: number; /** The OS platform used for running the game process. */ @@ -1160,11 +1233,6 @@ declare module PlayFabMultiplayerModels { * relative to the root asset folder when unzipped. */ StartMultiplayerServerCommand?: string; - /** - * When true, assets will be downloaded and uncompressed in memory, without the compressedversion being written first to - * disc. - */ - UseStreamingForAssetDownloads?: boolean; /** The VM size the build was created on. */ VmSize?: string; /** The configuration for the VmStartupScript feature for the build */ @@ -1207,6 +1275,12 @@ declare module PlayFabMultiplayerModels { * set ownership. The useConnections property can be either true or false. */ OwnerMigrationPolicy?: string; + /** + * A setting that controls whether only the lobby owner can send invites to join the lobby. When true, only the lobby owner + * can send invites. When false or not specified, any member can send invites. Defaults to false if not specified. + * Restricted to client owned lobbies. + */ + RestrictInvitesToLobbyOwner: boolean; /** * The public key-value pairs which allow queries to differentiate between lobbies. Queries will refer to these key-value * pairs in their filter and order by clauses to retrieve lobbies fitting the specified criteria. At most 30 key-value @@ -1593,7 +1667,11 @@ declare module PlayFabMultiplayerModels { OrderBy?: string; /** Request pagination information. */ Pagination?: PaginationRequest; - /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */ + /** + * Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. Only mutual Xbox Live friends + * (where both users follow each other) are included, unlike GetFriendsList which includes all users the caller is + * following. + */ XboxToken?: string; } @@ -1780,6 +1858,8 @@ declare module PlayFabMultiplayerModels { GameAssetReferences?: AssetReference[]; /** The game certificates for the build. */ GameCertificateReferences?: GameCertificateReference[]; + /** The game secrets for the build. */ + GameSecretReferences?: GameSecretReference[]; /** The instrumentation configuration of the build. */ InstrumentationConfiguration?: InstrumentationConfiguration; /** @@ -2168,6 +2248,12 @@ declare module PlayFabMultiplayerModels { * set ownership. The useConnections property can be either true or false. */ OwnerMigrationPolicy?: string; + /** + * A setting that controls whether only the lobby owner can send invites to join the lobby. When true, only the lobby owner + * can send invites. When false or not specified, any member can send invites. Defaults to false if not specified. + * Restricted to client owned lobbies. + */ + RestrictInvitesToLobbyOwner: boolean; /** * A setting to control whether connections are used. Defaults to true. When true, notifications are sent to subscribed * players, disconnect detection removes connectionHandles, only owner migration policies using connections are allowed, @@ -2460,7 +2546,7 @@ declare module PlayFabMultiplayerModels { export interface ListMatchmakingTicketsForPlayerRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** The entity key for which to find the ticket Ids. */ + /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ Entity?: EntityKey; /** The name of the queue to find a match for. */ QueueName: string; @@ -2559,7 +2645,7 @@ declare module PlayFabMultiplayerModels { export interface ListServerBackfillTicketsForPlayerRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** The entity key for which to find the ticket Ids. */ + /** The entity to perform this action on. */ Entity: EntityKey; /** The name of the queue the tickets are in. */ QueueName: string; @@ -2637,6 +2723,11 @@ declare module PlayFabMultiplayerModels { * PubSub. */ PubSubConnectionHandle?: string; + /** + * A setting that controls lobby invites. When true only owners can invite new players, when false all members area allowed + * to invite. + */ + RestrictInvitesToLobbyOwner: boolean; /** Search data. */ SearchData?: { [key: string]: string | null }; /** Preview: Lobby joined server. This is not the server owner, rather the server that has joined a client owned lobby. */ @@ -2803,30 +2894,6 @@ declare module PlayFabMultiplayerModels { | "Locked"; - export interface MonitoringApplicationConfiguration { - /** Asset which contains the monitoring application files and scripts. */ - AssetReference: AssetReference; - /** Execution script name, this will be the main executable for the monitoring application. */ - ExecutionScriptName: string; - /** Installation script name, this will be run before the ExecutionScript. */ - InstallationScriptName?: string; - /** Timespan the monitoring application will be kept alive when running from the start of the VM */ - OnStartRuntimeInMinutes?: number; - - } - - export interface MonitoringApplicationConfigurationParams { - /** Asset which contains the monitoring application files and scripts. */ - AssetReference: AssetReferenceParams; - /** Execution script name, this will be the main executable for the monitoring application. */ - ExecutionScriptName: string; - /** Installation script name, this will be run before the ExecutionScript. */ - InstallationScriptName?: string; - /** Timespan the monitoring application will be kept alive when running from the start of the VM */ - OnStartRuntimeInMinutes?: number; - - } - export interface MultiplayerServerSummary { /** The connected players in the multiplayer server. */ ConnectedPlayers?: ConnectedPlayer[]; @@ -2903,7 +2970,7 @@ declare module PlayFabMultiplayerModels { export interface PartyNetworkConfiguration { /** Controls whether and how to support direct peer-to-peer connection attempts among devices in the network. */ DirectPeerConnectivityOptions?: string; - /** The maximum number of devices allowed to connect to the network. Must be between 1 and 32, inclusive. */ + /** The maximum number of devices allowed to connect to the network. Must be between 1 and 128, inclusive. */ MaxDevices: number; /** The maximum number of devices allowed per user. Must be greater than 0. */ MaxDevicesPerUser: number; @@ -3046,8 +3113,8 @@ declare module PlayFabMultiplayerModels { */ PreferredRegions: string[]; /** - * Data encoded as a string that is passed to the game server when requested. This can be used to to communicate - * information such as game mode or map through the request flow. + * Data encoded as a string that is passed to the game server when requested. This can be used to communicate information + * such as game mode or map through the request flow. Maximum size is 8KB */ SessionCookie?: string; /** A guid string session ID created track the multiplayer server session over its life. */ @@ -3090,6 +3157,8 @@ declare module PlayFabMultiplayerModels { NetworkConfiguration: PartyNetworkConfiguration; /** A guid string party ID created track the party session over its life. */ PartyId?: string; + /** A player entity Id on behalf of whom the request is being made. */ + PlayFabId?: string; /** * The preferred regions to request a party session from. The party service will iterate through the regions in the * specified order and allocate a party session from the first one that is available. @@ -3106,6 +3175,8 @@ declare module PlayFabMultiplayerModels { InvitationId?: string; /** The guid string party ID of the party session. */ PartyId?: string; + /** The region the party session is located in. */ + Region?: string; /** A base-64 encoded string containing the serialized network descriptor for this party. */ SerializedNetworkDescriptor?: string; @@ -3326,11 +3397,18 @@ declare module PlayFabMultiplayerModels { EntityKey: EntityKey; /** Opaque string, given to a client upon creating a connection with PubSub. */ PubSubConnectionHandle: string; - /** The name of the resource to subscribe to. */ + /** + * The name of the resource to subscribe to. For LobbyChange subscriptions this is the lobbyId. For LobbyInvite + * subscriptions this should always be "@me". + */ ResourceId: string; /** Version number for the subscription of this resource. */ SubscriptionVersion: number; - /** Subscription type. */ + /** + * Subscription type. "LobbyChange" subscriptions allow a member or owner to receive notifications of lobby data, member or + * owner changes. "LobbyInvite" subscriptions allow a player to receive invites to lobbies. A player does not need to be a + * member of a lobby to receive lobby invites. + */ Type: string; } @@ -3624,6 +3702,12 @@ declare module PlayFabMultiplayerModels { * server-owned (must be 'Server') - Any server can set ownership. The useConnections property must be true. */ Owner?: EntityKey; + /** + * A setting that controls whether only the lobby owner can send invites to join the lobby. When true, only the lobby owner + * can send invites. When false or not specified, any member can send invites. Will not modify current configuration if not + * specified. Restricted to client owned lobbies. + */ + RestrictInvitesToLobbyOwner?: boolean; /** * The public key-value pairs which allow queries to differentiate between lobbies. Optional. Sets or updates key-value * pairs on the lobby for use with queries. Only the current lobby owner can set search data. New keys will be added with diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabProfilesApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabProfilesApi.d.ts index 96e73a36..ce708bfc 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabProfilesApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabProfilesApi.d.ts @@ -29,6 +29,11 @@ declare module PlayFabProfilesModule { * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/gettitleplayersfromxboxliveids */ GetTitlePlayersFromXboxLiveIDs(request: PlayFabProfilesModels.GetTitlePlayersFromXboxLiveIDsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Update the display name of the entity + * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/setdisplayname + */ + SetDisplayName(request: PlayFabProfilesModels.SetDisplayNameRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Sets the global title access policy * https://docs.microsoft.com/rest/api/playfab/profiles/account-management/setglobalpolicy @@ -135,6 +140,8 @@ declare module PlayFabProfilesModels { Permissions?: EntityPermissionStatement[]; /** The statistics on this profile. */ Statistics?: { [key: string]: EntityStatisticValue }; + /** A mapping of statistic name to the columns defined in the corresponding definition. */ + StatisticsColumnDetails?: { [key: string]: StatisticColumnCollection }; /** * The version number of the profile in persistent storage at the time of the read. Used for optional optimistic * concurrency during update. @@ -177,6 +184,8 @@ declare module PlayFabProfilesModels { DataAsObject?: boolean; /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ Entity?: EntityKey; + /** Determines whether the entity statistics will be returned in the entity profile. Default is false. */ + IncludeStatistics: boolean; } @@ -196,6 +205,8 @@ declare module PlayFabProfilesModels { DataAsObject?: boolean; /** Entity keys of the profiles to load. Must be between 1 and 25 */ Entities: EntityKey[]; + /** Determines whether the entity statistics will be returned in the entity profile. Default is false. */ + IncludeStatistics: boolean; } @@ -264,6 +275,26 @@ declare module PlayFabProfilesModels { | "Deleted" | "None"; + export interface SetDisplayNameRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The new value to be set on Entity Profile's display name */ + DisplayName?: string; + /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ + Entity?: EntityKey; + /** The expected version of a profile to perform this update on */ + ExpectedVersion?: number; + + } + + export interface SetDisplayNameResponse extends PlayFabModule.IPlayFabResultCommon { + /** The type of operation that occured on the profile's display name */ + OperationResult?: string; + /** The updated version of the profile after the display name update */ + VersionNumber?: number; + + } + export interface SetEntityProfilePolicyRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -315,5 +346,25 @@ declare module PlayFabProfilesModels { } + type StatisticAggregationMethod = "Last" + + | "Min" + | "Max" + | "Sum"; + + export interface StatisticColumn { + /** Aggregation method for calculating new value of a statistic. */ + AggregationMethod: string; + /** Name of the statistic column, as originally configured. */ + Name: string; + + } + + export interface StatisticColumnCollection { + /** Columns for the statistic defining the aggregation method for each column. */ + Columns?: StatisticColumn[]; + + } + } diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabProgressionApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabProgressionApi.d.ts index 28e3d4c3..00230005 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabProgressionApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabProgressionApi.d.ts @@ -35,7 +35,7 @@ declare module PlayFabProgressionModule { */ DeleteStatistics(request: PlayFabProgressionModels.DeleteStatisticsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** - * Get the friend leaderboard for the specified entity. A maximum of 100 friend entries are listed in the leaderboard. + * Get the friend leaderboard for the specified entity. A maximum of 25 friend entries are listed in the leaderboard. * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/getfriendleaderboardforentity */ GetFriendLeaderboardForEntity(request: PlayFabProgressionModels.GetFriendLeaderboardForEntityRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -64,11 +64,6 @@ declare module PlayFabProgressionModule { * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatisticdefinition */ GetStatisticDefinition(request: PlayFabProgressionModels.GetStatisticDefinitionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; - /** - * Get all current statistic definitions information - * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatisticdefinitions - */ - GetStatisticDefinitions(request: PlayFabProgressionModels.GetStatisticDefinitionsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Gets statistics for the specified entity. * https://docs.microsoft.com/rest/api/playfab/progression/statistics/getstatistics @@ -99,16 +94,31 @@ declare module PlayFabProgressionModule { * https://docs.microsoft.com/rest/api/playfab/progression/statistics/liststatisticdefinitions */ ListStatisticDefinitions(request: PlayFabProgressionModels.ListStatisticDefinitionsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks an aggregation source from a statistic definition. + * https://docs.microsoft.com/rest/api/playfab/progression/statistics/unlinkaggregationsourcefromstatistic + */ + UnlinkAggregationSourceFromStatistic(request: PlayFabProgressionModels.UnlinkAggregationSourceFromStatisticRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Unlinks a leaderboard definition from it's linked statistic definition. * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/unlinkleaderboardfromstatistic */ UnlinkLeaderboardFromStatistic(request: PlayFabProgressionModels.UnlinkLeaderboardFromStatisticRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Updates a leaderboard definition. + * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/updateleaderboarddefinition + */ + UpdateLeaderboardDefinition(request: PlayFabProgressionModels.UpdateLeaderboardDefinitionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Adds or updates entries on the specified leaderboard. * https://docs.microsoft.com/rest/api/playfab/progression/leaderboards/updateleaderboardentries */ UpdateLeaderboardEntries(request: PlayFabProgressionModels.UpdateLeaderboardEntriesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Update an existing entity statistic definition. + * https://docs.microsoft.com/rest/api/playfab/progression/statistics/updatestatisticdefinition + */ + UpdateStatisticDefinition(request: PlayFabProgressionModels.UpdateStatisticDefinitionRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Update statistics on an entity profile. Depending on the statistic definition, this may result in entity being ranked on * various leaderboards. @@ -121,7 +131,10 @@ declare module PlayFabProgressionModule { declare module PlayFabProgressionModels { export interface CreateLeaderboardDefinitionRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Leaderboard columns describing the sort directions, cannot be changed after creation. */ + /** + * Leaderboard columns describing the sort directions, cannot be changed after creation. A maximum of 5 columns are + * allowed. + */ Columns: LeaderboardColumn[]; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -130,23 +143,33 @@ declare module PlayFabProgressionModels { * 'external' as the type. */ EntityType: string; + /** [In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted. */ + EventEmissionConfig?: LeaderboardEventEmissionConfig; /** A name for the leaderboard, unique per title. */ Name: string; /** Maximum number of entries on this leaderboard */ SizeLimit: number; /** The version reset configuration for the leaderboard definition. */ - VersionConfiguration: VersionConfiguration; + VersionConfiguration?: VersionConfiguration; } export interface CreateStatisticDefinitionRequest extends PlayFabModule.IPlayFabRequestCommon { - /** The columns for the statistic defining the aggregation method for each column. */ + /** + * [In Preview]: The list of statistic definition names whose scores must be aggregated towards this stat. If + * AggregationSource is specified, the entityType of this definition MUST be Title (making it a CommunityStat). Currently, + * only one aggregation source can be specified. + */ + AggregationSources?: string[]; + /** The columns for the statistic defining the aggregation method for each column. A maximum of 5 columns are allowed. */ Columns?: StatisticColumn[]; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** The entity type allowed to have score(s) for this statistic. */ EntityType?: string; - /** Name of the statistic. Must be less than 50 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */ + /** [In Preview]: Configurations for different Statistics events that can be emitted by the service. */ + EventEmissionConfig?: StatisticsEventEmissionConfig; + /** Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */ Name: string; /** The version reset configuration for the statistic definition. */ VersionConfiguration?: VersionConfiguration; @@ -224,9 +247,9 @@ declare module PlayFabProgressionModels { } export interface EntityStatistics { - /** Entity key */ + /** The entity for which the statistics are returned. */ EntityKey?: EntityKey; - /** All statistics for the given entitykey */ + /** The statistics for the given entity key. */ Statistics?: EntityStatisticValue[]; } @@ -243,6 +266,11 @@ declare module PlayFabProgressionModels { } + type EventType = "None" + + | "Telemetry" + | "PlayStream"; + type ExternalFriendSources = "None" | "Steam" @@ -256,7 +284,7 @@ declare module PlayFabProgressionModels { CustomTags?: { [key: string]: string | null }; /** Name of the leaderboard. */ LeaderboardName: string; - /** Maximum number of results to return from the leaderboard. Minimum 1, maximum 1,000. */ + /** Maximum number of results to return from the leaderboard. Minimum 1, maximum 100. */ PageSize: number; /** Index position to start from. 1 is beginning of leaderboard. */ StartingPosition?: number; @@ -266,8 +294,12 @@ declare module PlayFabProgressionModels { } export interface GetEntityLeaderboardResponse extends PlayFabModule.IPlayFabResultCommon { - /** Leaderboard columns describing the sort directions, */ + /** Leaderboard columns describing the sort directions. */ Columns?: LeaderboardColumn[]; + /** The number of entries on the leaderboard. */ + EntryCount: number; + /** The time the next scheduled reset will occur. Null if the leaderboard does not reset on a schedule. */ + NextReset?: string; /** Individual entity rankings in the leaderboard, in sorted order by rank. */ Rankings?: EntityLeaderboardEntry[]; /** Version of the leaderboard being returned. */ @@ -332,6 +364,8 @@ declare module PlayFabProgressionModels { * 'external' as the type. */ EntityType: string; + /** [In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted. */ + EventEmissionConfig?: LeaderboardEventEmissionConfig; /** Last time, in UTC, leaderboard version was incremented. */ LastResetTime?: string; /** A name for the leaderboard, unique per title. */ @@ -360,18 +394,28 @@ declare module PlayFabProgressionModels { export interface GetStatisticDefinitionRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Name of the statistic. Must be less than 50 characters. */ + /** Name of the statistic. Must be less than 150 characters. */ Name: string; } export interface GetStatisticDefinitionResponse extends PlayFabModule.IPlayFabResultCommon { + /** The list of statistic definitions names this definition aggregates to. */ + AggregationDestinations?: string[]; + /** + * The list of statistic definitions names whose values must be aggregated towards this stat. If AggregationSource is + * specified, the entityType of this definition MUST be Title (making it a CommunityStat). Currently, only one aggregation + * source can be specified. + */ + AggregationSources?: string[]; /** The columns for the statistic defining the aggregation method for each column. */ Columns?: StatisticColumn[]; /** Created time, in UTC */ Created: string; /** The entity type that can have this statistic. */ EntityType?: string; + /** [In Preview]: Configurations for different Statistics events that can be emitted by the service. */ + EventEmissionConfig?: StatisticsEventEmissionConfig; /** Last time, in UTC, statistic version was incremented. */ LastResetTime?: string; /** The list of leaderboards that are linked to this statistic definition. */ @@ -385,23 +429,13 @@ declare module PlayFabProgressionModels { } - export interface GetStatisticDefinitionsRequest extends PlayFabModule.IPlayFabRequestCommon { - /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ - CustomTags?: { [key: string]: string | null }; - - } - - export interface GetStatisticDefinitionsResponse extends PlayFabModule.IPlayFabResultCommon { - /** List of statistic definitions for the title. */ - StatisticDefinitions?: StatisticDefinition[]; - - } - export interface GetStatisticsForEntitiesRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** Collection of Entity IDs to retrieve statistics for. */ Entities: EntityKey[]; + /** The list of statistics to return for the user. If set to null, the current version of all statistics are returned. */ + StatisticNames?: string[]; } @@ -418,6 +452,8 @@ declare module PlayFabProgressionModels { CustomTags?: { [key: string]: string | null }; /** The optional entity to perform this action on. Defaults to the currently logged in entity. */ Entity?: EntityKey; + /** The list of statistics to return for the user. If set to null, the current version of all statistics are returned. */ + StatisticNames?: string[]; } @@ -482,6 +518,8 @@ declare module PlayFabProgressionModels { * 'external' as the type. */ EntityType: string; + /** [In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted. */ + EventEmissionConfig?: LeaderboardEventEmissionConfig; /** Last time, in UTC, leaderboard version was incremented. */ LastResetTime?: string; /** A name for the leaderboard, unique per title. */ @@ -495,13 +533,18 @@ declare module PlayFabProgressionModels { } + export interface LeaderboardEntityRankOnVersionEndConfig { + /** The type of event to emit when the leaderboard version end. */ + EventType: string; + /** The maximum number of entity to return on leaderboard version end. Range is 1 to 1000. */ + RankLimit: number; + + } + export interface LeaderboardEntryUpdate { /** The unique Id for the entry. If using PlayFab Entities, this would be the entityId of the entity. */ EntityId: string; - /** - * Arbitrary metadata to store along side the leaderboard entry, will be returned by all Leaderboard APIs. Must be less - * than 50 UTF8 encoded characters. - */ + /** Arbitrary metadata to store along side the leaderboard entry, will be returned by all Leaderboard APIs. */ Metadata?: string; /** * The scores for the leaderboard. The number of values provided here must match the number of columns in the Leaderboard @@ -511,10 +554,24 @@ declare module PlayFabProgressionModels { } + export interface LeaderboardEventEmissionConfig { + /** This event emits the top ranks of the leaderboard when the leaderboard version end. */ + EntityRankOnVersionEndConfig?: LeaderboardEntityRankOnVersionEndConfig; + /** This event is emitted when the leaderboard version end. */ + VersionEndConfig?: LeaderboardVersionEndConfig; + + } + type LeaderboardSortDirection = "Descending" | "Ascending"; + export interface LeaderboardVersionEndConfig { + /** The type of event to emit when the leaderboard version end. */ + EventType: string; + + } + export interface LinkedStatisticColumn { /** The name of the statistic column that this leaderboard column is sourced from. */ LinkedStatisticColumnName: string; @@ -526,24 +583,38 @@ declare module PlayFabProgressionModels { export interface ListLeaderboardDefinitionsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; + /** The page size for the request. */ + PageSize?: number; + /** The skip token for the paged request. */ + SkipToken?: string; } export interface ListLeaderboardDefinitionsResponse extends PlayFabModule.IPlayFabResultCommon { /** List of leaderboard definitions for the title. */ LeaderboardDefinitions?: LeaderboardDefinition[]; + /** The page size on the response. */ + PageSize: number; + /** The skip token for the paged response. */ + SkipToken?: string; } export interface ListStatisticDefinitionsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; + /** The page size for the request. */ + PageSize?: number; + /** The skip token for the paged request. */ + SkipToken?: string; } export interface ListStatisticDefinitionsResponse extends PlayFabModule.IPlayFabResultCommon { - /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ - CustomTags?: { [key: string]: string | null }; + /** The page size on the response. */ + PageSize: number; + /** The skip token for the paged response. */ + SkipToken?: string; /** List of statistic definitions for the title. */ StatisticDefinitions?: StatisticDefinition[]; @@ -577,12 +648,22 @@ declare module PlayFabProgressionModels { } export interface StatisticDefinition { + /** The list of statistic definitions names this definition aggregates to. */ + AggregationDestinations?: string[]; + /** + * The list of statistic definitions names whose values must be aggregated towards this stat. If AggregationSource is + * specified, the entityType of this definition MUST be Title (making it a CommunityStat). Currently, only one aggregation + * source can be specified. + */ + AggregationSources?: string[]; /** The columns for the statistic defining the aggregation method for each column. */ Columns?: StatisticColumn[]; /** Created time, in UTC */ Created: string; /** The entity type that can have this statistic. */ EntityType?: string; + /** [In Preview]: Configurations for different Statistics events that can be emitted by the service. */ + EventEmissionConfig?: StatisticsEventEmissionConfig; /** Last time, in UTC, statistic version was incremented. */ LastResetTime?: string; /** The list of leaderboards that are linked to this statistic definition. */ @@ -602,11 +683,27 @@ declare module PlayFabProgressionModels { } + export interface StatisticsEventEmissionConfig { + /** Emitted when statistics are updated. */ + UpdateEventConfig?: StatisticsUpdateEventConfig; + + } + + export interface StatisticsUpdateEventConfig { + /** The event type to emit when statistics are updated. */ + EventType: string; + + } + export interface StatisticUpdate { /** - * Arbitrary metadata to store along side the statistic, will be returned by all Leaderboard APIs. Must be less than 50 - * UTF8 encoded characters. + * A list of entities to which the statistic update must be aggregated to, in addition to the entity being updated. For + * example, for Group stats where the stat value is aggregated based on the group members, this would refer to the Group + * entity. For a community stat that's aggregated at the Title, it is not required to populate this property (Title is the + * default). */ + AggregationTargetEntityKeys?: EntityKey[]; + /** Arbitrary metadata to store along side the statistic, will be returned by all Leaderboard APIs. */ Metadata?: string; /** Name of the statistic, as originally configured. */ Name: string; @@ -622,6 +719,16 @@ declare module PlayFabProgressionModels { } + export interface UnlinkAggregationSourceFromStatisticRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The name of the statistic to unlink. */ + Name: string; + /** The name of the aggregation source statistic to unlink. */ + SourceStatisticName: string; + + } + export interface UnlinkLeaderboardFromStatisticRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -632,6 +739,20 @@ declare module PlayFabProgressionModels { } + export interface UpdateLeaderboardDefinitionRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** [In Preview]: The configuration for the events emitted by this leaderboard. If not specified, no events will be emitted. */ + EventEmissionConfig?: LeaderboardEventEmissionConfig; + /** The name of the leaderboard to update the definition for. */ + Name: string; + /** Maximum number of entries on this leaderboard */ + SizeLimit?: number; + /** The version reset configuration for the leaderboard definition. */ + VersionConfiguration?: VersionConfiguration; + + } + export interface UpdateLeaderboardEntriesRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -642,6 +763,18 @@ declare module PlayFabProgressionModels { } + export interface UpdateStatisticDefinitionRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** [In Preview]: Configurations for different Statistics events that can be emitted by the service. */ + EventEmissionConfig?: StatisticsEventEmissionConfig; + /** Name of the statistic. Must be less than 150 characters. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'. */ + Name: string; + /** The version reset configuration for the statistic definition. */ + VersionConfiguration?: VersionConfiguration; + + } + export interface UpdateStatisticsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -649,6 +782,8 @@ declare module PlayFabProgressionModels { Entity?: EntityKey; /** Collection of statistics to update, maximum 50. */ Statistics: StatisticUpdate[]; + /** Optional transactionId of this update which can be used to ensure idempotence. */ + TransactionId?: string; } diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabServerApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabServerApi.d.ts index 64b7b5fa..dbde1d7a 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabServerApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabServerApi.d.ts @@ -23,6 +23,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/account-management/addgenericid */ AddGenericID(request: PlayFabServerModels.AddGenericIDRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Adds or updates a contact email to the specified player's profile. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/addorupdatecontactemail + */ + AddOrUpdateContactEmail(request: PlayFabServerModels.AddOrUpdateContactEmailRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Adds a given tag to a player profile. The tag's namespace is automatically generated based on the source of the tag. * https://docs.microsoft.com/rest/api/playfab/server/playstream/addplayertag @@ -53,7 +58,7 @@ declare module PlayFabServerModule { */ AwardSteamAchievement(request: PlayFabServerModels.AwardSteamAchievementRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** - * Bans users by PlayFab ID with optional IP address, or MAC address for the provided game. + * Bans users by PlayFab ID with optional IP address for the provided game. * https://docs.microsoft.com/rest/api/playfab/server/account-management/banusers */ BanUsers(request: PlayFabServerModels.BanUsersRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -82,6 +87,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/account-management/deleteplayer */ DeletePlayer(request: PlayFabServerModels.DeletePlayerRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Deletes title-specific custom properties for a player + * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/deleteplayercustomproperties + */ + DeletePlayerCustomProperties(request: PlayFabServerModels.DeletePlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Deletes push notification template for title * https://docs.microsoft.com/rest/api/playfab/server/account-management/deletepushnotificationtemplate @@ -108,9 +118,17 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/server-side-cloud-script/executecloudscript */ ExecuteCloudScript(request: PlayFabServerModels.ExecuteCloudScriptServerRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Starts an export for the player profiles in a segment. This API creates a snapshot of all the player profiles which + * match the segment definition at the time of the API call. Profiles which change while an export is in progress will not + * be reflected in the results. + * https://docs.microsoft.com/rest/api/playfab/server/playstream/exportplayersinsegment + */ + ExportPlayersInSegment(request: PlayFabServerModels.ExportPlayersInSegmentRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves an array of player segment definitions. Results from this can be used in subsequent API calls such as - * GetPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not change. + * ExportPlayersInSegment which requires a Segment ID. While segment names can change the ID for that segment will not + * change. * https://docs.microsoft.com/rest/api/playfab/server/playstream/getallsegments */ GetAllSegments(request: PlayFabServerModels.GetAllSegmentsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; @@ -205,6 +223,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercombinedinfo */ GetPlayerCombinedInfo(request: PlayFabServerModels.GetPlayerCombinedInfoRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves a title-specific custom property value for a player. + * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayercustomproperty + */ + GetPlayerCustomProperty(request: PlayFabServerModels.GetPlayerCustomPropertyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the player's profile * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayerprofile @@ -215,15 +238,6 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersegments */ GetPlayerSegments(request: PlayFabServerModels.GetPlayersSegmentsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; - /** - * Allows for paging through all players in a given segment. This API creates a snapshot of all player profiles that match - * the segment definition at the time of its creation and lives through the Total Seconds to Live, refreshing its life span - * on each subsequent use of the Continuation Token. Profiles that change during the course of paging will not be reflected - * in the results. AB Test segments are currently not supported by this operation. NOTE: This API is limited to being - * called 30 times in one minute. You will be returned an error if you exceed this threshold. - * https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayersinsegment - */ - GetPlayersInSegment(request: PlayFabServerModels.GetPlayersInSegmentRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the current version and values for the indicated statistics, for the local player. * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/getplayerstatistics @@ -239,6 +253,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/playstream/getplayertags */ GetPlayerTags(request: PlayFabServerModels.GetPlayerTagsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the unique PlayFab identifiers for the given set of Battle.net account identifiers. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrombattlenetaccountids + */ + GetPlayFabIDsFromBattleNetAccountIds(request: PlayFabServerModels.GetPlayFabIDsFromBattleNetAccountIdsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the unique PlayFab identifiers for the given set of Facebook identifiers. * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromfacebookids @@ -266,6 +285,13 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromnintendoswitchdeviceids */ GetPlayFabIDsFromNintendoSwitchDeviceIds(request: PlayFabServerModels.GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the unique PlayFab identifiers for the given set of OpenId subject identifiers. A OpenId subject identifier is + * the OpenId issuer plus the OpenId subject for the player, as specified by the title when the OpenId identifier was added + * to the player account. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromopenidsubjectidentifiers + */ + GetPlayFabIDsFromOpenIdSubjectIdentifiers(request: PlayFabServerModels.GetPlayFabIDsFromOpenIdsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the unique PlayFab identifiers for the given set of PlayStation :tm: Network identifiers. * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnaccountids @@ -276,12 +302,23 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfrompsnonlineids */ GetPlayFabIDsFromPSNOnlineIDs(request: PlayFabServerModels.GetPlayFabIDsFromPSNOnlineIDsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the associated PlayFab account identifiers for the given set of server custom player identifiers. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromservercustomids + */ + GetPlayFabIDsFromServerCustomIDs(request: PlayFabServerModels.GetPlayFabIDsFromServerCustomIDsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are the profile * IDs for the user accounts, available as SteamId in the Steamworks Community API calls. * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamids */ GetPlayFabIDsFromSteamIDs(request: PlayFabServerModels.GetPlayFabIDsFromSteamIDsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the unique PlayFab identifiers for the given set of Steam identifiers. The Steam identifiers are persona + * names. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/getplayfabidsfromsteamnames + */ + GetPlayFabIDsFromSteamNames(request: PlayFabServerModels.GetPlayFabIDsFromSteamNamesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the unique PlayFab identifiers for the given set of Twitch identifiers. The Twitch identifiers are the IDs for * the user accounts, available as "_id" from the Twitch API methods (ex: @@ -306,6 +343,19 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/getrandomresulttables */ GetRandomResultTables(request: PlayFabServerModels.GetRandomResultTablesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves the result of an export started by ExportPlayersInSegment API. If the ExportPlayersInSegment is successful and + * complete, this API returns the IndexUrl from which the index file can be downloaded. The index file has a list of urls + * from which the files containing the player profile data can be downloaded. Otherwise, it returns the current 'State' of + * the export + * https://docs.microsoft.com/rest/api/playfab/server/playstream/getsegmentexport + */ + GetSegmentExport(request: PlayFabServerModels.GetPlayersInSegmentExportRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Returns the total number of players in a given segment. + * https://docs.microsoft.com/rest/api/playfab/server/playstream/getsegmentplayercount + */ + GetSegmentPlayerCount(request: PlayFabServerModels.GetSegmentPlayerCountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Retrieves the associated PlayFab account identifiers for the given set of server custom identifiers. * https://docs.microsoft.com/rest/api/playfab/server/account-management/getservercustomidsfromplayfabids @@ -415,6 +465,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/grantitemstousers */ GrantItemsToUsers(request: PlayFabServerModels.GrantItemsToUsersRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Links the Battle.net account associated with the token to the user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkbattlenetaccount + */ + LinkBattleNetAccount(request: PlayFabServerModels.LinkBattleNetAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Links the Nintendo account associated with the token to the user's PlayFab account * https://docs.microsoft.com/rest/api/playfab/server/account-management/linknintendoserviceaccount @@ -450,11 +505,49 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/account-management/linksteamid */ LinkSteamId(request: PlayFabServerModels.LinkSteamIdRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Links the Twitch account associated with the token to the user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/linktwitchaccount + */ + LinkTwitchAccount(request: PlayFabServerModels.LinkTwitchAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Links the Xbox Live account associated with the provided access code to the user's PlayFab account * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkxboxaccount */ LinkXboxAccount(request: PlayFabServerModels.LinkXboxAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Links the Xbox Live account associated with the provided Xbox ID and Sandbox to the user's PlayFab account + * https://docs.microsoft.com/rest/api/playfab/server/account-management/linkxboxid + */ + LinkXboxId(request: PlayFabServerModels.LinkXboxIdRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Retrieves title-specific custom property values for a player. + * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/listplayercustomproperties + */ + ListPlayerCustomProperties(request: PlayFabServerModels.ListPlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Signs the user in using the Android device identifier, returning a session identifier that can subsequently be used for + * API calls which require an authenticated user + * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithandroiddeviceid + */ + LoginWithAndroidDeviceID(request: PlayFabServerModels.LoginWithAndroidDeviceIDRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Sign in the user with a Battle.net identity token + * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithbattlenet + */ + LoginWithBattleNet(request: PlayFabServerModels.LoginWithBattleNetRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Signs the user in using a custom unique identifier generated by the title, returning a session identifier that can + * subsequently be used for API calls which require an authenticated user + * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithcustomid + */ + LoginWithCustomID(request: PlayFabServerModels.LoginWithCustomIDRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Signs the user in using the iOS device identifier, returning a session identifier that can subsequently be used for API + * calls which require an authenticated user + * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithiosdeviceid + */ + LoginWithIOSDeviceID(request: PlayFabServerModels.LoginWithIOSDeviceIDRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Signs the user in using a PlayStation :tm: Network authentication code, returning a session identifier that can * subsequently be used for API calls which require an authenticated user @@ -473,6 +566,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithsteamid */ LoginWithSteamId(request: PlayFabServerModels.LoginWithSteamIdRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Sign in the user with a Twitch access token + * https://docs.microsoft.com/rest/api/playfab/server/authentication/loginwithtwitch + */ + LoginWithTwitch(request: PlayFabServerModels.LoginWithTwitchRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Signs the user in using a Xbox Live Token from an external server backend, returning a session identifier that can * subsequently be used for API calls which require an authenticated user @@ -635,6 +733,31 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/player-item-management/subtractuservirtualcurrency */ SubtractUserVirtualCurrency(request: PlayFabServerModels.SubtractUserVirtualCurrencyRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks the related Apple account from the specified user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkapple + */ + UnlinkApple(request: PlayFabServerModels.UnlinkAppleRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks the related Battle.net account from the user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkbattlenetaccount + */ + UnlinkBattleNetAccount(request: PlayFabServerModels.UnlinkBattleNetAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks the related Facebook account from the user's PlayFab account + * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkfacebookaccount + */ + UnlinkFacebookAccount(request: PlayFabServerModels.UnlinkFacebookAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks the related Facebook Instant Games identifier from the user's PlayFab account + * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkfacebookinstantgamesid + */ + UnlinkFacebookInstantGamesId(request: PlayFabServerModels.UnlinkFacebookInstantGamesIdRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks the related Game Center account from the specified user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkgamecenteraccount + */ + UnlinkGameCenterAccount(request: PlayFabServerModels.UnlinkGameCenterAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Unlinks the related Nintendo account from the user's PlayFab account * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinknintendoserviceaccount @@ -660,6 +783,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinksteamid */ UnlinkSteamId(request: PlayFabServerModels.UnlinkSteamIdRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Unlinks the related Twitch account from the user's PlayFab account. + * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinktwitchaccount + */ + UnlinkTwitchAccount(request: PlayFabServerModels.UnlinkTwitchAccountRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Unlinks the related Xbox Live account from the user's PlayFab account * https://docs.microsoft.com/rest/api/playfab/server/account-management/unlinkxboxaccount @@ -712,6 +840,11 @@ declare module PlayFabServerModule { * https://docs.microsoft.com/rest/api/playfab/server/characters/updatecharacterstatistics */ UpdateCharacterStatistics(request: PlayFabServerModels.UpdateCharacterStatisticsRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; + /** + * Updates the title-specific custom property values for a player + * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayercustomproperties + */ + UpdatePlayerCustomProperties(request: PlayFabServerModels.UpdatePlayerCustomPropertiesRequest, callback: PlayFabModule.ApiCallback, customData?: any, extraHeaders?: { [key: string]: string }): Promise>; /** * Updates the values of the specified title-specific statistics for the user * https://docs.microsoft.com/rest/api/playfab/server/player-data-management/updateplayerstatistics @@ -782,16 +915,6 @@ declare module PlayFabServerModule { } declare module PlayFabServerModels { - export interface AdCampaignAttribution { - /** UTC time stamp of attribution */ - AttributedAt: string; - /** Attribution campaign identifier */ - CampaignId?: string; - /** Attribution network name */ - Platform?: string; - - } - export interface AdCampaignAttributionModel { /** UTC time stamp of attribution */ AttributedAt: string; @@ -841,6 +964,20 @@ declare module PlayFabServerModels { } + export interface AddOrUpdateContactEmailRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The new contact email to associate with the player. */ + EmailAddress: string; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + + } + + export interface AddOrUpdateContactEmailResult extends PlayFabModule.IPlayFabResultCommon { + + } + export interface AddPlayerTagRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -946,7 +1083,7 @@ declare module PlayFabServerModels { PlayFabId?: string; /** The reason why this ban was applied. */ Reason?: string; - /** The family type of the suer that is included in the ban. */ + /** The family type of the user that is included in the ban. */ UserFamilyType?: string; } @@ -979,6 +1116,14 @@ declare module PlayFabServerModels { } + export interface BattleNetAccountPlayFabIdPair { + /** Unique Battle.net account identifier for a user. */ + BattleNetAccountId?: string; + /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Battle.net account identifier. */ + PlayFabId?: string; + + } + export interface CatalogItem { /** * defines the bundle properties for the item - bundles are items which contain other items, including random drop tables @@ -1121,12 +1266,6 @@ declare module PlayFabServerModels { } - type ChurnRiskLevel = "NoData" - - | "LowRisk" - | "MediumRisk" - | "HighRisk"; - type CloudScriptRevisionOption = "Live" | "Latest" @@ -1154,16 +1293,6 @@ declare module PlayFabServerModels { } - export interface ContactEmailInfo { - /** The email address */ - EmailAddress?: string; - /** The name of the email info data */ - Name?: string; - /** The verification status of the email */ - VerificationStatus?: string; - - } - export interface ContactEmailInfoModel { /** The email address */ EmailAddress?: string; @@ -1612,6 +1741,14 @@ declare module PlayFabServerModels { | "ZMW" | "ZWD"; + export interface CustomPropertyDetails { + /** The custom property's name. */ + Name?: string; + /** The custom property's value. */ + Value?: any; + + } + export interface DeleteCharacterFromUserRequest extends PlayFabModule.IPlayFabRequestCommon { /** Unique PlayFab assigned ID for a specific character owned by a user */ CharacterId: string; @@ -1631,6 +1768,42 @@ declare module PlayFabServerModels { } + export interface DeletedPropertyDetails { + /** The name of the property which was requested to be deleted. */ + Name?: string; + /** Indicates whether or not the property was deleted. If false, no property with that name existed. */ + WasDeleted: boolean; + + } + + export interface DeletePlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** + * Optional field used for concurrency control. One can ensure that the delete operation will only be performed if the + * player's properties have not been updated by any other clients since the last version. + */ + ExpectedPropertiesVersion?: number; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + /** A list of property names denoting which properties should be deleted. */ + PropertyNames: string[]; + + } + + export interface DeletePlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** The list of properties requested to be deleted. */ + DeletedProperties?: DeletedPropertyDetails[]; + /** PlayFab unique identifier of the user whose properties were deleted. */ + PlayFabId?: string; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface DeletePlayerRequest extends PlayFabModule.IPlayFabRequestCommon { /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId: string; @@ -1768,6 +1941,20 @@ declare module PlayFabServerModels { } + export interface ExportPlayersInSegmentRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique identifier of the requested segment. */ + SegmentId: string; + + } + + export interface ExportPlayersInSegmentResult extends PlayFabModule.IPlayFabResultCommon { + /** Unique identifier of the export for the requested Segment. */ + ExportId?: string; + /** Unique identifier of the requested Segment. */ + SegmentId?: string; + + } + type ExternalFriendSources = "None" | "Steam" @@ -1793,20 +1980,23 @@ declare module PlayFabServerModels { } export interface FriendInfo { - /** Available Facebook information (if the user and PlayFab friend are also connected in Facebook). */ + /** Available Facebook information (if the user and connected Facebook friend both have PlayFab Accounts in the same title). */ FacebookInfo?: UserFacebookInfo; /** PlayFab unique identifier for this friend. */ FriendPlayFabId?: string; - /** Available Game Center information (if the user and PlayFab friend are also connected in Game Center). */ + /** + * Available Game Center information (if the user and connected Game Center friend both have PlayFab Accounts in the same + * title). + */ GameCenterInfo?: UserGameCenterInfo; /** The profile of the user, if requested. */ Profile?: PlayerProfileModel; /** - * Available PlayStation :tm: Network information, if the user and PlayFab friend are both connected to PlayStation :tm: - * Network. + * Available PlayStation :tm: Network information, if the user connected PlayStation :tm Network friend both have PlayFab + * Accounts in the same title. */ PSNInfo?: UserPsnInfo; - /** Available Steam information (if the user and PlayFab friend are also connected in Steam). */ + /** Available Steam information (if the user and connected Steam friend both have PlayFab Accounts in the same title). */ SteamInfo?: UserSteamInfo; /** Tags which have been associated with this friend. */ Tags?: string[]; @@ -1814,7 +2004,7 @@ declare module PlayFabServerModels { TitleDisplayName?: string; /** PlayFab unique username for this friend. */ Username?: string; - /** Available Xbox information, if the user and PlayFab friend are both connected to Xbox Live. */ + /** Available Xbox information, (if the user and connected Xbox Live friend both have PlayFab Accounts in the same title). */ XboxInfo?: UserXboxInfo; } @@ -1924,7 +2114,6 @@ declare module PlayFabServerModels { | "UnableToConnectToDatabase" | "InternalServerError" | "InvalidReportDate" - | "ReportNotAvailable" | "DatabaseThroughputExceeded" | "InvalidGameTicket" | "ExpiredGameTicket" @@ -2300,7 +2489,6 @@ declare module PlayFabServerModels { | "InsightsManagementGetOperationStatusInvalidParameter" | "DuplicatePurchaseTransactionId" | "EvaluationModePlayerCountExceeded" - | "GetPlayersInSegmentRateLimitExceeded" | "CloudScriptFunctionNameSizeExceeded" | "PaidInsightsFeaturesNotEnabled" | "CloudScriptAzureFunctionsQueueRequestError" @@ -2398,9 +2586,34 @@ declare module PlayFabServerModels { | "MultipleLinkedStatisticsNotAllowed" | "DuplicateLinkedStatisticColumnNameFound" | "AggregationTypeNotAllowedForMultiColumnStatistic" - | "MaxQueryableVerionsValueNotAllowedForTier" + | "MaxQueryableVersionsValueNotAllowedForTier" | "StatisticDefinitionHasNullOrEmptyVersionConfiguration" | "StatisticColumnLengthMismatch" + | "InvalidExternalEntityId" + | "UpdatingStatisticsUsingTransactionIdNotAvailableForFreeTier" + | "TransactionAlreadyApplied" + | "ReportDataNotRetrievedSuccessfully" + | "ResetIntervalCannotBeModified" + | "VersionIncrementRateExceeded" + | "InvalidSteamUsername" + | "InvalidVersionResetForLinkedLeaderboard" + | "BattleNetNotEnabledForTitle" + | "ReportNotProcessed" + | "DataNotAvailable" + | "InvalidReportName" + | "ResourceNotModified" + | "StudioCreationLimitExceeded" + | "StudioDeletionInitiated" + | "ProductDisabledForTitle" + | "PreconditionFailed" + | "CannotEnableAnonymousPlayerCreation" + | "ParentCustomerAccountNotFound" + | "AccountLinkedToABannedPlayer" + | "AzureSubscriptionNotEligibleForLinking" + | "EntityIsNotAMember" + | "IPAddressNotFound" + | "PSNNextGenNotConfiguredForTitle" + | "InvalidNintendoIssuer" | "MatchmakingEntityInvalid" | "MatchmakingPlayerAttributesInvalid" | "MatchmakingQueueNotFound" @@ -2445,6 +2658,7 @@ declare module PlayFabServerModels { | "CatalogBadRequest" | "CatalogTooManyRequests" | "InvalidCatalogItemConfiguration" + | "LegacyEconomyDisabled" | "ExportInvalidStatusUpdate" | "ExportInvalidPrefix" | "ExportBlobContainerDoesNotExist" @@ -2515,6 +2729,10 @@ declare module PlayFabServerModels { | "ExperimentationExclusionGroupCannotDelete" | "ExperimentationExclusionGroupInvalidTrafficAllocation" | "ExperimentationExclusionGroupInvalidName" + | "ExperimentationLegacyExperimentInvalidOperation" + | "ExperimentationExperimentStopFailed" + | "ExperimentationExperimentDeleteFailed" + | "ExperimentationExperimentStartFailed" | "MaxActionDepthExceeded" | "TitleNotOnUpdatedPricingPlan" | "SegmentManagementTitleNotInFlight" @@ -2532,8 +2750,11 @@ declare module PlayFabServerModels { | "AsyncExportNotFound" | "AsyncExportRateLimitExceeded" | "AnalyticsSegmentCountOverLimit" + | "GetSegmentPlayerCountNotInFlight" + | "GetSegmentPlayerCountRateLimitExceeded" | "SnapshotNotFound" | "InventoryApiNotImplemented" + | "InventoryCollectionDeletionDisallowed" | "LobbyDoesNotExist" | "LobbyRateLimitExceeded" | "LobbyPlayerAlreadyJoined" @@ -2579,6 +2800,13 @@ declare module PlayFabServerModels { | "EventSinkInsufficientRoleAssignment" | "EventSinkContainerNotFound" | "EventSinkTenantIdInvalid" + | "EventSinkResourceMisconfigured" + | "EventSinkAccessDenied" + | "EventSinkWriteConflict" + | "EventSinkResourceNotFound" + | "EventSinkResourceFeatureNotSupported" + | "EventSinkBucketNameInvalid" + | "EventSinkResourceUnavailable" | "OperationCanceled" | "InvalidDisplayNameRandomSuffixLength" | "AllowNonUniquePlayerDisplayNamesDisableNotAllowed" @@ -2599,8 +2827,6 @@ declare module PlayFabServerModels { | "PlayerCustomPropertiesPropertyDoesNotExist" | "AddonAlreadyExists" | "AddonDoesntExist" - | "CopilotDisabled" - | "CopilotInvalidRequest" | "TrueSkillUnauthorized" | "TrueSkillInvalidTitleId" | "TrueSkillInvalidScenarioId" @@ -2667,6 +2893,11 @@ declare module PlayFabServerModels { | "TrueSkillInvalidPlayerId" | "TrueSkillInvalidSquadSize" | "TrueSkillConditionSetNotInModel" + | "TrueSkillModelStateInvalidForOperation" + | "TrueSkillScenarioContainsActiveModel" + | "TrueSkillInvalidConditionRank" + | "TrueSkillTotalScenarioLimitExceeded" + | "TrueSkillInvalidConditionsList" | "GameSaveManifestNotFound" | "GameSaveManifestVersionAlreadyExists" | "GameSaveConflictUpdatingManifest" @@ -2676,6 +2907,33 @@ declare module PlayFabServerModels { | "GameSaveUnknownFileInManifest" | "GameSaveFileExceededReportedSize" | "GameSaveFileNotUploaded" + | "GameSaveBadRequest" + | "GameSaveOperationNotAllowed" + | "GameSaveDataStorageQuotaExceeded" + | "GameSaveNewerManifestExists" + | "GameSaveBaseVersionNotAvailable" + | "GameSaveManifestVersionQuarantined" + | "GameSaveManifestUploadProgressUpdateNotAllowed" + | "GameSaveNotFinalizedManifestNotEligibleAsKnownGood" + | "GameSaveNoUpdatesRequested" + | "GameSaveTitleDoesNotExist" + | "GameSaveOperationNotAllowedForTitle" + | "GameSaveManifestFilesLimitExceeded" + | "GameSaveManifestDescriptionUpdateNotAllowed" + | "GameSaveTitleConfigNotFound" + | "GameSaveTitleAlreadyOnboarded" + | "GameSaveServiceNotEnabledForTitle" + | "GameSaveServiceOnboardingPending" + | "GameSaveManifestNotEligibleAsConflictingVersion" + | "GameSaveServiceUnavailable" + | "GameSaveConflict" + | "GameSaveManifestNotEligibleForRollback" + | "GameSaveTitleClientAnonymousAccountCreationNotDisabled" + | "GameSaveTitleConfigNoUpdatesRequested" + | "GameSavePlayerNotEligibleForTransfer" + | "GameSaveAlreadyAutoRolledBack" + | "GameSaveManifestNotEligibleForRestore" + | "GameSaveManifestArchived" | "StateShareForbidden" | "StateShareTitleNotInFlight" | "StateShareStateNotFound" @@ -2683,7 +2941,28 @@ declare module PlayFabServerModels { | "StateShareStateRedemptionLimitExceeded" | "StateShareStateRedemptionLimitNotUpdated" | "StateShareCreatedStatesLimitExceeded" - | "StateShareIdMissingOrMalformed"; + | "StateShareIdMissingOrMalformed" + | "PlayerCreationDisabled" + | "AccountAlreadyExists" + | "TagInvalid" + | "TagTooLong" + | "StatisticColumnAggregationMismatch" + | "StatisticResetIntervalMismatch" + | "VersionConfigurationCannotBeSpecifiedForLinkedStat" + | "VersionConfigurationIsRequired" + | "InvalidEntityTypeForAggregation" + | "MultiLevelAggregationNotAllowed" + | "AggregationTypeNotAllowedForLinkedStat" + | "OperationDeniedDueToDefinitionPolicy" + | "StatisticUpdateNotAllowedWhileLinked" + | "UnsupportedEntityType" + | "EntityTypeSpecifiedRequiresAggregationSource" + | "PlayFabErrorEventNotSupportedForEntityType" + | "MetadataLengthExceeded" + | "MaxQueryableVersionsExceeded" + | "StatisticVersionIncrementNotAllowedWhileLinked" + | "StoreMetricsRequestInvalidInput" + | "StoreMetricsErrorRetrievingMetrics"; export interface GenericPlayFabIdPair { /** Unique generic service identifier for a user. */ @@ -2869,6 +3148,11 @@ declare module PlayFabServerModels { * comma-separated list of platforms. */ ExternalPlatformFriends?: string; + /** + * If true, include friends from the same namespace even if they have not logged in to the current title. Defaults to + * false. + */ + NamespaceWide?: boolean; /** PlayFab identifier of the player whose friend list to get. */ PlayFabId: string; /** @@ -2877,7 +3161,10 @@ declare module PlayFabServerModels { * the Game Manager "Client Profile Options" tab in the "Settings" section. */ ProfileConstraints?: PlayerProfileViewConstraints; - /** Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. */ + /** + * Xbox token if Xbox friends should be included. Requires Xbox be configured on PlayFab. When provided, all Xbox Live + * users the caller is following are included regardless of whether they follow the caller back. + */ XboxToken?: string; } @@ -3068,6 +3355,27 @@ declare module PlayFabServerModels { } + export interface GetPlayerCustomPropertyRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + /** Specific property name to search for in the player's properties. */ + PropertyName: string; + + } + + export interface GetPlayerCustomPropertyResult extends PlayFabModule.IPlayFabResultCommon { + /** PlayFab unique identifier of the user whose properties are being returned. */ + PlayFabId?: string; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + /** Player specific property and its corresponding value. */ + Property?: CustomPropertyDetails; + + } + export interface GetPlayerProfileRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -3097,39 +3405,17 @@ declare module PlayFabServerModels { } - export interface GetPlayersInSegmentRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Continuation token if retrieving subsequent pages of results. */ - ContinuationToken?: string; - /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ - CustomTags?: { [key: string]: string | null }; - /** - * If set to true, the profiles are loaded asynchronously and the response will include a continuation token and - * approximate profile count until the first batch of profiles is loaded. Use this parameter to help avoid network - * timeouts. - */ - GetProfilesAsync?: boolean; - /** - * Maximum is 10,000. The value 0 will prevent loading any profiles and return only the count of profiles matching this - * segment. - */ - MaxBatchSize?: number; - /** - * 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 5,400 (90 minutes). - */ - SecondsToLive?: number; - /** Unique identifier for this segment. */ - SegmentId: string; + export interface GetPlayersInSegmentExportRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique identifier of the export for the requested Segment. */ + ExportId: string; } - export interface GetPlayersInSegmentResult extends PlayFabModule.IPlayFabResultCommon { - /** Continuation token to use to retrieve subsequent pages of results. If token returns null there are no more results. */ - ContinuationToken?: string; - /** Array of player profiles in this segment. */ - PlayerProfiles?: PlayerProfile[]; - /** Count of profiles matching this segment. */ - ProfilesInSegment: number; + export interface GetPlayersInSegmentExportResponse extends PlayFabModule.IPlayFabResultCommon { + /** Url from which the index file can be downloaded. */ + IndexUrl?: string; + /** Shows the current status of the export */ + State?: string; } @@ -3196,10 +3482,25 @@ declare module PlayFabServerModels { } + export interface GetPlayFabIDsFromBattleNetAccountIdsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Array of unique Battle.net account identifiers for which the title needs to get PlayFab identifiers. The array cannot + * exceed 10 in length. + */ + BattleNetAccountIds: string[]; + + } + + export interface GetPlayFabIDsFromBattleNetAccountIdsResult extends PlayFabModule.IPlayFabResultCommon { + /** Mapping of Battle.net account identifiers to PlayFab identifiers. */ + Data?: BattleNetAccountPlayFabIdPair[]; + + } + export interface GetPlayFabIDsFromFacebookIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** - * Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000 - * in length. + * Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 25 in + * length. */ FacebookIDs: string[]; @@ -3242,9 +3543,14 @@ declare module PlayFabServerModels { } export interface GetPlayFabIDsFromNintendoServiceAccountIdsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Nintendo NSA issuer URL identifying the environment. When provided, only accounts registered in that environment are + * returned. If null or empty, falls back to the default environment. + */ + Issuer?: string; /** * Array of unique Nintendo Switch Account identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ NintendoAccountIds: string[]; @@ -3259,7 +3565,7 @@ declare module PlayFabServerModels { export interface GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Nintendo Switch Device identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ NintendoSwitchDeviceIds: string[]; @@ -3271,14 +3577,39 @@ declare module PlayFabServerModels { } + export interface GetPlayFabIDsFromOpenIdsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Array of unique OpenId Connect identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed + * 10 in length. + */ + OpenIdSubjectIdentifiers: OpenIdSubjectIdentifier[]; + + } + + export interface GetPlayFabIDsFromOpenIdsResult extends PlayFabModule.IPlayFabResultCommon { + /** Mapping of OpenId Connect identifiers to PlayFab identifiers. */ + Data?: OpenIdSubjectIdentifierPlayFabIdPair[]; + + } + export interface GetPlayFabIDsFromPSNAccountIDsRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */ + /** + * Id of the PlayStation :tm: Network issuer environment. If null, defaults to the production environment. This must match + * the issuer the account signed in under, otherwise the lookup returns a null PlayFabId rather than an error. + */ IssuerId?: number; /** * Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ PSNAccountIDs: string[]; + /** + * The PlayStation :tm: Network sandbox the account is keyed under. Sandbox membership is per account, not per title: + * supply this only for accounts that sign in from a sandbox, and omit it for accounts that do not, including all retail + * accounts. Supplying a sandbox id that an account is not keyed under, or omitting one that it is, returns a null + * PlayFabId rather than an error. + */ + SandboxId?: string; } @@ -3289,13 +3620,23 @@ declare module PlayFabServerModels { } export interface GetPlayFabIDsFromPSNOnlineIDsRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */ + /** + * Id of the PlayStation :tm: Network issuer environment. If null, defaults to the production environment. This must match + * the issuer the account signed in under, otherwise the lookup returns a null PlayFabId rather than an error. + */ IssuerId?: number; /** * Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ PSNOnlineIDs: string[]; + /** + * The PlayStation :tm: Network sandbox the account is keyed under. Sandbox membership is per account, not per title: + * supply this only for accounts that sign in from a sandbox, and omit it for accounts that do not, including all retail + * accounts. Supplying a sandbox id that an account is not keyed under, or omitting one that it is, returns a null + * PlayFabId rather than an error. + */ + SandboxId?: string; } @@ -3305,10 +3646,25 @@ declare module PlayFabServerModels { } + export interface GetPlayFabIDsFromServerCustomIDsRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Array of unique server custom player identifiers for which the title needs to get PlayFab identifiers. Cannot contain + * more than 25 identifiers. + */ + ServerCustomIds: string[]; + + } + + export interface GetPlayFabIDsFromServerCustomIDsResult extends PlayFabModule.IPlayFabResultCommon { + /** Mapping of server custom identifiers to PlayFab identifiers. */ + Data?: ServerCustomIDPlayFabIDPair[]; + + } + export interface GetPlayFabIDsFromSteamIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array - * cannot exceed 2,000 in length. + * cannot exceed 25 in length. */ SteamStringIDs?: string[]; @@ -3320,10 +3676,25 @@ declare module PlayFabServerModels { } + export interface GetPlayFabIDsFromSteamNamesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Array of unique Steam identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 25 in + * length. + */ + SteamNames: string[]; + + } + + export interface GetPlayFabIDsFromSteamNamesResult extends PlayFabModule.IPlayFabResultCommon { + /** Mapping of Steam identifiers to PlayFab identifiers. */ + Data?: SteamNamePlayFabIdPair[]; + + } + export interface GetPlayFabIDsFromTwitchIDsRequest extends PlayFabModule.IPlayFabRequestCommon { /** * Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot - * exceed 2,000 in length. + * exceed 25 in length. */ TwitchIds: string[]; @@ -3340,7 +3711,7 @@ declare module PlayFabServerModels { Sandbox?: string; /** * Array of unique Xbox Live account identifiers for which the title needs to get PlayFab identifiers. The array cannot - * exceed 2,000 in length. + * exceed 25 in length. */ XboxLiveAccountIDs: string[]; @@ -3381,6 +3752,18 @@ declare module PlayFabServerModels { } + export interface GetSegmentPlayerCountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique identifier for the requested segment. */ + SegmentId: string; + + } + + export interface GetSegmentPlayerCountResult extends PlayFabModule.IPlayFabResultCommon { + /** Count of profiles matching this segment. */ + ProfilesInSegment: number; + + } + export interface GetSegmentResult { /** Identifier of the segments AB Test, if it is attached to one. */ ABTestParent?: string; @@ -3749,6 +4132,18 @@ declare module PlayFabServerModels { } + export interface LinkBattleNetAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** If another user is already linked to a specific Battle.net account, unlink the other user and re-link. */ + ForceLink?: boolean; + /** The JSON Web Token (JWT) returned by Battle.net after login */ + IdentityToken: string; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + + } + export interface LinkedPlatformAccountModel { /** Linked account email of the user on the platform, if available */ Email?: string; @@ -3807,6 +4202,11 @@ declare module PlayFabServerModels { export interface LinkPSNAccountRequest extends PlayFabModule.IPlayFabRequestCommon { /** Authentication code provided by the PlayStation :tm: Network. */ AuthCode: string; + /** + * Optional PlayStation :tm: Network auth version. Controls which PlayStation :tm: Network auth version is used. Accepted + * values are "v2" and "v3". + */ + AuthVersion?: string; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** If another user is already linked to the account, unlink the other user and re-link. */ @@ -3829,12 +4229,21 @@ declare module PlayFabServerModels { CustomTags?: { [key: string]: string | null }; /** If another user is already linked to the account, unlink the other user and re-link. */ ForceLink?: boolean; - /** Id of the PlayStation :tm: Network issuer environment. If null, defaults to production environment. */ + /** + * Id of the PlayStation :tm: Network issuer environment. If null, defaults to the production environment. This must match + * the issuer the account signs in under, otherwise the link will not be resolved by that sign in. + */ IssuerId?: number; /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId: string; /** Id of the PlayStation :tm: Network user. Also known as the PSN Account Id. */ PSNUserId: string; + /** + * The PlayStation :tm: Network sandbox to key the link under. Sandbox membership is per account, not per title: supply + * this only when the account signs in from a sandbox, and omit it otherwise, including for all retail accounts. This must + * match the sandbox the account signs in from, otherwise the link will not be resolved by that sign in. + */ + SandboxId?: string; } @@ -3863,7 +4272,7 @@ declare module PlayFabServerModels { CustomTags?: { [key: string]: string | null }; /** If another user is already linked to the account, unlink the other user and re-link. */ ForceLink?: boolean; - /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */ + /** PlayFab unique identifier of the user to link. */ PlayFabId: string; /** Unique Steam identifier for a user. */ SteamId: string; @@ -3874,12 +4283,24 @@ declare module PlayFabServerModels { } + export interface LinkTwitchAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Twitch access token for authentication. */ + AccessToken: string; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** If another user is already linked to the account, unlink the other user and re-link. */ + ForceLink?: boolean; + /** PlayFab unique identifier of the user to link. */ + PlayFabId: string; + + } + export interface LinkXboxAccountRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; /** If another user is already linked to the account, unlink the other user and re-link. */ ForceLink?: boolean; - /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */ + /** PlayFab unique identifier of the user to link. */ PlayFabId: string; /** Token provided by the Xbox Live SDK/XDK method GetTokenAndSignatureAsync("POST", "https://playfabapi.com/", ""). */ XboxToken: string; @@ -3890,6 +4311,39 @@ declare module PlayFabServerModels { } + export interface LinkXboxIdRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** If another user is already linked to the account, unlink the other user and re-link. */ + ForceLink?: boolean; + /** PlayFab unique identifier of the user to link. */ + PlayFabId: string; + /** The id of Xbox Live sandbox. */ + Sandbox: string; + /** Unique Xbox identifier for a user. */ + XboxId: string; + + } + + export interface ListPlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + + } + + export interface ListPlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** PlayFab unique identifier of the user whose properties are being returned. */ + PlayFabId?: string; + /** Player specific properties and their corresponding values for this title. */ + Properties?: CustomPropertyDetails[]; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface ListUsersCharactersRequest extends PlayFabModule.IPlayFabRequestCommon { /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId: string; @@ -3947,11 +4401,74 @@ declare module PlayFabServerModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; + + export interface LoginWithAndroidDeviceIDRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Specific model of the user's device. */ + AndroidDevice?: string; + /** Android device identifier for the user's device. */ + AndroidDeviceId: string; + /** Automatically create a PlayFab account if one is not currently linked to this ID. */ + CreateAccount?: boolean; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Flags for which pieces of info to return for the user. */ + InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; + /** Specific Operating System version for the user's device. */ + OS?: string; + + } + + export interface LoginWithBattleNetRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Automatically create a PlayFab account if one is not currently linked to this ID. */ + CreateAccount?: boolean; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** The JSON Web Token (JWT) returned by Battle.net after login */ + IdentityToken: string; + /** Flags for which pieces of info to return for the user. */ + InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; + + } + + export interface LoginWithCustomIDRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Automatically create a PlayFab account if one is not currently linked to this ID. */ + CreateAccount?: boolean; + /** Custom unique identifier for the user, generated by the title. */ + CustomId: string; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Flags for which pieces of info to return for the user. */ + InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; + + } + + export interface LoginWithIOSDeviceIDRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Automatically create a PlayFab account if one is not currently linked to this ID. */ + CreateAccount?: boolean; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Vendor-specific iOS identifier for the user's device. */ + DeviceId: string; + /** Specific model of the user's device. */ + DeviceModel?: string; + /** Flags for which pieces of info to return for the user. */ + InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; + /** Specific Operating System version for the user's device. */ + OS?: string; + + } export interface LoginWithPSNRequest extends PlayFabModule.IPlayFabRequestCommon { /** Auth code provided by the PlayStation :tm: Network OAuth provider. */ AuthCode: string; + /** + * Optional PlayStation :tm: Network auth version. Controls which PlayStation :tm: Network auth version is used. Accepted + * values are "v2" and "v3". + */ + AuthVersion?: string; /** Automatically create a PlayFab account if one is not currently linked to this ID. */ CreateAccount?: boolean; /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ @@ -3972,7 +4489,7 @@ declare module PlayFabServerModels { CustomTags?: { [key: string]: string | null }; /** Flags for which pieces of info to return for the user. */ InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** The backend server identifier for this player. */ ServerCustomId: string; @@ -3991,6 +4508,22 @@ declare module PlayFabServerModels { } + export interface LoginWithTwitchRequest extends PlayFabModule.IPlayFabRequestCommon { + /** Twitch access token for authentication. */ + AccessToken: string; + /** If true, create a new PlayFab account if one does not exist. */ + CreateAccount?: boolean; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Parameters for requesting additional player info. */ + InfoRequestParameters?: GetPlayerCombinedInfoRequestParams; + /** Player secret for additional authentication. */ + PlayerSecret?: string; + /** PlayFab unique identifier of the user. */ + PlayFabId: string; + + } + export interface LoginWithXboxIdRequest extends PlayFabModule.IPlayFabRequestCommon { /** Automatically create a PlayFab account if one is not currently linked to this ID. */ CreateAccount?: boolean; @@ -4149,6 +4682,22 @@ declare module PlayFabServerModels { } + export interface OpenIdSubjectIdentifier { + /** The issuer URL for the OpenId Connect provider, or the override URL if an override exists. */ + Issuer: string; + /** The unique subject identifier within the context of the issuer. */ + Subject: string; + + } + + export interface OpenIdSubjectIdentifierPlayFabIdPair { + /** Unique OpenId Connect identifier for a user. */ + OpenIdSubjectIdentifier?: OpenIdSubjectIdentifier; + /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the OpenId Connect identifier. */ + PlayFabId?: string; + + } + export interface PlayerLeaderboardEntry { /** Title-specific display name of the user for this leaderboard entry. */ DisplayName?: string; @@ -4163,80 +4712,6 @@ declare module PlayFabServerModels { } - export interface PlayerLinkedAccount { - /** Linked account's email */ - Email?: string; - /** Authentication platform */ - Platform?: string; - /** Platform user identifier */ - PlatformUserId?: string; - /** Linked account's username */ - Username?: string; - - } - - export interface PlayerLocation { - /** City of the player's geographic location. */ - City?: string; - /** The two-character continent code for this location */ - ContinentCode: string; - /** The two-character ISO 3166-1 country code for the country associated with the location */ - CountryCode: string; - /** Latitude coordinate of the player's geographic location. */ - Latitude?: number; - /** Longitude coordinate of the player's geographic location. */ - Longitude?: number; - - } - - export interface PlayerProfile { - /** Array of ad campaigns player has been attributed to */ - AdCampaignAttributions?: AdCampaignAttribution[]; - /** Image URL of the player's avatar. */ - AvatarUrl?: string; - /** Banned until UTC Date. If permanent ban this is set for 20 years after the original ban date. */ - BannedUntil?: string; - /** The prediction of the player to churn within the next seven days. */ - ChurnPrediction?: string; - /** Array of contact email addresses associated with the player */ - ContactEmailAddresses?: ContactEmailInfo[]; - /** Player record created */ - Created?: string; - /** Player Display Name */ - DisplayName?: string; - /** Last login */ - LastLogin?: string; - /** Array of third party accounts linked to this player */ - LinkedAccounts?: PlayerLinkedAccount[]; - /** Dictionary of player's locations by type. */ - Locations?: { [key: string]: PlayerLocation }; - /** Player account origination */ - Origination?: string; - /** List of player variants for experimentation */ - PlayerExperimentVariants?: string[]; - /** PlayFab Player ID */ - PlayerId?: string; - /** Array of player statistics */ - PlayerStatistics?: PlayerStatistic[]; - /** Publisher this player belongs to */ - PublisherId?: string; - /** Array of configured push notification end points */ - PushNotificationRegistrations?: PushNotificationRegistration[]; - /** Dictionary of player's statistics using only the latest version's value */ - Statistics?: { [key: string]: number }; - /** List of player's tags for segmentation. */ - Tags?: string[]; - /** Title ID this profile applies to */ - TitleId?: string; - /** A sum of player's total purchases in USD across all currencies. */ - TotalValueToDateInUSD?: number; - /** Dictionary of player's total purchases by currency. */ - ValuesToDate?: { [key: string]: number }; - /** Dictionary of player's virtual currency balances */ - VirtualCurrencyBalances?: { [key: string]: number }; - - } - export interface PlayerProfileModel { /** List of advertising campaigns the player has been attributed to */ AdCampaignAttributions?: AdCampaignAttributionModel[]; @@ -4326,18 +4801,6 @@ declare module PlayFabServerModels { } - export interface PlayerStatistic { - /** Statistic ID */ - Id?: string; - /** Statistic name */ - Name?: string; - /** Current statistic value */ - StatisticValue: number; - /** Statistic version (0 if not a versioned statistic) */ - StatisticVersion: number; - - } - export interface PlayerStatisticVersion { /** time when the statistic version became active */ ActivationTime: string; @@ -4396,14 +4859,6 @@ declare module PlayFabServerModels { | "GoogleCloudMessaging"; - export interface PushNotificationRegistration { - /** Notification configured endpoint */ - NotificationEndpointARN?: string; - /** Push notification platform */ - Platform?: string; - - } - export interface PushNotificationRegistrationModel { /** Notification configured endpoint */ NotificationEndpointARN?: string; @@ -4703,7 +5158,7 @@ declare module PlayFabServerModels { InfoResultPayload?: GetPlayerCombinedInfoResultPayload; /** The time of this user's previous login. If there was no previous login, then it's DateTime.MinValue */ LastLoginTime?: string; - /** True if the account was newly created on this login. */ + /** True if the master_player_account was newly created on this login. */ NewlyCreated: boolean; /** Player's unique PlayFabId. */ PlayFabId?: string; @@ -4727,7 +5182,7 @@ declare module PlayFabServerModels { } export interface SetPlayerSecretRequest extends PlayFabModule.IPlayFabRequestCommon { - /** Player secret that is used to verify API request signatures (Enterprise Only). */ + /** Player secret that is used to verify API request signatures. */ PlayerSecret?: string; /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ PlayFabId: string; @@ -4830,6 +5285,14 @@ declare module PlayFabServerModels { } + export interface SteamNamePlayFabIdPair { + /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */ + PlayFabId?: string; + /** Unique Steam identifier for a user, also known as Steam persona name. */ + SteamName?: string; + + } + export interface SteamPlayFabIdPair { /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Steam identifier. */ PlayFabId?: string; @@ -4960,6 +5423,64 @@ declare module PlayFabServerModels { } + export interface UnlinkAppleRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + + } + + export interface UnlinkAppleResult extends PlayFabModule.IPlayFabResultCommon { + + } + + export interface UnlinkBattleNetAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + + } + + export interface UnlinkFacebookAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** PlayFab unique identifier of the user to unlink. */ + PlayFabId: string; + + } + + export interface UnlinkFacebookAccountResult extends PlayFabModule.IPlayFabResultCommon { + + } + + export interface UnlinkFacebookInstantGamesIdRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Facebook Instant Games identifier for the user. If not specified, the most recently linked identifier will be used. */ + FacebookInstantGamesId?: string; + /** PlayFab unique identifier of the user to unlink. */ + PlayFabId: string; + + } + + export interface UnlinkFacebookInstantGamesIdResult extends PlayFabModule.IPlayFabResultCommon { + + } + + export interface UnlinkGameCenterAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + + } + + export interface UnlinkGameCenterAccountResult extends PlayFabModule.IPlayFabResultCommon { + + } + export interface UnlinkNintendoServiceAccountRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -5020,10 +5541,23 @@ declare module PlayFabServerModels { } + export interface UnlinkTwitchAccountRequest extends PlayFabModule.IPlayFabRequestCommon { + /** + * Valid token issued by Twitch. Used to specify which twitch account to unlink from the profile. By default it uses the + * one that is present on the profile. + */ + AccessToken?: string; + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** PlayFab unique identifier of the user to unlink. */ + PlayFabId: string; + + } + export interface UnlinkXboxAccountRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; - /** Unique PlayFab identifier for a user, or null if no PlayFab account is linked to the Xbox Live identifier. */ + /** PlayFab unique identifier of the user to unlink. */ PlayFabId: string; } @@ -5168,6 +5702,32 @@ declare module PlayFabServerModels { } + export interface UpdatePlayerCustomPropertiesRequest extends PlayFabModule.IPlayFabRequestCommon { + /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ + CustomTags?: { [key: string]: string | null }; + /** + * Optional field used for concurrency control. One can ensure that the update operation will only be performed if the + * player's properties have not been updated by any other clients since last the version. + */ + ExpectedPropertiesVersion?: number; + /** Unique PlayFab assigned ID of the user on whom the operation will be performed. */ + PlayFabId: string; + /** Collection of properties to be set for a player. */ + Properties: UpdateProperty[]; + + } + + export interface UpdatePlayerCustomPropertiesResult extends PlayFabModule.IPlayFabResultCommon { + /** PlayFab unique identifier of the user whose properties were updated. */ + PlayFabId?: string; + /** + * Indicates the current version of a player's properties that have been set. This is incremented after updates and + * deletes. This version can be provided in update and delete calls for concurrency control. + */ + PropertiesVersion: number; + + } + export interface UpdatePlayerStatisticsRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -5187,6 +5747,14 @@ declare module PlayFabServerModels { } + export interface UpdateProperty { + /** Name of the custom property. Can contain Unicode letters and digits. They are limited in size. */ + Name: string; + /** Value of the custom property. Limited to booleans, numbers, and strings. */ + Value: any; + + } + export interface UpdateSharedGroupDataRequest extends PlayFabModule.IPlayFabRequestCommon { /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */ CustomTags?: { [key: string]: string | null }; @@ -5285,6 +5853,8 @@ declare module PlayFabServerModels { AndroidDeviceInfo?: UserAndroidDeviceInfo; /** Sign in with Apple account information, if an Apple account has been linked */ AppleAccountInfo?: UserAppleIdInfo; + /** Battle.net account information, if a Battle.net account has been linked */ + BattleNetAccountInfo?: UserBattleNetInfo; /** Timestamp indicating when the user account was created */ Created: string; /** Custom ID information, if a custom ID has been assigned */ @@ -5342,6 +5912,14 @@ declare module PlayFabServerModels { } + export interface UserBattleNetInfo { + /** Battle.net identifier */ + BattleNetAccountId?: string; + /** Battle.net display name */ + BattleNetBattleTag?: string; + + } + export interface UserCustomIdInfo { /** Custom ID */ CustomId?: string; @@ -5475,7 +6053,9 @@ declare module PlayFabServerModels { | "Apple" | "NintendoSwitchAccount" | "GooglePlayGames" - | "XboxMobileStore"; + | "XboxMobileStore" + | "King" + | "BattleNet"; export interface UserPrivateAccountInfo { /** user email address */ @@ -5484,10 +6064,17 @@ declare module PlayFabServerModels { } export interface UserPsnInfo { + /** + * Id of the PlayStation :tm: Network issuer environment this account is keyed under. Supply this value as IssuerId when + * looking the account up. + */ + IssuerId?: number; /** PlayStation :tm: Network account ID */ PsnAccountId?: string; /** PlayStation :tm: Network online ID */ PsnOnlineId?: string; + /** PlayStation :tm: Network sandbox ID */ + PsnSandboxId?: string; }