LootLockerServerResponse.h

Go to the documentation of this file.

// Copyright (c) 2021 LootLocker
 
#pragma once
#include "LootLockerServerResponse.generated.h"
 
USTRUCT(BlueprintType)
struct FLootLockerServerEmptyRequest
{
    GENERATED_BODY()
};
 
USTRUCT(BlueprintType)
struct FLootLockerServerErrorData
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Code;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Doc_url;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Request_id;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Trace_id;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    int Retry_after_seconds = -1;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Message;
};
 
USTRUCT(BlueprintType)
struct FLootLockerServerRequestContext
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString RequestTime = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString RequestId = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString RequestURL = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString RequestMethod = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString RequestParametersJsonString = "";
};
 
USTRUCT(BlueprintType)
struct FLootLockerServerResponse
{
    GENERATED_BODY()
    
    
    UPROPERTY(BlueprintReadWrite, Category = "LootLockerServer")
    bool Success = false;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    int StatusCode = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString FullTextFromServer;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FLootLockerServerErrorData ErrorData;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FLootLockerServerRequestContext RequestContext;
};
 
//==================================================
// C++ Delegate Definitions
//==================================================
 
/*
 C++ response delegate for a generic LootLocker Response
 */
DECLARE_DELEGATE_OneParam(FLootLockerServerResponseCallback, FLootLockerServerResponse);
 
//==================================================
// Definition of pagination data structures
//==================================================
 
USTRUCT(BlueprintType)
struct FLootLockerServerKeyBasedPagination
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, BlueprintReadWrite, Category = "LootLockerServer")
    int Total = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, BlueprintReadWrite, Category = "LootLockerServer")
    FString Next_Cursor = "";
    UPROPERTY(BlueprintReadWrite, EditAnywhere, BlueprintReadWrite, Category = "LootLockerServer")
    FString Previous_Cursor = "";
};
 
USTRUCT(BlueprintType)
struct FLootLockerServerIndexBasedPagination
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, BlueprintReadWrite, Category = "LootLockerServer")
    int32 Total = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, BlueprintReadWrite, Category = "LootLockerServer")
    int32 Next_Cursor = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, BlueprintReadWrite, Category = "LootLockerServer")
    int32 Previous_Cursor = 0;
};
 
USTRUCT(BlueprintType)
struct FLootLockerServerExtendedPaginationError
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Field;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Message;
};
 
USTRUCT(BlueprintType)
struct FLootLockerServerExtendedIndexBasedPagination
{
    GENERATED_BODY()
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    int32 Total = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    int32 Offset = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    int32 Per_page = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    int32 Last_page = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    int32 Current_page = 0;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Next_page;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    FString Prev_page;
    UPROPERTY(BlueprintReadWrite, EditAnywhere, Category = "LootLockerServer")
    TArray<FLootLockerServerExtendedPaginationError> Errors;
};
 
struct LootLockerServerStaticRequestErrorStatusCodes
{
    static const int LL_ERROR_UNDOCUMENTED = 0;
    static const int LL_ERROR_INVALID_HTTP = -1;
    static const int LL_ERROR_INVALID_INPUT = -2;
    static const int LL_ERROR_PARSE_ERROR = -3;
};
 
class LootLockerServerResponseFactory
{
public:
    // Construct a standardized error response
    template<typename T>
    static T Error(FString ErrorMessage, int StatusCode = 0, const FString& RequestId = "")
    {
        T ErrorResponse;
        ErrorResponse.Success = false;
        ErrorResponse.StatusCode = StatusCode;
        ErrorResponse.FullTextFromServer = "{ \"message\": \"" + ErrorMessage + "\"}";
        ErrorResponse.ErrorData.Message = ErrorMessage;
        ErrorResponse.RequestContext.RequestId = RequestId;
        return ErrorResponse;
    }
};