Document fields for entitlement history

Author: Erik Bylund

Runtime/Game/LootLockerSDKManager.cs

@@ -5560,9 +5560,9 @@ public static void ListEntitlements(int count, string after, Action<LootLockerEn
             if(count > 0 || !string.IsNullOrEmpty(after)) 
                 endpoint += endpoint.Contains("?") ? "&" : "?";
             if (count > 0)
-                endpoint += $"count={count}&";
+                endpoint += $"per_page={count}&";
             if (!string.IsNullOrEmpty(after))
-                endpoint += $"after={after}&";
+                endpoint += $"cursor={after}&";
 
             LootLockerServerRequest.CallAPI(endpoint, LootLockerEndPoints.listEntitlementHistory.httpMethod, onComplete: (serverResponse) => { LootLockerResponse.Deserialize(onComplete, serverResponse); });
         }

Runtime/Game/Requests/CatalogRequests.cs

@@ -205,7 +205,7 @@ public class LootLockerAssetDetails
        /// </summary>
         public int legacy_id { get; set; }
         /// <summary>
-       /// The unique identyfing id of this asset.
+       /// The unique identifying id of this asset
        /// </summary>
         public string id { get; set; }
         /// <summary>

Runtime/Game/Requests/EntitlementRequests.cs

@@ -1,4 +1,47 @@
-namespace LootLocker.Requests
+using LootLocker.LootLockerEnums;
+
+namespace LootLocker.LootLockerEnums
+{
+    /// <summary>
+    /// An enum with the supported stores that can generate entitlements
+    /// </summary>
+    public enum LootLockerEntitlementHistoryListingStore
+    {
+        None = 0,
+        Apple_app_store = 1,
+        Google_play_store = 2,
+        Steam_store = 3,
+        Playstation_network = 4,
+        Nintendo_eshop = 5,
+        Lootlocker = 6
+    };
+
+    /// <summary>
+    /// Status of the entitlement
+    /// </summary>
+    public enum LootLockerEntitlementHistoryListingStatus
+    {
+        None = 0,
+        Active = 1,
+        Pending = 2,
+        Expired = 3,
+        Canceled = 4,
+        Refunded = 5
+    };
+
+    /// <summary>
+    /// Status of the entitlement
+    /// </summary>
+    public enum LootLockerEntitlementHistoryListingType
+    {
+        Undefined = 0,
+        One_time_purchase = 1,
+        Leaderboard_reward = 2,
+        Subscription = 3
+    };
+}
+
+namespace LootLocker.Requests
 {
     //==================================================
     // Data Definitions
@@ -10,34 +53,34 @@ public class LootLockerEntitlementHistoryItem
     {
 
         /// <summary>
-        /// TODO: Document
+        /// When this item was created
         /// </summary>
-        public string created_at { get; set; }
+        public string Created_at { get; set; }
 
         /// <summary>
-        /// TODO: Document
+        /// What kind of reward this item is
         /// </summary>
-        public string reward_kind { get; set; }
+        public string Reward_kind { get; set; }
 
         /// <summary>
-        /// TODO: Document
+        /// The unique identifier of this specific item
         /// </summary>
-        public string id { get; set; }
+        public string Id { get; set; }
 
         /// <summary>
-        /// TODO: Document
+        /// The id of the reward this item is in
         /// </summary>
-        public string reward_id { get; set; }
+        public string Reward_id { get; set; }
 
         /// <summary>
-        /// TODO: Document
+        /// The id of the catalog item that this item is in
         /// </summary>
-        public string catalog_id { get; set; }
+        public string Catalog_id { get; set; }
 
         /// <summary>
-        /// TODO: Document
+        /// Whether this item is purchasable
         /// </summary>
-        public bool purchasable { get; set; }
+        public bool Purchasable { get; set; }
     }
 
     /// <summary>
@@ -46,14 +89,14 @@ public class LootLockerEntitlementHistoryMetadata
     {
 
         /// <summary>
-        /// TODO: Document
+        /// The key of this pair, describes what the value is
         /// </summary>
-        public string key { get; set; }
+        public string Key { get; set; }
 
         /// <summary>
-        /// TODO: Document
+        /// The value of this pair, contains the information of the metadata
         /// </summary>
-        public string value { get; set; }
+        public string Value { get; set; }
     }
 
     /// <summary>
@@ -62,24 +105,19 @@ public class LootLockerEntitlementHistoryReward
     {
 
         /// <summary>
-        /// TODO: Document
-        /// </summary>
-        public string created_at { get; set; }
-
-        /// <summary>
-        /// TODO: Document
+        /// When this reward was created
         /// </summary>
-        public string entitlement_id { get; set; }
+        public string Created_at { get; set; }
 
         /// <summary>
-        /// TODO: Document
+        /// The id of this entitlement
         /// </summary>
-        public string id { get; set; }
+        public string Entitlement_id { get; set; }
 
         /// <summary>
-        /// TODO: Document
+        /// The unique identifier of this reward
         /// </summary>
-        public string reward_id { get; set; }
+        public string Id { get; set; }
     }
 
     //==================================================
@@ -92,14 +130,14 @@ public class LootLockerEntitlementHistoryResponse : LootLockerResponse
     {
 
         /// <summary>
-        /// TODO: Document
+        /// List of entitlement history entries
         /// </summary>
-        public LootLockerEntitlementListing[] listings { get; set; }
-        
+        public LootLockerEntitlementListing[] Listings { get; set; }
+
         /// <summary>
-        /// TODO: Document
+        /// Pagination data to use for subsequent requests
         /// </summary>
-        public LootLockerPaginationResponse<string> pagination { get; set; }
+        public LootLockerPaginationResponse<string> Pagination { get; set; }
     }
 
     /// <summary>
@@ -108,48 +146,44 @@ public class LootLockerEntitlementListing
     {
 
         /// <summary>
-        /// TODO: Document
-        /// </summary>
-        public string created_at { get; set; }
-        
-        /// <summary>
-        /// TODO: Document
+        /// When this entitlement listing was created
         /// </summary>
-        public string id { get; set; }
+        public string Created_at { get; set; }
 
         /// <summary>
-        /// TODO: Document
+        /// The unique identifier of this entitlement listing
         /// </summary>
-        public LootLockerEntitlementHistoryItem[] items { get; set; }
-        
+        public string Id { get; set; }
+
         /// <summary>
-        /// TODO: Document
+        /// List of items in this entitlement (items are related to the catalog) 
         /// </summary>
-        public LootLockerEntitlementHistoryMetadata[] metadata { get; set; }
-        
+        public LootLockerEntitlementHistoryItem[] Items { get; set; }
+
         /// <summary>
-        /// TODO: Document
+        /// List of rewards in this entitlement (these are rewards from systems such as leaderboards, progressions, etc.) 
         /// </summary>
-        public string player_id { get; set; }
-        
+        public LootLockerEntitlementHistoryReward[] Rewards { get; set; }
+
         /// <summary>
-        /// TODO: Document
+        /// Metadata related to this entitlement listing
+        /// This array consists of key value pairs and contains various pieces of information about the entitlement, such as information from third party stores etc.
         /// </summary>
-        public LootLockerEntitlementHistoryReward[] rewards { get; set; }
-        
+        public LootLockerEntitlementHistoryMetadata[] Metadata { get; set; }
+
         /// <summary>
-        /// TODO: Document
+        /// The status of this entitlement listing
         /// </summary>
-        public string status { get; set; }
-        
+        public LootLockerEntitlementHistoryListingStatus Status { get; set; } = LootLockerEntitlementHistoryListingStatus.None;
+
         /// <summary>
-        /// TODO: Document
+        /// Which store (if any) that this entitlement listing relates to
         /// </summary>
-        public string store { get; set; }
-        
+        public LootLockerEntitlementHistoryListingStore Store { get; set; } = LootLockerEntitlementHistoryListingStore.None;
+
         /// <summary>
-        /// TODO: Document
+        /// Which type this entitlement listing is
         /// </summary>
-        public string type { get; set; }
+        public LootLockerEntitlementHistoryListingType Type { get; set; } = LootLockerEntitlementHistoryListingType.Undefined;
     }
 }