tessl/pypi-rocketchat-a-p-i
Python API wrapper for Rocket.Chat's REST API, enabling developers to programmatically interact with Rocket.Chat servers for chat automation, bot development, and integration purposes
—
Pending
groups.mddocs/
Private Groups
Private group management with enhanced privacy controls and restricted access. Provides similar functionality to public channels but with additional privacy and membership restrictions.
Capabilities
Group Creation and Management
def groups_create(self, name, **kwargs):
"""
Create a new private group.
Parameters:
- name (str): Group name
- members (list, optional): Initial members list
- readonly (bool, optional): Create as read-only
- customFields (dict, optional): Custom fields
Returns:
requests.Response: Group creation result
"""
def groups_info(self, room_id=None, room_name=None, **kwargs):
"""
Get private group information.
Parameters:
- room_id (str, optional): Group ID
- room_name (str, optional): Group name
Returns:
requests.Response: Group information
"""
def groups_delete(self, room_id=None, group=None, **kwargs):
"""
Delete a private group.
Parameters:
- room_id (str, optional): Group ID
- group (str, optional): Group name
Returns:
requests.Response: Deletion result
"""Group Listing and Access
def groups_list(self, **kwargs):
"""
List private groups user is part of.
Parameters:
- offset (int, optional): Number of items to skip
- count (int, optional): Number of items to return
Returns:
requests.Response: List of groups
"""
def groups_list_all(self, **kwargs):
"""
List all private groups (admin only).
Parameters:
- offset (int, optional): Number of items to skip
- count (int, optional): Number of items to return
Returns:
requests.Response: List of all groups
"""Membership Management
def groups_invite(self, room_id, user_id, **kwargs):
"""
Invite user to private group.
Parameters:
- room_id (str): Group ID
- user_id (str): User ID to invite
Returns:
requests.Response: Invitation result
"""
def groups_kick(self, room_id, user_id, **kwargs):
"""
Remove user from private group.
Parameters:
- room_id (str): Group ID
- user_id (str): User ID to remove
Returns:
requests.Response: Removal result
"""
def groups_leave(self, room_id, **kwargs):
"""
Leave private group.
Parameters:
- room_id (str): Group ID
Returns:
requests.Response: Leave result
"""
def groups_members(self, room_id=None, group=None, **kwargs):
"""
List group members.
Parameters:
- room_id (str, optional): Group ID
- group (str, optional): Group name
Returns:
requests.Response: List of members
"""Group Configuration
def groups_rename(self, room_id, name, **kwargs):
"""
Rename private group.
Parameters:
- room_id (str): Group ID
- name (str): New name
Returns:
requests.Response: Rename result
"""
def groups_set_description(self, room_id, description, **kwargs):
"""
Set group description.
Parameters:
- room_id (str): Group ID
- description (str): Description text
Returns:
requests.Response: Update result
"""
def groups_set_topic(self, room_id, topic, **kwargs):
"""
Set group topic.
Parameters:
- room_id (str): Group ID
- topic (str): Topic text
Returns:
requests.Response: Update result
"""
def groups_set_read_only(self, room_id, read_only, **kwargs):
"""
Set group read-only status.
Parameters:
- room_id (str): Group ID
- read_only (bool): Read-only status
Returns:
requests.Response: Update result
"""Role Management
def groups_add_moderator(self, room_id, user_id, **kwargs):
"""
Add group moderator.
Parameters:
- room_id (str): Group ID
- user_id (str): User ID
Returns:
requests.Response: Role assignment result
"""
def groups_add_owner(self, room_id, user_id, **kwargs):
"""
Add group owner.
Parameters:
- room_id (str): Group ID
- user_id (str): User ID
Returns:
requests.Response: Role assignment result
"""
def groups_add_leader(self, room_id, user_id, **kwargs):
"""
Add group leader.
Parameters:
- room_id (str): Group ID
- user_id (str): User ID
Returns:
requests.Response: Role assignment result
"""Install with Tessl CLI
npx tessl i tessl/pypi-rocketchat-a-p-i