js-bao-wss-client / GroupTypeConfigsAPI
Interface: GroupTypeConfigsAPI
Sub-API for group type configurations (client.groupTypeConfigs.*). A configuration attaches a CEL rule set to every group of a given type and controls whether the group's creator is automatically added as a member.
Methods
create()
create(
params):Promise<GroupTypeConfigInfo>
Creates a new group type configuration.
Parameters
params
Configuration for the new group type
Returns
Promise<GroupTypeConfigInfo>
delete()
delete(
groupType):Promise<{success:boolean; }>
Deletes a group type configuration.
Parameters
groupType
string
The group type identifier to delete
Returns
Promise<{ success: boolean; }>
get()
get(
groupType):Promise<GroupTypeConfigInfo>
Retrieves the configuration for a specific group type.
Parameters
groupType
string
The group type identifier to look up
Returns
Promise<GroupTypeConfigInfo>
list()
list():
Promise<GroupTypeConfigInfo[]>
Lists all group type configurations for the current app.
Returns
Promise<GroupTypeConfigInfo[]>
update()
update(
groupType,params):Promise<GroupTypeConfigInfo>
Updates an existing group type configuration's rule set or auto-add-creator setting.
Parameters
groupType
string
The group type identifier to update
params
Fields to update on the group type configuration
Returns
Promise<GroupTypeConfigInfo>