Skip to content

Module: client/apis/GroupsAPI

Table of contents

Classes

Type aliases

Type aliases

AcceptJoinRequest

Ƭ AcceptJoinRequest: unknown

Defined in: client/apis/GroupsAPI.ts:180

AcceptJoinRequestOptions

Ƭ AcceptJoinRequestOptions: object

Type declaration:

Name Type
groupId number
userId number

Defined in: client/apis/GroupsAPI.ts:176

AcceptJoinRequests

Ƭ AcceptJoinRequests: unknown

Defined in: client/apis/GroupsAPI.ts:165

AcceptJoinRequestsOptions

Ƭ AcceptJoinRequestsOptions: object

Type declaration:

Name Type
groupId number
userIds number[]

Defined in: client/apis/GroupsAPI.ts:161

AcceptRelationshipRequest

Ƭ AcceptRelationshipRequest: unknown

Defined in: client/apis/GroupsAPI.ts:341

AcceptRelationshipRequestOptions

Ƭ AcceptRelationshipRequestOptions: DeclineRelationshipRequestOptions

Defined in: client/apis/GroupsAPI.ts:340

AcceptRelationshipRequests

Ƭ AcceptRelationshipRequests: unknown

Defined in: client/apis/GroupsAPI.ts:327

AcceptRelationshipRequestsOptions

Ƭ AcceptRelationshipRequestsOptions: DeclineRelationshipRequestsOptions

Defined in: client/apis/GroupsAPI.ts:326

ChangeOwner

Ƭ ChangeOwner: unknown

Defined in: client/apis/GroupsAPI.ts:264

ChangeOwnerOptions

Ƭ ChangeOwnerOptions: object

Type declaration:

Name Type
groupId number
userId number

Defined in: client/apis/GroupsAPI.ts:260

ClaimGroup

Ƭ ClaimGroup: unknown

Defined in: client/apis/GroupsAPI.ts:268

ClaimGroupOptions

Ƭ ClaimGroupOptions: object

Type declaration:

Name Type
groupId number

Defined in: client/apis/GroupsAPI.ts:265

CreateGroup

Ƭ CreateGroup: GroupOptions

Defined in: client/apis/GroupsAPI.ts:120

CreateGroupOptions

Ƭ CreateGroupOptions: object

Type declaration:

Name Type
buildersClubMembersOnly boolean
description string
files unknown
name string
publicGroup boolean

Defined in: client/apis/GroupsAPI.ts:113

CreateRelationship

Ƭ CreateRelationship: unknown

Defined in: client/apis/GroupsAPI.ts:335

CreateRelationshipOptions

Ƭ CreateRelationshipOptions: Omit<DeclineRelationshipRequestsOptions, withGroups> & { withGroup: number }

Defined in: client/apis/GroupsAPI.ts:332

CreateRole

Ƭ CreateRole: Omit<GetRolesByIds[data][0], groupId>

Defined in: client/apis/GroupsAPI.ts:514

CreateRoleOptions

Ƭ CreateRoleOptions: object

Type declaration:

Name Type
description string
groupId number
name string
rank number
usingGroupFunds boolean

Defined in: client/apis/GroupsAPI.ts:507

CreateWallPost

Ƭ CreateWallPost: GetWallPosts[data][0]

Defined in: client/apis/GroupsAPI.ts:438

CreateWallPostOptions

Ƭ CreateWallPostOptions: object

Type declaration:

Name Type
body string
captchaProvider PROVIDER_ARKOSELABS | string
captchaToken string
groupId number

Defined in: client/apis/GroupsAPI.ts:432

DeclineJoinRequest

Ƭ DeclineJoinRequest: unknown

Defined in: client/apis/GroupsAPI.ts:170

DeclineJoinRequestOptions

Ƭ DeclineJoinRequestOptions: object

Type declaration:

Name Type
groupId number
userId number

Defined in: client/apis/GroupsAPI.ts:166

DeclineJoinRequests

Ƭ DeclineJoinRequests: unknown

Defined in: client/apis/GroupsAPI.ts:142

DeclineJoinRequestsOptions

Ƭ DeclineJoinRequestsOptions: object

Type declaration:

Name Type
groupId number
userIds number[]

Defined in: client/apis/GroupsAPI.ts:138

DeclineRelationshipRequest

Ƭ DeclineRelationshipRequest: unknown

Defined in: client/apis/GroupsAPI.ts:339

DeclineRelationshipRequestOptions

Ƭ DeclineRelationshipRequestOptions: Omit<DeclineRelationshipRequestsOptions, withGroups> & { withGroup: number }

Defined in: client/apis/GroupsAPI.ts:336

DeclineRelationshipRequests

Ƭ DeclineRelationshipRequests: unknown

Defined in: client/apis/GroupsAPI.ts:323

DeclineRelationshipRequestsOptions

Ƭ DeclineRelationshipRequestsOptions: object

Type declaration:

Name Type
groupId number
relationshipType GetGroupRelationshipsOptions[relationshipType]
withGroups number[]

Defined in: client/apis/GroupsAPI.ts:318

DeleteRelationship

Ƭ DeleteRelationship: unknown

Defined in: client/apis/GroupsAPI.ts:331

DeleteRelationshipOptions

Ƭ DeleteRelationshipOptions: Omit<DeclineRelationshipRequestsOptions, withGroups> & { withGroup: number }

Defined in: client/apis/GroupsAPI.ts:328

DeleteRole

Ƭ DeleteRole: unknown

Defined in: client/apis/GroupsAPI.ts:519

DeleteRoleOptions

Ƭ DeleteRoleOptions: object

Type declaration:

Name Type
groupId number
roleId number

Defined in: client/apis/GroupsAPI.ts:515

Ƭ DeleteSocialLink: unknown

Defined in: client/apis/GroupsAPI.ts:401

DeleteSocialLinkOptions

Ƭ DeleteSocialLinkOptions: object

Type declaration:

Name Type
groupId number
id number

Defined in: client/apis/GroupsAPI.ts:397

DeleteWallPost

Ƭ DeleteWallPost: unknown

Defined in: client/apis/GroupsAPI.ts:443

DeleteWallPostOptions

Ƭ DeleteWallPostOptions: object

Type declaration:

Name Type
groupId number
id number

Defined in: client/apis/GroupsAPI.ts:439

DeleteWallPostsByUser

Ƭ DeleteWallPostsByUser: unknown

Defined in: client/apis/GroupsAPI.ts:448

DeleteWallPostsByUserOptions

Ƭ DeleteWallPostsByUserOptions: object

Type declaration:

Name Type
groupId number
userId number

Defined in: client/apis/GroupsAPI.ts:444

GetAllRolesPermissions

Ƭ GetAllRolesPermissions: object

Type declaration:

Name Type
data GroupRolePermissionsOptions[]

Defined in: client/apis/GroupsAPI.ts:376

GetAllRolesPermissionsOptions

Ƭ GetAllRolesPermissionsOptions: object

Type declaration:

Name Type
groupId number

Defined in: client/apis/GroupsAPI.ts:373

GetGroup

Ƭ GetGroup: object

Type declaration:

Name Type
description string
id number
isBuildersClubOnly boolean
isLocked boolean
memberCount number
name string
owner object
owner.buildersClubMembershipType None | string
owner.displayName string
owner.userId number
owner.username string
publicEntryAllowed boolean
shout object
shout.body string
shout.created string
shout.poster object
shout.poster.buildersClubMembershipType None | string
shout.poster.displayName string
shout.poster.userId number
shout.poster.username string
shout.updated string

Defined in: client/apis/GroupsAPI.ts:9

GetGroupAuditLogs

Ƭ GetGroupAuditLogs: object

Type declaration:

Name Type
data { actionType: string ; actor: { role: { description: string ; id: number ; memberCount: number ; name: string ; rank: number } ; user: { buildersClubMembershipType: None | string ; displayName: string ; userId: number ; username: string } } ; created: string ; description: unknown }[]
nextPageCursor string
previousPageCursor string

Defined in: client/apis/GroupsAPI.ts:48

GetGroupAuditLogsOptions

Ƭ GetGroupAuditLogsOptions: object

Type declaration:

Name Type
actionType DeletePost | RemoveMember | AcceptJoinRequest | DeclineJoinRequest | PostStatus | ChangeRank | BuyAd | SendAllyRequest | CreateEnemy | AcceptAllyRequest | DeclineAllyRequest | DeleteAlly | DeleteEnemy | AddGroupPlace | RemoveGroupPlace | CreateItems | ConfigureItems | SpendGroupFunds | ChangeOwner | Delete | AdjustCurrencyAmounts | Abandon | Claim | Rename | ChangeDescription | InviteToClan | KickFromClan | CancelCLanInvite | BuyClan | CreateGroupAsset | UpdateGroupAsset | ConfigureGroupAsset | RevertGroupAsset | CreateGroupDeveloperProduct | ConfigureGroupGame | Lock | Unlock | CreateGamePass | CreateBadge | ConfigureBadge | SavePlace | PublishPlace
cursor? string
groupId number
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc

Defined in: client/apis/GroupsAPI.ts:41

GetGroupConfigurationMetaData

Ƭ GetGroupConfigurationMetaData: object

Type declaration:

Name Type
groupConfiguration object
groupConfiguration.cost number
groupConfiguration.descriptionMaxLength number
groupConfiguration.iconMaxFileSizeMb number
groupConfiguration.nameMaxLength number
isDefaultEmblemPolicyEnabled boolean
isPremiumPayoutsEnabled boolean
recurringPayoutsConfiguration object
recurringPayoutsConfiguration.maxPayoutPartners number
roleConfiguration object
roleConfiguration.cost number
roleConfiguration.descriptionMaxLength number
roleConfiguration.limit number
roleConfiguration.maxRank number
roleConfiguration.minRank number
roleConfiguration.nameMaxLength number

Defined in: client/apis/GroupsAPI.ts:85

GetGroupOptions

Ƭ GetGroupOptions: object

Type declaration:

Name Type
groupId number

Defined in: client/apis/GroupsAPI.ts:6

GetGroupPayouts

Ƭ GetGroupPayouts: object

Type declaration:

Name Type
data { percentage: number ; user: { buildersClubMembershipType: None | string ; displayName: string ; userId: number ; username: string } }[]

Defined in: client/apis/GroupsAPI.ts:283

GetGroupPayoutsOptions

Ƭ GetGroupPayoutsOptions: object

Type declaration:

Name Type
groupId number

Defined in: client/apis/GroupsAPI.ts:280

GetGroupRelationships

Ƭ GetGroupRelationships: object

Type declaration:

Name Type
groupId number
nextRowIndex number
relatedGroups GroupOptions[]
relationshipType GetGroupRelationshipsOptions[relationshipType]
totalGroupCount number

Defined in: client/apis/GroupsAPI.ts:311

GetGroupRelationshipsOptions

Ƭ GetGroupRelationshipsOptions: object

Type declaration:

Name Type
groupId number
maxRows? number
relationshipType enemies | allies
startRowIndex? number

Defined in: client/apis/GroupsAPI.ts:305

GetGroupRoles

Ƭ GetGroupRoles: object

Type declaration:

Name Type
groupId number
roles { description: string ; id: number ; memberCount: number ; name: string ; rank: number }[]

Defined in: client/apis/GroupsAPI.ts:208

GetGroupRolesOptions

Ƭ GetGroupRolesOptions: object

Type declaration:

Name Type
groupId number

Defined in: client/apis/GroupsAPI.ts:205

GetGroupSearchMetaData

Ƭ GetGroupSearchMetaData: object

Type declaration:

Name Type
SuggestedGroupKeywords string[]

Defined in: client/apis/GroupsAPI.ts:478

GetGroupSettings

Ƭ GetGroupSettings: object

Type declaration:

Name Type
areEnemiesAllowed boolean
areGroupFundsVisible boolean
areGroupGamesVisible boolean
groupId number
isApprovalRequired boolean
isBuildersClubRequired boolean

Defined in: client/apis/GroupsAPI.ts:75

GetGroupSettingsOptions

Ƭ GetGroupSettingsOptions: object

Type declaration:

Name Type
groupId number

Defined in: client/apis/GroupsAPI.ts:72

GetGroupsMetaData

Ƭ GetGroupsMetaData: object

Type declaration:

Name Type
areProfileGroupsHidden boolean
currentGroupCount number
groupLimit number
groupStatusMaxLength number
isGroupDetailsPolicyEnabled boolean

Defined in: client/apis/GroupsAPI.ts:106

GetGuestPermissions

Ƭ GetGuestPermissions: GroupRolePermissionsOptions

Defined in: client/apis/GroupsAPI.ts:372

GetGuestPermissionsOptions

Ƭ GetGuestPermissionsOptions: object

Type declaration:

Name Type
groupId number

Defined in: client/apis/GroupsAPI.ts:369

GetJoinRequest

Ƭ GetJoinRequest: GetJoinRequests[data][0]

Defined in: client/apis/GroupsAPI.ts:175

GetJoinRequestOptions

Ƭ GetJoinRequestOptions: object

Type declaration:

Name Type
groupId number
userId number

Defined in: client/apis/GroupsAPI.ts:171

GetJoinRequests

Ƭ GetJoinRequests: object

Type declaration:

Name Type
data { created: string ; requester: { displayName: string ; userId: number ; username: string } }[]
nextPageCursor string
previousPageCursor string

Defined in: client/apis/GroupsAPI.ts:149

GetJoinRequestsOptions

Ƭ GetJoinRequestsOptions: object

Type declaration:

Name Type
cursor? string
groupId number
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc

Defined in: client/apis/GroupsAPI.ts:143

GetMembers

Ƭ GetMembers: GetMembersWithRole

Defined in: client/apis/GroupsAPI.ts:241

GetMembersOptions

Ƭ GetMembersOptions: object

Type declaration:

Name Type
cursor? string
groupId number
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc

Defined in: client/apis/GroupsAPI.ts:235

GetMembersWithRole

Ƭ GetMembersWithRole: object

Type declaration:

Name Type
data { buildersClubMembershipType: None | string ; displayName: string ; userId: number ; username: string }[]
nextPageCursor string
previousPageCursor string

Defined in: client/apis/GroupsAPI.ts:225

GetMembersWithRoleOptions

Ƭ GetMembersWithRoleOptions: object

Type declaration:

Name Type
cursor? string
groupId number
limit? 10 | 25 | 50 | 100
roleId number
sortOrder? Asc | Desc

Defined in: client/apis/GroupsAPI.ts:218

GetMultiGroups

Ƭ GetMultiGroups: object

Type declaration:

Name Type
data GroupOptions[]

Defined in: client/apis/GroupsAPI.ts:38

GetMultiGroupsOptions

Ƭ GetMultiGroupsOptions: object

Type declaration:

Name Type
groupIds number[]

Defined in: client/apis/GroupsAPI.ts:35

GetRelationshipRequests

Ƭ GetRelationshipRequests: GetGroupRelationships

Defined in: client/apis/GroupsAPI.ts:325

GetRelationshipRequestsOptions

Ƭ GetRelationshipRequestsOptions: GetGroupRelationshipsOptions

Defined in: client/apis/GroupsAPI.ts:324

GetRolePermissions

Ƭ GetRolePermissions: GroupRolePermissionsOptions

Defined in: client/apis/GroupsAPI.ts:346

GetRolePermissionsOptions

Ƭ GetRolePermissionsOptions: object

Type declaration:

Name Type
groupId number
roleId number

Defined in: client/apis/GroupsAPI.ts:342

GetRolesByIds

Ƭ GetRolesByIds: object

Type declaration:

Name Type
data { description: string ; groupId: number ; id: number ; memberCount: number ; name: string ; rank: number }[]

Defined in: client/apis/GroupsAPI.ts:484

GetRolesByIdsOptions

Ƭ GetRolesByIdsOptions: object

Type declaration:

Name Type
roleIds number[]

Defined in: client/apis/GroupsAPI.ts:481

GetSelfGroupMembership

Ƭ GetSelfGroupMembership: object

Type declaration:

Name Type
groupId number
isPendingJoin boolean
isPrimary boolean
permissions GroupRolePermissionsOptions[permissions]
userRole object
userRole.role object
userRole.role.description string
userRole.role.id number
userRole.role.memberCount number
userRole.role.name string
userRole.role.rank number
userRole.user object
userRole.user.buildersClubMembershipType None | string
userRole.user.displayName string
userRole.user.userId number
userRole.user.username string

Defined in: client/apis/GroupsAPI.ts:184

GetSelfGroupMembershipOptions

Ƭ GetSelfGroupMembershipOptions: object

Type declaration:

Name Type
groupId number

Defined in: client/apis/GroupsAPI.ts:181

GetSelfPendingGroupJoins

Ƭ GetSelfPendingGroupJoins: object

Type declaration:

Name Type
data GroupOptions[]

Defined in: client/apis/GroupsAPI.ts:248

Ƭ GetSocialLinks: object

Type declaration:

Name Type
data { id: number ; title: string ; type: Facebook | string ; url: string }[]

Defined in: client/apis/GroupsAPI.ts:382

GetSocialLinksOptions

Ƭ GetSocialLinksOptions: object

Type declaration:

Name Type
groupId number

Defined in: client/apis/GroupsAPI.ts:379

GetUserGroups

Ƭ GetUserGroups: object

Type declaration:

Name Type
data { group: GroupOptions ; role: GetGroupRoles[roles][0] }[]

Defined in: client/apis/GroupsAPI.ts:254

GetUserGroupsOptions

Ƭ GetUserGroupsOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/GroupsAPI.ts:251

GetUserPrimaryGroup

Ƭ GetUserPrimaryGroup: object

Type declaration:

Name Type
group? GroupOptions
isPrimaryGroup? boolean
role? GroupRoleOptions

Defined in: client/apis/GroupsAPI.ts:497

GetUserPrimaryGroupOptions

Ƭ GetUserPrimaryGroupOptions: object

Type declaration:

Name Type
userId number

Defined in: client/apis/GroupsAPI.ts:494

GetWallPosts

Ƭ GetWallPosts: object

Type declaration:

Name Type
data { body: string ; created: string ; id: number ; poster: { buildersClubMembershipType: None | string ; displayName: string ; userId: number ; username: string } ; updated: string }[]
nextPageCursor string
previousPageCursor string

Defined in: client/apis/GroupsAPI.ts:416

GetWallPostsOptions

Ƭ GetWallPostsOptions: object

Type declaration:

Name Type
cursor? string
groupId number
limit? 10 | 25 | 50 | 100
sortOrder? Asc | Desc

Defined in: client/apis/GroupsAPI.ts:410

JoinGroup

Ƭ JoinGroup: unknown

Defined in: client/apis/GroupsAPI.ts:247

JoinGroupOptions

Ƭ JoinGroupOptions: object

Type declaration:

Name Type
captchaProvider PROVIDER_ARKOSELABS | string
captchaToken string
groupId number

Defined in: client/apis/GroupsAPI.ts:242

KickMember

Ƭ KickMember: unknown

Defined in: client/apis/GroupsAPI.ts:273

KickMemberOptions

Ƭ KickMemberOptions: object

Type declaration:

Name Type
groupId number
userId number

Defined in: client/apis/GroupsAPI.ts:269

PayoutMembers

Ƭ PayoutMembers: unknown

Defined in: client/apis/GroupsAPI.ts:302

PayoutMembersOptions

Ƭ PayoutMembersOptions: object

Type declaration:

Name Type
groupId number
type FixedAmount | Percentage | string
users { amount: number ; userId: number }[]

Defined in: client/apis/GroupsAPI.ts:294

Ƭ PostSocialLink: GetSocialLinks[data][0]

Defined in: client/apis/GroupsAPI.ts:396

PostSocialLinkOptions

Ƭ PostSocialLinkOptions: object

Type declaration:

Name Type
groupId number
title string
type Facebook | string
url string

Defined in: client/apis/GroupsAPI.ts:390

RemovePrimaryGroup

Ƭ RemovePrimaryGroup: unknown

Defined in: client/apis/GroupsAPI.ts:502

SearchGroups

Ƭ SearchGroups: object

Type declaration:

Name Type
data { id: number ; memberCount: number ; name: string }[]

Defined in: client/apis/GroupsAPI.ts:471

SearchGroupsByKeyword

Ƭ SearchGroupsByKeyword: object

Type declaration:

Name Type
data { created: string ; description: string ; id: number ; memberCount: number ; name: string ; publicEntryAllowed: boolean ; updated: string }[]
keyword string
nextPageCursor string
previousPageCursor string

Defined in: client/apis/GroupsAPI.ts:454

SearchGroupsByKeywordOptions

Ƭ SearchGroupsByKeywordOptions: object

Type declaration:

Name Type
cursor? string
keyword string
limit? 10 | 25 | 50 | 100

Defined in: client/apis/GroupsAPI.ts:449

SearchGroupsOptions

Ƭ SearchGroupsOptions: object

Type declaration:

Name Type
groupName string

Defined in: client/apis/GroupsAPI.ts:468

SetPrimaryGroup

Ƭ SetPrimaryGroup: unknown

Defined in: client/apis/GroupsAPI.ts:506

SetPrimaryGroupOptions

Ƭ SetPrimaryGroupOptions: object

Type declaration:

Name Type
groupId number

Defined in: client/apis/GroupsAPI.ts:503

UpdateGroupDescription

Ƭ UpdateGroupDescription: object

Type declaration:

Name Type
newDescription string

Defined in: client/apis/GroupsAPI.ts:125

UpdateGroupDescriptionOptions

Ƭ UpdateGroupDescriptionOptions: object

Type declaration:

Name Type
description string
groupId number

Defined in: client/apis/GroupsAPI.ts:121

UpdateGroupIcon

Ƭ UpdateGroupIcon: unknown

Defined in: client/apis/GroupsAPI.ts:137

UpdateGroupIconOptions

Ƭ UpdateGroupIconOptions: object

Type declaration:

Name Type
files unknown
groupId number

Defined in: client/apis/GroupsAPI.ts:133

UpdateGroupSettings

Ƭ UpdateGroupSettings: unknown

Defined in: client/apis/GroupsAPI.ts:84

UpdateGroupSettingsOptions

Ƭ UpdateGroupSettingsOptions: GetGroupSettings

Defined in: client/apis/GroupsAPI.ts:83

UpdateGroupStatus

Ƭ UpdateGroupStatus: GroupOptions[shout]

Defined in: client/apis/GroupsAPI.ts:132

UpdateGroupStatusOptions

Ƭ UpdateGroupStatusOptions: object

Type declaration:

Name Type
groupId number
message string

Defined in: client/apis/GroupsAPI.ts:128

UpdateMember

Ƭ UpdateMember: unknown

Defined in: client/apis/GroupsAPI.ts:279

UpdateMemberOptions

Ƭ UpdateMemberOptions: object

Type declaration:

Name Type
groupId number
roleId number
userId number

Defined in: client/apis/GroupsAPI.ts:274

UpdateRecurringPayouts

Ƭ UpdateRecurringPayouts: unknown

Defined in: client/apis/GroupsAPI.ts:304

UpdateRecurringPayoutsOptions

Ƭ UpdateRecurringPayoutsOptions: PayoutMembersOptions

Defined in: client/apis/GroupsAPI.ts:303

UpdateRole

Ƭ UpdateRole: CreateRole

Defined in: client/apis/GroupsAPI.ts:527

UpdateRoleOptions

Ƭ UpdateRoleOptions: object

Type declaration:

Name Type
description string
groupId number
name string
rank number
roleId number

Defined in: client/apis/GroupsAPI.ts:520

UpdateRolePermissions

Ƭ UpdateRolePermissions: unknown

Defined in: client/apis/GroupsAPI.ts:368

UpdateRolePermissionsOptions

Ƭ UpdateRolePermissionsOptions: object

Type declaration:

Name Type
AddGroupPlaces boolean
AdvertiseGroup boolean
ChangeRank boolean
CreateItems boolean
DeleteFromWall boolean
InviteMembers boolean
ManageClan boolean
ManageGroupGames boolean
ManageItems boolean
ManageRelationships boolean
PostToStatus boolean
PostToWall boolean
RemoveMembers boolean
SpendGroupFunds boolean
ViewAuditLogs boolean
ViewStatus boolean
ViewWall boolean
groupId number
roleId number

Defined in: client/apis/GroupsAPI.ts:347

Ƭ UpdateSocialLink: unknown

Defined in: client/apis/GroupsAPI.ts:409

UpdateSocialLinkOptions

Ƭ UpdateSocialLinkOptions: object

Type declaration:

Name Type
groupId number
id number
title string
type Facebook | string
url string

Defined in: client/apis/GroupsAPI.ts:402