@community-fabs/playfab-web-sdk 1.193.250606-1

package/dist/Groups.d.ts

@@ -0,0 +1,785 @@
+import { I as IPlayFabRequestCommon, a as IPlayFabResultCommon, P as PlayFabCommon, E as EmptyResponse } from './PlayFabCommon-Dnp_xHg5.js';
+
+interface AcceptGroupApplicationRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /**
+     * 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.
+     */
+    Entity: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface AcceptGroupInvitationRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface AddMembersRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /** List of entities to add to the group. Only entities of type title_player_account and character may be added to groups. */
+    Members: EntityKey[];
+    /**
+     * 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.
+     */
+    RoleId?: string;
+}
+interface ApplyToGroupRequest extends IPlayFabRequestCommon {
+    /** Optional, default true. Automatically accept an outstanding invitation if one exists instead of creating an application */
+    AutoAcceptOutstandingInvite?: boolean;
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface ApplyToGroupResponse extends IPlayFabResultCommon {
+    /** Type of entity that requested membership */
+    Entity?: EntityWithLineage;
+    /** When the application to join will expire and be deleted */
+    Expires: string;
+    /** ID of the group that the entity requesting membership to */
+    Group?: EntityKey;
+}
+interface BlockEntityRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface ChangeMemberRoleRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /**
+     * 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.
+     */
+    DestinationRoleId?: string;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /**
+     * List of entities to move between roles in the group. All entities in this list must be members of the group and origin
+     * role.
+     */
+    Members: EntityKey[];
+    /** The ID of the role that the entities currently are a member of. Role IDs must be between 1 and 64 characters long. */
+    OriginRoleId: string;
+}
+interface CreateGroupRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+    /** The name of the group. This is unique at the title level by default. */
+    GroupName: string;
+}
+interface CreateGroupResponse extends IPlayFabResultCommon {
+    /** The ID of the administrator role for the group. */
+    AdminRoleId?: string;
+    /** The server date and time the group was created. */
+    Created: string;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /** The name of the group. */
+    GroupName?: string;
+    /** The ID of the default member role for the group. */
+    MemberRoleId?: string;
+    /** The current version of the profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+    /** The list of roles and names that belong to the group. */
+    Roles?: Record<string, string | null>;
+}
+interface CreateGroupRoleRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /**
+     * 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 and are restricted to a-Z, A-Z, 0-9, &#39;(&#39;, &#39;)&#39;, &#39;_&#39;, &#39;-&#39; and &#39;.&#39;.
+     */
+    RoleId: string;
+    /**
+     * 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
+     */
+    RoleName: string;
+}
+interface CreateGroupRoleResponse extends IPlayFabResultCommon {
+    /** The current version of the group profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+    /** ID for the role */
+    RoleId?: string;
+    /** The name of the role */
+    RoleName?: string;
+}
+interface DeleteGroupRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** ID of the group or role to remove */
+    Group: EntityKey;
+}
+interface DeleteRoleRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /** The ID of the role to delete. Role IDs must be between 1 and 64 characters long. */
+    RoleId?: string;
+}
+interface EntityKey {
+    /** Unique ID of the entity. */
+    Id: string;
+    /** Entity type. See https://docs.microsoft.com/gaming/playfab/features/data/entities/available-built-in-entity-types */
+    Type?: string;
+    /**
+     * Alternate name for Type.
+     * @deprecated Please use Type instead.
+     */
+    TypeString?: string;
+}
+interface EntityMemberRole {
+    /** The list of members in the role */
+    Members?: EntityWithLineage[];
+    /** The ID of the role. */
+    RoleId?: string;
+    /** The name of the role */
+    RoleName?: string;
+}
+interface EntityWithLineage {
+    /** The entity key for the specified entity */
+    Key?: EntityKey;
+    /** Dictionary of entity keys for related entities. Dictionary key is entity type. */
+    Lineage?: Record<string, EntityKey>;
+}
+interface GetGroupRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group?: EntityKey;
+    /** The full name of the group */
+    GroupName?: string;
+}
+interface GetGroupResponse extends IPlayFabResultCommon {
+    /** The ID of the administrator role for the group. */
+    AdminRoleId?: string;
+    /** The server date and time the group was created. */
+    Created: string;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /** The name of the group. */
+    GroupName?: string;
+    /** The ID of the default member role for the group. */
+    MemberRoleId?: string;
+    /** The current version of the profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+    /** The list of roles and names that belong to the group. */
+    Roles?: Record<string, string | null>;
+}
+interface GroupApplication {
+    /** Type of entity that requested membership */
+    Entity?: EntityWithLineage;
+    /** When the application to join will expire and be deleted */
+    Expires: string;
+    /** ID of the group that the entity requesting membership to */
+    Group?: EntityKey;
+}
+interface GroupBlock {
+    /** The entity that is blocked */
+    Entity?: EntityWithLineage;
+    /** ID of the group that the entity is blocked from */
+    Group: EntityKey;
+}
+interface GroupInvitation {
+    /** When the invitation will expire and be deleted */
+    Expires: string;
+    /** The group that the entity invited to */
+    Group?: EntityKey;
+    /** The entity that created the invitation */
+    InvitedByEntity?: EntityWithLineage;
+    /** The entity that is invited */
+    InvitedEntity?: EntityWithLineage;
+    /** ID of the role in the group to assign the user to. */
+    RoleId?: string;
+}
+interface GroupRole {
+    /** ID for the role */
+    RoleId?: string;
+    /** The name of the role */
+    RoleName?: string;
+}
+interface GroupWithRoles {
+    /** ID for the group */
+    Group?: EntityKey;
+    /** The name of the group */
+    GroupName?: string;
+    /** The current version of the profile, can be used for concurrency control during updates. */
+    ProfileVersion: number;
+    /** The list of roles within the group */
+    Roles?: GroupRole[];
+}
+interface InviteToGroupRequest extends IPlayFabRequestCommon {
+    /** Optional, default true. Automatically accept an application if one exists instead of creating an invitation */
+    AutoAcceptOutstandingApplication?: boolean;
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /**
+     * Optional. ID of an existing a role in the group to assign the user to. The group&#39;s default member role is used if this
+     * is not specified. Role IDs must be between 1 and 64 characters long.
+     */
+    RoleId?: string;
+}
+interface InviteToGroupResponse extends IPlayFabResultCommon {
+    /** When the invitation will expire and be deleted */
+    Expires: string;
+    /** The group that the entity invited to */
+    Group?: EntityKey;
+    /** The entity that created the invitation */
+    InvitedByEntity?: EntityWithLineage;
+    /** The entity that is invited */
+    InvitedEntity?: EntityWithLineage;
+    /** ID of the role in the group to assign the user to. */
+    RoleId?: string;
+}
+interface IsMemberRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /**
+     * 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.
+     */
+    RoleId?: string;
+}
+interface IsMemberResponse extends IPlayFabResultCommon {
+    /** A value indicating whether or not the entity is a member. */
+    IsMember: boolean;
+}
+interface ListGroupApplicationsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface ListGroupApplicationsResponse extends IPlayFabResultCommon {
+    /** The requested list of applications to the group. */
+    Applications?: GroupApplication[];
+}
+interface ListGroupBlocksRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface ListGroupBlocksResponse extends IPlayFabResultCommon {
+    /** The requested list blocked entities. */
+    BlockedEntities?: GroupBlock[];
+}
+interface ListGroupInvitationsRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface ListGroupInvitationsResponse extends IPlayFabResultCommon {
+    /** The requested list of group invitations. */
+    Invitations?: GroupInvitation[];
+}
+interface ListGroupMembersRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** ID of the group to list the members and roles for */
+    Group: EntityKey;
+}
+interface ListGroupMembersResponse extends IPlayFabResultCommon {
+    /** The requested list of roles and member entity IDs. */
+    Members?: EntityMemberRole[];
+}
+interface ListMembershipOpportunitiesRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+}
+interface ListMembershipOpportunitiesResponse extends IPlayFabResultCommon {
+    /** The requested list of group applications. */
+    Applications?: GroupApplication[];
+    /** The requested list of group invitations. */
+    Invitations?: GroupInvitation[];
+}
+interface ListMembershipRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The optional entity to perform this action on. Defaults to the currently logged in entity. */
+    Entity?: EntityKey;
+}
+interface ListMembershipResponse extends IPlayFabResultCommon {
+    /** The list of groups */
+    Groups?: GroupWithRoles[];
+}
+interface RemoveGroupApplicationRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface RemoveGroupInvitationRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface RemoveMembersRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /** List of entities to remove */
+    Members: EntityKey[];
+    /** The ID of the role to remove the entities from. */
+    RoleId?: string;
+}
+interface UnblockEntityRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /** The entity to perform this action on. */
+    Entity: EntityKey;
+    /** The identifier of the group */
+    Group: EntityKey;
+}
+interface UpdateGroupRequest extends IPlayFabRequestCommon {
+    /** Optional: the ID of an existing role to set as the new administrator role for the group */
+    AdminRoleId?: string;
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /**
+     * 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.
+     */
+    ExpectedProfileVersion?: number;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /** Optional: the new name of the group */
+    GroupName?: string;
+    /** Optional: the ID of an existing role to set as the new member role for the group */
+    MemberRoleId?: string;
+}
+interface UpdateGroupResponse extends IPlayFabResultCommon {
+    /** Optional reason to explain why the operation was the result that it was. */
+    OperationReason?: string;
+    /** New version of the group data. */
+    ProfileVersion: number;
+    /** Indicates which operation was completed, either Created, Updated, Deleted or None. */
+    SetResult?: string;
+}
+interface UpdateGroupRoleRequest extends IPlayFabRequestCommon {
+    /** The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.). */
+    CustomTags?: Record<string, string | null>;
+    /**
+     * 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.
+     */
+    ExpectedProfileVersion?: number;
+    /** The identifier of the group */
+    Group: EntityKey;
+    /** ID of the role to update. Role IDs must be between 1 and 64 characters long. */
+    RoleId?: string;
+    /** The new name of the role */
+    RoleName: string;
+}
+interface UpdateGroupRoleResponse extends IPlayFabResultCommon {
+    /** Optional reason to explain why the operation was the result that it was. */
+    OperationReason?: string;
+    /** New version of the role data. */
+    ProfileVersion: number;
+    /** Indicates which operation was completed, either Created, Updated, Deleted or None. */
+    SetResult?: string;
+}
+
+declare class PlayFabGroupsApi extends PlayFabCommon {
+    /**
+     * Accepts an outstanding invitation to to join a group
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/acceptgroupapplication Microsoft Documentation}
+     * @example
+     * await groupClient.AcceptGroupApplication({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    AcceptGroupApplication(request: AcceptGroupApplicationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Accepts an invitation to join a group
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/acceptgroupinvitation Microsoft Documentation}
+     * @example
+     * await groupClient.AcceptGroupInvitation({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
+     */
+    AcceptGroupInvitation(request: AcceptGroupInvitationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Adds members to a group or role.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/addmembers Microsoft Documentation}
+     * @example
+     * await groupClient.AddMembers({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "Members": [
+     *     {
+     *       "Id": "90901000",
+     *       "Type": "title_player_account",
+     *       "TypeString": "title_player_account"
+     *     }
+     *   ]
+     * });
+     */
+    AddMembers(request: AddMembersRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Applies to join a group
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/applytogroup Microsoft Documentation}
+     * @example
+     * await groupClient.ApplyToGroup({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
+     */
+    ApplyToGroup(request: ApplyToGroupRequest, extraHeaders?: Record<string, string>): Promise<ApplyToGroupResponse>;
+    /**
+     * Blocks a list of entities from joining a group.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/blockentity Microsoft Documentation}
+     * @example
+     * await groupClient.BlockEntity({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    BlockEntity(request: BlockEntityRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Changes the role membership of a list of entities from one role to another.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/changememberrole Microsoft Documentation}
+     * @example
+     * await groupClient.ChangeMemberRole({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "OriginRoleId": "awesomepeople",
+     *   "DestinationRoleId": "members",
+     *   "Members": [
+     *     {
+     *       "Id": "90901000",
+     *       "Type": "title_player_account",
+     *       "TypeString": "title_player_account"
+     *     }
+     *   ]
+     * });
+     */
+    ChangeMemberRole(request: ChangeMemberRoleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Creates a new group.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/creategroup Microsoft Documentation}
+     * @example
+     * await groupClient.CreateGroup({
+     *   "GroupName": "Example Group"
+     * });
+     */
+    CreateGroup(request: CreateGroupRequest, extraHeaders?: Record<string, string>): Promise<CreateGroupResponse>;
+    /**
+     * Creates a new group role.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/createrole Microsoft Documentation}
+     * @example
+     * await groupClient.CreateRole({
+     *   "RoleId": "example",
+     *   "RoleName": "Example Role",
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
+     */
+    CreateRole(request: CreateGroupRoleRequest, extraHeaders?: Record<string, string>): Promise<CreateGroupRoleResponse>;
+    /**
+     * Deletes a group and all roles, invitations, join requests, and blocks associated with it.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/deletegroup Microsoft Documentation}
+     * @example
+     * await groupClient.DeleteGroup({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
+     */
+    DeleteGroup(request: DeleteGroupRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Deletes an existing role in a group.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/deleterole Microsoft Documentation}
+     * @example
+     * await groupClient.DeleteRole({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "RoleId": "ABC1234DEF"
+     * });
+     */
+    DeleteRole(request: DeleteRoleRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Gets information about a group and its roles
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/getgroup Microsoft Documentation}
+     * @example
+     * await groupClient.GetGroup({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
+     */
+    GetGroup(request: GetGroupRequest, extraHeaders?: Record<string, string>): Promise<GetGroupResponse>;
+    /**
+     * Invites a player to join a group
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/invitetogroup Microsoft Documentation}
+     * @example
+     * await groupClient.InviteToGroup({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "RoleId": "awesomepeople",
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    InviteToGroup(request: InviteToGroupRequest, extraHeaders?: Record<string, string>): Promise<InviteToGroupResponse>;
+    /**
+     * Checks to see if an entity is a member of a group or role within the group
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/ismember Microsoft Documentation}
+     * @example
+     * await groupClient.IsMember({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "RoleId": "ABC1234DEF",
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    IsMember(request: IsMemberRequest, extraHeaders?: Record<string, string>): Promise<IsMemberResponse>;
+    /**
+     * Lists all outstanding requests to join a group
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupapplications Microsoft Documentation}
+     * @example
+     * await groupClient.ListGroupApplications({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
+     */
+    ListGroupApplications(request: ListGroupApplicationsRequest, extraHeaders?: Record<string, string>): Promise<ListGroupApplicationsResponse>;
+    /**
+     * Lists all entities blocked from joining a group
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupblocks Microsoft Documentation}
+     * @example
+     * await groupClient.ListGroupBlocks({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
+     */
+    ListGroupBlocks(request: ListGroupBlocksRequest, extraHeaders?: Record<string, string>): Promise<ListGroupBlocksResponse>;
+    /**
+     * Lists all outstanding invitations for a group
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupinvitations Microsoft Documentation}
+     * @example
+     * await groupClient.ListGroupInvitations({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
+     */
+    ListGroupInvitations(request: ListGroupInvitationsRequest, extraHeaders?: Record<string, string>): Promise<ListGroupInvitationsResponse>;
+    /**
+     * Lists all members for a group
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listgroupmembers Microsoft Documentation}
+     * @example
+     * await groupClient.ListGroupMembers({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   }
+     * });
+     */
+    ListGroupMembers(request: ListGroupMembersRequest, extraHeaders?: Record<string, string>): Promise<ListGroupMembersResponse>;
+    /**
+     * Lists all groups and roles for an entity
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listmembership Microsoft Documentation}
+     * @example
+     * await groupClient.ListMembership({});
+     */
+    ListMembership(request: ListMembershipRequest, extraHeaders?: Record<string, string>): Promise<ListMembershipResponse>;
+    /**
+     * Lists all outstanding invitations and group applications for an entity
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/listmembershipopportunities Microsoft Documentation}
+     * @example
+     * await groupClient.ListMembershipOpportunities({});
+     */
+    ListMembershipOpportunities(request: ListMembershipOpportunitiesRequest, extraHeaders?: Record<string, string>): Promise<ListMembershipOpportunitiesResponse>;
+    /**
+     * Removes an application to join a group
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/removegroupapplication Microsoft Documentation}
+     * @example
+     * await groupClient.RemoveGroupApplication({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    RemoveGroupApplication(request: RemoveGroupApplicationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Removes an invitation join a group
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/removegroupinvitation Microsoft Documentation}
+     * @example
+     * await groupClient.RemoveGroupInvitation({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    RemoveGroupInvitation(request: RemoveGroupInvitationRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Removes members from a group.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/removemembers Microsoft Documentation}
+     * @example
+     * await groupClient.RemoveMembers({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "RoleId": "ABC1234DEF",
+     *   "Members": [
+     *     {
+     *       "Id": "90901000",
+     *       "Type": "title_player_account",
+     *       "TypeString": "title_player_account"
+     *     }
+     *   ]
+     * });
+     */
+    RemoveMembers(request: RemoveMembersRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Unblocks a list of entities from joining a group
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/unblockentity Microsoft Documentation}
+     * @example
+     * await groupClient.UnblockEntity({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "Entity": {
+     *     "Id": "90901000",
+     *     "Type": "title_player_account",
+     *     "TypeString": "title_player_account"
+     *   }
+     * });
+     */
+    UnblockEntity(request: UnblockEntityRequest, extraHeaders?: Record<string, string>): Promise<EmptyResponse>;
+    /**
+     * Updates non-membership data about a group.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/updategroup Microsoft Documentation}
+     * @example
+     * await groupClient.UpdateGroup({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "GroupName": "My New Group Name",
+     *   "ExpectedProfileVersion": 17
+     * });
+     */
+    UpdateGroup(request: UpdateGroupRequest, extraHeaders?: Record<string, string>): Promise<UpdateGroupResponse>;
+    /**
+     * Updates metadata about a role.
+     *
+     * {@link https://docs.microsoft.com/rest/api/playfab/group/groups/updaterole Microsoft Documentation}
+     * @example
+     * await groupClient.UpdateRole({
+     *   "Group": {
+     *     "Id": "ABC1234ABC"
+     *   },
+     *   "RoleId": "ABC1234DEF",
+     *   "RoleName": "My New Role Name",
+     *   "ExpectedProfileVersion": 17
+     * });
+     */
+    UpdateRole(request: UpdateGroupRoleRequest, extraHeaders?: Record<string, string>): Promise<UpdateGroupRoleResponse>;
+}
+
+export { PlayFabGroupsApi as default };