diff --git a/PlayFabSdk/package.json b/PlayFabSdk/package.json index d92b76e3..817f859b 100644 --- a/PlayFabSdk/package.json +++ b/PlayFabSdk/package.json @@ -1,6 +1,6 @@ { "name": "playfab-web-sdk", - "version": "1.211.260313", + "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 a2d9d57c..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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); }, diff --git a/PlayFabSdk/src/PlayFab/PlayFabAdminApi.js b/PlayFabSdk/src/PlayFab/PlayFabAdminApi.js index 63eae33f..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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); }, @@ -397,6 +401,14 @@ 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); }, @@ -421,13 +433,6 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetPlayerSharedSecrets", request, "X-SecretKey", callback, customData, extraHeaders); }, - /** - * @deprecated Please use ExportPlayersInSegment instead. - */ - 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); }, @@ -456,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); }, @@ -584,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); }, @@ -648,6 +661,10 @@ 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); }, @@ -712,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 c40dd4c0..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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 28808e74..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabSdk/src/PlayFab/PlayFabCloudScriptApi.js b/PlayFabSdk/src/PlayFab/PlayFabCloudScriptApi.js index b20c8c27..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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 450eeede..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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 20597ded..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabSdk/src/PlayFab/PlayFabEventsApi.js b/PlayFabSdk/src/PlayFab/PlayFabEventsApi.js index 0ed64000..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabSdk/src/PlayFab/PlayFabExperimentationApi.js b/PlayFabSdk/src/PlayFab/PlayFabExperimentationApi.js index f84d9feb..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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 91ea8b0c..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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 733a871b..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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 c56dd499..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabSdk/src/PlayFab/PlayFabMultiplayerApi.js b/PlayFabSdk/src/PlayFab/PlayFabMultiplayerApi.js index 507eb6b4..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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 d92c1aea..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabSdk/src/PlayFab/PlayFabProgressionApi.js b/PlayFabSdk/src/PlayFab/PlayFabProgressionApi.js index 277c9c03..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabSdk/src/PlayFab/PlayFabServerApi.js b/PlayFabSdk/src/PlayFab/PlayFabServerApi.js index 5da70918..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -317,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); }, @@ -397,13 +401,6 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayerSegments", request, "X-SecretKey", callback, customData, extraHeaders); }, - /** - * @deprecated Do not use - */ - 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); }, @@ -452,6 +449,10 @@ 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); }, @@ -476,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); }, @@ -748,6 +757,10 @@ 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); }, @@ -760,6 +773,10 @@ PlayFab.ServerApi = { 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); }, diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabAddonApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabAddonApi.d.ts index 813f6c85..6ec1a36a 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabAddonApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabAddonApi.d.ts @@ -4,6 +4,11 @@ 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/addon/createorupdateapple @@ -159,6 +164,20 @@ 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; @@ -303,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[]; } @@ -639,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[]; } diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabAdminApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabAdminApi.d.ts index f8d94c21..46869cef 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabAdminApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabAdminApi.d.ts @@ -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 @@ -172,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>; @@ -215,6 +221,16 @@ 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 @@ -245,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. @@ -294,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 @@ -464,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 @@ -557,6 +574,11 @@ 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 @@ -640,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>; } } @@ -717,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; @@ -798,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. */ @@ -1120,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; @@ -1460,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; @@ -2576,7 +2606,6 @@ declare module PlayFabAdminModels { | "InsightsManagementGetOperationStatusInvalidParameter" | "DuplicatePurchaseTransactionId" | "EvaluationModePlayerCountExceeded" - | "GetPlayersInSegmentRateLimitExceeded" | "CloudScriptFunctionNameSizeExceeded" | "PaidInsightsFeaturesNotEnabled" | "CloudScriptAzureFunctionsQueueRequestError" @@ -2698,6 +2727,10 @@ declare module PlayFabAdminModels { | "ParentCustomerAccountNotFound" | "AccountLinkedToABannedPlayer" | "AzureSubscriptionNotEligibleForLinking" + | "EntityIsNotAMember" + | "IPAddressNotFound" + | "PSNNextGenNotConfiguredForTitle" + | "InvalidNintendoIssuer" | "MatchmakingEntityInvalid" | "MatchmakingPlayerAttributesInvalid" | "MatchmakingQueueNotFound" @@ -2815,6 +2848,8 @@ declare module PlayFabAdminModels { | "ExperimentationExclusionGroupInvalidName" | "ExperimentationLegacyExperimentInvalidOperation" | "ExperimentationExperimentStopFailed" + | "ExperimentationExperimentDeleteFailed" + | "ExperimentationExperimentStartFailed" | "MaxActionDepthExceeded" | "TitleNotOnUpdatedPricingPlan" | "SegmentManagementTitleNotInFlight" @@ -2832,7 +2867,8 @@ declare module PlayFabAdminModels { | "AsyncExportNotFound" | "AsyncExportRateLimitExceeded" | "AnalyticsSegmentCountOverLimit" - | "GetPlayersInSegmentRetired" + | "GetSegmentPlayerCountNotInFlight" + | "GetSegmentPlayerCountRateLimitExceeded" | "SnapshotNotFound" | "InventoryApiNotImplemented" | "InventoryCollectionDeletionDisallowed" @@ -2908,8 +2944,6 @@ declare module PlayFabAdminModels { | "PlayerCustomPropertiesPropertyDoesNotExist" | "AddonAlreadyExists" | "AddonDoesntExist" - | "CopilotDisabled" - | "CopilotInvalidRequest" | "TrueSkillUnauthorized" | "TrueSkillInvalidTitleId" | "TrueSkillInvalidScenarioId" @@ -3012,6 +3046,11 @@ declare module PlayFabAdminModels { | "GameSaveConflict" | "GameSaveManifestNotEligibleForRollback" | "GameSaveTitleClientAnonymousAccountCreationNotDisabled" + | "GameSaveTitleConfigNoUpdatesRequested" + | "GameSavePlayerNotEligibleForTransfer" + | "GameSaveAlreadyAutoRolledBack" + | "GameSaveManifestNotEligibleForRestore" + | "GameSaveManifestArchived" | "StateShareForbidden" | "StateShareTitleNotInFlight" | "StateShareStateNotFound" @@ -3038,6 +3077,7 @@ declare module PlayFabAdminModels { | "PlayFabErrorEventNotSupportedForEntityType" | "MetadataLengthExceeded" | "MaxQueryableVersionsExceeded" + | "StatisticVersionIncrementNotAllowedWhileLinked" | "StoreMetricsRequestInvalidInput" | "StoreMetricsErrorRetrievingMetrics"; @@ -3049,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 { } @@ -3171,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; @@ -3271,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 }; @@ -3358,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. */ @@ -3397,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; @@ -3711,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; @@ -3968,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; @@ -3999,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 @@ -4041,82 +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; - /** Dictionary of player's custom properties. */ - CustomProperties?: { [key: string]: any }; - /** 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[]; @@ -4206,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; @@ -4250,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; @@ -4264,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; @@ -4499,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; @@ -5165,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; @@ -5570,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; @@ -5650,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. */ @@ -5664,6 +5690,11 @@ 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[]; } @@ -6029,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; } @@ -6098,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 58381549..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; } diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabClientApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabClientApi.d.ts index 39be01d0..b75e42e4 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabClientApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabClientApi.d.ts @@ -2363,6 +2363,11 @@ 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 @@ -2821,6 +2826,11 @@ 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 25 in length. @@ -2866,13 +2876,23 @@ declare module PlayFabClientModels { } 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 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; } @@ -2883,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 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; } @@ -3504,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. */ @@ -3669,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 @@ -3690,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 @@ -3700,7 +3735,7 @@ 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 @@ -3715,13 +3750,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 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 (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 @@ -3738,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 @@ -3774,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 @@ -3799,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 @@ -3818,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; @@ -3850,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() @@ -3876,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() @@ -3904,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 @@ -3927,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 @@ -3948,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 @@ -3969,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 @@ -3992,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 @@ -4001,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 @@ -4031,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; @@ -4058,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 @@ -4089,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 @@ -4108,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 @@ -4541,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 @@ -4745,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; } @@ -5632,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; } 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 de9c8dc2..733020c5 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabEconomyApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabEconomyApi.d.ts @@ -158,9 +158,10 @@ declare module PlayFabEconomyModule { */ GetItems(request: PlayFabEconomyModels.GetItemsRequest, 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>; @@ -1459,7 +1460,10 @@ declare module PlayFabEconomyModels { 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 }; 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/PlayFabMultiplayerApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabMultiplayerApi.d.ts index 35291eab..17112934 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabMultiplayerApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabMultiplayerApi.d.ts @@ -523,7 +523,35 @@ declare module PlayFabMultiplayerModels { | "UkSouth" | "SwedenCentral" | "CanadaCentral" - | "MexicoCentral"; + | "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" @@ -540,6 +568,9 @@ declare module PlayFabMultiplayerModels { | "Easv4" | "Ev4" | "Esv4" + | "Edsv4" + | "Edsv5" + | "Edsv6" | "Dsv3" | "Dsv2" | "NCasT4_v3" @@ -548,7 +579,15 @@ declare module PlayFabMultiplayerModels { | "HBv3" | "Ddv5" | "Ddsv5" - | "Ddsv6"; + | "Ddsv6" + | "Fasv6" + | "Fasv7" + | "Fadsv7" + | "Eadsv5" + | "Eadsv6" + | "Eadsv7" + | "Dadsv7" + | "Dpdsv6"; type AzureVmSize = "Standard_A1" @@ -577,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" @@ -593,6 +644,10 @@ declare module PlayFabMultiplayerModels { | "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" @@ -601,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" @@ -637,7 +716,11 @@ declare module PlayFabMultiplayerModels { | "Standard_D2ds_v6" | "Standard_D4ds_v6" | "Standard_D8ds_v6" - | "Standard_D16ds_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. */ @@ -723,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; @@ -737,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; @@ -883,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. */ @@ -928,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. */ @@ -942,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 */ @@ -984,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. */ @@ -1034,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. */ @@ -1050,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 */ @@ -1097,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. */ @@ -1155,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. */ @@ -1172,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 */ @@ -1802,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; /** @@ -2488,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; @@ -2587,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; @@ -2836,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[]; @@ -3141,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; diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabProfilesApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabProfilesApi.d.ts index f28ed924..ce708bfc 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabProfilesApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabProfilesApi.d.ts @@ -140,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. @@ -182,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; } @@ -201,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; } @@ -340,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 eed7301f..00230005 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabProgressionApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabProgressionApi.d.ts @@ -696,6 +696,13 @@ declare module PlayFabProgressionModels { } export interface StatisticUpdate { + /** + * 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. */ diff --git a/PlayFabSdk/src/Typings/PlayFab/PlayFabServerApi.d.ts b/PlayFabSdk/src/Typings/PlayFab/PlayFabServerApi.d.ts index 58ce46f3..dbde1d7a 100644 --- a/PlayFabSdk/src/Typings/PlayFab/PlayFabServerApi.d.ts +++ b/PlayFabSdk/src/Typings/PlayFab/PlayFabServerApi.d.ts @@ -118,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>; @@ -230,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 @@ -303,6 +302,11 @@ 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. @@ -339,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 @@ -716,6 +733,11 @@ 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 @@ -731,6 +753,11 @@ declare module PlayFabServerModule { * 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 @@ -888,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; @@ -1249,12 +1266,6 @@ declare module PlayFabServerModels { } - type ChurnRiskLevel = "NoData" - - | "LowRisk" - | "MediumRisk" - | "HighRisk"; - type CloudScriptRevisionOption = "Live" | "Latest" @@ -1282,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; @@ -1940,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" @@ -2474,7 +2489,6 @@ declare module PlayFabServerModels { | "InsightsManagementGetOperationStatusInvalidParameter" | "DuplicatePurchaseTransactionId" | "EvaluationModePlayerCountExceeded" - | "GetPlayersInSegmentRateLimitExceeded" | "CloudScriptFunctionNameSizeExceeded" | "PaidInsightsFeaturesNotEnabled" | "CloudScriptAzureFunctionsQueueRequestError" @@ -2596,6 +2610,10 @@ declare module PlayFabServerModels { | "ParentCustomerAccountNotFound" | "AccountLinkedToABannedPlayer" | "AzureSubscriptionNotEligibleForLinking" + | "EntityIsNotAMember" + | "IPAddressNotFound" + | "PSNNextGenNotConfiguredForTitle" + | "InvalidNintendoIssuer" | "MatchmakingEntityInvalid" | "MatchmakingPlayerAttributesInvalid" | "MatchmakingQueueNotFound" @@ -2713,6 +2731,8 @@ declare module PlayFabServerModels { | "ExperimentationExclusionGroupInvalidName" | "ExperimentationLegacyExperimentInvalidOperation" | "ExperimentationExperimentStopFailed" + | "ExperimentationExperimentDeleteFailed" + | "ExperimentationExperimentStartFailed" | "MaxActionDepthExceeded" | "TitleNotOnUpdatedPricingPlan" | "SegmentManagementTitleNotInFlight" @@ -2730,7 +2750,8 @@ declare module PlayFabServerModels { | "AsyncExportNotFound" | "AsyncExportRateLimitExceeded" | "AnalyticsSegmentCountOverLimit" - | "GetPlayersInSegmentRetired" + | "GetSegmentPlayerCountNotInFlight" + | "GetSegmentPlayerCountRateLimitExceeded" | "SnapshotNotFound" | "InventoryApiNotImplemented" | "InventoryCollectionDeletionDisallowed" @@ -2806,8 +2827,6 @@ declare module PlayFabServerModels { | "PlayerCustomPropertiesPropertyDoesNotExist" | "AddonAlreadyExists" | "AddonDoesntExist" - | "CopilotDisabled" - | "CopilotInvalidRequest" | "TrueSkillUnauthorized" | "TrueSkillInvalidTitleId" | "TrueSkillInvalidScenarioId" @@ -2910,6 +2929,11 @@ declare module PlayFabServerModels { | "GameSaveConflict" | "GameSaveManifestNotEligibleForRollback" | "GameSaveTitleClientAnonymousAccountCreationNotDisabled" + | "GameSaveTitleConfigNoUpdatesRequested" + | "GameSavePlayerNotEligibleForTransfer" + | "GameSaveAlreadyAutoRolledBack" + | "GameSaveManifestNotEligibleForRestore" + | "GameSaveManifestArchived" | "StateShareForbidden" | "StateShareTitleNotInFlight" | "StateShareStateNotFound" @@ -2936,6 +2960,7 @@ declare module PlayFabServerModels { | "PlayFabErrorEventNotSupportedForEntityType" | "MetadataLengthExceeded" | "MaxQueryableVersionsExceeded" + | "StatisticVersionIncrementNotAllowedWhileLinked" | "StoreMetricsRequestInvalidInput" | "StoreMetricsErrorRetrievingMetrics"; @@ -3123,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; /** @@ -3375,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; } @@ -3535,6 +3543,11 @@ 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 25 in length. @@ -3580,13 +3593,23 @@ declare module PlayFabServerModels { } 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 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; } @@ -3597,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 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; } @@ -3613,6 +3646,21 @@ 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 @@ -3704,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; @@ -4142,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. */ @@ -4164,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; } @@ -4390,6 +4464,11 @@ declare module PlayFabServerModels { 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.). */ @@ -4410,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; @@ -4633,82 +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; - /** Dictionary of player's custom properties. */ - CustomProperties?: { [key: string]: any }; - /** 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[]; @@ -4798,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; @@ -4868,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; @@ -5199,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; @@ -5440,6 +5423,18 @@ 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 }; @@ -5474,6 +5469,18 @@ declare module PlayFabServerModels { } + 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 }; @@ -6057,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/PlayFabTestingExample/src/PlayFab/PlayFabAddonApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabAddonApi.js index a2d9d57c..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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); }, diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabAdminApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabAdminApi.js index 63eae33f..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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); }, @@ -397,6 +401,14 @@ 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); }, @@ -421,13 +433,6 @@ PlayFab.AdminApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Admin/GetPlayerSharedSecrets", request, "X-SecretKey", callback, customData, extraHeaders); }, - /** - * @deprecated Please use ExportPlayersInSegment instead. - */ - 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); }, @@ -456,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); }, @@ -584,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); }, @@ -648,6 +661,10 @@ 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); }, @@ -712,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 c40dd4c0..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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 28808e74..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabCloudScriptApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabCloudScriptApi.js index b20c8c27..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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 450eeede..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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 20597ded..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabEventsApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabEventsApi.js index 0ed64000..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabExperimentationApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabExperimentationApi.js index f84d9feb..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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 91ea8b0c..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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 733a871b..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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 c56dd499..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabMultiplayerApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabMultiplayerApi.js index 507eb6b4..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +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 d92c1aea..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabProgressionApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabProgressionApi.js index 277c9c03..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; diff --git a/PlayFabTestingExample/src/PlayFab/PlayFabServerApi.js b/PlayFabTestingExample/src/PlayFab/PlayFabServerApi.js index 5da70918..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.211.260313", + sdkVersion: "1.222.260922", requestGetParams: { - sdk: "JavaScriptSDK-1.211.260313" + 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.211.260313"; +PlayFab.sdkVersion = "1.222.260922"; PlayFab.GenerateErrorReport = function (error) { if (error == null) return ""; @@ -317,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); }, @@ -397,13 +401,6 @@ PlayFab.ServerApi = { return PlayFab._internalSettings.ExecuteRequestWrapper("/Server/GetPlayerSegments", request, "X-SecretKey", callback, customData, extraHeaders); }, - /** - * @deprecated Do not use - */ - 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); }, @@ -452,6 +449,10 @@ 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); }, @@ -476,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); }, @@ -748,6 +757,10 @@ 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); }, @@ -760,6 +773,10 @@ PlayFab.ServerApi = { 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); }, diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabAddonApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabAddonApi.d.ts index 813f6c85..6ec1a36a 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabAddonApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabAddonApi.d.ts @@ -4,6 +4,11 @@ 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/addon/createorupdateapple @@ -159,6 +164,20 @@ 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; @@ -303,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[]; } @@ -639,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[]; } diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabAdminApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabAdminApi.d.ts index f8d94c21..46869cef 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabAdminApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabAdminApi.d.ts @@ -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 @@ -172,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>; @@ -215,6 +221,16 @@ 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 @@ -245,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. @@ -294,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 @@ -464,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 @@ -557,6 +574,11 @@ 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 @@ -640,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>; } } @@ -717,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; @@ -798,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. */ @@ -1120,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; @@ -1460,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; @@ -2576,7 +2606,6 @@ declare module PlayFabAdminModels { | "InsightsManagementGetOperationStatusInvalidParameter" | "DuplicatePurchaseTransactionId" | "EvaluationModePlayerCountExceeded" - | "GetPlayersInSegmentRateLimitExceeded" | "CloudScriptFunctionNameSizeExceeded" | "PaidInsightsFeaturesNotEnabled" | "CloudScriptAzureFunctionsQueueRequestError" @@ -2698,6 +2727,10 @@ declare module PlayFabAdminModels { | "ParentCustomerAccountNotFound" | "AccountLinkedToABannedPlayer" | "AzureSubscriptionNotEligibleForLinking" + | "EntityIsNotAMember" + | "IPAddressNotFound" + | "PSNNextGenNotConfiguredForTitle" + | "InvalidNintendoIssuer" | "MatchmakingEntityInvalid" | "MatchmakingPlayerAttributesInvalid" | "MatchmakingQueueNotFound" @@ -2815,6 +2848,8 @@ declare module PlayFabAdminModels { | "ExperimentationExclusionGroupInvalidName" | "ExperimentationLegacyExperimentInvalidOperation" | "ExperimentationExperimentStopFailed" + | "ExperimentationExperimentDeleteFailed" + | "ExperimentationExperimentStartFailed" | "MaxActionDepthExceeded" | "TitleNotOnUpdatedPricingPlan" | "SegmentManagementTitleNotInFlight" @@ -2832,7 +2867,8 @@ declare module PlayFabAdminModels { | "AsyncExportNotFound" | "AsyncExportRateLimitExceeded" | "AnalyticsSegmentCountOverLimit" - | "GetPlayersInSegmentRetired" + | "GetSegmentPlayerCountNotInFlight" + | "GetSegmentPlayerCountRateLimitExceeded" | "SnapshotNotFound" | "InventoryApiNotImplemented" | "InventoryCollectionDeletionDisallowed" @@ -2908,8 +2944,6 @@ declare module PlayFabAdminModels { | "PlayerCustomPropertiesPropertyDoesNotExist" | "AddonAlreadyExists" | "AddonDoesntExist" - | "CopilotDisabled" - | "CopilotInvalidRequest" | "TrueSkillUnauthorized" | "TrueSkillInvalidTitleId" | "TrueSkillInvalidScenarioId" @@ -3012,6 +3046,11 @@ declare module PlayFabAdminModels { | "GameSaveConflict" | "GameSaveManifestNotEligibleForRollback" | "GameSaveTitleClientAnonymousAccountCreationNotDisabled" + | "GameSaveTitleConfigNoUpdatesRequested" + | "GameSavePlayerNotEligibleForTransfer" + | "GameSaveAlreadyAutoRolledBack" + | "GameSaveManifestNotEligibleForRestore" + | "GameSaveManifestArchived" | "StateShareForbidden" | "StateShareTitleNotInFlight" | "StateShareStateNotFound" @@ -3038,6 +3077,7 @@ declare module PlayFabAdminModels { | "PlayFabErrorEventNotSupportedForEntityType" | "MetadataLengthExceeded" | "MaxQueryableVersionsExceeded" + | "StatisticVersionIncrementNotAllowedWhileLinked" | "StoreMetricsRequestInvalidInput" | "StoreMetricsErrorRetrievingMetrics"; @@ -3049,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 { } @@ -3171,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; @@ -3271,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 }; @@ -3358,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. */ @@ -3397,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; @@ -3711,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; @@ -3968,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; @@ -3999,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 @@ -4041,82 +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; - /** Dictionary of player's custom properties. */ - CustomProperties?: { [key: string]: any }; - /** 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[]; @@ -4206,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; @@ -4250,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; @@ -4264,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; @@ -4499,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; @@ -5165,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; @@ -5570,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; @@ -5650,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. */ @@ -5664,6 +5690,11 @@ 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[]; } @@ -6029,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; } @@ -6098,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 58381549..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; } diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabClientApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabClientApi.d.ts index 39be01d0..b75e42e4 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabClientApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabClientApi.d.ts @@ -2363,6 +2363,11 @@ 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 @@ -2821,6 +2826,11 @@ 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 25 in length. @@ -2866,13 +2876,23 @@ declare module PlayFabClientModels { } 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 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; } @@ -2883,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 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; } @@ -3504,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. */ @@ -3669,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 @@ -3690,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 @@ -3700,7 +3735,7 @@ 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 @@ -3715,13 +3750,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 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 (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 @@ -3738,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 @@ -3774,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 @@ -3799,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 @@ -3818,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; @@ -3850,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() @@ -3876,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() @@ -3904,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 @@ -3927,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 @@ -3948,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 @@ -3969,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 @@ -3992,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 @@ -4001,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 @@ -4031,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; @@ -4058,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 @@ -4089,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 @@ -4108,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 @@ -4541,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 @@ -4745,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; } @@ -5632,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; } 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 de9c8dc2..733020c5 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabEconomyApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabEconomyApi.d.ts @@ -158,9 +158,10 @@ declare module PlayFabEconomyModule { */ GetItems(request: PlayFabEconomyModels.GetItemsRequest, 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>; @@ -1459,7 +1460,10 @@ declare module PlayFabEconomyModels { 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 }; 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/PlayFabMultiplayerApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabMultiplayerApi.d.ts index 35291eab..17112934 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabMultiplayerApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabMultiplayerApi.d.ts @@ -523,7 +523,35 @@ declare module PlayFabMultiplayerModels { | "UkSouth" | "SwedenCentral" | "CanadaCentral" - | "MexicoCentral"; + | "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" @@ -540,6 +568,9 @@ declare module PlayFabMultiplayerModels { | "Easv4" | "Ev4" | "Esv4" + | "Edsv4" + | "Edsv5" + | "Edsv6" | "Dsv3" | "Dsv2" | "NCasT4_v3" @@ -548,7 +579,15 @@ declare module PlayFabMultiplayerModels { | "HBv3" | "Ddv5" | "Ddsv5" - | "Ddsv6"; + | "Ddsv6" + | "Fasv6" + | "Fasv7" + | "Fadsv7" + | "Eadsv5" + | "Eadsv6" + | "Eadsv7" + | "Dadsv7" + | "Dpdsv6"; type AzureVmSize = "Standard_A1" @@ -577,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" @@ -593,6 +644,10 @@ declare module PlayFabMultiplayerModels { | "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" @@ -601,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" @@ -637,7 +716,11 @@ declare module PlayFabMultiplayerModels { | "Standard_D2ds_v6" | "Standard_D4ds_v6" | "Standard_D8ds_v6" - | "Standard_D16ds_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. */ @@ -723,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; @@ -737,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; @@ -883,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. */ @@ -928,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. */ @@ -942,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 */ @@ -984,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. */ @@ -1034,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. */ @@ -1050,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 */ @@ -1097,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. */ @@ -1155,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. */ @@ -1172,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 */ @@ -1802,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; /** @@ -2488,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; @@ -2587,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; @@ -2836,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[]; @@ -3141,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; diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabProfilesApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabProfilesApi.d.ts index f28ed924..ce708bfc 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabProfilesApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabProfilesApi.d.ts @@ -140,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. @@ -182,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; } @@ -201,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; } @@ -340,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 eed7301f..00230005 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabProgressionApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabProgressionApi.d.ts @@ -696,6 +696,13 @@ declare module PlayFabProgressionModels { } export interface StatisticUpdate { + /** + * 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. */ diff --git a/PlayFabTestingExample/src/typings/PlayFab/PlayFabServerApi.d.ts b/PlayFabTestingExample/src/typings/PlayFab/PlayFabServerApi.d.ts index 58ce46f3..dbde1d7a 100644 --- a/PlayFabTestingExample/src/typings/PlayFab/PlayFabServerApi.d.ts +++ b/PlayFabTestingExample/src/typings/PlayFab/PlayFabServerApi.d.ts @@ -118,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>; @@ -230,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 @@ -303,6 +302,11 @@ 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. @@ -339,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 @@ -716,6 +733,11 @@ 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 @@ -731,6 +753,11 @@ declare module PlayFabServerModule { * 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 @@ -888,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; @@ -1249,12 +1266,6 @@ declare module PlayFabServerModels { } - type ChurnRiskLevel = "NoData" - - | "LowRisk" - | "MediumRisk" - | "HighRisk"; - type CloudScriptRevisionOption = "Live" | "Latest" @@ -1282,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; @@ -1940,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" @@ -2474,7 +2489,6 @@ declare module PlayFabServerModels { | "InsightsManagementGetOperationStatusInvalidParameter" | "DuplicatePurchaseTransactionId" | "EvaluationModePlayerCountExceeded" - | "GetPlayersInSegmentRateLimitExceeded" | "CloudScriptFunctionNameSizeExceeded" | "PaidInsightsFeaturesNotEnabled" | "CloudScriptAzureFunctionsQueueRequestError" @@ -2596,6 +2610,10 @@ declare module PlayFabServerModels { | "ParentCustomerAccountNotFound" | "AccountLinkedToABannedPlayer" | "AzureSubscriptionNotEligibleForLinking" + | "EntityIsNotAMember" + | "IPAddressNotFound" + | "PSNNextGenNotConfiguredForTitle" + | "InvalidNintendoIssuer" | "MatchmakingEntityInvalid" | "MatchmakingPlayerAttributesInvalid" | "MatchmakingQueueNotFound" @@ -2713,6 +2731,8 @@ declare module PlayFabServerModels { | "ExperimentationExclusionGroupInvalidName" | "ExperimentationLegacyExperimentInvalidOperation" | "ExperimentationExperimentStopFailed" + | "ExperimentationExperimentDeleteFailed" + | "ExperimentationExperimentStartFailed" | "MaxActionDepthExceeded" | "TitleNotOnUpdatedPricingPlan" | "SegmentManagementTitleNotInFlight" @@ -2730,7 +2750,8 @@ declare module PlayFabServerModels { | "AsyncExportNotFound" | "AsyncExportRateLimitExceeded" | "AnalyticsSegmentCountOverLimit" - | "GetPlayersInSegmentRetired" + | "GetSegmentPlayerCountNotInFlight" + | "GetSegmentPlayerCountRateLimitExceeded" | "SnapshotNotFound" | "InventoryApiNotImplemented" | "InventoryCollectionDeletionDisallowed" @@ -2806,8 +2827,6 @@ declare module PlayFabServerModels { | "PlayerCustomPropertiesPropertyDoesNotExist" | "AddonAlreadyExists" | "AddonDoesntExist" - | "CopilotDisabled" - | "CopilotInvalidRequest" | "TrueSkillUnauthorized" | "TrueSkillInvalidTitleId" | "TrueSkillInvalidScenarioId" @@ -2910,6 +2929,11 @@ declare module PlayFabServerModels { | "GameSaveConflict" | "GameSaveManifestNotEligibleForRollback" | "GameSaveTitleClientAnonymousAccountCreationNotDisabled" + | "GameSaveTitleConfigNoUpdatesRequested" + | "GameSavePlayerNotEligibleForTransfer" + | "GameSaveAlreadyAutoRolledBack" + | "GameSaveManifestNotEligibleForRestore" + | "GameSaveManifestArchived" | "StateShareForbidden" | "StateShareTitleNotInFlight" | "StateShareStateNotFound" @@ -2936,6 +2960,7 @@ declare module PlayFabServerModels { | "PlayFabErrorEventNotSupportedForEntityType" | "MetadataLengthExceeded" | "MaxQueryableVersionsExceeded" + | "StatisticVersionIncrementNotAllowedWhileLinked" | "StoreMetricsRequestInvalidInput" | "StoreMetricsErrorRetrievingMetrics"; @@ -3123,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; /** @@ -3375,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; } @@ -3535,6 +3543,11 @@ 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 25 in length. @@ -3580,13 +3593,23 @@ declare module PlayFabServerModels { } 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 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; } @@ -3597,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 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; } @@ -3613,6 +3646,21 @@ 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 @@ -3704,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; @@ -4142,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. */ @@ -4164,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; } @@ -4390,6 +4464,11 @@ declare module PlayFabServerModels { 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.). */ @@ -4410,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; @@ -4633,82 +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; - /** Dictionary of player's custom properties. */ - CustomProperties?: { [key: string]: any }; - /** 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[]; @@ -4798,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; @@ -4868,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; @@ -5199,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; @@ -5440,6 +5423,18 @@ 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 }; @@ -5474,6 +5469,18 @@ declare module PlayFabServerModels { } + 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 }; @@ -6057,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; }