Class: default

client/apis/GroupsAPI.default

Hierarchy

• default

↳ default

Table of contents

Constructors

• constructor

Properties

• client
• options

Methods

• acceptJoinRequest
• acceptJoinRequests
• acceptRelationshipRequest
• acceptRelationshipRequests
• changeGroupOwner
• claimGroup
• createGroup
• createRelationship
• createRole
• createSocialLink
• createWallPost
• declineJoinRequest
• declineJoinRequests
• declineRelationshipRequest
• declineRelationshipRequests
• deleteRelationship
• deleteRole
• deleteSocialLink
• deleteUserWallPosts
• deleteWallPost
• getAllRolesPermissions
• getAuditLogs
• getGroup
• getGroupConfigurationMetaData
• getGroupPayouts
• getGroupRelationships
• getGroupRoles
• getGroupSearchMetaData
• getGroupSettings
• getGroupsMetaData
• getGuestPermissions
• getJoinRequest
• getJoinRequests
• getMembers
• getMembersWithRole
• getMultiGroups
• getRelationshipRequests
• getRolePermissions
• getRolesByIds
• getSelfGroupMembership
• getSelfPendingGroupJoins
• getSocialLinks
• getUserGroups
• getUserPrimaryGroup
• getWallPosts
• joinGroup
• kickMember
• payoutMembers
• removePrimaryGroup
• request
• searchGroups
• searchGroupsByKeyword
• setPrimaryGroup
• updateGroupDescription
• updateGroupIcon
• updateGroupSettings
• updateGroupStatus
• updateMember
• updateRecurringPayouts
• updateRole
• updateRolePermissions
• updateSocialLink

Constructors

constructor

+ new default(client: default): default

Parameters:

Name	Type
client	default

Returns: default

Inherited from: default

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

Properties

client

• client: default

Inherited from: default.client

Defined in: client/apis/BaseAPI.ts:25

---

options

• options: BaseAPIOptions

Inherited from: default.options

Defined in: client/apis/BaseAPI.ts:26

Methods

acceptJoinRequest

▸ acceptJoinRequest(options: AcceptJoinRequestOptions): Promise<unknown>

Parameters:

Name	Type
options	AcceptJoinRequestOptions

Returns: Promise<unknown>

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

---

acceptJoinRequests

▸ acceptJoinRequests(options: AcceptJoinRequestsOptions): Promise<unknown>

Parameters:

Name	Type
options	AcceptJoinRequestsOptions

Returns: Promise<unknown>

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

---

acceptRelationshipRequest

▸ acceptRelationshipRequest(options: DeclineRelationshipRequestOptions): Promise<unknown>

Parameters:

Name	Type
options	DeclineRelationshipRequestOptions

Returns: Promise<unknown>

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

---

acceptRelationshipRequests

▸ acceptRelationshipRequests(options: DeclineRelationshipRequestsOptions): Promise<unknown>

Parameters:

Name	Type
options	DeclineRelationshipRequestsOptions

Returns: Promise<unknown>

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

---

changeGroupOwner

▸ changeGroupOwner(options: ChangeOwnerOptions): Promise<unknown>

Parameters:

Name	Type
options	ChangeOwnerOptions

Returns: Promise<unknown>

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

---

claimGroup

▸ claimGroup(options: ClaimGroupOptions): Promise<unknown>

Parameters:

Name	Type
options	ClaimGroupOptions

Returns: Promise<unknown>

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

---

createGroup

▸ createGroup(options: CreateGroupOptions): Promise<GroupOptions>

Parameters:

Name	Type
options	CreateGroupOptions

Returns: Promise<GroupOptions>

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

---

createRelationship

▸ createRelationship(options: CreateRelationshipOptions): Promise<unknown>

Parameters:

Name	Type
options	CreateRelationshipOptions

Returns: Promise<unknown>

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

---

createRole

▸ createRole(options: CreateRoleOptions): Promise<Pick<{ description: string ; groupId: number ; id: number ; memberCount: number ; name: string ; rank: number }, id | name | description | rank | memberCount>>

Parameters:

Name	Type
options	CreateRoleOptions

Returns: Promise<Pick<{ description: string ; groupId: number ; id: number ; memberCount: number ; name: string ; rank: number }, id | name | description | rank | memberCount>>

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

---

createSocialLink

▸ createSocialLink(options: PostSocialLinkOptions): Promise<{ id: number ; title: string ; type: string ; url: string }>

Parameters:

Name	Type
options	PostSocialLinkOptions

Returns: Promise<{ id: number ; title: string ; type: string ; url: string }>

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

---

createWallPost

▸ createWallPost(options: CreateWallPostOptions): Promise<{ body: string ; created: string ; id: number ; poster: { buildersClubMembershipType: string ; displayName: string ; userId: number ; username: string } ; updated: string }>

Parameters:

Name	Type
options	CreateWallPostOptions

Returns: Promise<{ body: string ; created: string ; id: number ; poster: { buildersClubMembershipType: string ; displayName: string ; userId: number ; username: string } ; updated: string }>

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

---

declineJoinRequest

▸ declineJoinRequest(options: DeclineJoinRequestOptions): Promise<unknown>

Parameters:

Name	Type
options	DeclineJoinRequestOptions

Returns: Promise<unknown>

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

---

declineJoinRequests

▸ declineJoinRequests(options: DeclineJoinRequestsOptions): Promise<unknown>

Parameters:

Name	Type
options	DeclineJoinRequestsOptions

Returns: Promise<unknown>

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

---

declineRelationshipRequest

▸ declineRelationshipRequest(options: DeclineRelationshipRequestOptions): Promise<unknown>

Parameters:

Name	Type
options	DeclineRelationshipRequestOptions

Returns: Promise<unknown>

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

---

declineRelationshipRequests

▸ declineRelationshipRequests(options: DeclineRelationshipRequestsOptions): Promise<unknown>

Parameters:

Name	Type
options	DeclineRelationshipRequestsOptions

Returns: Promise<unknown>

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

---

deleteRelationship

▸ deleteRelationship(options: DeleteRelationshipOptions): Promise<unknown>

Parameters:

Name	Type
options	DeleteRelationshipOptions

Returns: Promise<unknown>

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

---

deleteRole

▸ deleteRole(options: DeleteRoleOptions): Promise<unknown>

Parameters:

Name	Type
options	DeleteRoleOptions

Returns: Promise<unknown>

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

---

deleteSocialLink

▸ deleteSocialLink(options: DeleteSocialLinkOptions): Promise<unknown>

Parameters:

Name	Type
options	DeleteSocialLinkOptions

Returns: Promise<unknown>

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

---

deleteUserWallPosts

▸ deleteUserWallPosts(options: DeleteWallPostsByUserOptions): Promise<unknown>

Parameters:

Name	Type
options	DeleteWallPostsByUserOptions

Returns: Promise<unknown>

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

---

deleteWallPost

▸ deleteWallPost(options: DeleteWallPostOptions): Promise<unknown>

Parameters:

Name	Type
options	DeleteWallPostOptions

Returns: Promise<unknown>

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

---

getAllRolesPermissions

▸ getAllRolesPermissions(options: GetAllRolesPermissionsOptions): Promise<GetAllRolesPermissions>

Parameters:

Name	Type
options	GetAllRolesPermissionsOptions

Returns: Promise<GetAllRolesPermissions>

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

---

getAuditLogs

▸ getAuditLogs(options: GetGroupAuditLogsOptions): Promise<GetGroupAuditLogs>

Parameters:

Name	Type
options	GetGroupAuditLogsOptions

Returns: Promise<GetGroupAuditLogs>

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

---

getGroup

▸ getGroup(options: GetGroupOptions): Promise<GetGroup>

Parameters:

Name	Type
options	GetGroupOptions

Returns: Promise<GetGroup>

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

---

getGroupConfigurationMetaData

▸ getGroupConfigurationMetaData(): Promise<GetGroupConfigurationMetaData>

Returns: Promise<GetGroupConfigurationMetaData>

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

---

getGroupPayouts

▸ getGroupPayouts(options: GetGroupPayoutsOptions): Promise<GetGroupPayouts>

Parameters:

Name	Type
options	GetGroupPayoutsOptions

Returns: Promise<GetGroupPayouts>

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

---

getGroupRelationships

▸ getGroupRelationships(options: GetGroupRelationshipsOptions): Promise<GetGroupRelationships>

Parameters:

Name	Type
options	GetGroupRelationshipsOptions

Returns: Promise<GetGroupRelationships>

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

---

getGroupRoles

▸ getGroupRoles(options: GetGroupRolesOptions): Promise<GetGroupRoles>

Parameters:

Name	Type
options	GetGroupRolesOptions

Returns: Promise<GetGroupRoles>

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

---

getGroupSearchMetaData

▸ getGroupSearchMetaData(): Promise<GetGroupSearchMetaData>

Returns: Promise<GetGroupSearchMetaData>

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

---

getGroupSettings

▸ getGroupSettings(options: GetGroupSettingsOptions): Promise<GetGroupSettings>

Parameters:

Name	Type
options	GetGroupSettingsOptions

Returns: Promise<GetGroupSettings>

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

---

getGroupsMetaData

▸ getGroupsMetaData(): Promise<GetGroupsMetaData>

Returns: Promise<GetGroupsMetaData>

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

---

getGuestPermissions

▸ getGuestPermissions(options: GetGuestPermissionsOptions): Promise<GroupRolePermissionsOptions>

Parameters:

Name	Type
options	GetGuestPermissionsOptions

Returns: Promise<GroupRolePermissionsOptions>

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

---

getJoinRequest

▸ getJoinRequest(options: GetJoinRequestOptions): Promise<{ created: string ; requester: { displayName: string ; userId: number ; username: string } }>

Parameters:

Name	Type
options	GetJoinRequestOptions

Returns: Promise<{ created: string ; requester: { displayName: string ; userId: number ; username: string } }>

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

---

getJoinRequests

▸ getJoinRequests(options: GetJoinRequestsOptions): Promise<GetJoinRequests>

Parameters:

Name	Type
options	GetJoinRequestsOptions

Returns: Promise<GetJoinRequests>

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

---

getMembers

▸ getMembers(options: GetMembersOptions): Promise<GetMembersWithRole>

Parameters:

Name	Type
options	GetMembersOptions

Returns: Promise<GetMembersWithRole>

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

---

getMembersWithRole

▸ getMembersWithRole(options: GetMembersWithRoleOptions): Promise<GetMembersWithRole>

Parameters:

Name	Type
options	GetMembersWithRoleOptions

Returns: Promise<GetMembersWithRole>

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

---

getMultiGroups

▸ getMultiGroups(options: GetMultiGroupsOptions): Promise<GetMultiGroups>

Parameters:

Name	Type
options	GetMultiGroupsOptions

Returns: Promise<GetMultiGroups>

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

---

getRelationshipRequests

▸ getRelationshipRequests(options: GetGroupRelationshipsOptions): Promise<GetGroupRelationships>

Parameters:

Name	Type
options	GetGroupRelationshipsOptions

Returns: Promise<GetGroupRelationships>

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

---

getRolePermissions

▸ getRolePermissions(options: GetRolePermissionsOptions): Promise<GroupRolePermissionsOptions>

Parameters:

Name	Type
options	GetRolePermissionsOptions

Returns: Promise<GroupRolePermissionsOptions>

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

---

getRolesByIds

▸ getRolesByIds(options: GetRolesByIdsOptions): Promise<GetRolesByIds>

Parameters:

Name	Type
options	GetRolesByIdsOptions

Returns: Promise<GetRolesByIds>

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

---

getSelfGroupMembership

▸ getSelfGroupMembership(options: GetSelfGroupMembershipOptions): Promise<GetSelfGroupMembership>

Parameters:

Name	Type
options	GetSelfGroupMembershipOptions

Returns: Promise<GetSelfGroupMembership>

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

---

getSelfPendingGroupJoins

▸ getSelfPendingGroupJoins(): Promise<GetSelfPendingGroupJoins>

Returns: Promise<GetSelfPendingGroupJoins>

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

---

getSocialLinks

▸ getSocialLinks(options: GetSocialLinksOptions): Promise<GetSocialLinks>

Parameters:

Name	Type
options	GetSocialLinksOptions

Returns: Promise<GetSocialLinks>

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

---

getUserGroups

▸ getUserGroups(options: GetUserGroupsOptions): Promise<GetUserGroups>

Parameters:

Name	Type
options	GetUserGroupsOptions

Returns: Promise<GetUserGroups>

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

---

getUserPrimaryGroup

▸ getUserPrimaryGroup(options: GetUserPrimaryGroupOptions): Promise<GetUserPrimaryGroup>

Parameters:

Name	Type
options	GetUserPrimaryGroupOptions

Returns: Promise<GetUserPrimaryGroup>

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

---

getWallPosts

▸ getWallPosts(options: GetWallPostsOptions): Promise<GetWallPosts>

Parameters:

Name	Type
options	GetWallPostsOptions

Returns: Promise<GetWallPosts>

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

---

joinGroup

▸ joinGroup(options: JoinGroupOptions): Promise<unknown>

Parameters:

Name	Type
options	JoinGroupOptions

Returns: Promise<unknown>

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

---

kickMember

▸ kickMember(options: KickMemberOptions): Promise<unknown>

Parameters:

Name	Type
options	KickMemberOptions

Returns: Promise<unknown>

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

---

payoutMembers

▸ payoutMembers(options: PayoutMembersOptions): Promise<unknown>

Parameters:

Name	Type
options	PayoutMembersOptions

Returns: Promise<unknown>

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

---

removePrimaryGroup

▸ removePrimaryGroup(): Promise<unknown>

Returns: Promise<unknown>

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

---

request

▸ request(options: BaseAPIRequestOptions): Promise<RESTResponseDataType>

Parameters:

Name	Type
options	BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

Defined in: client/apis/BaseAPI.ts:33

---

searchGroups

▸ searchGroups(options: SearchGroupsOptions): Promise<SearchGroups>

Parameters:

Name	Type
options	SearchGroupsOptions

Returns: Promise<SearchGroups>

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

---

searchGroupsByKeyword

▸ searchGroupsByKeyword(options: SearchGroupsByKeywordOptions): Promise<SearchGroupsByKeyword>

Parameters:

Name	Type
options	SearchGroupsByKeywordOptions

Returns: Promise<SearchGroupsByKeyword>

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

---

setPrimaryGroup

▸ setPrimaryGroup(options: SetPrimaryGroupOptions): Promise<unknown>

Parameters:

Name	Type
options	SetPrimaryGroupOptions

Returns: Promise<unknown>

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

---

updateGroupDescription

▸ updateGroupDescription(options: UpdateGroupDescriptionOptions): Promise<UpdateGroupDescription>

Parameters:

Name	Type
options	UpdateGroupDescriptionOptions

Returns: Promise<UpdateGroupDescription>

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

---

updateGroupIcon

▸ updateGroupIcon(options: UpdateGroupIconOptions): Promise<unknown>

Parameters:

Name	Type
options	UpdateGroupIconOptions

Returns: Promise<unknown>

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

---

updateGroupSettings

▸ updateGroupSettings(options: GetGroupSettings): Promise<unknown>

Parameters:

Name	Type
options	GetGroupSettings

Returns: Promise<unknown>

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

---

updateGroupStatus

▸ updateGroupStatus(options: UpdateGroupStatusOptions): Promise<null | { body: string ; created: string ; poster: { buildersClubMembershipType: string ; displayName: string ; userId: number ; username: string } ; updated: string }>

Parameters:

Name	Type
options	UpdateGroupStatusOptions

Returns: Promise<null | { body: string ; created: string ; poster: { buildersClubMembershipType: string ; displayName: string ; userId: number ; username: string } ; updated: string }>

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

---

updateMember

▸ updateMember(options: UpdateMemberOptions): Promise<unknown>

Parameters:

Name	Type
options	UpdateMemberOptions

Returns: Promise<unknown>

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

---

updateRecurringPayouts

▸ updateRecurringPayouts(options: PayoutMembersOptions): Promise<unknown>

Parameters:

Name	Type
options	PayoutMembersOptions

Returns: Promise<unknown>

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

---

updateRole

▸ updateRole(options: UpdateRoleOptions): Promise<Pick<{ description: string ; groupId: number ; id: number ; memberCount: number ; name: string ; rank: number }, id | name | description | rank | memberCount>>

Parameters:

Name	Type
options	UpdateRoleOptions

Returns: Promise<Pick<{ description: string ; groupId: number ; id: number ; memberCount: number ; name: string ; rank: number }, id | name | description | rank | memberCount>>

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

---

updateRolePermissions

▸ updateRolePermissions(options: UpdateRolePermissionsOptions): Promise<unknown>

Parameters:

Name	Type
options	UpdateRolePermissionsOptions

Returns: Promise<unknown>

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

---

updateSocialLink

▸ updateSocialLink(options: UpdateSocialLinkOptions): Promise<unknown>

Parameters:

Name	Type
options	UpdateSocialLinkOptions

Returns: Promise<unknown>

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