PlayFabDataDataModels.h

#import <Foundation/Foundation.h>
#import "PlayFabBaseModel.h"


typedef enum
{
    DataOperationTypesCreated,
    DataOperationTypesUpdated,
    DataOperationTypesDeleted,
    DataOperationTypesNone
} DataOperationTypes;

//predeclare all non-enum classes

@class DataAbortFileUploadsRequest;

@class DataAbortFileUploadsResponse;

@class DataDeleteFilesRequest;

@class DataDeleteFilesResponse;

@class DataEntityKey;

@class DataFinalizeFileUploadsRequest;

@class DataFinalizeFileUploadsResponse;

@class DataGetFileMetadata;

@class DataGetFilesRequest;

@class DataGetFilesResponse;

@class DataGetObjectsRequest;

@class DataGetObjectsResponse;

@class DataInitiateFileUploadMetadata;

@class DataInitiateFileUploadsRequest;

@class DataInitiateFileUploadsResponse;

@class DataObjectResult;

@class DataSetObject;

@class DataSetObjectInfo;

@class DataSetObjectsRequest;

@class DataSetObjectsResponse;



/// <summary>
/*
/// Aborts the pending upload of the requested files.
*/
/// </summary>
@interface DataAbortFileUploadsRequest : PlayFabBaseModel


/// <summary>
/*
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
*/
/// </summary>
@property NSDictionary* CustomTags; 

/// <summary>
/*
/// The entity to perform this action on.
*/
/// </summary>
@property DataEntityKey* Entity; 

/// <summary>
/*
/// Names of the files to have their pending uploads aborted.
*/
/// </summary>
@property NSArray* FileNames; 

/// <summary>
/*
/// The expected version of the profile, if set and doesn't match the current version of the profile the operation will not be performed.
*/
/// </summary>
@property NSNumber* ProfileVersion; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface DataAbortFileUploadsResponse : PlayFabBaseModel


/// <summary>
/*
/// The entity id and type.
*/
/// </summary>
@property DataEntityKey* Entity; 

/// <summary>
/*
/// The current version of the profile, can be used for concurrency control during updates.
*/
/// </summary>
@property NSNumber* ProfileVersion; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Deletes the requested files from the entity's profile.
*/
/// </summary>
@interface DataDeleteFilesRequest : PlayFabBaseModel


/// <summary>
/*
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
*/
/// </summary>
@property NSDictionary* CustomTags; 

/// <summary>
/*
/// The entity to perform this action on.
*/
/// </summary>
@property DataEntityKey* Entity; 

/// <summary>
/*
/// Names of the files to be deleted.
*/
/// </summary>
@property NSArray* FileNames; 

/// <summary>
/*
/// The expected version of the profile, if set and doesn't match the current version of the profile the operation will not be performed.
*/
/// </summary>
@property NSNumber* ProfileVersion; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface DataDeleteFilesResponse : PlayFabBaseModel


/// <summary>
/*
/// The entity id and type.
*/
/// </summary>
@property DataEntityKey* Entity; 

/// <summary>
/*
/// The current version of the profile, can be used for concurrency control during updates.
*/
/// </summary>
@property NSNumber* ProfileVersion; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Combined entity type and ID structure which uniquely identifies a single entity.
*/
/// </summary>
@interface DataEntityKey : PlayFabBaseModel


/// <summary>
/*
/// Unique ID of the entity.
*/
/// </summary>
@property NSString* Id; 

/// <summary>
/*
/// Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types
*/
/// </summary>
@property NSString* Type; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Finalizes the upload of the requested files. Verifies that the files have been successfully uploaded and moves the file pointers from pending to live.
*/
/// </summary>
@interface DataFinalizeFileUploadsRequest : PlayFabBaseModel


/// <summary>
/*
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
*/
/// </summary>
@property NSDictionary* CustomTags; 

/// <summary>
/*
/// The entity to perform this action on.
*/
/// </summary>
@property DataEntityKey* Entity; 

/// <summary>
/*
/// Names of the files to be finalized. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'
*/
/// </summary>
@property NSArray* FileNames; 

/// <summary>
/*
/// The current version of the profile, can be used for concurrency control during updates.
*/
/// </summary>
@property NSNumber* ProfileVersion; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface DataFinalizeFileUploadsResponse : PlayFabBaseModel


/// <summary>
/*
/// The entity id and type.
*/
/// </summary>
@property DataEntityKey* Entity; 

/// <summary>
/*
/// Collection of metadata for the entity's files
*/
/// </summary>
@property NSDictionary* Metadata; 

/// <summary>
/*
/// The current version of the profile, can be used for concurrency control during updates.
*/
/// </summary>
@property NSNumber* ProfileVersion; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface DataGetFileMetadata : PlayFabBaseModel


/// <summary>
/*
/// Checksum value for the file, can be used to check if the file on the server has changed.
*/
/// </summary>
@property NSString* Checksum; 

/// <summary>
/*
/// Download URL where the file can be retrieved
*/
/// </summary>
@property NSString* DownloadUrl; 

/// <summary>
/*
/// Name of the file
*/
/// </summary>
@property NSString* FileName; 

/// <summary>
/*
/// Last UTC time the file was modified
*/
/// </summary>
@property NSDate* LastModified; 

/// <summary>
/*
/// Storage service's reported byte count
*/
/// </summary>
@property NSNumber* Size; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Returns URLs that may be used to download the files for a profile for a limited length of time. Only returns files that have been successfully uploaded, files that are still pending will either return the old value, if it exists, or nothing.
*/
/// </summary>
@interface DataGetFilesRequest : PlayFabBaseModel


/// <summary>
/*
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
*/
/// </summary>
@property NSDictionary* CustomTags; 

/// <summary>
/*
/// The entity to perform this action on.
*/
/// </summary>
@property DataEntityKey* Entity; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface DataGetFilesResponse : PlayFabBaseModel


/// <summary>
/*
/// The entity id and type.
*/
/// </summary>
@property DataEntityKey* Entity; 

/// <summary>
/*
/// Collection of metadata for the entity's files
*/
/// </summary>
@property NSDictionary* Metadata; 

/// <summary>
/*
/// The current version of the profile, can be used for concurrency control during updates.
*/
/// </summary>
@property NSNumber* ProfileVersion; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Gets JSON objects from an entity profile and returns it. 
*/
/// </summary>
@interface DataGetObjectsRequest : PlayFabBaseModel


/// <summary>
/*
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
*/
/// </summary>
@property NSDictionary* CustomTags; 

/// <summary>
/*
/// The entity to perform this action on.
*/
/// </summary>
@property DataEntityKey* Entity; 

/// <summary>
/*
/// Determines whether the object will be returned as an escaped JSON string or as a un-escaped JSON object. Default is JSON object.
*/
/// </summary>
@property bool EscapeObject; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface DataGetObjectsResponse : PlayFabBaseModel


/// <summary>
/*
/// The entity id and type.
*/
/// </summary>
@property DataEntityKey* Entity; 

/// <summary>
/*
/// Requested objects that the calling entity has access to
*/
/// </summary>
@property NSDictionary* Objects; 

/// <summary>
/*
/// The current version of the profile, can be used for concurrency control during updates.
*/
/// </summary>
@property NSNumber* ProfileVersion; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface DataInitiateFileUploadMetadata : PlayFabBaseModel


/// <summary>
/*
/// Name of the file.
*/
/// </summary>
@property NSString* FileName; 

/// <summary>
/*
/// Location the data should be sent to via an HTTP PUT operation.
*/
/// </summary>
@property NSString* UploadUrl; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Returns URLs that may be used to upload the files for a profile 5 minutes. After using the upload calls FinalizeFileUploads must be called to move the file status from pending to live.
*/
/// </summary>
@interface DataInitiateFileUploadsRequest : PlayFabBaseModel


/// <summary>
/*
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
*/
/// </summary>
@property NSDictionary* CustomTags; 

/// <summary>
/*
/// The entity to perform this action on.
*/
/// </summary>
@property DataEntityKey* Entity; 

/// <summary>
/*
/// Names of the files to be set. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'
*/
/// </summary>
@property NSArray* FileNames; 

/// <summary>
/*
/// The expected version of the profile, if set and doesn't match the current version of the profile the operation will not be performed.
*/
/// </summary>
@property NSNumber* ProfileVersion; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface DataInitiateFileUploadsResponse : PlayFabBaseModel


/// <summary>
/*
/// The entity id and type.
*/
/// </summary>
@property DataEntityKey* Entity; 

/// <summary>
/*
/// The current version of the profile, can be used for concurrency control during updates.
*/
/// </summary>
@property NSNumber* ProfileVersion; 

/// <summary>
/*
/// Collection of file names and upload urls
*/
/// </summary>
@property NSArray* UploadDetails; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface DataObjectResult : PlayFabBaseModel


/// <summary>
/*
/// Un-escaped JSON object, if EscapeObject false or default.
*/
/// </summary>
@property NSDictionary* DataObject; 

/// <summary>
/*
/// Escaped string JSON body of the object, if EscapeObject is true.
*/
/// </summary>
@property NSString* EscapedDataObject; 

/// <summary>
/*
/// Name of the object. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'
*/
/// </summary>
@property NSString* ObjectName; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface DataSetObject : PlayFabBaseModel


/// <summary>
/*
/// Body of the object to be saved. If empty and DeleteObject is true object will be deleted if it exists, or no operation will occur if it does not exist. Only one of Object or EscapedDataObject fields may be used.
*/
/// </summary>
@property NSDictionary* DataObject; 

/// <summary>
/*
/// Flag to indicate that this object should be deleted. Both DataObject and EscapedDataObject must not be set as well.
*/
/// </summary>
@property bool DeleteObject; 

/// <summary>
/*
/// Body of the object to be saved as an escaped JSON string. If empty and DeleteObject is true object will be deleted if it exists, or no operation will occur if it does not exist. Only one of DataObject or EscapedDataObject fields may be used.
*/
/// </summary>
@property NSString* EscapedDataObject; 

/// <summary>
/*
/// Name of object. Restricted to a-Z, 0-9, '(', ')', '_', '-' and '.'.
*/
/// </summary>
@property NSString* ObjectName; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface DataSetObjectInfo : PlayFabBaseModel


/// <summary>
/*
/// Name of the object
*/
/// </summary>
@property NSString* ObjectName; 

/// <summary>
/*
/// Optional reason to explain why the operation was the result that it was.
*/
/// </summary>
@property NSString* OperationReason; 

/// <summary>
/*
/// Indicates which operation was completed, either Created, Updated, Deleted or None.
*/
/// </summary>
@property DataOperationTypes SetResult; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Sets JSON objects on the requested entity profile. May include a version number to be used to perform optimistic concurrency operations during update. If the current version differs from the version in the request the request will be ignored. If no version is set on the request then the value will always be updated if the values differ. Using the version value does not guarantee a write though, ConcurrentEditError may still occur if multiple clients are attempting to update the same profile. 
*/
/// </summary>
@interface DataSetObjectsRequest : PlayFabBaseModel


/// <summary>
/*
/// The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
*/
/// </summary>
@property NSDictionary* CustomTags; 

/// <summary>
/*
/// The entity to perform this action on.
*/
/// </summary>
@property DataEntityKey* Entity; 

/// <summary>
/*
/// 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.
*/
/// </summary>
@property NSNumber* ExpectedProfileVersion; 

/// <summary>
/*
/// Collection of objects to set on the profile.
*/
/// </summary>
@property NSArray* Objects; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface DataSetObjectsResponse : PlayFabBaseModel


/// <summary>
/*
/// New version of the entity profile.
*/
/// </summary>
@property NSNumber* ProfileVersion; 

/// <summary>
/*
/// New version of the entity profile.
*/
/// </summary>
@property NSArray* SetResults; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end