https://api.playfab.com/releaseNotes/#181204

Source/PlayFabSDK/Authentication/PlayFabAuthenticationModels.cs

@@ -21,6 +21,13 @@ public class EntityKey
         public string Type;
     }
 
+    /// <summary>
+    /// This API must be called with X-SecretKey, X-Authentication or X-EntityToken headers. An optional EntityKey may be
+    /// included to attempt to set the resulting EntityToken to a specific entity, however the entity must be a relation of the
+    /// caller, such as the master_player_account of a character. If sending X-EntityToken the account will be marked as freshly
+    /// logged in and will issue a new token. If using X-Authentication or X-EntityToken the header must still be valid and
+    /// cannot be expired or revoked.
+    /// </summary>
     [Serializable]
     public class GetEntityTokenRequest : PlayFabRequestCommon
     {

Source/PlayFabSDK/CloudScript/PlayFabCloudScriptModels.cs

@@ -79,6 +79,9 @@ public class ExecuteCloudScriptResult : PlayFabResultCommon
         public int Revision;
     }
 
+    /// <summary>
+    /// Executes CloudScript with the entity profile that is defined in the request.
+    /// </summary>
     [Serializable]
     public class ExecuteEntityCloudScriptRequest : PlayFabRequestCommon
     {

Source/PlayFabSDK/Data/PlayFabDataModels.cs

@@ -5,6 +5,9 @@
 
 namespace PlayFab.DataModels
 {
+    /// <summary>
+    /// Aborts the pending upload of the requested files.
+    /// </summary>
     [Serializable]
     public class AbortFileUploadsRequest : PlayFabRequestCommon
     {
@@ -36,6 +39,9 @@ public class AbortFileUploadsResponse : PlayFabResultCommon
         public int ProfileVersion;
     }
 
+    /// <summary>
+    /// Deletes the requested files from the entity's profile.
+    /// </summary>
     [Serializable]
     public class DeleteFilesRequest : PlayFabRequestCommon
     {
@@ -83,6 +89,10 @@ public class EntityKey
         public string Type;
     }
 
+    /// <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>
     [Serializable]
     public class FinalizeFileUploadsRequest : PlayFabRequestCommon
     {
@@ -138,6 +148,11 @@ public class GetFileMetadata
         public int Size;
     }
 
+    /// <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>
     [Serializable]
     public class GetFilesRequest : PlayFabRequestCommon
     {
@@ -164,6 +179,9 @@ public class GetFilesResponse : PlayFabResultCommon
         public int ProfileVersion;
     }
 
+    /// <summary>
+    /// Gets JSON objects from an entity profile and returns it.
+    /// </summary>
     [Serializable]
     public class GetObjectsRequest : PlayFabRequestCommon
     {
@@ -208,6 +226,10 @@ public class InitiateFileUploadMetadata
         public string UploadUrl;
     }
 
+    /// <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>
     [Serializable]
     public class InitiateFileUploadsRequest : PlayFabRequestCommon
     {
@@ -308,6 +330,13 @@ public class SetObjectInfo
         public OperationTypes? SetResult;
     }
 
+    /// <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>
     [Serializable]
     public class SetObjectsRequest : PlayFabRequestCommon
     {

Source/PlayFabSDK/Groups/PlayFabGroupsModels.cs

@@ -5,6 +5,10 @@
 
 namespace PlayFab.GroupsModels
 {
+    /// <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>
     [Serializable]
     public class AcceptGroupApplicationRequest : PlayFabRequestCommon
     {
@@ -19,6 +23,11 @@ public class AcceptGroupApplicationRequest : PlayFabRequestCommon
         public EntityKey Group;
     }
 
+    /// <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>
     [Serializable]
     public class AcceptGroupInvitationRequest : PlayFabRequestCommon
     {
@@ -32,6 +41,11 @@ public class AcceptGroupInvitationRequest : PlayFabRequestCommon
         public EntityKey Group;
     }
 
+    /// <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>
     [Serializable]
     public class AddMembersRequest : PlayFabRequestCommon
     {
@@ -50,6 +64,13 @@ public class AddMembersRequest : PlayFabRequestCommon
         public string RoleId;
     }
 
+    /// <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>
     [Serializable]
     public class ApplyToGroupRequest : PlayFabRequestCommon
     {
@@ -87,6 +108,11 @@ public class ApplyToGroupResponse : PlayFabResultCommon
         public EntityKey Group;
     }
 
+    /// <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>
     [Serializable]
     public class BlockEntityRequest : PlayFabRequestCommon
     {
@@ -100,6 +126,11 @@ public class BlockEntityRequest : PlayFabRequestCommon
         public EntityKey Group;
     }
 
+    /// <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>
     [Serializable]
     public class ChangeMemberRoleRequest : PlayFabRequestCommon
     {
@@ -123,6 +154,10 @@ public class ChangeMemberRoleRequest : PlayFabRequestCommon
         public string OriginRoleId;
     }
 
+    /// <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>
     [Serializable]
     public class CreateGroupRequest : PlayFabRequestCommon
     {
@@ -169,6 +204,11 @@ public class CreateGroupResponse : PlayFabResultCommon
         public Dictionary<string,string> Roles;
     }
 
+    /// <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>
     [Serializable]
     public class CreateGroupRoleRequest : PlayFabRequestCommon
     {
@@ -205,6 +245,11 @@ public class CreateGroupRoleResponse : PlayFabResultCommon
         public string RoleName;
     }
 
+    /// <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>
     [Serializable]
     public class DeleteGroupRequest : PlayFabRequestCommon
     {
@@ -214,6 +259,9 @@ public class DeleteGroupRequest : PlayFabRequestCommon
         public EntityKey Group;
     }
 
+    /// <summary>
+    /// Returns information about the role
+    /// </summary>
     [Serializable]
     public class DeleteRoleRequest : PlayFabRequestCommon
     {
@@ -281,6 +329,9 @@ public class EntityWithLineage
         public Dictionary<string,EntityKey> Lineage;
     }
 
+    /// <summary>
+    /// Returns the ID, name, role list and other non-membership related information about a group.
+    /// </summary>
     [Serializable]
     public class GetGroupRequest : PlayFabRequestCommon
     {
@@ -431,6 +482,13 @@ public class GroupWithRoles
         public List<GroupRole> Roles;
     }
 
+    /// <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>
     [Serializable]
     public class InviteToGroupRequest : PlayFabRequestCommon
     {
@@ -481,6 +539,11 @@ public class InviteToGroupResponse : PlayFabResultCommon
         public string RoleId;
     }
 
+    /// <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>
     [Serializable]
     public class IsMemberRequest : PlayFabRequestCommon
     {
@@ -508,6 +571,10 @@ public class IsMemberResponse : PlayFabResultCommon
         public bool IsMember;
     }
 
+    /// <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>
     [Serializable]
     public class ListGroupApplicationsRequest : PlayFabRequestCommon
     {
@@ -526,6 +593,9 @@ public class ListGroupApplicationsResponse : PlayFabResultCommon
         public List<GroupApplication> Applications;
     }
 
+    /// <summary>
+    /// Lists all entities blocked from joining a group. A list of blocked entities is returned
+    /// </summary>
     [Serializable]
     public class ListGroupBlocksRequest : PlayFabRequestCommon
     {
@@ -544,6 +614,10 @@ public class ListGroupBlocksResponse : PlayFabResultCommon
         public List<GroupBlock> BlockedEntities;
     }
 
+    /// <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>
     [Serializable]
     public class ListGroupInvitationsRequest : PlayFabRequestCommon
     {
@@ -562,6 +636,11 @@ public class ListGroupInvitationsResponse : PlayFabResultCommon
         public List<GroupInvitation> Invitations;
     }
 
+    /// <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>
     [Serializable]
     public class ListGroupMembersRequest : PlayFabRequestCommon
     {
@@ -580,6 +659,11 @@ public class ListGroupMembersResponse : PlayFabResultCommon
         public List<EntityMemberRole> Members;
     }
 
+    /// <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>
     [Serializable]
     public class ListMembershipOpportunitiesRequest : PlayFabRequestCommon
     {
@@ -602,6 +686,11 @@ public class ListMembershipOpportunitiesResponse : PlayFabResultCommon
         public List<GroupInvitation> Invitations;
     }
 
+    /// <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>
     [Serializable]
     public class ListMembershipRequest : PlayFabRequestCommon
     {
@@ -628,6 +717,11 @@ public enum OperationTypes
         None
     }
 
+    /// <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>
     [Serializable]
     public class RemoveGroupApplicationRequest : PlayFabRequestCommon
     {
@@ -641,6 +735,12 @@ public class RemoveGroupApplicationRequest : PlayFabRequestCommon
         public EntityKey Group;
     }
 
+    /// <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>
     [Serializable]
     public class RemoveGroupInvitationRequest : PlayFabRequestCommon
     {
@@ -654,6 +754,10 @@ public class RemoveGroupInvitationRequest : PlayFabRequestCommon
         public EntityKey Group;
     }
 
+    /// <summary>
+    /// Removes members from a group. A member can always remove themselves from a group, regardless of permissions. Returns
+    /// nothing if successful.
+    /// </summary>
     [Serializable]
     public class RemoveMembersRequest : PlayFabRequestCommon
     {
@@ -671,6 +775,9 @@ public class RemoveMembersRequest : PlayFabRequestCommon
         public string RoleId;
     }
 
+    /// <summary>
+    /// Unblocks a list of entities from joining a group. No data is returned in the case of success.
+    /// </summary>
     [Serializable]
     public class UnblockEntityRequest : PlayFabRequestCommon
     {
@@ -684,6 +791,10 @@ public class UnblockEntityRequest : PlayFabRequestCommon
         public EntityKey Group;
     }
 
+    /// <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>
     [Serializable]
     public class UpdateGroupRequest : PlayFabRequestCommon
     {
@@ -728,6 +839,9 @@ public class UpdateGroupResponse : PlayFabResultCommon
         public OperationTypes? SetResult;
     }
 
+    /// <summary>
+    /// Updates the role name. Returns information about whether the update was successful.
+    /// </summary>
     [Serializable]
     public class UpdateGroupRoleRequest : PlayFabRequestCommon
     {