LootLockerEntitlementRequestHandler.h

Go to the documentation of this file.

// Copyright (c) 2021 LootLocker
 
#pragma once
 
 
#include "CoreMinimal.h"
#include "LootLockerResponse.h"
#include "LootLockerPlayerData.h"
#include "LootLockerEntitlementRequestHandler.generated.h"
 
//==================================================
// Data Type Definitions
//==================================================

UENUM(BlueprintType, Category = "LootLocker")
enum class ELootLockerEntitlementHistoryListingStore : uint8
{
    None = 0,
    Apple_app_store = 1,
    Google_play_store = 2,
    Steam_store = 3,
    Playstation_network = 4,
    Nintendo_eshop = 5,
    Lootlocker = 6
};


UENUM(BlueprintType, Category = "LootLocker")
enum class ELootLockerEntitlementHistoryListingStatus : uint8
{
    None = 0,
    Active = 1,
    Pending = 2,
    Expired = 3,
    Canceled = 4,
    Refunded = 5
};


UENUM(BlueprintType, Category = "LootLocker")
enum class ELootLockerEntitlementHistoryListingType : uint8
{
    Undefined = 0,
    One_time_purchase = 1,
    Leaderboard_reward = 2,
    Subscription = 3
};


UENUM(BlueprintType, Category = "LootLocker")
enum class ELootLockerEntitlementRewardEntityKind : uint8
{
    Asset = 0,
    Currency = 1,
    Progression_Points = 2,
    Progression_Reset = 3,
    Group = 4,
};


USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerEntitlementHistoryItem
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Created_at = "";

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerEntitlementRewardEntityKind Reward_kind = ELootLockerEntitlementRewardEntityKind::Asset;

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Id = "";

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Reward_id = "";

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Catalog_id = "";

    bool Purchasable = false;
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerEntitlementHistoryMetadata
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Key = "";

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Value = "";
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerEntitlementHistoryReward
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Created_at = "";

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Entitlement_id = "";

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Id = "";
};

USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerEntitlementListing
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Created_at = "";

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString Id = "";

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerEntitlementHistoryItem> Items;

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerEntitlementHistoryReward> Rewards;

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerEntitlementHistoryMetadata> Metadata;

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerEntitlementHistoryListingStatus Status = ELootLockerEntitlementHistoryListingStatus::None;

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerEntitlementHistoryListingStore Store = ELootLockerEntitlementHistoryListingStore::None;

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerEntitlementHistoryListingType Type = ELootLockerEntitlementHistoryListingType::Undefined;
};
 
//==================================================
// Response Definitions
//==================================================
USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerEntitlementHistoryResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerEntitlementListing> Listings;

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FLootLockerKeyBasedPagination Pagination;
};
 
USTRUCT(BlueprintType, Category = "LootLocker")
struct FLootLockerSingleEntitlementResponse : public FLootLockerResponse
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    FString created_at = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerEntitlementHistoryListingStatus Status = ELootLockerEntitlementHistoryListingStatus::None;

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerEntitlementHistoryListingStore Store = ELootLockerEntitlementHistoryListingStore::None;

    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    ELootLockerEntitlementHistoryListingType Type = ELootLockerEntitlementHistoryListingType::Undefined;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerEntitlementHistoryItem> Items;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLocker")
    TArray<FLootLockerEntitlementHistoryMetadata> Metadata;
};
 
//==================================================
// Delegate Definitions
//==================================================

DECLARE_DELEGATE_OneParam(FLootLockerListEntitlementsResponseDelegate, FLootLockerEntitlementHistoryResponse);
DECLARE_DELEGATE_OneParam(FLootLockerSingleEntitlementResponseDelegate, FLootLockerSingleEntitlementResponse);
 
//==================================================
// API Class Definition
//==================================================

UCLASS()
class LOOTLOCKERSDK_API ULootLockerEntitlementRequestHandler : public UObject
{
    GENERATED_BODY()
public:
    ULootLockerEntitlementRequestHandler() {};
 
    static FString ListEntitlements(const FLootLockerPlayerData& PlayerData, int Count, const FString& After, const FLootLockerListEntitlementsResponseDelegate& OnComplete);
    static FString GetEntitlement(const FLootLockerPlayerData& PlayerData, FString EntitlementID, const FLootLockerSingleEntitlementResponseDelegate& OnComplete);
};