*bump version

pancake-llc · Feb 3, 2023 · a71209e · a71209e
1 parent 4ccac33
commit a71209e
Show file tree

Hide file tree

Showing 17 changed files with 479 additions and 65 deletions.
diff --git a/Admin/PlayFabAdminAPI.cs b/Admin/PlayFabAdminAPI.cs
@@ -1242,7 +1242,10 @@ public static void SetStoreItems(UpdateStoreItemsRequest request, Action<UpdateS
         }
 
         /// <summary>
-        /// Creates and updates the key-value store of custom title settings which can be read by the client
+        /// Creates and updates the key-value store of custom title settings which can be read by the client. For example, a
+        /// developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths,
+        /// movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new
+        /// build.
         /// </summary>
         public static void SetTitleData(SetTitleDataRequest request, Action<SetTitleDataResult> resultCallback, Action<PlayFabError> errorCallback, object customData = null, Dictionary<string, string> extraHeaders = null)
         {
@@ -1268,7 +1271,8 @@ public static void SetTitleDataAndOverrides(SetTitleDataAndOverridesRequest requ
         }
 
         /// <summary>
-        /// Updates the key-value store of custom title settings which cannot be read by the client
+        /// Updates the key-value store of custom title settings which cannot be read by the client. These values can be used to
+        /// tweak settings used by game servers and Cloud Scripts without the need to update and re-deploy.
         /// </summary>
         public static void SetTitleInternalData(SetTitleDataRequest request, Action<SetTitleDataResult> resultCallback, Action<PlayFabError> errorCallback, object customData = null, Dictionary<string, string> extraHeaders = null)
         {

diff --git a/Admin/PlayFabAdminInstanceAPI.cs b/Admin/PlayFabAdminInstanceAPI.cs
@@ -1080,7 +1080,10 @@ public void SetStoreItems(UpdateStoreItemsRequest request, Action<UpdateStoreIte
         }
 
         /// <summary>
-        /// Creates and updates the key-value store of custom title settings which can be read by the client
+        /// Creates and updates the key-value store of custom title settings which can be read by the client. For example, a
+        /// developer could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths,
+        /// movement speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new
+        /// build.
         /// </summary>
         public void SetTitleData(SetTitleDataRequest request, Action<SetTitleDataResult> resultCallback, Action<PlayFabError> errorCallback, object customData = null, Dictionary<string, string> extraHeaders = null)
         {
@@ -1102,7 +1105,8 @@ public void SetTitleDataAndOverrides(SetTitleDataAndOverridesRequest request, Ac
         }
 
         /// <summary>
-        /// Updates the key-value store of custom title settings which cannot be read by the client
+        /// Updates the key-value store of custom title settings which cannot be read by the client. These values can be used to
+        /// tweak settings used by game servers and Cloud Scripts without the need to update and re-deploy.
         /// </summary>
         public void SetTitleInternalData(SetTitleDataRequest request, Action<SetTitleDataResult> resultCallback, Action<PlayFabError> errorCallback, object customData = null, Dictionary<string, string> extraHeaders = null)
         {

diff --git a/Admin/PlayFabAdminModels.cs b/Admin/PlayFabAdminModels.cs
@@ -565,6 +565,19 @@ public class CheckLimitedEditionItemAvailabilityResult : PlayFabResultCommon
         public int Amount;
     }
 
+    [Serializable]
+    public class ChurnPredictionSegmentFilter : PlayFabBaseModel
+    {
+        /// <summary>
+        /// Comparison
+        /// </summary>
+        public SegmentFilterComparison? Comparison;
+        /// <summary>
+        /// RiskLevel
+        /// </summary>
+        public ChurnRiskLevel? RiskLevel;
+    }
+
     public enum ChurnRiskLevel
     {
         NoData,
@@ -2393,9 +2406,9 @@ public enum GenericErrorCodes
         AutomationRuleAlreadyExists,
         AutomationRuleLimitExceeded,
         InvalidGooglePlayGamesServerAuthCode,
-        StorageAccountNotFound,
         PlayStreamConnectionFailed,
         InvalidEventContents,
+        InsightsV1Deprecated,
         MatchmakingEntityInvalid,
         MatchmakingPlayerAttributesInvalid,
         MatchmakingQueueNotFound,
@@ -4385,6 +4398,10 @@ public class PlayerProfile : PlayFabBaseModel
         /// </summary>
         public DateTime? BannedUntil;
         /// <summary>
+        /// The prediction of the player to churn within the next seven days.
+        /// </summary>
+        public ChurnRiskLevel? ChurnPrediction;
+        /// <summary>
         /// Array of contact email addresses associated with the player
         /// </summary>
         public List<ContactEmailInfo> ContactEmailAddresses;
@@ -5229,6 +5246,10 @@ public class SegmentAndDefinition : PlayFabBaseModel
         /// </summary>
         public AllPlayersSegmentFilter AllPlayersFilter;
         /// <summary>
+        /// Filter property for player churn risk level.
+        /// </summary>
+        public ChurnPredictionSegmentFilter ChurnPredictionFilter;
+        /// <summary>
         /// Filter property for first login date.
         /// </summary>
         public FirstLoginDateSegmentFilter FirstLoginDateFilter;
@@ -6002,11 +6023,8 @@ public class SetTitleDataAndOverridesResult : PlayFabResultCommon
     }
 
     /// <summary>
-    /// This API method is designed to store title specific values which can be read by the client. For example, a developer
-    /// could choose to store values which modify the user experience, such as enemy spawn rates, weapon strengths, movement
-    /// speeds, etc. This allows a developer to update the title without the need to create, test, and ship a new build. This
-    /// operation is additive. If a Key does not exist in the current dataset, it will be added with the specified Value. If it
-    /// already exists, the Value for that key will be overwritten with the new Value.
+    /// This operation is additive. If a Key does not exist in the current dataset, it will be added with the specified Value.
+    /// If it already exists, the Value for that key will be overwritten with the new Value.
     /// </summary>
     [Serializable]
     public class SetTitleDataRequest : PlayFabRequestCommon

diff --git a/Client/PlayFabClientModels.cs b/Client/PlayFabClientModels.cs
@@ -1481,6 +1481,16 @@ public class ExecuteCloudScriptResult : PlayFabResultCommon
         public int Revision;
     }
 
+    public enum ExternalFriendSources
+    {
+        None,
+        Steam,
+        Facebook,
+        Xbox,
+        Psn,
+        All
+    }
+
     [Serializable]
     public class FacebookInstantGamesPlayFabIdPair : PlayFabBaseModel
     {
@@ -1869,11 +1879,6 @@ public class GetCharacterInventoryResult : PlayFabResultCommon
     [Serializable]
     public class GetCharacterLeaderboardRequest : PlayFabRequestCommon
     {
-        /// <summary>
-        /// Optional character type on which to filter the leaderboard entries.
-        /// </summary>
-        [Obsolete("No longer available", true)]
-        public string CharacterType;
         /// <summary>
         /// Maximum number of entries to retrieve. Default 10, maximum 100.
         /// </summary>
@@ -1956,12 +1961,19 @@ public class GetFriendLeaderboardAroundPlayerRequest : PlayFabRequestCommon
         /// </summary>
         public Dictionary<string,string> CustomTags;
         /// <summary>
+        /// Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
+        /// comma-separated list of platforms.
+        /// </summary>
+        public ExternalFriendSources? ExternalPlatformFriends;
+        /// <summary>
         /// Indicates whether Facebook friends should be included in the response. Default is true.
         /// </summary>
+        [Obsolete("Use 'ExternalPlatformFriends' instead", true)]
         public bool? IncludeFacebookFriends;
         /// <summary>
         /// Indicates whether Steam service friends should be included in the response. Default is true.
         /// </summary>
+        [Obsolete("Use 'ExternalPlatformFriends' instead", true)]
         public bool? IncludeSteamFriends;
         /// <summary>
         /// Maximum number of entries to retrieve. Default 10, maximum 100.
@@ -2022,12 +2034,19 @@ public class GetFriendLeaderboardRequest : PlayFabRequestCommon
         /// </summary>
         public Dictionary<string,string> CustomTags;
         /// <summary>
+        /// Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
+        /// comma-separated list of platforms.
+        /// </summary>
+        public ExternalFriendSources? ExternalPlatformFriends;
+        /// <summary>
         /// Indicates whether Facebook friends should be included in the response. Default is true.
         /// </summary>
+        [Obsolete("Use 'ExternalPlatformFriends' instead", true)]
         public bool? IncludeFacebookFriends;
         /// <summary>
         /// Indicates whether Steam service friends should be included in the response. Default is true.
         /// </summary>
+        [Obsolete("Use 'ExternalPlatformFriends' instead", true)]
         public bool? IncludeSteamFriends;
         /// <summary>
         /// Maximum number of entries to retrieve. Default 10, maximum 100.
@@ -2065,12 +2084,19 @@ public class GetFriendsListRequest : PlayFabRequestCommon
         /// </summary>
         public Dictionary<string,string> CustomTags;
         /// <summary>
+        /// Indicates which other platforms' friends should be included in the response. In HTTP, it is represented as a
+        /// comma-separated list of platforms.
+        /// </summary>
+        public ExternalFriendSources? ExternalPlatformFriends;
+        /// <summary>
         /// Indicates whether Facebook friends should be included in the response. Default is true.
         /// </summary>
+        [Obsolete("Use 'ExternalPlatformFriends' instead", true)]
         public bool? IncludeFacebookFriends;
         /// <summary>
         /// Indicates whether Steam service friends should be included in the response. Default is true.
         /// </summary>
+        [Obsolete("Use 'ExternalPlatformFriends' instead", true)]
         public bool? IncludeSteamFriends;
         /// <summary>
         /// If non-null, this determines which properties of the resulting player profiles to return. For API calls from the client,
@@ -2107,11 +2133,6 @@ public class GetLeaderboardAroundCharacterRequest : PlayFabRequestCommon
         /// </summary>
         public string CharacterId;
         /// <summary>
-        /// Optional character type on which to filter the leaderboard entries.
-        /// </summary>
-        [Obsolete("No longer available", true)]
-        public string CharacterType;
-        /// <summary>
         /// Maximum number of entries to retrieve. Default 10, maximum 100.
         /// </summary>
         public int? MaxResultsCount;
@@ -2621,7 +2642,8 @@ public class GetPlayerTradesResponse : PlayFabResultCommon
     public class GetPlayFabIDsFromFacebookIDsRequest : PlayFabRequestCommon
     {
         /// <summary>
-        /// Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers.
+        /// Array of unique Facebook identifiers for which the title needs to get PlayFab identifiers. The array cannot exceed 2,000
+        /// in length.
         /// </summary>
         public List<string> FacebookIDs;
     }
@@ -2642,7 +2664,8 @@ public class GetPlayFabIDsFromFacebookIDsResult : PlayFabResultCommon
     public class GetPlayFabIDsFromFacebookInstantGamesIdsRequest : PlayFabRequestCommon
     {
         /// <summary>
-        /// Array of unique Facebook Instant Games identifiers for which the title needs to get PlayFab identifiers.
+        /// Array of unique Facebook Instant Games identifiers for which the title needs to get PlayFab identifiers. The array
+        /// cannot exceed 25 in length.
         /// </summary>
         public List<string> FacebookInstantGamesIds;
     }
@@ -2664,6 +2687,7 @@ public class GetPlayFabIDsFromGameCenterIDsRequest : PlayFabRequestCommon
     {
         /// <summary>
         /// Array of unique Game Center identifiers (the Player Identifier) for which the title needs to get PlayFab identifiers.
+        /// The array cannot exceed 2,000 in length.
         /// </summary>
         public List<string> GameCenterIDs;
     }
@@ -2706,7 +2730,8 @@ public class GetPlayFabIDsFromGenericIDsResult : PlayFabResultCommon
     public class GetPlayFabIDsFromGoogleIDsRequest : PlayFabRequestCommon
     {
         /// <summary>
-        /// Array of unique Google identifiers (Google+ user IDs) for which the title needs to get PlayFab identifiers.
+        /// Array of unique Google identifiers (Google+ user IDs) for which the title needs to get PlayFab identifiers. The array
+        /// cannot exceed 2,000 in length.
         /// </summary>
         public List<string> GoogleIDs;
     }
@@ -2728,6 +2753,7 @@ public class GetPlayFabIDsFromGooglePlayGamesPlayerIDsRequest : PlayFabRequestCo
     {
         /// <summary>
         /// Array of unique Google Play Games identifiers (Google+ user IDs) for which the title needs to get PlayFab identifiers.
+        /// The array cannot exceed 2,000 in length.
         /// </summary>
         public List<string> GooglePlayGamesPlayerIDs;
     }
@@ -2748,7 +2774,8 @@ public class GetPlayFabIDsFromGooglePlayGamesPlayerIDsResult : PlayFabResultComm
     public class GetPlayFabIDsFromKongregateIDsRequest : PlayFabRequestCommon
     {
         /// <summary>
-        /// Array of unique Kongregate identifiers (Kongregate's user_id) for which the title needs to get PlayFab identifiers.
+        /// Array of unique Kongregate identifiers (Kongregate's user_id) for which the title needs to get PlayFab identifiers. The
+        /// array cannot exceed 2,000 in length.
         /// </summary>
         public List<string> KongregateIDs;
     }
@@ -2769,7 +2796,8 @@ public class GetPlayFabIDsFromKongregateIDsResult : PlayFabResultCommon
     public class GetPlayFabIDsFromNintendoServiceAccountIdsRequest : PlayFabRequestCommon
     {
         /// <summary>
-        /// Array of unique Nintendo Switch Account identifiers for which the title needs to get PlayFab identifiers.
+        /// Array of unique Nintendo Switch Account identifiers for which the title needs to get PlayFab identifiers. The array
+        /// cannot exceed 2,000 in length.
         /// </summary>
         public List<string> NintendoAccountIds;
     }
@@ -2790,7 +2818,8 @@ public class GetPlayFabIDsFromNintendoServiceAccountIdsResult : PlayFabResultCom
     public class GetPlayFabIDsFromNintendoSwitchDeviceIdsRequest : PlayFabRequestCommon
     {
         /// <summary>
-        /// Array of unique Nintendo Switch Device identifiers for which the title needs to get PlayFab identifiers.
+        /// Array of unique Nintendo Switch Device identifiers for which the title needs to get PlayFab identifiers. The array
+        /// cannot exceed 2,000 in length.
         /// </summary>
         public List<string> NintendoSwitchDeviceIds;
     }
@@ -2815,7 +2844,8 @@ public class GetPlayFabIDsFromPSNAccountIDsRequest : PlayFabRequestCommon
         /// </summary>
         public int? IssuerId;
         /// <summary>
-        /// Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers.
+        /// Array of unique PlayStation :tm: Network identifiers for which the title needs to get PlayFab identifiers. The array
+        /// cannot exceed 2,000 in length.
         /// </summary>
         public List<string> PSNAccountIDs;
     }
@@ -2836,7 +2866,8 @@ public class GetPlayFabIDsFromPSNAccountIDsResult : PlayFabResultCommon
     public class GetPlayFabIDsFromSteamIDsRequest : PlayFabRequestCommon
     {
         /// <summary>
-        /// Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers.
+        /// Array of unique Steam identifiers (Steam profile IDs) for which the title needs to get PlayFab identifiers. The array
+        /// cannot exceed 2,000 in length.
         /// </summary>
         public List<string> SteamStringIDs;
     }
@@ -2857,7 +2888,8 @@ public class GetPlayFabIDsFromSteamIDsResult : PlayFabResultCommon
     public class GetPlayFabIDsFromTwitchIDsRequest : PlayFabRequestCommon
     {
         /// <summary>
-        /// Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers.
+        /// Array of unique Twitch identifiers (Twitch's _id) for which the title needs to get PlayFab identifiers. The array cannot
+        /// exceed 2,000 in length.
         /// </summary>
         public List<string> TwitchIds;
     }
@@ -2882,7 +2914,8 @@ public class GetPlayFabIDsFromXboxLiveIDsRequest : PlayFabRequestCommon
         /// </summary>
         public string Sandbox;
         /// <summary>
-        /// Array of unique Xbox Live account identifiers for which the title needs to get PlayFab identifiers.
+        /// Array of unique Xbox Live account identifiers for which the title needs to get PlayFab identifiers. The array cannot
+        /// exceed 2,000 in length.
         /// </summary>
         public List<string> XboxLiveAccountIDs;
     }

diff --git a/CloudScript/PlayFabCloudScriptModels.cs b/CloudScript/PlayFabCloudScriptModels.cs
@@ -892,10 +892,6 @@ public class PostFunctionResultForPlayerTriggeredActionRequest : PlayFabRequestC
         /// </summary>
         public Dictionary<string,string> CustomTags;
         /// <summary>
-        /// The optional entity to perform this action on. Defaults to the currently logged in entity.
-        /// </summary>
-        public EntityKey Entity;
-        /// <summary>
         /// The result of the function execution.
         /// </summary>
         public ExecuteFunctionResult FunctionResult;
@@ -917,10 +913,6 @@ public class PostFunctionResultForScheduledTaskRequest : PlayFabRequestCommon
         /// </summary>
         public Dictionary<string,string> CustomTags;
         /// <summary>
-        /// The entity to perform this action on.
-        /// </summary>
-        public EntityKey Entity;
-        /// <summary>
         /// The result of the function execution
         /// </summary>
         public ExecuteFunctionResult FunctionResult;

diff --git a/Economy/PlayFabEconomyAPI.cs b/Economy/PlayFabEconomyAPI.cs
@@ -331,6 +331,19 @@ public static void GetMicrosoftStoreAccessTokens(GetMicrosoftStoreAccessTokensRe
             PlayFabHttp.MakeApiCall("/Inventory/GetMicrosoftStoreAccessTokens", request, AuthType.EntityToken, resultCallback, errorCallback, customData, extraHeaders, context, callSettings);
         }
 
+        /// <summary>
+        /// Get transaction history.
+        /// </summary>
+        public static void GetTransactionHistory(GetTransactionHistoryRequest request, Action<GetTransactionHistoryResponse> resultCallback, Action<PlayFabError> errorCallback, object customData = null, Dictionary<string, string> extraHeaders = null)
+        {
+            var context = (request == null ? null : request.AuthenticationContext) ?? PlayFabSettings.staticPlayer;
+            var callSettings = PlayFabSettings.staticSettings;
+            if (!context.IsEntityLoggedIn()) throw new PlayFabException(PlayFabExceptionCode.NotLoggedIn,"Must be logged in to call this method");
+
+
+            PlayFabHttp.MakeApiCall("/Inventory/GetTransactionHistory", request, AuthType.EntityToken, resultCallback, errorCallback, customData, extraHeaders, context, callSettings);
+        }
+
         /// <summary>
         /// Initiates a publish of an item from the working catalog to the public catalog.
         /// </summary>