Spaces:
Runtime error
Runtime error
File size: 5,715 Bytes
46252cd | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 | /**
* Groups resource — WhatsApp group management.
*
* Backed by `src/modules/group/group.controller.ts`.
* @packageDocumentation
*/
import { encodeSegment } from '../http.js';
import type { OpenWAClient } from '../client.js';
import type {
CreateGroupRequest,
GroupInfo,
GroupSettingsResponse,
GroupSummary,
InviteCodeResponse,
JoinGroupRequest,
JoinGroupResponse,
SuccessResult,
UpdateGroupSettingsRequest,
} from '../types.js';
export interface ListGroupsQuery {
limit?: number;
offset?: number;
}
export class GroupsResource {
constructor(private readonly client: OpenWAClient) {}
/** List all groups for the session. */
list(sessionId: string, query?: ListGroupsQuery): Promise<GroupSummary[]> {
return this.client.request<GroupSummary[]>({
method: 'GET',
path: `/api/sessions/${encodeSegment(sessionId)}/groups`,
query,
});
}
/** Get detailed group info including the participant list. */
get(sessionId: string, groupId: string): Promise<GroupInfo> {
return this.client.request<GroupInfo>({
method: 'GET',
path: `/api/sessions/${encodeSegment(sessionId)}/groups/${encodeSegment(groupId)}`,
});
}
/** Create a new group. */
create(sessionId: string, body: CreateGroupRequest): Promise<GroupInfo> {
return this.client.request<GroupInfo>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/groups`,
body,
});
}
/** Join a group via an invite code. */
joinGroup(sessionId: string, body: JoinGroupRequest): Promise<JoinGroupResponse> {
return this.client.request<JoinGroupResponse>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/groups/join`,
body,
});
}
/** Add participants to a group. */
addParticipants(sessionId: string, groupId: string, participants: string[]): Promise<SuccessResult> {
return this.client.request<SuccessResult>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/groups/${encodeSegment(groupId)}/participants`,
body: { participants },
});
}
/** Remove participants from a group. */
removeParticipants(sessionId: string, groupId: string, participants: string[]): Promise<SuccessResult> {
return this.client.request<SuccessResult>({
method: 'DELETE',
path: `/api/sessions/${encodeSegment(sessionId)}/groups/${encodeSegment(groupId)}/participants`,
body: { participants },
});
}
/** Promote participants to group admin. */
promoteParticipants(sessionId: string, groupId: string, participants: string[]): Promise<SuccessResult> {
return this.client.request<SuccessResult>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/groups/${encodeSegment(groupId)}/participants/promote`,
body: { participants },
});
}
/** Demote participants from group admin. */
demoteParticipants(sessionId: string, groupId: string, participants: string[]): Promise<SuccessResult> {
return this.client.request<SuccessResult>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/groups/${encodeSegment(groupId)}/participants/demote`,
body: { participants },
});
}
/** Update the group subject (name). */
setSubject(sessionId: string, groupId: string, subject: string): Promise<SuccessResult> {
return this.client.request<SuccessResult>({
method: 'PUT',
path: `/api/sessions/${encodeSegment(sessionId)}/groups/${encodeSegment(groupId)}/subject`,
body: { subject },
});
}
/** Update the group description (empty string clears it). */
setDescription(sessionId: string, groupId: string, description: string): Promise<SuccessResult> {
return this.client.request<SuccessResult>({
method: 'PUT',
path: `/api/sessions/${encodeSegment(sessionId)}/groups/${encodeSegment(groupId)}/description`,
body: { description },
});
}
/** Get the group settings (announce / locked / ephemeral timer). */
getGroupSettings(sessionId: string, groupId: string): Promise<GroupSettingsResponse> {
return this.client.request<GroupSettingsResponse>({
method: 'GET',
path: `/api/sessions/${encodeSegment(sessionId)}/groups/${encodeSegment(groupId)}/settings`,
});
}
/**
* Update the group settings. At least one field is required; `ephemeralSeconds`
* is unsupported on the whatsapp-web.js engine (the server answers 501).
*/
updateGroupSettings(sessionId: string, groupId: string, body: UpdateGroupSettingsRequest): Promise<SuccessResult> {
return this.client.request<SuccessResult>({
method: 'PUT',
path: `/api/sessions/${encodeSegment(sessionId)}/groups/${encodeSegment(groupId)}/settings`,
body,
});
}
/** Leave a group. */
leave(sessionId: string, groupId: string): Promise<SuccessResult> {
return this.client.request<SuccessResult>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/groups/${encodeSegment(groupId)}/leave`,
});
}
/** Get the group invite code and link. */
inviteCode(sessionId: string, groupId: string): Promise<InviteCodeResponse> {
return this.client.request<InviteCodeResponse>({
method: 'GET',
path: `/api/sessions/${encodeSegment(sessionId)}/groups/${encodeSegment(groupId)}/invite-code`,
});
}
/** Revoke the current invite code and generate a new one. */
revokeInviteCode(sessionId: string, groupId: string): Promise<InviteCodeResponse> {
return this.client.request<InviteCodeResponse>({
method: 'POST',
path: `/api/sessions/${encodeSegment(sessionId)}/groups/${encodeSegment(groupId)}/invite-code/revoke`,
});
}
}
|