@@ -951,6 +951,10 @@ def remove_reaction(self, reaction_data: Dict[str, Any]) -> Dict[str, Any]:
951
951
)
952
952
953
953
def get_realm_emoji (self ) -> Dict [str , Any ]:
954
+ logger .warning ("get_realm_emoji() is deprecated." " Please use get_custom_emoji() instead." )
955
+ return self .get_custom_emoji ()
956
+
957
+ def get_custom_emoji (self ) -> Dict [str , Any ]:
954
958
"""
955
959
See examples/realm-emoji for example usage.
956
960
"""
@@ -978,6 +982,12 @@ def delete_custom_emoji(self, emoji_name: str) -> Dict[str, Any]:
978
982
)
979
983
980
984
def get_realm_linkifiers (self ) -> Dict [str , Any ]:
985
+ logger .warning (
986
+ "get_realm_linkifiers() is deprecated." " Please use get_linkifiers() instead."
987
+ )
988
+ return self .get_linkifiers ()
989
+
990
+ def get_linkifiers (self ) -> Dict [str , Any ]:
981
991
"""
982
992
Example usage:
983
993
@@ -1000,6 +1010,10 @@ def get_realm_linkifiers(self) -> Dict[str, Any]:
1000
1010
)
1001
1011
1002
1012
def add_realm_filter (self , pattern : str , url_format_string : str ) -> Dict [str , Any ]:
1013
+ logger .warning ("get_members() is deprecated." " Please use get_users() instead." )
1014
+ self .add_linkifier (pattern , url_format_string )
1015
+
1016
+ def add_linkifier (self , pattern : str , url_format_string : str ) -> Dict [str , Any ]:
1003
1017
"""
1004
1018
Example usage:
1005
1019
@@ -1016,6 +1030,12 @@ def add_realm_filter(self, pattern: str, url_format_string: str) -> Dict[str, An
1016
1030
)
1017
1031
1018
1032
def remove_realm_filter (self , filter_id : int ) -> Dict [str , Any ]:
1033
+ logger .warning (
1034
+ "remove_realm_filter() is deprecated." " Please use remove_linkifier() instead."
1035
+ )
1036
+ return self .remove_linkifier (filter_id )
1037
+
1038
+ def remove_linkifier (self , filter_id : int ) -> Dict [str , Any ]:
1019
1039
"""
1020
1040
Example usage:
1021
1041
@@ -1028,6 +1048,11 @@ def remove_realm_filter(self, filter_id: int) -> Dict[str, Any]:
1028
1048
)
1029
1049
1030
1050
def get_realm_profile_fields (self ) -> Dict [str , Any ]:
1051
+ logger .warning (
1052
+ "get_realm_profile_fields() is deprecated." " Please use get_custom_profile_fields() instead."
1053
+ )
1054
+ return self .get_custom_profile_fields ()
1055
+ def get_custom_profile_fields (self ) -> Dict [str , Any ]:
1031
1056
"""
1032
1057
Example usage:
1033
1058
@@ -1039,7 +1064,14 @@ def get_realm_profile_fields(self) -> Dict[str, Any]:
1039
1064
method = "GET" ,
1040
1065
)
1041
1066
1067
+
1042
1068
def create_realm_profile_field (self , ** request : Any ) -> Dict [str , Any ]:
1069
+ logger .warning (
1070
+ "create_realm_profile_field() is deprecated." " Please use create_custom_profile_field() instead."
1071
+ )
1072
+ return self .create_custom_profile_field (request )
1073
+
1074
+ def create_custom_profile_field (self , ** request : Any ) -> Dict [str , Any ]:
1043
1075
"""
1044
1076
Example usage:
1045
1077
@@ -1065,6 +1097,12 @@ def remove_realm_profile_field(self, field_id: int) -> Dict[str, Any]:
1065
1097
)
1066
1098
1067
1099
def reorder_realm_profile_fields (self , ** request : Any ) -> Dict [str , Any ]:
1100
+ logger .warning (
1101
+ "reorder_realm_profile_fields() is deprecated." " Please use reorder_custom_profile_fields() instead."
1102
+ )
1103
+ return self .reorder_custom_profile_fields (request )
1104
+
1105
+ def reorder_custom_profile_fields (self , ** request : Any ) -> Dict [str , Any ]:
1068
1106
"""
1069
1107
Example usage:
1070
1108
@@ -1078,6 +1116,12 @@ def reorder_realm_profile_fields(self, **request: Any) -> Dict[str, Any]:
1078
1116
)
1079
1117
1080
1118
def update_realm_profile_field (self , field_id : int , ** request : Any ) -> Dict [str , Any ]:
1119
+ logger .warning (
1120
+ "update_realm_profile_field() is deprecated." " Please use update_linkifier() instead."
1121
+ )
1122
+ return self .update_linkifier (field_id )
1123
+
1124
+ def update_linkifier (self , field_id : int , ** request : Any ) -> Dict [str , Any ]:
1081
1125
"""
1082
1126
Example usage:
1083
1127
@@ -1118,6 +1162,17 @@ def register(
1118
1162
event_types : Optional [Iterable [str ]] = None ,
1119
1163
narrow : Optional [List [List [str ]]] = None ,
1120
1164
** kwargs : object ,
1165
+ ) -> Dict [str , Any ]:
1166
+ logger .warning (
1167
+ "register() is deprecated." " Please use register_queue() instead."
1168
+ )
1169
+ return self .register_queue (event_types , narrow )
1170
+
1171
+ def register_queue (
1172
+ self ,
1173
+ event_types : Optional [Iterable [str ]] = None ,
1174
+ narrow : Optional [List [List [str ]]] = None ,
1175
+ ** kwargs : object ,
1121
1176
) -> Dict [str , Any ]:
1122
1177
"""
1123
1178
Example usage:
@@ -1139,6 +1194,12 @@ def register(
1139
1194
)
1140
1195
1141
1196
def deregister (self , queue_id : str , timeout : Optional [float ] = None ) -> Dict [str , Any ]:
1197
+ logger .warning (
1198
+ "deregister() is deprecated." " Please use delete_queue() instead."
1199
+ )
1200
+ return self .delete_queue (queue_id , timeout )
1201
+
1202
+ def delete_queue (self , queue_id : str , timeout : Optional [float ] = None ) -> Dict [str , Any ]:
1142
1203
"""
1143
1204
Example usage:
1144
1205
@@ -1157,6 +1218,10 @@ def deregister(self, queue_id: str, timeout: Optional[float] = None) -> Dict[str
1157
1218
)
1158
1219
1159
1220
def get_profile (self , request : Optional [Dict [str , Any ]] = None ) -> Dict [str , Any ]:
1221
+ logger .warning ("get_profile() is deprecated." " Please use get_own_user() instead." )
1222
+ self .get_own_user (request )
1223
+
1224
+ def get_own_user (self , request : Optional [Dict [str , Any ]] = None ) -> Dict [str , Any ]:
1160
1225
"""
1161
1226
Example usage:
1162
1227
@@ -1232,6 +1297,10 @@ def update_stream(self, stream_data: Dict[str, Any]) -> Dict[str, Any]:
1232
1297
)
1233
1298
1234
1299
def delete_stream (self , stream_id : int ) -> Dict [str , Any ]:
1300
+ logger .warning ("delete_stream() is deprecated." " Please use archive_stream() instead." )
1301
+ return self .archive_stream (stream_id )
1302
+
1303
+ def archive_stream (self , stream_id : int ) -> Dict [str , Any ]:
1235
1304
"""
1236
1305
See examples/delete-stream for example usage.
1237
1306
"""
@@ -1255,6 +1324,10 @@ def add_default_stream(self, stream_id: int) -> Dict[str, Any]:
1255
1324
)
1256
1325
1257
1326
def get_user_by_id (self , user_id : int , ** request : Any ) -> Dict [str , Any ]:
1327
+ logger .warning ("get_user_by_id() is deprecated." " Please use get_user() instead." )
1328
+ return self .get_user (user_id )
1329
+
1330
+ def get_user (self , user_id : int , ** request : Any ) -> Dict [str , Any ]:
1258
1331
1259
1332
"""
1260
1333
Example usage:
@@ -1269,6 +1342,10 @@ def get_user_by_id(self, user_id: int, **request: Any) -> Dict[str, Any]:
1269
1342
)
1270
1343
1271
1344
def deactivate_user_by_id (self , user_id : int ) -> Dict [str , Any ]:
1345
+ logger .warning ("deactivate_user_by_id() is deprecated." " Please use deactivate_user() instead." )
1346
+ return self .deactivate_user (user_id )
1347
+
1348
+ def deactivate_user (self , user_id : int ) -> Dict [str , Any ]:
1272
1349
1273
1350
"""
1274
1351
Example usage:
@@ -1282,6 +1359,10 @@ def deactivate_user_by_id(self, user_id: int) -> Dict[str, Any]:
1282
1359
)
1283
1360
1284
1361
def reactivate_user_by_id (self , user_id : int ) -> Dict [str , Any ]:
1362
+ logger .warning ("reactivate_user_by_id() is deprecated." " Please use reactivate_user() instead." )
1363
+ return self .reactivate_user (user_id )
1364
+
1365
+ def reactivate_user (self , user_id : int ) -> Dict [str , Any ]:
1285
1366
1286
1367
"""
1287
1368
Example usage:
@@ -1295,6 +1376,10 @@ def reactivate_user_by_id(self, user_id: int) -> Dict[str, Any]:
1295
1376
)
1296
1377
1297
1378
def update_user_by_id (self , user_id : int , ** request : Any ) -> Dict [str , Any ]:
1379
+ logger .warning ("update_user_by_id() is deprecated." " Please use update_user() instead." )
1380
+ return self .update_user (user_id , request )
1381
+
1382
+ def update_user (self , user_id : int , ** request : Any ) -> Dict [str , Any ]:
1298
1383
1299
1384
"""
1300
1385
Example usage:
@@ -1321,8 +1406,7 @@ def get_users(self, request: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
1321
1406
def get_members (self , request : Optional [Dict [str , Any ]] = None ) -> Dict [str , Any ]:
1322
1407
# This exists for backwards-compatibility; we renamed this
1323
1408
# function get_users for consistency with the rest of the API.
1324
- # Later, we may want to add a warning for clients using this
1325
- # legacy name.
1409
+ logger .warning ("get_members() is deprecated." " Please use get_users() instead." )
1326
1410
return self .get_users (request = request )
1327
1411
1328
1412
def get_alert_words (self ) -> Dict [str , Any ]:
@@ -1364,6 +1448,10 @@ def list_subscriptions(self, request: Optional[Dict[str, Any]] = None) -> Dict[s
1364
1448
return self .get_subscriptions (request )
1365
1449
1366
1450
def add_subscriptions (self , streams : Iterable [Dict [str , Any ]], ** kwargs : Any ) -> Dict [str , Any ]:
1451
+ logger .warning ("add_subscriptions() is deprecated." " Please use subscribe() instead." )
1452
+ return self .subscribe (streams )
1453
+
1454
+ def subscribe (self , streams : Iterable [Dict [str , Any ]], ** kwargs : Any ) -> Dict [str , Any ]:
1367
1455
"""
1368
1456
See examples/subscribe for example usage.
1369
1457
"""
@@ -1376,6 +1464,12 @@ def add_subscriptions(self, streams: Iterable[Dict[str, Any]], **kwargs: Any) ->
1376
1464
1377
1465
def remove_subscriptions (
1378
1466
self , streams : Iterable [str ], principals : Union [Sequence [str ], Sequence [int ]] = []
1467
+ ) -> Dict [str , Any ]:
1468
+ logger .warning ("remove_subscriptions() is deprecated." " Please use unsubscribe() instead." )
1469
+ return self .unsubscribe (streams , principals )
1470
+
1471
+ def unsubscribe (
1472
+ self , streams : Iterable [str ], principals : Union [Sequence [str ], Sequence [int ]] = []
1379
1473
) -> Dict [str , Any ]:
1380
1474
"""
1381
1475
See examples/unsubscribe for example usage.
0 commit comments