PlayFabGroupsDataModels.h

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


typedef enum
{
    GroupsOperationTypesCreated,
    GroupsOperationTypesUpdated,
    GroupsOperationTypesDeleted,
    GroupsOperationTypesNone
} GroupsOperationTypes;

//predeclare all non-enum classes

@class GroupsAcceptGroupApplicationRequest;

@class GroupsAcceptGroupInvitationRequest;

@class GroupsAddMembersRequest;

@class GroupsApplyToGroupRequest;

@class GroupsApplyToGroupResponse;

@class GroupsBlockEntityRequest;

@class GroupsChangeMemberRoleRequest;

@class GroupsCreateGroupRequest;

@class GroupsCreateGroupResponse;

@class GroupsCreateGroupRoleRequest;

@class GroupsCreateGroupRoleResponse;

@class GroupsDeleteGroupRequest;

@class GroupsDeleteRoleRequest;

@class GroupsEmptyResponse;

@class GroupsEntityKey;

@class GroupsEntityMemberRole;

@class GroupsEntityWithLineage;

@class GroupsGetGroupRequest;

@class GroupsGetGroupResponse;

@class GroupsGroupApplication;

@class GroupsGroupBlock;

@class GroupsGroupInvitation;

@class GroupsGroupRole;

@class GroupsGroupWithRoles;

@class GroupsInviteToGroupRequest;

@class GroupsInviteToGroupResponse;

@class GroupsIsMemberRequest;

@class GroupsIsMemberResponse;

@class GroupsListGroupApplicationsRequest;

@class GroupsListGroupApplicationsResponse;

@class GroupsListGroupBlocksRequest;

@class GroupsListGroupBlocksResponse;

@class GroupsListGroupInvitationsRequest;

@class GroupsListGroupInvitationsResponse;

@class GroupsListGroupMembersRequest;

@class GroupsListGroupMembersResponse;

@class GroupsListMembershipOpportunitiesRequest;

@class GroupsListMembershipOpportunitiesResponse;

@class GroupsListMembershipRequest;

@class GroupsListMembershipResponse;

@class GroupsRemoveGroupApplicationRequest;

@class GroupsRemoveGroupInvitationRequest;

@class GroupsRemoveMembersRequest;

@class GroupsUnblockEntityRequest;

@class GroupsUpdateGroupRequest;

@class GroupsUpdateGroupResponse;

@class GroupsUpdateGroupRoleRequest;

@class GroupsUpdateGroupRoleResponse;



/// <summary>
/*
/// Accepts an outstanding invitation to to join a group if the invited entity is not blocked by the group. Nothing is returned in the case of success.
*/
/// </summary>
@interface GroupsAcceptGroupApplicationRequest : PlayFabBaseModel


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

/// <summary>
/*
/// Type of the entity to accept as. Must be the same entity as the claimant or an entity that is a child of the claimant entity.
*/
/// </summary>
@property GroupsEntityKey* Entity; 

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Accepts an outstanding invitation to join the group if the invited entity is not blocked by the group. Only the invited entity or a parent in its chain (e.g. title) may accept the invitation on the invited entity's behalf. Nothing is returned in the case of success.
*/
/// </summary>
@interface GroupsAcceptGroupInvitationRequest : PlayFabBaseModel


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

/// <summary>
/*
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
*/
/// </summary>
@property GroupsEntityKey* Entity; 

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Adds members to a group or role. Existing members of the group will added to roles within the group, but if the user is not already a member of the group, only title claimants may add them to the group, and others must use the group application or invite system to add new members to a group. Returns nothing if successful.
*/
/// </summary>
@interface GroupsAddMembersRequest : PlayFabBaseModel


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

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// List of entities to add to the group. Only entities of type title_player_account and character may be added to groups.
*/
/// </summary>
@property NSArray* Members; 

/// <summary>
/*
/// Optional: The ID of the existing role to add the entities to. If this is not specified, the default member role for the group will be used. Role IDs must be between 1 and 64 characters long.
*/
/// </summary>
@property NSString* RoleId; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Creates an application to join a group. Calling this while a group application already exists will return the same application instead of an error and will not refresh the time before the application expires. By default, if the entity has an invitation to join the group outstanding, this will accept the invitation to join the group instead and return an error indicating such, rather than creating a duplicate application to join that will need to be cleaned up later. Returns information about the application or an error indicating an invitation was accepted instead.
*/
/// </summary>
@interface GroupsApplyToGroupRequest : PlayFabBaseModel


/// <summary>
/*
/// Optional, default true. Automatically accept an outstanding invitation if one exists instead of creating an application
*/
/// </summary>
@property bool AutoAcceptOutstandingInvite; 

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

/// <summary>
/*
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
*/
/// </summary>
@property GroupsEntityKey* Entity; 

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Describes an application to join a group
*/
/// </summary>
@interface GroupsApplyToGroupResponse : PlayFabBaseModel


/// <summary>
/*
/// Type of entity that requested membership
*/
/// </summary>
@property GroupsEntityWithLineage* Entity; 

/// <summary>
/*
/// When the application to join will expire and be deleted
*/
/// </summary>
@property NSDate* Expires; 

/// <summary>
/*
/// ID of the group that the entity requesting membership to
*/
/// </summary>
@property GroupsEntityKey* Group; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Blocks a list of entities from joining a group. Blocked entities may not create new applications to join, be invited to join, accept an invitation, or have an application accepted. Failure due to being blocked does not clean up existing applications or invitations to the group. No data is returned in the case of success.
*/
/// </summary>
@interface GroupsBlockEntityRequest : 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 GroupsEntityKey* Entity; 

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Changes the role membership of a list of entities from one role to another in in a single operation. The destination role must already exist. This is equivalent to adding the entities to the destination role and removing from the origin role. Returns nothing if successful.
*/
/// </summary>
@interface GroupsChangeMemberRoleRequest : PlayFabBaseModel


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

/// <summary>
/*
/// The ID of the role that the entities will become a member of. This must be an existing role. Role IDs must be between 1 and 64 characters long.
*/
/// </summary>
@property NSString* DestinationRoleId; 

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// List of entities to move between roles in the group. All entities in this list must be members of the group and origin role.
*/
/// </summary>
@property NSArray* Members; 

/// <summary>
/*
/// The ID of the role that the entities currently are a member of. Role IDs must be between 1 and 64 characters long.
*/
/// </summary>
@property NSString* OriginRoleId; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Creates a new group, as well as administration and member roles, based off of a title's group template. Returns information about the group that was created.
*/
/// </summary>
@interface GroupsCreateGroupRequest : PlayFabBaseModel


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

/// <summary>
/*
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
*/
/// </summary>
@property GroupsEntityKey* Entity; 

/// <summary>
/*
/// The name of the group. This is unique at the title level by default.
*/
/// </summary>
@property NSString* GroupName; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface GroupsCreateGroupResponse : PlayFabBaseModel


/// <summary>
/*
/// The ID of the administrator role for the group.
*/
/// </summary>
@property NSString* AdminRoleId; 

/// <summary>
/*
/// The server date and time the group was created.
*/
/// </summary>
@property NSDate* Created; 

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// The name of the group.
*/
/// </summary>
@property NSString* GroupName; 

/// <summary>
/*
/// The ID of the default member role for the group.
*/
/// </summary>
@property NSString* MemberRoleId; 

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

/// <summary>
/*
/// The list of roles and names that belong to the group.
*/
/// </summary>
@property NSDictionary* Roles; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Creates a new role within an existing group, with no members. Both the role ID and role name must be unique within the group, but the name can be the same as the ID. The role ID is set at creation and cannot be changed. Returns information about the role that was created.
*/
/// </summary>
@interface GroupsCreateGroupRoleRequest : PlayFabBaseModel


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

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// The ID of the role. This must be unique within the group and cannot be changed. Role IDs must be between 1 and 64 characters long.
*/
/// </summary>
@property NSString* RoleId; 

/// <summary>
/*
/// The name of the role. This must be unique within the group and can be changed later. Role names must be between 1 and 100 characters long
*/
/// </summary>
@property NSString* RoleName; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface GroupsCreateGroupRoleResponse : PlayFabBaseModel


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

/// <summary>
/*
/// ID for the role
*/
/// </summary>
@property NSString* RoleId; 

/// <summary>
/*
/// The name of the role
*/
/// </summary>
@property NSString* RoleName; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Deletes a group and all roles, invitations, join requests, and blocks associated with it. Permission to delete is only required the group itself to execute this action. The group and data cannot be cannot be recovered once removed, but any abuse reports about the group will remain. No data is returned in the case of success.
*/
/// </summary>
@interface GroupsDeleteGroupRequest : PlayFabBaseModel


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

/// <summary>
/*
/// ID of the group or role to remove
*/
/// </summary>
@property GroupsEntityKey* Group; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Returns information about the role
*/
/// </summary>
@interface GroupsDeleteRoleRequest : PlayFabBaseModel


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

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// The ID of the role to delete. Role IDs must be between 1 and 64 characters long.
*/
/// </summary>
@property NSString* RoleId; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface GroupsEmptyResponse : PlayFabBaseModel

/*
@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 GroupsEntityKey : 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


@interface GroupsEntityMemberRole : PlayFabBaseModel


/// <summary>
/*
/// The list of members in the role
*/
/// </summary>
@property NSArray* Members; 

/// <summary>
/*
/// The ID of the role.
*/
/// </summary>
@property NSString* RoleId; 

/// <summary>
/*
/// The name of the role
*/
/// </summary>
@property NSString* RoleName; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Entity wrapper class that contains the entity key and the entities that make up the lineage of the entity.
*/
/// </summary>
@interface GroupsEntityWithLineage : PlayFabBaseModel


/// <summary>
/*
/// The entity key for the specified entity
*/
/// </summary>
@property GroupsEntityKey* Key; 

/// <summary>
/*
/// Dictionary of entity keys for related entities. Dictionary key is entity type.
*/
/// </summary>
@property NSDictionary* Lineage; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Returns the ID, name, role list and other non-membership related information about a group.
*/
/// </summary>
@interface GroupsGetGroupRequest : PlayFabBaseModel


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

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// The full name of the group
*/
/// </summary>
@property NSString* GroupName; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface GroupsGetGroupResponse : PlayFabBaseModel


/// <summary>
/*
/// The ID of the administrator role for the group.
*/
/// </summary>
@property NSString* AdminRoleId; 

/// <summary>
/*
/// The server date and time the group was created.
*/
/// </summary>
@property NSDate* Created; 

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// The name of the group.
*/
/// </summary>
@property NSString* GroupName; 

/// <summary>
/*
/// The ID of the default member role for the group.
*/
/// </summary>
@property NSString* MemberRoleId; 

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

/// <summary>
/*
/// The list of roles and names that belong to the group.
*/
/// </summary>
@property NSDictionary* Roles; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Describes an application to join a group
*/
/// </summary>
@interface GroupsGroupApplication : PlayFabBaseModel


/// <summary>
/*
/// Type of entity that requested membership
*/
/// </summary>
@property GroupsEntityWithLineage* Entity; 

/// <summary>
/*
/// When the application to join will expire and be deleted
*/
/// </summary>
@property NSDate* Expires; 

/// <summary>
/*
/// ID of the group that the entity requesting membership to
*/
/// </summary>
@property GroupsEntityKey* Group; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Describes an entity that is blocked from joining a group.
*/
/// </summary>
@interface GroupsGroupBlock : PlayFabBaseModel


/// <summary>
/*
/// The entity that is blocked
*/
/// </summary>
@property GroupsEntityWithLineage* Entity; 

/// <summary>
/*
/// ID of the group that the entity is blocked from
*/
/// </summary>
@property GroupsEntityKey* Group; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Describes an invitation to a group.
*/
/// </summary>
@interface GroupsGroupInvitation : PlayFabBaseModel


/// <summary>
/*
/// When the invitation will expire and be deleted
*/
/// </summary>
@property NSDate* Expires; 

/// <summary>
/*
/// The group that the entity invited to
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// The entity that created the invitation
*/
/// </summary>
@property GroupsEntityWithLineage* InvitedByEntity; 

/// <summary>
/*
/// The entity that is invited
*/
/// </summary>
@property GroupsEntityWithLineage* InvitedEntity; 

/// <summary>
/*
/// ID of the role in the group to assign the user to.
*/
/// </summary>
@property NSString* RoleId; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Describes a group role
*/
/// </summary>
@interface GroupsGroupRole : PlayFabBaseModel


/// <summary>
/*
/// ID for the role
*/
/// </summary>
@property NSString* RoleId; 

/// <summary>
/*
/// The name of the role
*/
/// </summary>
@property NSString* RoleName; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Describes a group and the roles that it contains
*/
/// </summary>
@interface GroupsGroupWithRoles : PlayFabBaseModel


/// <summary>
/*
/// ID for the group
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// The name of the group
*/
/// </summary>
@property NSString* GroupName; 

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

/// <summary>
/*
/// The list of roles within the group
*/
/// </summary>
@property NSArray* Roles; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Invites a player to join a group, if they are not blocked by the group. An optional role can be provided to automatically assign the player to the role if they accept the invitation. By default, if the entity has an application to the group outstanding, this will accept the application instead and return an error indicating such, rather than creating a duplicate invitation to join that will need to be cleaned up later. Returns information about the new invitation or an error indicating an existing application to join was accepted.
*/
/// </summary>
@interface GroupsInviteToGroupRequest : PlayFabBaseModel


/// <summary>
/*
/// Optional, default true. Automatically accept an application if one exists instead of creating an invitation
*/
/// </summary>
@property bool AutoAcceptOutstandingApplication; 

/// <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 GroupsEntityKey* Entity; 

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// Optional. ID of an existing a role in the group to assign the user to. The group's default member role is used if this is not specified. Role IDs must be between 1 and 64 characters long.
*/
/// </summary>
@property NSString* RoleId; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Describes an invitation to a group.
*/
/// </summary>
@interface GroupsInviteToGroupResponse : PlayFabBaseModel


/// <summary>
/*
/// When the invitation will expire and be deleted
*/
/// </summary>
@property NSDate* Expires; 

/// <summary>
/*
/// The group that the entity invited to
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// The entity that created the invitation
*/
/// </summary>
@property GroupsEntityWithLineage* InvitedByEntity; 

/// <summary>
/*
/// The entity that is invited
*/
/// </summary>
@property GroupsEntityWithLineage* InvitedEntity; 

/// <summary>
/*
/// ID of the role in the group to assign the user to.
*/
/// </summary>
@property NSString* RoleId; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Checks to see if an entity is a member of a group or role within the group. A result indicating if the entity is a member of the group is returned, or a permission error if the caller does not have permission to read the group's member list.
*/
/// </summary>
@interface GroupsIsMemberRequest : 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 GroupsEntityKey* Entity; 

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// Optional: ID of the role to check membership of. Defaults to any role (that is, check to see if the entity is a member of the group in any capacity) if not specified.
*/
/// </summary>
@property NSString* RoleId; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface GroupsIsMemberResponse : PlayFabBaseModel


/// <summary>
/*
/// A value indicating whether or not the entity is a member.
*/
/// </summary>
@property bool IsMember; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Lists all outstanding requests to join a group. Returns a list of all requests to join, as well as when the request will expire. To get the group applications for a specific entity, use ListMembershipOpportunities.
*/
/// </summary>
@interface GroupsListGroupApplicationsRequest : PlayFabBaseModel


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

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface GroupsListGroupApplicationsResponse : PlayFabBaseModel


/// <summary>
/*
/// The requested list of applications to the group.
*/
/// </summary>
@property NSArray* Applications; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Lists all entities blocked from joining a group. A list of blocked entities is returned
*/
/// </summary>
@interface GroupsListGroupBlocksRequest : PlayFabBaseModel


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

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface GroupsListGroupBlocksResponse : PlayFabBaseModel


/// <summary>
/*
/// The requested list blocked entities.
*/
/// </summary>
@property NSArray* BlockedEntities; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Lists all outstanding invitations for a group. Returns a list of entities that have been invited, as well as when the invitation will expire. To get the group invitations for a specific entity, use ListMembershipOpportunities.
*/
/// </summary>
@interface GroupsListGroupInvitationsRequest : PlayFabBaseModel


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

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface GroupsListGroupInvitationsResponse : PlayFabBaseModel


/// <summary>
/*
/// The requested list of group invitations.
*/
/// </summary>
@property NSArray* Invitations; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Gets a list of members and the roles they belong to within the group. If the caller does not have permission to view the role, and the member is in no other role, the member is not displayed. Returns a list of entities that are members of the group.
*/
/// </summary>
@interface GroupsListGroupMembersRequest : PlayFabBaseModel


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

/// <summary>
/*
/// ID of the group to list the members and roles for
*/
/// </summary>
@property GroupsEntityKey* Group; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface GroupsListGroupMembersResponse : PlayFabBaseModel


/// <summary>
/*
/// The requested list of roles and member entity IDs.
*/
/// </summary>
@property NSArray* Members; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Lists all outstanding group applications and invitations for an entity. Anyone may call this for any entity, but data will only be returned for the entity or a parent of that entity. To list invitations or applications for a group to check if a player is trying to join, use ListGroupInvitations and ListGroupApplications.
*/
/// </summary>
@interface GroupsListMembershipOpportunitiesRequest : PlayFabBaseModel


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

/// <summary>
/*
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
*/
/// </summary>
@property GroupsEntityKey* Entity; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface GroupsListMembershipOpportunitiesResponse : PlayFabBaseModel


/// <summary>
/*
/// The requested list of group applications.
*/
/// </summary>
@property NSArray* Applications; 

/// <summary>
/*
/// The requested list of group invitations.
*/
/// </summary>
@property NSArray* Invitations; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Lists the groups and roles that an entity is a part of, checking to see if group and role metadata and memberships should be visible to the caller. If the entity is not in any roles that are visible to the caller, the group is not returned in the results, even if the caller otherwise has permission to see that the entity is a member of that group.
*/
/// </summary>
@interface GroupsListMembershipRequest : PlayFabBaseModel


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

/// <summary>
/*
/// The optional entity to perform this action on. Defaults to the currently logged in entity.
*/
/// </summary>
@property GroupsEntityKey* Entity; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface GroupsListMembershipResponse : PlayFabBaseModel


/// <summary>
/*
/// The list of groups
*/
/// </summary>
@property NSArray* Groups; 
/*
@property NSObject* Request;
@property NSObject* CustomData;
*/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Removes an existing application to join the group. This is used for both rejection of an application as well as withdrawing an application. The applying entity or a parent in its chain (e.g. title) may withdraw the application, and any caller with appropriate access in the group may reject an application. No data is returned in the case of success.
*/
/// </summary>
@interface GroupsRemoveGroupApplicationRequest : 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 GroupsEntityKey* Entity; 

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Removes an existing invitation to join the group. This is used for both rejection of an invitation as well as rescinding an invitation. The invited entity or a parent in its chain (e.g. title) may reject the invitation by calling this method, and any caller with appropriate access in the group may rescind an invitation. No data is returned in the case of success.
*/
/// </summary>
@interface GroupsRemoveGroupInvitationRequest : 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 GroupsEntityKey* Entity; 

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Removes members from a group. A member can always remove themselves from a group, regardless of permissions. Returns nothing if successful.
*/
/// </summary>
@interface GroupsRemoveMembersRequest : PlayFabBaseModel


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

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// List of entities to remove
*/
/// </summary>
@property NSArray* Members; 

/// <summary>
/*
/// The ID of the role to remove the entities from.
*/
/// </summary>
@property NSString* RoleId; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Unblocks a list of entities from joining a group. No data is returned in the case of success.
*/
/// </summary>
@interface GroupsUnblockEntityRequest : 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 GroupsEntityKey* Entity; 

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


/// <summary>
/*
/// Updates data about a group, such as the name or default member role. Returns information about whether the update was successful. Only title claimants may modify the administration role for a group.
*/
/// </summary>
@interface GroupsUpdateGroupRequest : PlayFabBaseModel


/// <summary>
/*
/// Optional: the ID of an existing role to set as the new administrator role for the group
*/
/// </summary>
@property NSString* AdminRoleId; 

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

/// <summary>
/*
/// Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from the GetGroup API, you can ensure that the group data update will only be performed if the group has not been updated by any other clients since the version you last loaded.
*/
/// </summary>
@property NSNumber* ExpectedProfileVersion; 

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// Optional: the new name of the group
*/
/// </summary>
@property NSString* GroupName; 

/// <summary>
/*
/// Optional: the ID of an existing role to set as the new member role for the group
*/
/// </summary>
@property NSString* MemberRoleId; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface GroupsUpdateGroupResponse : PlayFabBaseModel


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

/// <summary>
/*
/// New version of the group data.
*/
/// </summary>
@property NSNumber* ProfileVersion; 

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


/// <summary>
/*
/// Updates the role name. Returns information about whether the update was successful.
*/
/// </summary>
@interface GroupsUpdateGroupRoleRequest : PlayFabBaseModel


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

/// <summary>
/*
/// Optional field used for concurrency control. By specifying the previously returned value of ProfileVersion from the GetGroup API, you can ensure that the group data update will only be performed if the group has not been updated by any other clients since the version you last loaded.
*/
/// </summary>
@property NSNumber* ExpectedProfileVersion; 

/// <summary>
/*
/// The identifier of the group
*/
/// </summary>
@property GroupsEntityKey* Group; 

/// <summary>
/*
/// ID of the role to update. Role IDs must be between 1 and 64 characters long.
*/
/// </summary>
@property NSString* RoleId; 

/// <summary>
/*
/// The new name of the role
*/
/// </summary>
@property NSString* RoleName; 
/**/
-(id)initWithDictionary:(NSDictionary*)properties;
@end


@interface GroupsUpdateGroupRoleResponse : PlayFabBaseModel


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

/// <summary>
/*
/// New version of the role data.
*/
/// </summary>
@property NSNumber* ProfileVersion; 

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