Skip to content

Commit 4f88851

Browse files
pipozzzpipozzz
authored
Merge pull request #49 from soundstorm/master
Complete refresh
2 parents 3a32e0b + f4accc4 commit 4f88851

14 files changed

Lines changed: 385 additions & 33 deletions

‎README.md‎

Lines changed: 67 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -16,61 +16,99 @@ Python API wrapper for the [Rocket chat API](https://rocket.chat/docs/developer-
1616
#### Usage
1717

1818
Initialize the client with a username and password or token and user_id.
19-
This user *must* have Admin privs:
19+
Currently no 2FA is supported.
2020

2121
from rocketchat.api import RocketChatAPI
2222

2323
api = RocketChatAPI(settings={'username': 'someuser', 'password': 'somepassword',
24-
'domain': 'https://myrockethchatdomain.com'})
24+
'domain': 'https://myrocketchatdomain.com'})
2525
# or
2626
api = RocketChatAPI(settings={'token': 'sometoken', 'user_id': 'someuserid',
27-
'domain': 'https://myrockethchatdomain.com'})
27+
'domain': 'https://myrocketchatdomain.com'})
2828

2929
##### Available Calls
30+
31+
###### Messages / Rooms general functions
3032
api.send_message('message', 'room_id')
3133

34+
api.upload_file(room_id='room_id',
35+
file='file',
36+
description='File description',
37+
message='Example message')
38+
39+
api.upload_remote_file(room_id='room_id',
40+
url='url',
41+
description='File description',
42+
message='Example message')
43+
44+
###### Users
45+
api.create_user('email',
46+
'name',
47+
'password',
48+
'username',
49+
active=True,
50+
roles=['user'],
51+
join_default_channels=True,
52+
require_password_change=False,
53+
send_welcome_email=False,
54+
verified=False,
55+
customFields=None)
56+
57+
api.delete_user('user_id')
58+
59+
api.get_user_id('user_name')
60+
61+
api.get_users()
62+
63+
api.get_user_info('user_id')
64+
65+
api.get_my_info()
66+
67+
###### Direct Messages
68+
api.create_im_room('username')
69+
70+
api.close_room('room_id')
71+
72+
api.open_room('room_id')
73+
74+
api.get_im_room_history('room_id', oldest=date)
75+
76+
api.get_im_rooms()
77+
78+
###### Groups / Private Rooms
79+
api.create_private_room('room_name',
80+
members=[],
81+
read_only=False)
82+
83+
api.invite_private_room('room_id', 'user_id')
84+
3285
api.get_private_rooms()
3386

3487
api.get_private_room_history('room_id', oldest=date)
3588

36-
api.get_public_rooms()
37-
38-
api.get_room_info('room_id')
89+
api.get_room_id('room_name')
3990

4091
api.get_private_room_info('room_id')
4192

42-
api.get_room_history('room_id')
93+
api.set_room_topic('topic', 'room_id')
94+
95+
###### Channels / Public Rooms
96+
api.get_public_rooms()
4397

4498
api.create_public_room('room_name',
4599
members=[],
46100
read_only=False)
47101

48-
api.delete_public_room('room_id')
102+
api.invite_public_room('room_id', 'user_id')
49103

50-
api.get_my_info()
104+
api.get_room_info('room_id')
51105

52-
api.get_users()
106+
api.get_public_room_id('room_name')
53107

54-
api.get_user_info('user_id')
108+
api.get_room_history('room_id')
55109

56-
api.create_user('email',
57-
'name',
58-
'password',
59-
'username',
60-
active=True,
61-
roles=['user'],
62-
join_default_channels=True,
63-
require_password_change=False,
64-
send_welcome_email=False,
65-
verified=False,
66-
customFields=None)
67-
68-
api.delete_user('user_id')
110+
api.delete_public_room('room_id')
69111

70-
api.upload_file(room_id='room_id',
71-
file='file',
72-
description='File description',
73-
message='Example message')
74112

75113
check /rocketchat/calls/api.py for more.
76114

@@ -80,7 +118,6 @@ check /rocketchat/calls/api.py for more.
80118

81119
##### Sending a message
82120

83-
You'll first need to get the _id of the room you want to send a message to. Currently, Rocket
84-
can only send messages to *public* rooms.
121+
You'll first need to get the `_id` of the room you want to send a message to.
85122

86123
api.send_message('Your message', room_id)

‎docs/rocketchat.calls.channels.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ rocketchat.calls.channels.get\_history module
2828
:undoc-members:
2929
:show-inheritance:
3030

31+
rocketchat.calls.channels.invite\_public\_room module
32+
---------------------------------------------
33+
34+
.. automodule:: rocketchat.calls.channels.invite_public_room
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
3139
rocketchat.calls.channels.get\_public\_rooms module
3240
---------------------------------------------------
3341

@@ -36,6 +44,14 @@ rocketchat.calls.channels.get\_public\_rooms module
3644
:undoc-members:
3745
:show-inheritance:
3846

47+
rocketchat.calls.channels.get\_public\_room\_id module
48+
------------------------------------------------------
49+
50+
.. automodule:: rocketchat.calls.channels.get_public_room_id
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
3955
rocketchat.calls.channels.get\_room\_info module
4056
------------------------------------------------
4157

‎docs/rocketchat.calls.groups.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ rocketchat.calls.groups package
44
Submodules
55
----------
66

7+
rocketchat.calls.groups.create\_private\_room module
8+
----------------------------------------------------------
9+
10+
.. automodule:: rocketchat.calls.groups.create_private_room
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
715
rocketchat.calls.groups.get\_private\_room\_history module
816
----------------------------------------------------------
917

@@ -12,6 +20,14 @@ rocketchat.calls.groups.get\_private\_room\_history module
1220
:undoc-members:
1321
:show-inheritance:
1422

23+
rocketchat.calls.groups.invite\_private\_room module
24+
----------------------------------------------------------
25+
26+
.. automodule:: rocketchat.calls.groups.invite_private_room
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
1531
rocketchat.calls.groups.get\_private\_room\_info module
1632
-------------------------------------------------------
1733

@@ -44,6 +60,14 @@ rocketchat.calls.groups.upload\_file module
4460
:undoc-members:
4561
:show-inheritance:
4662

63+
rocketchat.calls.groups.upload\_remote\_file module
64+
---------------------------------------------------
65+
66+
.. automodule:: rocketchat.calls.groups.upload_remote_file
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:
70+
4771

4872
Module contents
4973
---------------

‎docs/rocketchat.calls.im.rst‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
rocketchat.calls.im package
2+
===========================
3+
4+
Submodules
5+
----------
6+
7+
rocketchat.calls.im.close\_room module
8+
--------------------------------------
9+
10+
.. automodule:: rocketchat.calls.im.close_room
11+
:members:
12+
:undoc-members:
13+
:show-inheritance:
14+
15+
rocketchat.calls.im.create\_room module
16+
---------------------------------------
17+
18+
.. automodule:: rocketchat.calls.im.create_room
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
rocketchat.calls.im.get\_history module
24+
---------------------------------------
25+
26+
.. automodule:: rocketchat.calls.im.get_history
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
rocketchat.calls.im.get\_rooms module
32+
-------------------------------------
33+
34+
.. automodule:: rocketchat.calls.im.get_rooms
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
rocketchat.calls.im.open\_room module
40+
-------------------------------------
41+
42+
.. automodule:: rocketchat.calls.im.open_room
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
48+
Module contents
49+
---------------
50+
51+
.. automodule:: rocketchat.calls.im
52+
:members:
53+
:undoc-members:
54+
:show-inheritance:

‎docs/rocketchat.calls.users.rst‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,14 @@ rocketchat.calls.users.delete\_user module
2020
:undoc-members:
2121
:show-inheritance:
2222

23+
rocketchat.calls.users.get\_user\_id module
24+
-------------------------------------------
25+
26+
.. automodule:: rocketchat.calls.users.get_user_id
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
2331
rocketchat.calls.users.get\_user\_info module
2432
---------------------------------------------
2533

0 commit comments

Comments
 (0)