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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
use std::collections::HashMap;
use serde::{Deserialize, Serialize};
use crate::{
field_access, impl_default, impl_display, impl_response, message::response::BaseResponse,
BasicChannel, Bot, ChannelFolder, CrossRealmBot, CustomProfileField, CustomProfileFieldType,
DefaultChannelGroup, Draft, GiphyRatingOption, GroupSetting, MutedTopic, MutedUser,
NavigationView, NeverSubscribed, OnboardingStep, PresenceList, PushDevice,
RealmAuthenticationMethod, RealmAvailableVideoChatProvider, RealmBilling,
RealmCreatePrivateStreamPolicy, RealmCreatePublicStreamPolicy,
RealmCreateWebPublicStreamPolicy, RealmDefaultExternalAccount, RealmDomain, RealmEmbeddedBot,
RealmEmoji, RealmFilter, RealmIncomingWebhookBot, RealmLinkifier,
RealmMessageEditHistoryVisibilityPolicy, RealmOrganizationType, RealmPlanType, RealmPlayground,
RealmUserSettingsDefault, RealmVideoChatProvider, RealmWildcardMentionPolicy,
RecentPrivateConversation, SavedSnippet, ScheduledMessage, ServerSupportedPermissionSetting,
ServerThumbnailFormat, Subscription, TopicsPolicy, UnreadMsgs, User, UserGroup, UserSettings,
UserSettingsEmojisetChoice, UserStatus, UserTopic,
};
/// Represents the response to a `Register` Zulip API request.
///
/// Modified from `openapi-generator-cli` output:
///
/// ```shell,no_build,no_run
/// $ openapi-generator-cli generate -g rust -i ./zerver/openapi/zulip.yaml -o zulip-openapi --skip-validate-spec
/// ```
///
/// ```text
/// /*
/// * Zulip REST API
/// *
/// * Powerful open source group chat
/// *
/// * The version of the OpenAPI document: 1.0.0
/// *
/// * Generated by: https://openapi-generator.tech
/// */
/// ```
///
/// See [zerver/openapi/zulip.yaml](https://github.com/zulip/zulip/blob/main/zerver/openapi/zulip.yaml) for the original OpenAPI configuration.
///
/// Configuration slightly modified to work with the Rust generator of [`openapi-generator-cli`](https://openapi-generator.tech).
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
pub struct Response {
#[serde(flatten)]
base: BaseResponse,
#[serde(skip_serializing_if = "Option::is_none")]
ignored_parameters_unsupported: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
queue_id: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
last_event_id: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
zulip_feature_level: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
zulip_version: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
zulip_merge_base: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
alert_words: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
custom_profile_fields: Option<Vec<CustomProfileField>>,
#[serde(skip_serializing_if = "Option::is_none")]
custom_profile_field_types: Option<HashMap<String, CustomProfileFieldType>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_date_created: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
demo_organization_scheduled_deletion_date: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
drafts: Option<Vec<Draft>>,
#[serde(skip_serializing_if = "Option::is_none")]
onboarding_steps: Option<Vec<OnboardingStep>>,
#[serde(skip_serializing_if = "Option::is_none")]
navigation_tour_video_url: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
max_message_id: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
max_reminder_note_length: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
max_stream_name_length: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
max_stream_description_length: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
max_channel_folder_name_length: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
max_channel_folder_description_length: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
max_topic_length: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
max_message_length: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
server_min_deactivated_realm_deletion_days: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
server_max_deactivated_realm_deletion_days: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
server_presence_ping_interval_seconds: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
server_presence_offline_threshold_seconds: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
server_typing_started_expiry_period_milliseconds: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
server_typing_stopped_wait_period_milliseconds: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
server_typing_started_wait_period_milliseconds: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
scheduled_messages: Option<Vec<ScheduledMessage>>,
#[serde(skip_serializing_if = "Option::is_none")]
reminders: Option<Vec<ScheduledMessage>>,
#[serde(skip_serializing_if = "Option::is_none")]
muted_topics: Option<Vec<MutedTopic>>,
#[serde(skip_serializing_if = "Option::is_none")]
muted_users: Option<Vec<MutedUser>>,
#[serde(skip_serializing_if = "Option::is_none")]
presences: Option<PresenceList>,
#[serde(skip_serializing_if = "Option::is_none")]
presence_last_update_id: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
server_timestamp: Option<f64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_domains: Option<Vec<RealmDomain>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_emoji: Option<std::collections::HashMap<String, RealmEmoji>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_linkifiers: Option<Vec<RealmLinkifier>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_filters: Option<Vec<RealmFilter>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_playgrounds: Option<Vec<RealmPlayground>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_user_groups: Option<Vec<UserGroup>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_bots: Option<Vec<Bot>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_embedded_bots: Option<Vec<RealmEmbeddedBot>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_incoming_webhook_bots: Option<Vec<RealmIncomingWebhookBot>>,
#[serde(skip_serializing_if = "Option::is_none")]
recent_private_conversations: Option<Vec<RecentPrivateConversation>>,
#[serde(skip_serializing_if = "Option::is_none")]
navigation_views: Option<Vec<NavigationView>>,
#[serde(skip_serializing_if = "Option::is_none")]
saved_snippets: Option<Vec<SavedSnippet>>,
#[serde(skip_serializing_if = "Option::is_none")]
subscriptions: Option<Vec<Subscription>>,
#[serde(skip_serializing_if = "Option::is_none")]
unsubscribed: Option<Vec<Subscription>>,
#[serde(skip_serializing_if = "Option::is_none")]
never_subscribed: Option<Vec<NeverSubscribed>>,
#[serde(skip_serializing_if = "Option::is_none")]
channel_folders: Option<Vec<ChannelFolder>>,
#[serde(skip_serializing_if = "Option::is_none")]
unread_msgs: Option<UnreadMsgs>,
#[serde(skip_serializing_if = "Option::is_none")]
starred_messages: Option<Vec<i64>>,
#[serde(skip_serializing_if = "Option::is_none")]
streams: Option<Vec<BasicChannel>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_default_streams: Option<Vec<i64>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_default_stream_groups: Option<Vec<DefaultChannelGroup>>,
#[serde(skip_serializing_if = "Option::is_none")]
stop_words: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
user_status: Option<std::collections::HashMap<String, UserStatus>>,
#[serde(skip_serializing_if = "Option::is_none")]
user_settings: Option<UserSettings>,
#[serde(skip_serializing_if = "Option::is_none")]
user_topics: Option<Vec<UserTopic>>,
#[serde(skip_serializing_if = "Option::is_none")]
has_zoom_token: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
giphy_api_key: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
push_devices: Option<std::collections::HashMap<String, PushDevice>>,
#[serde(skip_serializing_if = "Option::is_none")]
enable_desktop_notifications: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
enable_digest_emails: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
enable_login_emails: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
enable_marketing_emails: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
email_notifications_batching_period_seconds: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
enable_offline_email_notifications: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
enable_offline_push_notifications: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
enable_online_push_notifications: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
enable_sounds: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
enable_stream_desktop_notifications: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
enable_stream_email_notifications: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
enable_stream_push_notifications: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
enable_stream_audible_notifications: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
wildcard_mentions_notify: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
message_content_in_email_notifications: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
notification_sound: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
pm_content_in_desktop_notifications: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
desktop_icon_count_display: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_name_in_email_notifications_policy: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
presence_enabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
available_notification_sounds: Option<Vec<String>>,
#[serde(skip_serializing_if = "Option::is_none")]
color_scheme: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
default_language: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
demote_inactive_streams: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
emojiset: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
enable_drafts_synchronization: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
fluid_layout_width: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
web_home_view: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
high_contrast_mode: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
left_side_userlist: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
starred_message_counts: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
timezone: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
translate_emoticons: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
twenty_four_hour_time: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
receives_typing_notifications: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
enter_sends: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
emojiset_choices: Option<Vec<UserSettingsEmojisetChoice>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_message_edit_history_visibility_policy: Option<RealmMessageEditHistoryVisibilityPolicy>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_allow_edit_history: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_add_custom_emoji_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_add_subscribers_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_delete_any_message_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_delete_own_message_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_set_delete_message_policy_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_set_topics_policy_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_invite_users_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_mention_many_users_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_move_messages_between_channels_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_move_messages_between_topics_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_create_groups: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_create_bots_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_create_write_only_bots_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_manage_all_groups: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_manage_billing_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_create_public_channel_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_create_private_channel_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_create_web_public_channel_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_resolve_topics_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_create_public_stream_policy: Option<RealmCreatePublicStreamPolicy>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_create_private_stream_policy: Option<RealmCreatePrivateStreamPolicy>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_create_web_public_stream_policy: Option<RealmCreateWebPublicStreamPolicy>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_wildcard_mention_policy: Option<RealmWildcardMentionPolicy>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_default_language: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_welcome_message_custom_text: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_description: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_digest_emails_enabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_disallow_disposable_email_addresses: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_email_changes_disabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_invite_required: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_create_multiuse_invite_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_inline_image_preview: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_inline_url_embed_preview: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_topics_policy: Option<TopicsPolicy>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_mandatory_topics: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_message_retention_days: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_name: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_require_e2ee_push_notifications: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_require_unique_names: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_name_changes_disabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_avatar_changes_disabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_emails_restricted_to_domains: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_send_welcome_emails: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_message_content_allowed_in_email_notifications: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_enable_spectator_access: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_want_advertise_in_communities_directory: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_video_chat_provider: Option<RealmVideoChatProvider>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_jitsi_server_url: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_giphy_rating: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_waiting_period_threshold: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_digest_weekday: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_direct_message_initiator_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_direct_message_permission_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_default_code_block_language: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_message_content_delete_limit_seconds: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_authentication_methods: Option<HashMap<String, RealmAuthenticationMethod>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_allow_message_editing: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_message_content_edit_limit_seconds: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_move_messages_within_stream_limit_seconds: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_move_messages_between_streams_limit_seconds: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_enable_read_receipts: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_icon_url: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_icon_source: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
max_icon_file_size_mib: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_logo_url: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_logo_source: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_night_logo_url: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_night_logo_source: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
max_logo_file_size_mib: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_bot_domain: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_uri: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_url: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_available_video_chat_providers: Option<HashMap<String, RealmAvailableVideoChatProvider>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_presence_disabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
settings_send_digest_emails: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_email_auth_enabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_password_auth_enabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_push_notifications_enabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_push_notifications_enabled_end_timestamp: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_upload_quota_mib: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_org_type: Option<RealmOrganizationType>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_plan_type: Option<RealmPlanType>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_enable_guest_user_dm_warning: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_enable_guest_user_indicator: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_access_all_users_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_can_summarize_topics_group: Option<GroupSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
zulip_plan_is_not_limited: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
upgrade_text_for_wide_organization_logo: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_default_external_accounts: Option<HashMap<String, RealmDefaultExternalAccount>>,
#[serde(skip_serializing_if = "Option::is_none")]
jitsi_server_url: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
development_environment: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
server_generation: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
password_min_length: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
password_max_length: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
password_min_guesses: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
giphy_rating_options: Option<HashMap<String, GiphyRatingOption>>,
#[serde(skip_serializing_if = "Option::is_none")]
max_file_upload_size_mib: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
max_avatar_file_size_mib: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
server_inline_image_preview: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
server_inline_url_embed_preview: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
server_thumbnail_formats: Option<Vec<ServerThumbnailFormat>>,
#[serde(skip_serializing_if = "Option::is_none")]
server_avatar_changes_disabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
server_name_changes_disabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
server_needs_upgrade: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
server_web_public_streams_enabled: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
server_emoji_data_url: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
server_jitsi_server_url: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
server_can_summarize_topics: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
event_queue_longpoll_timeout_seconds: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_billing: Option<RealmBilling>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_moderation_request_channel_id: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_new_stream_announcements_stream_id: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_signup_announcements_stream_id: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_zulip_update_announcements_stream_id: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_empty_topic_display_name: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_user_settings_defaults: Option<RealmUserSettingsDefault>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_users: Option<Vec<User>>,
#[serde(skip_serializing_if = "Option::is_none")]
realm_non_active_users: Option<Vec<User>>,
#[serde(skip_serializing_if = "Option::is_none")]
avatar_source: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
avatar_url_medium: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
avatar_url: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
can_create_streams: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
can_create_public_streams: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
can_create_private_streams: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
can_create_web_public_streams: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
can_subscribe_other_users: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
can_invite_others_to_realm: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
is_admin: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
is_owner: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
is_moderator: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
is_guest: Option<bool>,
#[serde(skip_serializing_if = "Option::is_none")]
user_id: Option<i64>,
#[serde(skip_serializing_if = "Option::is_none")]
email: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
delivery_email: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
full_name: Option<String>,
#[serde(skip_serializing_if = "Option::is_none")]
cross_realm_bots: Option<Vec<CrossRealmBot>>,
#[serde(skip_serializing_if = "Option::is_none")]
server_supported_permission_settings: Option<ServerSupportedPermissionSetting>,
#[serde(skip_serializing_if = "Option::is_none")]
max_bulk_new_subscription_messages: Option<f64>,
}
impl Response {
/// Creates a new [Response].
pub const fn new() -> Self {
Self {
base: BaseResponse::new(),
ignored_parameters_unsupported: None,
queue_id: None,
last_event_id: None,
zulip_feature_level: None,
zulip_version: None,
zulip_merge_base: None,
alert_words: None,
custom_profile_fields: None,
custom_profile_field_types: None,
realm_date_created: None,
demo_organization_scheduled_deletion_date: None,
drafts: None,
onboarding_steps: None,
navigation_tour_video_url: None,
max_message_id: None,
max_reminder_note_length: None,
max_stream_name_length: None,
max_stream_description_length: None,
max_channel_folder_name_length: None,
max_channel_folder_description_length: None,
max_topic_length: None,
max_message_length: None,
server_min_deactivated_realm_deletion_days: None,
server_max_deactivated_realm_deletion_days: None,
server_presence_ping_interval_seconds: None,
server_presence_offline_threshold_seconds: None,
server_typing_started_expiry_period_milliseconds: None,
server_typing_stopped_wait_period_milliseconds: None,
server_typing_started_wait_period_milliseconds: None,
scheduled_messages: None,
reminders: None,
muted_topics: None,
muted_users: None,
presences: None,
presence_last_update_id: None,
server_timestamp: None,
realm_domains: None,
realm_emoji: None,
realm_linkifiers: None,
realm_filters: None,
realm_playgrounds: None,
realm_user_groups: None,
realm_bots: None,
realm_embedded_bots: None,
realm_incoming_webhook_bots: None,
recent_private_conversations: None,
navigation_views: None,
saved_snippets: None,
subscriptions: None,
unsubscribed: None,
never_subscribed: None,
channel_folders: None,
unread_msgs: None,
starred_messages: None,
streams: None,
realm_default_streams: None,
realm_default_stream_groups: None,
stop_words: None,
user_status: None,
user_settings: None,
user_topics: None,
has_zoom_token: None,
giphy_api_key: None,
push_devices: None,
enable_desktop_notifications: None,
enable_digest_emails: None,
enable_login_emails: None,
enable_marketing_emails: None,
email_notifications_batching_period_seconds: None,
enable_offline_email_notifications: None,
enable_offline_push_notifications: None,
enable_online_push_notifications: None,
enable_sounds: None,
enable_stream_desktop_notifications: None,
enable_stream_email_notifications: None,
enable_stream_push_notifications: None,
enable_stream_audible_notifications: None,
wildcard_mentions_notify: None,
message_content_in_email_notifications: None,
notification_sound: None,
pm_content_in_desktop_notifications: None,
desktop_icon_count_display: None,
realm_name_in_email_notifications_policy: None,
presence_enabled: None,
available_notification_sounds: None,
color_scheme: None,
default_language: None,
demote_inactive_streams: None,
emojiset: None,
enable_drafts_synchronization: None,
fluid_layout_width: None,
web_home_view: None,
high_contrast_mode: None,
left_side_userlist: None,
starred_message_counts: None,
timezone: None,
translate_emoticons: None,
twenty_four_hour_time: None,
receives_typing_notifications: None,
enter_sends: None,
emojiset_choices: None,
realm_message_edit_history_visibility_policy: None,
realm_allow_edit_history: None,
realm_can_add_custom_emoji_group: None,
realm_can_add_subscribers_group: None,
realm_can_delete_any_message_group: None,
realm_can_delete_own_message_group: None,
realm_can_set_delete_message_policy_group: None,
realm_can_set_topics_policy_group: None,
realm_can_invite_users_group: None,
realm_can_mention_many_users_group: None,
realm_can_move_messages_between_channels_group: None,
realm_can_move_messages_between_topics_group: None,
realm_can_create_groups: None,
realm_can_create_bots_group: None,
realm_can_create_write_only_bots_group: None,
realm_can_manage_all_groups: None,
realm_can_manage_billing_group: None,
realm_can_create_public_channel_group: None,
realm_can_create_private_channel_group: None,
realm_can_create_web_public_channel_group: None,
realm_can_resolve_topics_group: None,
realm_create_public_stream_policy: None,
realm_create_private_stream_policy: None,
realm_create_web_public_stream_policy: None,
realm_wildcard_mention_policy: None,
realm_default_language: None,
realm_welcome_message_custom_text: None,
realm_description: None,
realm_digest_emails_enabled: None,
realm_disallow_disposable_email_addresses: None,
realm_email_changes_disabled: None,
realm_invite_required: None,
realm_create_multiuse_invite_group: None,
realm_inline_image_preview: None,
realm_inline_url_embed_preview: None,
realm_topics_policy: None,
realm_mandatory_topics: None,
realm_message_retention_days: None,
realm_name: None,
realm_require_e2ee_push_notifications: None,
realm_require_unique_names: None,
realm_name_changes_disabled: None,
realm_avatar_changes_disabled: None,
realm_emails_restricted_to_domains: None,
realm_send_welcome_emails: None,
realm_message_content_allowed_in_email_notifications: None,
realm_enable_spectator_access: None,
realm_want_advertise_in_communities_directory: None,
realm_video_chat_provider: None,
realm_jitsi_server_url: None,
realm_giphy_rating: None,
realm_waiting_period_threshold: None,
realm_digest_weekday: None,
realm_direct_message_initiator_group: None,
realm_direct_message_permission_group: None,
realm_default_code_block_language: None,
realm_message_content_delete_limit_seconds: None,
realm_authentication_methods: None,
realm_allow_message_editing: None,
realm_message_content_edit_limit_seconds: None,
realm_move_messages_within_stream_limit_seconds: None,
realm_move_messages_between_streams_limit_seconds: None,
realm_enable_read_receipts: None,
realm_icon_url: None,
realm_icon_source: None,
max_icon_file_size_mib: None,
realm_logo_url: None,
realm_logo_source: None,
realm_night_logo_url: None,
realm_night_logo_source: None,
max_logo_file_size_mib: None,
realm_bot_domain: None,
realm_uri: None,
realm_url: None,
realm_available_video_chat_providers: None,
realm_presence_disabled: None,
settings_send_digest_emails: None,
realm_email_auth_enabled: None,
realm_password_auth_enabled: None,
realm_push_notifications_enabled: None,
realm_push_notifications_enabled_end_timestamp: None,
realm_upload_quota_mib: None,
realm_org_type: None,
realm_plan_type: None,
realm_enable_guest_user_dm_warning: None,
realm_enable_guest_user_indicator: None,
realm_can_access_all_users_group: None,
realm_can_summarize_topics_group: None,
zulip_plan_is_not_limited: None,
upgrade_text_for_wide_organization_logo: None,
realm_default_external_accounts: None,
jitsi_server_url: None,
development_environment: None,
server_generation: None,
password_min_length: None,
password_max_length: None,
password_min_guesses: None,
giphy_rating_options: None,
max_file_upload_size_mib: None,
max_avatar_file_size_mib: None,
server_inline_image_preview: None,
server_inline_url_embed_preview: None,
server_thumbnail_formats: None,
server_avatar_changes_disabled: None,
server_name_changes_disabled: None,
server_needs_upgrade: None,
server_web_public_streams_enabled: None,
server_emoji_data_url: None,
server_jitsi_server_url: None,
server_can_summarize_topics: None,
event_queue_longpoll_timeout_seconds: None,
realm_billing: None,
realm_moderation_request_channel_id: None,
realm_new_stream_announcements_stream_id: None,
realm_signup_announcements_stream_id: None,
realm_zulip_update_announcements_stream_id: None,
realm_empty_topic_display_name: None,
realm_user_settings_defaults: None,
realm_users: None,
realm_non_active_users: None,
avatar_source: None,
avatar_url_medium: None,
avatar_url: None,
can_create_streams: None,
can_create_public_streams: None,
can_create_private_streams: None,
can_create_web_public_streams: None,
can_subscribe_other_users: None,
can_invite_others_to_realm: None,
is_admin: None,
is_owner: None,
is_moderator: None,
is_guest: None,
user_id: None,
email: None,
delivery_email: None,
full_name: None,
cross_realm_bots: None,
server_supported_permission_settings: None,
max_bulk_new_subscription_messages: None,
}
}
}
field_access! {
Response {
/// The initial value of `last_event_id` to pass to `GET /api/v1/events`.
last_event_id: option { i64 },
/// The server's current [Zulip feature level](https://zulip.com/api/changelog).
///
/// **Changes**: As of Zulip 3.0 (feature level 3), this is always present in the endpoint's response.
/// Previously, it was only present if `event_types` included `zulip_version`.
///
/// New in Zulip 3.0 (feature level 1).
zulip_feature_level: option { i64 },
/// The UNIX timestamp (UTC) for when the organization was created.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 8.0 (feature level 203).
realm_date_created: option { i64 },
/// The UNIX timestamp (UTC) when the demo organization will be automatically deleted.
///
/// Present if `realm` is present in `fetch_event_types`, and the realm is a demo organization.
///
/// Clients should use this to display a prominent warning to the user that the organization will be deleted at the indicated time.
///
/// **Changes**: New in Zulip 5.0 (feature level 94).
demo_organization_scheduled_deletion_date: option { i64 },
/// The highest message ID among all messages the user has received as of the moment of this request.
///
/// Present if `message` is present in `fetch_event_types`.
///
/// **Deprecated**: This field may be removed in future versions as it no longer has a clear purpose.
/// Clients wishing to fetch the latest messages should pass `\"anchor\": \"latest\"` to `GET /messages`.
max_message_id: option { i64 },
/// The maximum allowed length for a reminder note. **Changes**: New in Zulip 11.0 (feature level 415).
max_reminder_note_length: option { i64 },
/// The maximum allowed length for a channel description, in Unicode code points. Clients should use this property rather than hardcoding field sizes.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 4.0 (feature level 53). Previously, this required `stream` in `fetch_event_types`, was called `stream_description_max_length`, and always had a value of 1024.
max_stream_description_length: option { i64 },
/// The maximum allowed length for a channel folder description, in Unicode code points.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Clients should use this property rather than hardcoding field sizes.
///
/// **Changes**: New in Zulip 11.0 (feature level 410). Clients should use 1024 as a fallback value on previous feature levels.
max_channel_folder_description_length: option { i64 },
/// The maximum allowed length for a topic, in Unicode code points. Clients should use this property rather than hardcoding field sizes.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 4.0 (feature level 53). Previously, this property always had a value of 60.
max_topic_length: option { i64 },
/// The maximum allowed length for a message, in Unicode code points. Clients should use this property rather than hardcoding field sizes.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 4.0 (feature level 53). Previously, this property always had a value of 10000.
max_message_length: option { i64 },
/// The minimum permitted number of days before full data deletion (users, channels, messages, etc.) of a deactivated organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// If `null`, then a deactivated organization's data can be deleted immediately.
///
/// **Changes**: New in Zulip 10.0 (feature level 332)
server_min_deactivated_realm_deletion_days: option { i64 },
/// The maximum permitted number of days before full data deletion (users, channels, messages, etc.) of a deactivated organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// If `null`, then a deactivated organization's data can be retained indefinitely.
///
/// **Changes**: New in Zulip 10.0 (feature level 332).
server_max_deactivated_realm_deletion_days: option { i64 },
/// For clients implementing the [presence](https://zulip.com/api/get-presence) system,
/// the time interval the client should use for sending presence requests to the server
/// (and thus receive presence updates from the server).
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// It is important for presence implementations to use both this and `server_presence_offline_threshold_seconds` correctly,
/// so that a Zulip server can change these values to manage the trade-off between load and freshness of presence data.
///
/// **Changes**: New in Zulip 7.0 (feature level 164). Clients should use 60 for older Zulip servers,
/// since that's the value that was hardcoded in the Zulip mobile apps prior to this parameter being introduced.
server_presence_ping_interval_seconds: option { i64 },
/// How old a presence timestamp for a given user can be before the user should be displayed as offline by clients displaying Zulip presence data.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// See the related `server_presence_ping_interval_seconds` for details.
///
/// **Changes**: New in Zulip 7.0 (feature level 164). Clients should use 140 for older Zulip servers,
/// since that's the value that was hardcoded in the Zulip client apps prior to this parameter being introduced.
server_presence_offline_threshold_seconds: option { i64 },
/// For clients implementing [typing notifications](https://zulip.com/api/set-typing-status) protocol,
/// the time interval in milliseconds that the client should wait for additional [typing start](https://zulip.com/api/get-events#typing-start)
/// events from the server before removing an active typing indicator.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 8.0 (feature level 204).
/// Clients should use 15000 for older Zulip servers, since that's the value that was hardcoded in the Zulip apps prior to this parameter being introduced.
server_typing_started_expiry_period_milliseconds: option { i64 },
/// For clients implementing [typing notifications](https://zulip.com/api/set-typing-status) protocol,
/// the time interval in milliseconds that the client should use to send regular start notifications
/// to the server to indicate that the user is still actively interacting with the compose UI.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 8.0 (feature level 204).
/// Clients should use 10000 for older Zulip servers,
/// since that's the value that was hardcoded in the Zulip apps prior to this parameter being introduced.
server_typing_started_wait_period_milliseconds: option { i64 },
/// Provides the `last_update_id` value of the latest presence data fetched by the server and included in the response in `presences`.
///
/// Present if `presence` is present in `fetch_event_types`.
///
/// This can be used as the value of the `presence_last_update_id` parameter when polling for presence data at the
/// [/users/me/presence](https://zulip.com/api/update-presence) endpoint to tell the server to only fetch the relevant newer data in order to skip redundant already-known presence information.
///
/// **Changes**: New in Zulip 9.0 (feature level 263).
presence_last_update_id: option { i64 },
/// The time when the server fetched the `presences` data included in the response. Matches the similar field in presence responses.
///
/// Present if `presence` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 5.0 (feature level 70).
server_timestamp: option { f64 },
/// A boolean which signifies whether the user has a Zoom token and has thus completed OAuth flow for the [Zoom integration](https://zulip.com/help/configure-call-provider).
///
/// Present if `video_calls` is present in `fetch_event_types`.
///
/// Clients need to know whether initiating Zoom OAuth is required before creating a Zoom call.
has_zoom_token: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object` in their
/// [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
enable_desktop_notifications: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object` in their
/// [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
enable_digest_emails: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object` in their
/// [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
enable_login_emails: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object` in their
/// [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
enable_marketing_emails: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object` in their
/// [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
email_notifications_batching_period_seconds: option { i64 },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object` in their
/// [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
enable_offline_email_notifications: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
enable_offline_push_notifications: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
enable_sounds: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
enable_stream_desktop_notifications: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
enable_stream_email_notifications: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
enable_stream_push_notifications: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
enable_stream_audible_notifications: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
wildcard_mentions_notify: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
message_content_in_email_notifications: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
pm_content_in_desktop_notifications: option { bool },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
desktop_icon_count_display: option { i64 },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: In Zulip 7.0 (feature level 168), replaced previous `realm_name_in_notifications` global notifications setting with `realm_name_in_email_notifications_policy`.
///
/// **Deprecated** since Zulip 5.0 (feature level 89); both `realm_name_in_notifications` and the newer `realm_name_in_email_notifications_policy` are deprecated.
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
realm_name_in_email_notifications_policy: option { i64 },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
presence_enabled: option { bool },
/// The color scheme selected by the user.
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
color_scheme: option { i64 },
/// Whether the user has chosen to hide inactive channels.
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
demote_inactive_streams: option { i64 },
/// Whether drafts synchronization is enabled for the user.
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// If disabled, clients will receive an error when trying to use the `drafts` endpoints.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
///
/// New in Zulip 5.0 (feature level 87).
enable_drafts_synchronization: option { bool },
/// Whether the user has chosen for the layout width to be fluid.
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
fluid_layout_width: option { bool },
/// Whether has switched on high contrast mode.
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
high_contrast_mode: option { bool },
/// Whether the user has chosen for the userlist to be displayed on the left side of the screen (for desktop app and web app) in narrow windows.
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
left_side_userlist: option { bool },
/// Whether the user has chosen the number of starred messages to be displayed similar to unread counts.
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
starred_message_counts: option { bool },
/// Whether the user has chosen for emoticons to be translated into emoji in the Zulip compose box.
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
translate_emoticons: option { bool },
/// Whether the user has chosen a twenty four hour time display (true) or a twelve hour one (false).
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
twenty_four_hour_time: option { bool },
/// Whether the user is configured to receive typing notifications from other users.
///
/// The server will only deliver typing notifications events to users who for whom this is enabled.
///
/// **Changes**: New in Zulip 9.0 (feature level 253). Previously, there were only options to disable sending typing notifications.
receives_typing_notifications: option { bool },
/// Whether the user setting for [sending on pressing Enter](https://zulip.com/help/configure-send-message-keys) in the compose box is enabled.
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and process the `user_settings` event type instead.
///
/// Prior to Zulip 5.0 (feature level 84), this field was present in response if `realm_user` was present in `fetch_event_types`, not `update_display_settings`.
enter_sends: option { bool },
/// Whether this organization is configured to allow users to access [message edit history](https://zulip.com/help/view-a-messages-edit-history).
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// The value of `realm_allow_edit_history` is set as `false` if the `realm_message_edit_history_visibility_policy`
/// is configured as \"None\" and `true` if it is configured as \"Moves only\" or \"All\".
///
/// **Changes**: Deprecated in Zulip 10.0 (feature level 358) and will be removed in the future,
/// as it is an inaccurate version `realm_message_edit_history_visibility_policy`, which replaces this field.
realm_allow_edit_history: option { bool },
/// A deprecated representation of a superset of the users who have permission to create public channels in the organization, available for backwards-compatibility.
///
/// Present if `realm` is present in `fetch_event_types`.
realm_create_public_stream_policy: option { RealmCreatePublicStreamPolicy },
/// A deprecated representation of a superset of the users who have permission to create private channels in the organization, available for backwards-compatibility.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Clients should use `can_create_private_channel_group` instead.
realm_create_private_stream_policy: option { RealmCreatePrivateStreamPolicy },
/// A deprecated representation of a superset of the users who have permission to create web-public channels in the organization, available for backwards-compatibility.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Clients should use `can_create_web_public_channel_group` instead.
realm_create_web_public_stream_policy: option { RealmCreateWebPublicStreamPolicy },
/// A deprecated representation of a superset of the users who have permission to use wildcard mentions in large channels, available for backwards-compatibility.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Clients should use `can_create_web_public_channel_group` instead.
realm_wildcard_mention_policy: option { RealmWildcardMentionPolicy },
/// Present if `realm` is present in `fetch_event_types`.
///
/// Whether the organization has enabled [weekly digest emails](https://zulip.com/help/digest-emails).
realm_digest_emails_enabled: option { bool },
/// Present if `realm` is present in `fetch_event_types`.
///
/// Whether the organization disallows disposable email addresses.
realm_disallow_disposable_email_addresses: option { bool },
/// Present if `realm` is present in `fetch_event_types`.
///
/// Whether users are allowed to change their own email address in this organization.
/// This is typically disabled for organizations that synchronize accounts from LDAP or a similar corporate database.
realm_email_changes_disabled: option { bool },
/// Present if `realm` is present in `fetch_event_types`.
///
/// Whether an invitation is required to join this organization.
realm_invite_required: option { bool },
/// Present if `realm` is present in `fetch_event_types`.
///
/// Whether this organization has been configured to enable [previews of linked images](https://zulip.com/help/image-video-and-website-previews).
realm_inline_image_preview: option { bool },
/// Whether this organization has been configured to enable [previews of linked websites](https://zulip.com/help/image-video-and-website-previews).
///
/// Present if `realm` is present in `fetch_event_types`.
realm_inline_url_embed_preview: option { bool },
/// Present if `realm` is present in `fetch_event_types`.
realm_topics_policy: option { TopicsPolicy },
/// Whether [topics are required](https://zulip.com/help/require-topics) for messages in this organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: Deprecated in Zulip 11.0 (feature level 392). This is now controlled by the realm `topics_policy` setting.
realm_mandatory_topics: option { bool },
/// The default [message retention policy](https://zulip.com/help/message-retention-policy) for this organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// It can have one special value:
///
/// - `-1` denoting that the messages will be retained forever for this realm, by default.
///
/// **Changes**: Prior to Zulip 3.0 (feature level 22),
/// no limit was encoded as `null` instead of `-1`.
/// Clients can correctly handle all server versions by treating both `-1` and `null` as indicating unlimited message retention.
realm_message_retention_days: option { i64 },
/// Whether this realm is configured to disallow sending mobile push notifications with message content through the legacy mobile push notifications APIs.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// The new API uses end-to-end encryption to protect message content and metadata from being accessible to the push bouncer service, APNs, and FCM.
/// Clients that support the new E2EE API will use it automatically regardless of this setting.
///
/// If `true`, mobile push notifications sent to clients that lack support for E2EE push notifications will always have \"New message\" as their content.
/// Note that these legacy mobile notifications will still contain metadata, which may include the message's ID, the sender's name, email address, and avatar.
///
/// In a future release, once the official mobile apps have implemented fully validated their E2EE protocol support,
/// this setting will become strict, and disable the legacy protocol entirely.
///
/// **Changes**: New in Zulip 11.0 (feature level 409). Previously, this behavior was available only via the `PUSH_NOTIFICATION_REDACT_CONTENT` global server setting.
realm_require_e2ee_push_notifications: option { bool },
/// Indicates whether the organization is configured to require users to have unique full names.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// If true, the server will reject attempts to create a new user, or change the name of an existing user,
/// where doing so would lead to two users whose names are identical modulo case and unicode normalization.
///
/// **Changes**: New in Zulip 9.0 (feature level 246). Previously, the Zulip server could not be configured to enforce unique names.
realm_require_unique_names: option { bool },
/// Indicates whether users are [allowed to change](https://zulip.com/help/restrict-name-and-email-changes) their name via the Zulip UI in this organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Typically disabled in organizations syncing this type of account information from an external user database like LDAP.
realm_name_changes_disabled: option { bool },
/// Indicates whether users are [allowed to change](https://zulip.com/help/restrict-name-and-email-changes) their avatar via the Zulip UI in this organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Typically disabled in organizations syncing this type of account information from an external user database like LDAP.
realm_avatar_changes_disabled: option { bool },
/// Whether [new users joining](https://zulip.com/help/restrict-account-creation#configuring-email-domain-restrictions) this organization are required to have an email address in one of the `realm_domains` configured for the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
realm_emails_restricted_to_domains: option { bool },
/// Whether or not this organization is configured to send the standard Zulip [welcome emails](https://zulip.com/help/disable-welcome-emails) to new users joining the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
realm_send_welcome_emails: option { bool },
/// Whether notification emails in this organization are allowed to contain Zulip the message content, or simply indicate that a new message was sent.
///
/// Present if `realm` is present in `fetch_event_types`.
realm_message_content_allowed_in_email_notifications: option { bool },
/// Whether web-public channels and related anonymous access APIs/features are enabled in this organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Can only be enabled if the `WEB_PUBLIC_STREAMS_ENABLED` [server setting](https://zulip.readthedocs.io/en/stable/production/settings.html) is enabled on the Zulip server.
/// See also the `can_create_web_public_channel_group` realm setting.
///
/// **Changes**: New in Zulip 5.0 (feature level 109).
realm_enable_spectator_access: option { bool },
/// Whether the organization has given permission to be advertised in the Zulip [communities directory](https://zulip.com/help/communities-directory).
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Useful only to clients supporting changing this setting for the organization.
///
/// Giving permission via this setting does not guarantee that an organization will be listed in the Zulip communities directory.
///
/// **Changes**: New in Zulip 6.0 (feature level 129).
realm_want_advertise_in_communities_directory: option { bool },
/// The configured GIPHY rating for the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 4.0 (feature level 55).
realm_giphy_rating: option { i64 },
/// Members whose accounts have been created at least this many days ago will be treated as
/// [full members](https://zulip.com/api/roles-and-permissions#determining-if-a-user-is-a-full-member) for the purpose of settings that restrict access to new members.
///
/// Present if `realm` is present in `fetch_event_types`.
realm_waiting_period_threshold: option { i64 },
/// The day of the week when the organization will send its weekly digest email to inactive users.
///
/// Present if `realm` is present in `fetch_event_types`.
realm_digest_weekday: option { i64 },
/// Messages sent more than this many seconds ago cannot be deleted with this organization's [message deletion policy](https://zulip.com/help/restrict-message-editing-and-deletion).
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Will not be 0. A `null` value means no limit: messages can be deleted regardless of how long ago they were sent.
///
/// **Changes**: No limit was represented using the special value `0` before Zulip 5.0 (feature level 100).
realm_message_content_delete_limit_seconds: option { i64 },
/// Whether this organization's [message edit policy](https://zulip.com/help/restrict-message-editing-and-deletion) allows editing the content of messages.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// See [`PATCH /messages/{message_id}`](https://zulip.com/api/update-message) for details and history of how message editing permissions work.
realm_allow_message_editing: option { bool },
/// Messages sent more than this many seconds ago cannot be edited with this organization's [message edit policy](https://zulip.com/help/restrict-message-editing-and-deletion).
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Will not be `0`. A `null` value means no limit, so messages can be edited regardless of how long ago they were sent.
///
/// See [`PATCH /messages/{message_id}`](https://zulip.com/api/update-message) for details and history of how message editing permissions work.
///
/// **Changes**: Before Zulip 6.0 (feature level 138), no limit was represented using the special value `0`.
realm_message_content_edit_limit_seconds: option { i64 },
/// Messages sent more than this many seconds ago cannot be moved within a channel to another topic by
/// users who have permission to do so based on this organization's [topic edit policy](https://zulip.com/help/restrict-moving-messages).
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// This setting does not affect moderators and administrators.
///
/// Will not be `0`. A `null` value means no limit, so message topics can be edited regardless of how long ago they were sent.
///
/// See [`PATCH /messages/{message_id}`](https://zulip.com/api/update-message) for details and history of how message editing permissions work.
///
/// **Changes**: New in Zulip 7.0 (feature level 162). Previously, this time limit was always 72 hours for users who were not administrators or moderators.
realm_move_messages_within_stream_limit_seconds: option { i64 },
/// Messages sent more than this many seconds ago cannot be moved between channels by users who have permission to do so based
/// on this organization's [message move policy](https://zulip.com/help/restrict-moving-messages).
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// This setting does not affect moderators and administrators.
///
/// Will not be `0`. A `null` value means no limit, so messages can be moved regardless of how long ago they were sent.
///
/// See [`PATCH /messages/{message_id}`](https://zulip.com/api/update-message) for details and history of how message editing permissions work.
///
/// **Changes**: New in Zulip 7.0 (feature level 162). Previously, there was no time limit for moving messages between channels for users with permission to do so.
realm_move_messages_between_streams_limit_seconds: option { i64 },
/// Whether read receipts is enabled in the organization or not.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// If disabled, read receipt data will be unavailable to clients, regardless of individual users' personal read receipt settings.
/// See also the `send_read_receipts` setting within `realm_user_settings_defaults`.
///
/// **Changes**: New in Zulip 6.0 (feature level 137).
realm_enable_read_receipts: option { bool },
/// The maximum file size allowed for the organization's icon. Useful for UI allowing editing the organization's icon.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 5.0 (feature level 72). Previously, this was called `max_icon_file_size`.
max_icon_file_size_mib: option { i64 },
/// The maximum file size allowed for the uploaded organization logos.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 5.0 (feature level 72). Previously, this was called `max_logo_file_size`.
max_logo_file_size_mib: option { i64 },
/// Whether online presence of other users is shown in this organization.
///
/// Present if `realm` is present in `fetch_event_types`.
realm_presence_disabled: option { bool },
/// Whether this Zulip server is configured to allow organizations to enable [digest emails](https://zulip.com/help/digest-emails).
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Relevant for administrative settings UI that can change the digest email settings.
settings_send_digest_emails: option { bool },
/// Whether the organization has enabled Zulip's default email and password authentication feature.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Determines whether Zulip stores a password for the user and clients should offer any UI for changing the user's Zulip password.
realm_email_auth_enabled: option { bool },
/// Whether the organization allows any sort of password-based authentication (whether via EmailAuthBackend or LDAP passwords).
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Determines whether a client might ever need to display a password prompt
/// (clients will primarily look at this attribute in [server_settings](https://zulip.com/api/get-server-settings) before presenting a login page).
realm_password_auth_enabled: option { bool },
/// Whether push notifications are enabled for this organization. Typically `true` for Zulip Cloud and self-hosted realms that have a
/// valid registration for the [Mobile push notifications service](https://zulip.readthedocs.io/en/latest/production/mobile-push-notifications.html),
/// and `false` for self-hosted servers that do not.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: Before Zulip 8.0 (feature level 231),
/// this incorrectly was `true` for servers that were partly configured to use the Mobile Push Notifications Service but not properly registered.
realm_push_notifications_enabled: option { bool },
/// If the server expects the realm's push notifications access to end at a definite time in the future,
/// the UNIX timestamp (UTC) at which this is expected to happen.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Mobile clients should use this field to display warnings to users when the indicated timestamp is near.
///
/// **Changes**: New in Zulip 8.0 (feature level 231).
realm_push_notifications_enabled_end_timestamp: option { i64 },
/// The total quota for uploaded files in this organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Clients are not responsible for checking this quota; it is included in the API only for display purposes.
///
/// If `null`, there is no limit.
///
/// **Changes**: Before Zulip 9.0 (feature level 251), this field was incorrectly measured in bytes, not MiB.
///
/// New in Zulip 5.0 (feature level 72). Previously, this was called `realm_upload_quota`.
realm_upload_quota_mib: option { i64 },
/// Represents the [organization type](https://zulip.com/help/organization-type) for the realm.
///
/// Present if `realm` is present in `fetch_event_types`.
realm_org_type: option { RealmOrganizationType },
/// Represents the plan type of the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
realm_plan_type: option { RealmPlanType },
/// Whether clients should show a warning when a user is composing a DM to a guest user in this organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 10.0 (feature level 348).
realm_enable_guest_user_dm_warning: option { bool },
/// Whether clients should display \"(guest)\" after the names of guest users to prominently highlight their status.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 8.0 (feature level 216).
realm_enable_guest_user_indicator: option { bool },
/// Whether the organization is using a limited (Zulip Cloud Free) plan.
///
/// Present if `realm` is present in `fetch_event_types`.
zulip_plan_is_not_limited: option { bool },
/// Whether this Zulip server is a development environment.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Used to control certain features or UI (such as error popups) that should only apply when connected to a Zulip development environment.
development_environment: option { bool },
/// A timestamp indicating when the process hosting this event queue was started.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Clients will likely only find this value useful for inclusion in detailed error reports.
server_generation: option { i64 },
/// This Zulip server's configured minimum required length for passwords.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Necessary for password change UI to show whether the password will be accepted.
password_min_length: option { i64 },
/// This Zulip server's configured maximum length for passwords.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Necessary for password change UI to show whether the password will be accepted.
///
/// **Changes**: New in Zulip 10.0 (feature level 338).
password_max_length: option { i64 },
/// This Zulip server's configured minimum `zxcvbn` minimum guesses.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Necessary for password change UI to show whether the password will be accepted.
password_min_guesses: option { i64 },
/// The maximum file size that can be uploaded to this Zulip organization.
///
/// Present if `realm` is present in `fetch_event_types`.
max_file_upload_size_mib: option { i64 },
/// The maximum avatar size that can be uploaded to this Zulip server.
///
/// Present if `realm` is present in `fetch_event_types`.
max_avatar_file_size_mib: option { i64 },
/// Whether the server is configured with support for inline image previews.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Clients containing administrative UI for changing `realm_inline_image_preview` should consult this field before offering that feature.
server_inline_image_preview: option { bool },
/// Whether the server is configured with support for inline URL previews.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Clients containing administrative UI for changing `realm_inline_url_embed_preview` should consult this field before offering that feature.
server_inline_url_embed_preview: option { bool },
/// Whether the server allows avatar changes.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Similar to `realm_avatar_changes_disabled` but based on the `AVATAR_CHANGES_DISABLED` Zulip server level setting.
server_avatar_changes_disabled: option { bool },
/// Whether the server allows name changes.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Similar to `realm_name_changes_disabled` but based on the `NAME_CHANGES_DISABLED` Zulip server level setting.
server_name_changes_disabled: option { bool },
/// Whether the server is running an old version based on the Zulip [server release lifecycle](https://zulip.readthedocs.io/en/latest/overview/release-lifecycle.html#upgrade-nag),
/// such that the web app will display to the current user a prominent warning.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 5.0 (feature level 74).
server_needs_upgrade: option { bool },
/// The value of the `WEB_PUBLIC_STREAMS_ENABLED` Zulip server level setting.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// A server that has disabled this setting intends to not offer [web public channels](https://zulip.com/help/public-access-option) to realms it hosts.
/// (Zulip Cloud defaults to `true`; self-hosted servers default to `false`).
///
/// Clients should use this to determine whether to offer UI for the realm-level setting for enabling web-public channels (`realm_enable_spectator_access`).
///
/// **Changes**: New in Zulip 5.0 (feature level 110).
server_web_public_streams_enabled: option { bool },
/// Whether topic summarization is enabled in the server or not depending upon whether `TOPIC_SUMMARIZATION_MODEL` is set or not.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 10.0 (feature level 350).
server_can_summarize_topics: option { bool },
/// Recommended client-side HTTP request timeout for [`GET /events`](https://zulip.com/api/get-events) calls.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// This is guaranteed to be somewhat greater than the heartbeat frequency.
/// It is important that clients respect this parameter, so that increases in the heartbeat frequency do not break clients.
///
/// **Changes**: New in Zulip 5.0 (feature level 74).
/// Previously, this was hardcoded to 90 seconds, and clients should use that as a fallback value when interacting with servers where this field is not present.
event_queue_longpoll_timeout_seconds: option { i64 },
/// The ID of the private channel to which messages flagged by users for moderation are sent.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Moderators can use this channel to review and act on reported content.
///
/// Will be `-1` if moderation requests are disabled.
///
/// Clients should check whether moderation requests are disabled to determine whether to present a \"report message\" feature in their UI within a given organization.
///
/// **Changes**: New in Zulip 10.0 (feature level 331). Previously, no \"report message\" feature existed in Zulip.
realm_moderation_request_channel_id: option { i64 },
/// The ID of the channel to which automated messages announcing the [creation of new channels](https://zulip.com/help/configure-automated-notices#new-channel-announcements) are sent.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Will be `-1` if such automated messages are disabled.
///
/// Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.
///
/// **Changes**: In Zulip 9.0 (feature level 241), renamed 'realm_notifications_stream_id' to `realm_new_stream_announcements_stream_id`.)
realm_new_stream_announcements_stream_id: option { i64 },
/// The ID of the channel to which automated messages announcing that [new users have joined the organization](https://zulip.com/help/configure-automated-notices#new-user-announcements) are sent.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Will be `-1` if such automated messages are disabled.
///
/// Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.
///
/// **Changes**: In Zulip 9.0 (feature level 241), renamed 'realm_signup_notifications_stream_id' to `realm_signup_announcements_stream_id`.
realm_signup_announcements_stream_id: option { i64 },
/// The ID of the channel to which automated messages announcing new features or other end-user updates about the Zulip software are sent.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Will be `-1` if such automated messages are disabled.
///
/// Since these automated messages are sent by the server, this field is primarily relevant to clients containing UI for changing it.
///
/// **Changes**: New in Zulip 9.0 (feature level 242).
realm_zulip_update_announcements_stream_id: option { i64 },
/// Whether the current user is allowed to create at least one type of channel with the organization's [channel creation policy](https://zulip.com/help/configure-who-can-create-channels).
///
/// Its value will always equal `can_create_public_streams || can_create_private_streams`.
///
/// Present if `realm_user` is present in `fetch_event_types`.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 102),
/// when the new `create_private_stream_policy` and `create_public_stream_policy` properties introduced the possibility that a user could only create one type of channel.
///
/// This field will be removed in a future release.
can_create_streams: option { bool },
/// Whether the current user is allowed to create public channels with the organization's [channel creation policy](https://zulip.com/help/configure-who-can-create-channels).
///
/// Present if `realm_user` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 5.0 (feature level 102).
/// In older versions, the deprecated `can_create_streams` property should be used to determine whether the user can create public channels.
can_create_public_streams: option { bool },
/// Whether the current user is allowed to create private channels with the organization's [channel creation policy](https://zulip.com/help/configure-who-can-create-channels).
///
/// Present if `realm_user` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 5.0 (feature level 102).
/// In older versions, the deprecated `can_create_streams` property should be used to determine whether the user can create private channels.
can_create_private_streams: option { bool },
/// Whether the current user is allowed to create public channels with the organization's [channel creation policy](https://zulip.com/help/configure-who-can-create-channels).
///
/// Present if `realm_user` is present in `fetch_event_types`.
///
/// Note that this will be false if the Zulip server does not have the `WEB_PUBLIC_STREAMS_ENABLED` setting enabled or if the organization has not enabled the `enable_spectator_access` realm setting.
///
/// **Changes**: New in Zulip 5.0 (feature level 103).
can_create_web_public_streams: option { bool },
/// Whether the current user is allowed to subscribe other users to channels with the organization's [channels policy](https://zulip.com/help/configure-who-can-invite-to-channels).
///
/// Present if `realm_user` is present in `fetch_event_types`.
can_subscribe_other_users: option { bool },
/// Whether the current user [is allowed to invite others](https://zulip.com/help/restrict-account-creation#change-who-can-send-invitations) to the organization.
///
/// Present if `realm_user` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 4.0 (feature level 51).
can_invite_others_to_realm: option { bool },
/// Whether the current user is at least an [organization administrator](https://zulip.com/api/roles-and-permissions).
///
/// Present if `realm_user` is present in `fetch_event_types`.
is_admin: option { bool },
/// Whether the current user is an [organization owner](https://zulip.com/api/roles-and-permissions).
///
/// Present if `realm_user` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 3.0 (feature level 11).
is_owner: option { bool },
/// Present if `realm_user` is present in `fetch_event_types`.
///
/// Whether the current user is at least an [organization moderator](https://zulip.com/api/roles-and-permissions).
///
/// **Changes**: Prior to Zulip 11.0 (feature level 380), this was only true for users whose role was exactly the moderator role.
///
/// New in Zulip 4.0 (feature level 60).
is_moderator: option { bool },
/// Whether the current user is a [guest user](https://zulip.com/api/roles-and-permissions).
///
/// Present if `realm_user` is present in `fetch_event_types`.
is_guest: option { bool },
/// The unique ID for the current user.
///
/// Present if `realm_user` is present in `fetch_event_types`.
user_id: option { i64 },
/// Maximum number of new subscribers for which the server will respect the `send_new_subscription_messages` parameter when [adding subscribers to a channel](https://zulip.com/api/subscribe#parameter-send_new_subscription_messages).
///
/// **Changes**: New in Zulip 11.0 (feature level 397).
max_bulk_new_subscription_messages: option { f64 },
/// What typesof message edit history are accessible to users via [message edit history](https://zulip.com/help/view-a-messages-edit-history).
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// - \"all\" = All edit history is visible.
/// - \"moves\" = Only moves are visible.
/// - \"none\" = No edit history is visible.
///
/// **Changes**: New in Zulip 10.0 (feature level 358), replacing the previous `allow_edit_history` boolean setting; `true` corresponds to `all`, and `false` to `none`.
realm_message_edit_history_visibility_policy: option { RealmMessageEditHistoryVisibilityPolicy },
}
}
field_access! {
Response {
/// An array of any parameters sent in the request that are not
/// supported by the endpoint.
///
/// See `error handling` documentation for details on this and its change history.
///
/// [ignored_params](https://zulip.com/api/rest-error-handling#ignored-parameters)
ignored_parameters_unsupported: option_cow_deref { [String], Vec<String> },
/// The ID of the queue that has been allocated for your client.
///
/// Will be `null` only for unauthenticated access in realms that have enabled the [public access option](https://zulip.com/help/public-access-option).
queue_id: option_cow_deref { str, String },
/// The server's version number.
///
/// This is often a release version number, like `2.1.7`. But for a server running a [version from Git](https://zulip.readthedocs.io/en/latest/overview/release-lifecycle.html#git-versions),
/// it will be a Git reference to the commit, like `5.0-dev-1650-gc3fd37755f`.
///
/// **Changes**: As of Zulip 3.0 (feature level 3), this is always present in the endpoint's response. Previously, it was only present if `event_types` included `zulip_version`.
zulip_version: option_cow_deref { str, String },
/// The `git merge-base` between `zulip_version` and official branches in the public [Zulip server and web app repository](https://github.com/zulip/zulip),
/// in the same format as `zulip_version`. This will equal `zulip_version` if the server is not running a fork of the Zulip server.
///
/// This will be `\"\"` if the server does not know its `merge-base`.
///
/// **Changes**: New in Zulip 5.0 (feature level 88).
zulip_merge_base: option_cow_deref { str, String },
/// Present if `alert_words` is present in `fetch_event_types`.
///
/// An array of strings, each an [alert word](https://zulip.com/help/dm-mention-alert-notifications#alert-words) that the current user has configured.
alert_words: option_cow_deref { [String], Vec<String> },
/// Present if `custom_profile_fields` is present in `fetch_event_types`.
///
/// An array of dictionaries where each dictionary contains the details of a single custom profile field that is available to users in this Zulip organization.
///
/// This must be combined with the custom profile field values on individual user objects to display users' profiles.
custom_profile_fields: option_cow_deref { [CustomProfileField], Vec<CustomProfileField> },
/// An array containing draft objects for the user.
///
/// These drafts are being stored on the backend for the purpose of syncing across devices.
/// This array will be empty if `enable_drafts_synchronization` is set to `false`.
drafts: option_cow_deref { [Draft], Vec<Draft> },
/// Present if `onboarding_steps` is present in `fetch_event_types`.
///
/// An array of dictionaries, where each dictionary contains details about a single onboarding step that should be shown to the user.
///
/// We expect that only official Zulip clients will interact with this data.
///
/// **Changes**: Before Zulip 8.0 (feature level 233), this array was named `hotspots`.
/// Prior to this feature level, one-time notice onboarding steps were not supported,
/// and the `type` field in these objects did not exist as all onboarding steps were implicitly hotspots.
onboarding_steps: option_cow_deref { [OnboardingStep], Vec<OnboardingStep> },
/// Present if `onboarding_steps` is present in `fetch_event_types`.
///
/// URL of the navigation tour video to display to new users during onboarding. If `null`, the onboarding video experience is disabled.
///
/// **Changes**: New in Zulip 10.0 (feature level 369).
navigation_tour_video_url: option_cow_deref { str, String },
/// Present if `scheduled_messages` is present in `fetch_event_types`.
///
/// An array of all undelivered scheduled messages by the user.
///
/// **Changes**: New in Zulip 7.0 (feature level 179).
scheduled_messages: option_cow_deref { [ScheduledMessage], Vec<ScheduledMessage> },
/// Present if `reminders` is present in `fetch_event_types`.
///
/// An array of all undelivered reminders scheduled by the user.
///
/// **Changes**: New in Zulip 11.0 (feature level 399).
reminders: option_cow_deref { [ScheduledMessage], Vec<ScheduledMessage> },
/// Present if `muted_topics` is present in `fetch_event_types`.
///
/// Array of tuples, where each tuple describes a muted topic.
/// The first element of the tuple is the channel name in which the topic has to be muted,
/// the second element is the topic name to be muted and the third element is an integer UNIX timestamp representing when the topic was muted.
///
/// **Changes**: Deprecated in Zulip 6.0 (feature level 134).
/// Starting with this version, `muted_topics` will only be present in the response if the `user_topic` object,
/// which generalizes and replaces this field, is not explicitly requested via `fetch_event_types`.
///
/// Before Zulip 3.0 (feature level 1), the `muted_topics` array objects were 2-item tuples and did not include the timestamp information for when the topic was muted.
muted_topics: option_cow_deref { [MutedTopic], Vec<MutedTopic> },
/// Present if `muted_users` is present in `fetch_event_types`.
///
/// A list of dictionaries where each dictionary describes a [MutedUser].
///
/// **Changes**: New in Zulip 4.0 (feature level 48).
muted_users: option_cow_deref { [MutedUser], Vec<MutedUser> },
/// Present if `realm_domains` is present in `fetch_event_types`.
///
/// An array of dictionaries where each dictionary describes a domain within which users can join the organization without and invitation.
realm_domains: option_cow_deref { [RealmDomain], Vec<RealmDomain> },
/// Present if `realm_linkifiers` is present in `fetch_event_types`.
///
/// An ordered array of objects where each object describes a single [linkifier](https://zulip.com/help/add-a-custom-linkifier).
///
/// The order of the array reflects the order that each linkifier should be processed when linkifying messages and topics.
/// By default, new linkifiers are ordered last. This order can be modified with [`PATCH /realm/linkifiers`](https://zulip.com/api/reorder-linkifiers).
///
/// Clients will receive an empty array unless the event queue is registered with the client capability `{\"linkifier_url_template\": true}`.
/// See [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) parameter for how this can be specified.
///
/// **Changes**: Before Zulip 7.0 (feature level 176), the `linkifier_url_template` client capability was not required.
/// The requirement was added because linkifiers were updated to contain a URL template instead of a URL format string,
/// which was a not backwards-compatible change.
///
/// New in Zulip 4.0 (feature level 54). Clients can access this data for servers on earlier feature levels via the legacy `realm_filters` property.
realm_linkifiers: option_cow_deref { [RealmLinkifier], Vec<RealmLinkifier> },
/// Legacy property for [linkifiers](https://zulip.com/help/add-a-custom-linkifier).
///
/// Present if `realm_filters` is present in `fetch_event_types`.
///
/// When present, this is always an empty array.
///
/// **Changes**: Prior to Zulip 7.0 (feature level 176), this was an array of tuples, where each tuple described a linkifier.
/// The first element of the tuple was a string regex pattern which represented the pattern to be linkified on matching, for example `\"#(?P<id>[123])\"`.
/// The second element was a URL format string that the pattern should be linkified with.
/// A URL format string for the above example would be `\"https://realm.com/my_realm_filter/%(id)s\"`.
/// And the third element was the ID of the realm filter.
///
/// **Deprecated** in Zulip 4.0 (feature level 54), replaced by the `realm_linkifiers` key.
realm_filters: option_cow_deref { [RealmFilter], Vec<RealmFilter> },
/// Present if `realm_playgrounds` is present in `fetch_event_types`.
///
/// An array of dictionaries where each dictionary describes a [code playground](https://zulip.com/help/code-blocks#code-playgrounds) configured for this Zulip organization.
///
/// **Changes**: New in Zulip 4.0 (feature level 49).
realm_playgrounds: option_cow_deref { [RealmPlayground], Vec<RealmPlayground> },
/// Present if `realm_user_groups` is present in `fetch_event_types`.
///
/// An array of dictionaries where each dictionary describes a [user group](https://zulip.com/help/user-groups) in the Zulip organization.
///
/// Deactivated groups will only be included if `include_deactivated_groups` client capability is set to `true`.
///
/// **Changes**: Prior to Zulip 10.0 (feature level 294), deactivated groups were included for all the clients.
realm_user_groups: option_cow_deref { [UserGroup], Vec<UserGroup> },
/// Present if `realm_bot` is present in `fetch_event_types`.
///
/// An array of dictionaries where each dictionary describes a bot that the current user can administer.
/// If the current user is an organization administrator, this will include all bots in the organization.
/// Otherwise, it will only include bots owned by the user (either because the user created the bot or an administrator transferred the bot's ownership to the user).
realm_bots: option_cow_deref { [Bot], Vec<Bot> },
/// Present if `realm_embedded_bots` is present in `fetch_event_types`.
///
/// An array of dictionaries where each dictionary describes an type of embedded bot that is available to be configured on this Zulip server.
///
/// Clients only need these data if they contain UI for creating or administering bots.
realm_embedded_bots: option_cow_deref { [RealmEmbeddedBot], Vec<RealmEmbeddedBot> },
/// Present if `realm_incoming_webhook_bots` is present in `fetch_event_types`.
///
/// An array of dictionaries where each dictionary describes a type of incoming webhook integration that is available to be configured on this Zulip server.
///
/// Clients only need these data if they contain UI for creating or administering bots.
realm_incoming_webhook_bots: option_cow_deref { [RealmIncomingWebhookBot], Vec<RealmIncomingWebhookBot> },
/// Present if `recent_private_conversations` is present in `fetch_event_types`.
///
/// An array of dictionaries containing data on all direct message and group direct message conversations that the user has received (or sent) messages in, organized by conversation.
/// This data set is designed to support UI elements such as the \"Direct messages\" widget in the web application showing recent direct message conversations that the user has participated in.
///
/// \"Recent\" is defined as the server's discretion; the original implementation interpreted that as \"the 1000 most recent direct messages the user received\".
/// Present if `navigation_views` is present in `fetch_event_types`. An array of dictionaries containing data on all of the current user's navigation views.
///
/// **Changes**: New in Zulip 11.0 (feature level 390).
navigation_views: option_cow_deref { [NavigationView], Vec<NavigationView> },
/// Present if `saved_snippets` is present in `fetch_event_types`.
///
/// An array of dictionaries containing data on all of the current user's saved snippets.
///
/// **Changes**: New in Zulip 10.0 (feature level 297).
saved_snippets: option_cow_deref { [SavedSnippet], Vec<SavedSnippet> },
/// Present if `subscription` is present in `fetch_event_types`.
///
/// An array of dictionaries where each dictionary describes the properties of a channel the user is subscribed to (as well as that user's personal per-channel settings).
///
/// **Changes**: Removed `email_address` field from the dictionary in Zulip 8.0 (feature level 226).
///
/// Removed `role` field from the dictionary in Zulip 6.0 (feature level 133).
subscriptions: option_cow_deref { [Subscription], Vec<Subscription> },
/// Present if `subscription` is present in `fetch_event_types`.
///
/// A array of dictionaries where each dictionary describes one of the channels the user has unsubscribed from but was previously subscribed to along with the subscription details.
/// Unlike `never_subscribed`, the user might have messages in their personal message history that were sent to these channels.
///
/// **Changes**: Prior to Zulip 10.0 (feature level 349), if a user was in `can_administer_channel_group` of a channel that they had unsubscribed from,
/// but not an organization administrator, the channel in question would not be part of this array.
///
/// Removed `email_address` field from the dictionary in Zulip 8.0 (feature level 226). Removed `role` field from the dictionary in Zulip 6.0 (feature level 133).
unsubscribed: option_cow_deref { [Subscription], Vec<Subscription> },
/// Present if `subscription` is present in `fetch_event_types`.
///
/// A array of dictionaries where each dictionary describes one of the channels that is visible to the user and the user has never been subscribed to.
///
/// Important for clients containing UI where one can browse channels to subscribe to.
///
/// **Changes**: Before Zulip 10.0 (feature level 362),
/// archived channels did not appear in this list,
/// even if the `archived_channels` [client capability](https://zulip.com/api/register-queue#parameter-client_capabilities) was declared by the client.
///
/// Prior to Zulip 10.0 (feature level 349), if a user was in `can_administer_channel_group` of a channel that they never subscribed to,
/// but not an organization administrator, the channel in question would not be part of this array.
never_subscribed: option_cow_deref { [NeverSubscribed], Vec<NeverSubscribed> },
/// Present if `channel_folders` is present in `fetch_event_types`.
///
/// An array of dictionaries where each dictionary describes one of the channel folders in the organization.
///
/// Only channel folders with one or more public web channels are visible to spectators.
///
/// **Changes**: New in Zulip 11.0 (feature level 389).
channel_folders: option_cow_deref { [ChannelFolder], Vec<ChannelFolder> },
/// Present if `starred_messages` is present in `fetch_event_types`. Array containing the IDs of all messages which have been [starred](https://zulip.com/help/star-a-message) by the user.
starred_messages: option_cow_deref { [i64], Vec<i64> },
/// Present if `stream` is present in `fetch_event_types`.
///
/// Array of dictionaries where each dictionary contains details about a single channel in the organization that is visible to the user.
///
/// For organization administrators, this will include all private channels in the organization.
///
/// **Changes**: Before Zulip 11.0 (feature level 378),
/// archived channels did not appear in this list,
/// even if the `archived_channels` [client capability](https://zulip.com/api/register-queue#parameter-client_capabilities) was declared by the client.
///
/// As of Zulip 8.0 (feature level 205), this will include all web-public channels in the organization as well.
streams: option_cow_deref { [BasicChannel], Vec<BasicChannel> },
/// An array of IDs of all the [default channels](https://zulip.com/help/set-default-streams-for-new-users) in the organization.
///
/// Present if `default_streams` is present in `fetch_event_types`.
///
/// **Changes**: Before Zulip 10.0 (feature level 330), we sent array of dictionaries where each dictionary contained details about a single default stream for the Zulip organization.
realm_default_streams: option_cow_deref { [i64], Vec<i64> },
/// An array of dictionaries where each dictionary contains details about a single default channel group configured for this Zulip organization.
///
/// Present if `default_stream_groups` is present in `fetch_event_types`.
///
/// Default channel groups are an experimental feature.
realm_default_stream_groups: option_cow_deref { [DefaultChannelGroup], Vec<DefaultChannelGroup> },
/// An array containing the stop words used by the Zulip server's full-text search implementation.
///
/// Present if `stop_words` is present in `fetch_event_types`.
///
/// Useful for showing helpful error messages when a search returns limited results because a stop word in the query was ignored.
stop_words: option_cow_deref { [String], Vec<String> },
/// Present if `user_topic` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 6.0 (feature level 134), deprecating and replacing the previous `muted_topics` structure.
user_topics: option_cow_deref { [UserTopic], Vec<UserTopic> },
/// GIPHY's client-side SDKs needs this API key to use the GIPHY API.
///
/// Present if `giphy` is present in `fetch_event_types`.
///
/// GIPHY API keys are not secret (their main purpose appears to be allowing GIPHY to block a problematic app).
/// Please don't use our API key for an app unrelated to Zulip.
///
/// Developers of clients should also read the [GIPHY API TOS](https://support.giphy.com/hc/en-us/articles/360028134111-GIPHY-API-Terms-of-Service-) before using this API key.
///
/// **Changes**: Added in Zulip 4.0 (feature level 47).
giphy_api_key: option_cow_deref { str, String },
/// The current value of this global notification setting for the user.
///
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
notification_sound: option_cow_deref { str, String },
/// Present if `update_global_notifications` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// Array containing the names of the notification sound options supported by this Zulip server.
/// Only relevant to support UI for configuring notification sounds.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
available_notification_sounds: option_cow_deref { [String], Vec<String> },
/// The default language chosen by the user.
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
default_language: option_cow_deref { str, String },
/// The name of the emoji set that the user has chosen.
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
emojiset: option_cow_deref { str, String },
/// The [home view](https://zulip.com/help/configure-home-view) in Zulip, represented as the URL suffix after `#` to be rendered when Zulip loads.
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// Currently supported values are `all_messages` and `recent_topics`.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: New in Zulip 8.0 (feature level 219).
/// Previously, this was called `default_view`, which was new in Zulip 4.0 (feature level 42).
///
/// **Deprecated** in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
web_home_view: option_cow_deref { str, String },
/// The user's [profile time zone](https://zulip.com/help/change-your-timezone),
/// which is used primarily to display the user's local time to other users.
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
timezone: option_cow_deref { str, String },
/// Array of dictionaries where each dictionary describes an emoji set supported by this version of the Zulip server.
///
/// Present if `update_display_settings` is present in `fetch_event_types` and only for clients that did not include `user_settings_object`
/// in their [`client_capabilities`](https://zulip.com/api/register-queue#parameter-client_capabilities) when registering the event queue.
///
/// Only relevant to clients with configuration UI for choosing an emoji set; the currently selected emoji set is available in the `emojiset` key.
///
/// See [PATCH /settings](https://zulip.com/api/update-settings) for details on the meaning of this setting.
///
/// **Changes**: Deprecated in Zulip 5.0 (feature level 89).
/// Clients connecting to newer servers should declare the `user_settings_object` client capability and access the `user_settings` object instead.
emojiset_choices: option_cow_deref { [UserSettingsEmojisetChoice], Vec<UserSettingsEmojisetChoice> },
/// The [organization language](https://zulip.com/help/configure-organization-language) for automated messages and invitation emails.
///
/// Present if `realm` is present in `fetch_event_types`.
realm_default_language: option_cow_deref { str, String },
/// This organization's configured custom message for Welcome Bot to send to new user accounts, in Zulip Markdown format.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 11.0 (feature level 416).
realm_welcome_message_custom_text: option_cow_deref { str, String },
/// Present if `realm` is present in `fetch_event_types`. The description of the organization, used on login and registration pages.
realm_description: option_cow_deref { str, String },
/// Present if `realm` is present in `fetch_event_types`. The name of the organization, used in login pages etc.
realm_name: option_cow_deref { str, String },
/// The URL of the custom Jitsi Meet server configured in this organization's settings.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// `null`, the default, means that the organization is using the should use the server-level configuration, `server_jitsi_server_url`.
/// A correct client supporting only the modern API should use `realm_jitsi_server_url || server_jitsi_server_url` to create calls.
///
/// **Changes**: New in Zulip 8.0 (feature level 212).
/// Previously, this was only available as a server-level configuration, which was available via the `jitsi_server_url` field.
realm_jitsi_server_url: option_cow_deref { str, String },
/// The default pygments language code to be used for code blocks in this organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// If an empty string, no default has been set.
///
/// **Changes**: Prior to Zulip 8.0 (feature level 195),
/// a server bug meant that both `null` and an empty string could represent that no default was set for this realm setting.
/// Clients supporting older server versions should treat either value (`null` or `\"\"`) as no default being set.
realm_default_code_block_language: option_cow_deref { str, String },
/// The URL of the organization's [profile icon](https://zulip.com/help/create-your-organization-profile).
///
/// Present if `realm` is present in `fetch_event_types`.
realm_icon_url: option_cow_deref { str, String },
/// String indicating whether the organization's [profile icon](https://zulip.com/help/create-your-organization-profile) was uploaded by a user or is the default.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Useful for UI allowing editing the organization's icon.
///
/// - \"G\" means generated by Gravatar (the default).
/// - \"U\" means uploaded by an organization administrator.
realm_icon_source: option_cow_deref { str, String },
/// The URL of the organization's wide logo configured in the [organization profile](https://zulip.com/help/create-your-organization-profile).
///
/// Present if `realm` is present in `fetch_event_types`.
realm_logo_url: option_cow_deref { str, String },
/// String indicating whether the organization's [profile wide logo](https://zulip.com/help/create-your-organization-profile) was uploaded by a user or is the default.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Useful for UI allowing editing the organization's wide logo.
///
/// - \"D\" means the logo is the default Zulip logo.
/// - \"U\" means uploaded by an organization administrator.
realm_logo_source: option_cow_deref { str, String },
/// The URL of the organization's dark theme wide-format logo configured in the [organization profile](https://zulip.com/help/create-your-organization-profile).
///
/// Present if `realm` is present in `fetch_event_types`.
realm_night_logo_url: option_cow_deref { str, String },
/// String indicating whether the organization's dark theme [profile wide logo](https://zulip.com/help/create-your-organization-profile) was uploaded by a user or is the default.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Useful for UI allowing editing the organization's wide logo.
///
/// - \"D\" means the logo is the default Zulip logo.
/// - \"U\" means uploaded by an organization administrator.
realm_night_logo_source: option_cow_deref { str, String },
/// The fake email domain that will be used for new bots created this organization.
///
/// Useful for UI for creating bots.
///
/// Present if `realm` is present in `fetch_event_types`.
realm_bot_domain: option_cow_deref { str, String },
/// The URL for the organization. Alias of `realm_url`.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: Deprecated in Zulip 9.0 (feature level 257).
/// The term \"URI\" is deprecated in [web standards](https://url.spec.whatwg.org/#goals).
realm_uri: option_cow_deref { str, String },
/// The URL for the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 9.0 (feature level 257), replacing the deprecated `realm_uri`.
realm_url: option_cow_deref { str, String },
/// Text to use when displaying UI for wide organization logos, a feature that is currently not available on the Zulip Cloud Free plan.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Useful only for clients supporting administrative UI for uploading a new wide organization logo to brand the organization.
upgrade_text_for_wide_organization_logo: option_cow_deref { str, String },
/// The base URL to be used to create Jitsi video calls.
///
/// Equals `realm_jitsi_server_url || server_jitsi_server_url`.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: Deprecated in Zulip 8.0 (feature level 212) and will eventually be removed.
/// Previously, the Jitsi server to use was not configurable on a per-realm basis, and this field contained the server's configured Jitsi server.
/// (Which is now provided as `server_jitsi_server_url`).
/// Clients supporting older versions should fall back to this field when creating calls:
/// using `realm_jitsi_server_url || server_jitsi_server_url` with newer servers and using `jitsi_server_url` with servers below feature level 212.
jitsi_server_url: option_cow_deref { str, String },
/// A list describing the image formats that uploaded images will be thumbnailed into.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Any image with a source starting with `/user_uploads/thumbnail/`
/// can have its last path component replaced with any of the names contained in this list, to obtain the desired thumbnail size.
///
/// **Changes**: New in Zulip 9.0 (feature level 273).
server_thumbnail_formats: option_cow_deref { [ServerThumbnailFormat], Vec<ServerThumbnailFormat> },
/// The URL to a JSON file that describes which emoji names map to which emoji codes, for all Unicode emoji this Zulip server accepts.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// The data at the given URL is a JSON object with one property, `code_to_names`.
/// The value of that property is a JSON object where each key is an [emoji code](https://zulip.com/api/add-reaction#parameter-emoji_code) for an available Unicode emoji,
/// and each value is the corresponding [emoji names](https://zulip.com/api/add-reaction#parameter-emoji_name) for this emoji,
/// with the canonical name for the emoji always appearing first.
///
/// The HTTP response at that URL will have appropriate HTTP caching headers, such any HTTP implementation should get a cached version if emoji haven't changed since the last request.
///
/// **Changes**: New in Zulip 6.0 (feature level 140).
server_emoji_data_url: option_cow_deref { str, String },
/// The URL of the Jitsi server that the Zulip server is configured to use by default;
/// the organization-level setting `realm_jitsi_server_url` takes precedence over this setting when both are set.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 8.0 (feature level 212). Previously, this value was available as the now-deprecated `jitsi_server_url`.
server_jitsi_server_url: option_cow_deref { str, String },
/// Clients declaring the `empty_topic_name` client capability should use the value of `realm_empty_topic_display_name` to determine how to display the empty string topic.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Clients not declaring the `empty_topic_name` client capability receive `realm_empty_topic_display_name` value as the topic name replacing empty string.
///
/// **Changes**: New in Zulip 10.0 (feature level 334).
/// Previously, the empty string was not a valid topic name.
realm_empty_topic_display_name: option_cow_deref { str, String },
/// A array of dictionaries where each entry describes a user whose account has not been deactivated.
///
/// Present if `realm_user` is present in `fetch_event_types`.
///
/// Note that unlike the usual User dictionary, this does not contain the `is_active` key, as all the users present in this array have active accounts.
///
/// If the current user is a guest whose access to users is limited by a `can_access_all_users_group` policy,
/// and the event queue was registered with the `user_list_incomplete` client capability,
/// then users that the current user cannot access will not be included in this array.
/// If the current user's access to a user is restricted but the client lacks this capability,
/// then that inaccessible user will appear in the users array as an \"Unknown user\" object with the usual format but placeholder data whose only variable content is the user ID.
///
/// See also `cross_realm_bots` and `realm_non_active_users`.
///
/// **Changes**: Before Zulip 8.0 (feature level 232), the `user_list_incomplete` client capability did not exist,
/// and so all clients whose access to a new user was prevented by `can_access_all_users_group` policy would receive a fake \"Unknown user\" event for such users.
realm_users: option_cow_deref { [User], Vec<User> },
/// A array of dictionaries where each entry describes a user whose account has been deactivated.
///
/// Present if `realm_user` is present in `fetch_event_types`.
///
/// Note that unlike the usual User dictionary this does not contain the `is_active` key as all the users present in this array have deactivated accounts.
realm_non_active_users: option_cow_deref { [User], Vec<User> },
/// The avatar data source type for the current user. Value values are `G` (gravatar) and `U` (uploaded by user).
///
/// Present if `realm_user` is present in `fetch_event_types`.
avatar_source: option_cow_deref { str, String },
/// The avatar URL for the current user at 500x500 resolution, appropriate for use in settings UI showing the user's avatar.
///
/// Present if `realm_user` is present in `fetch_event_types`.
avatar_url_medium: option_cow_deref { str, String },
/// The URL of the avatar for the current user at 100x100 resolution. See also `avatar_url_medium`.
///
/// Present if `realm_user` is present in `fetch_event_types`.
avatar_url: option_cow_deref { str, String },
/// The Zulip API email address for the current user. See also `delivery_email`; these may be the same or different depending on the user's `email_address_visibility` policy.
///
/// Present if `realm_user` is present in `fetch_event_types`.
email: option_cow_deref { str, String },
/// The user's email address, appropriate for UI for changing the user's email address. See also `email`.
///
/// Present if `realm_user` is present in `fetch_event_types`.
delivery_email: option_cow_deref { str, String },
/// The full name of the current user.
///
/// Present if `realm_user` is present in `fetch_event_types`.
full_name: option_cow_deref { str, String },
/// Array of dictionaries where each dictionary contains details of a single cross realm bot.
///
/// Cross-realm bots are special system bot accounts like Notification Bot.
///
/// Most clients will want to combine this with `realm_users` in many contexts.
///
/// Present if `realm_user` is present in `fetch_event_types`.
cross_realm_bots: option_cow_deref { [CrossRealmBot], Vec<CrossRealmBot> },
}
}
field_access! {
Response {
/// Present if `user_settings` is present in `fetch_event_types`.
///
/// A dictionary containing the user's personal settings.
///
/// **Changes**: Removed `dense_mode` setting in Zulip 10.0
/// (feature level 364) as we now have `web_font_size_px` and
/// `web_line_height_percent` settings for more control.
///
/// New in Zulip 5.0 (feature level 89). Previously, these
/// settings appeared in the top-level object, where they are
/// available for clients without the `user_settings_object` client
/// capability for backwards-compatibility.
user_settings: option_ref { UserSettings },
/// Present if `message` and `update_message_flags` are both present in
/// `event_types`.
///
/// A set of data structures describing the conversations containing
/// the 50000 most recent unread messages the user has received. This will usually
/// contain every unread message the user has received, but clients should support
/// users with even more unread messages (and not hardcode the number 50000).
unread_msgs: option_ref { UnreadMsgs },
/// An array of objects; each object describes a type of custom profile field that could be configured on this Zulip server.
///
/// Present if `custom_profile_fields` is present in `fetch_event_types`.
///
/// Each custom profile type has an ID and the `type` property of a custom profile field is equal to one of these IDs.
///
/// This attribute is only useful for clients containing UI for changing the set of configured custom profile fields in a Zulip organization.
custom_profile_field_types: option_ref { HashMap<String, CustomProfileFieldType> },
/// A dictionary where each entry describes the presence details of a user in the Zulip organization.
///
/// Present if `presence` is present in `fetch_event_types`.
///
/// The format of the entry (modern or legacy) depends on the value of [`slim_presence`](#parameter-slim_presence). Users who have been offline for multiple weeks may not appear in this object.
presences: option_ref { PresenceList },
/// A dictionary of objects where each object describes a custom emoji that has been uploaded in this Zulip organization.
///
/// Present if `realm_emoji` is present in `fetch_event_types`.
realm_emoji: option_ref { HashMap<String, RealmEmoji> },
/// A dictionary which contains the [status](https://zulip.com/help/status-and-availability) of all users in the Zulip organization who have set a status.
///
/// Present if `user_status` is present in `fetch_event_types`.
///
/// **Changes**: The emoji parameters are new in Zulip 5.0 (feature level 86). Previously, Zulip did not support emoji associated with statuses.
user_status: option_ref { HashMap<String, UserStatus> },
/// Dictionary where each entry describes the user's push device's registration status and error code (if registration failed).
///
/// Present if `push_device` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 11.0 (feature level 406).
push_devices: option_ref { HashMap<String, PushDevice> },
/// The configured [video call provider](https://zulip.com/help/configure-call-provider) for the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
realm_video_chat_provider: option_ref { RealmVideoChatProvider },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to add custom emoji in the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
realm_can_add_custom_emoji_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to start a new direct message conversation involving other non-bot users.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Users who are outside this group and attempt to send the first direct message to a given collection of recipient users will receive an error, unless all other recipients are bots or the sender.
///
/// **Changes**: New in Zulip 9.0 (feature level 270). Previously, access to send direct messages was controlled by the `private_message_policy` realm setting, which supported values of 1 (enabled) and 2 (disabled).
realm_direct_message_initiator_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to add subscribers to channels in the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 10.0 (feature level 341).
/// Previously, this permission was controlled by the enum `invite_to_stream_policy`.
/// Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators.
realm_can_add_subscribers_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to delete any message in the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Note that a user must also be able to access the content of a message in order to delete it.
/// See [channel permissions](https://zulip.com/help/channel-permissions) for information about content access for channel messages.
/// For direct messages, the user must have received or sent the direct message to have content access.
///
/// **Changes**: New in Zulip 10.0 (feature level 281).
/// Previously, this permission was limited to administrators only and was uneditable.
realm_can_delete_any_message_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to delete messages that they have sent in the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 10.0 (feature level 291).
/// Previously, this permission was controlled by the enum `delete_own_message_policy`.
/// Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 5=Everyone.
///
/// Before Zulip 5.0 (feature level 101), the `allow_message_deleting` boolean setting controlled this permission; `true` corresponded to `Everyone`, and `false` to `Admins`.
realm_can_delete_own_message_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to change per-channel `can_delete_any_message_group` and `can_delete_own_message_group` permission settings.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Note that the user must be a member of both this group and the `can_administer_channel_group` of the channel whose message delete settings they want to change.
///
/// Organization administrators can always change these settings of every channel.
///
/// **Changes**: New in Zulip 11.0 (feature level 407).
realm_can_set_delete_message_policy_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to change per-channel `topics_policy` setting.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Note that the user must be a member of both this group and the `can_administer_channel_group` of the channel whose `topics_policy` they want to change.
///
/// Organization administrators can always change the `topics_policy` setting of every channel.
///
/// **Changes**: New in Zulip 11.0 (feature level 392).
realm_can_set_topics_policy_group: option_ref { GroupSetting },
/// Present if `realm` is present in `fetch_event_types`.
///
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to send email invitations for inviting other users to the organization.
///
/// **Changes**: New in Zulip 10.0 (feature level 321).
/// Previously, this permission was controlled by the enum `invite_to_realm_policy`.
/// Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 6=Nobody.
///
/// Before Zulip 4.0 (feature level 50), the `invite_by_admins_only` boolean setting controlled this permission; `true` corresponded to `Admins`, and `false` to `Members`.
realm_can_invite_users_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to use wildcard mentions in large channels.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// All users will receive a warning/reminder when using mentions in large channels, even when permitted to do so.
///
/// **Changes**: New in Zulip 10.0 (feature level 352).
/// Previously, this permission was controlled by the enum `wildcard_mention_policy`.
realm_can_mention_many_users_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to move messages from one channel to another in the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 10.0 (feature level 310).
/// Previously, this permission was controlled by the enum `move_messages_between_streams_policy`.
/// Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 6=Nobody.
///
/// In Zulip 7.0 (feature level 159), `Nobody` was added as an option to `move_messages_between_streams_policy` enum.
realm_can_move_messages_between_channels_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to move messages from one topic to another within a channel in the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 10.0 (feature level 316).
/// Previously, this permission was controlled by the enum `edit_topic_policy`.
/// Values were 1=Members, 2=Admins, 3=Full members, 4=Moderators, 5=Everyone, 6=Nobody.
///
/// In Zulip 7.0 (feature level 159), `Nobody` was added as an option to `edit_topic_policy` enum.
realm_can_move_messages_between_topics_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to create user groups in this organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 10.0 (feature level 299).
/// Previously `realm_user_group_edit_policy` field used to control the permission to create user groups.
realm_can_create_groups: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to create all types of bot users in the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// See also `can_create_write_only_bots_group`.
///
/// **Changes**: New in Zulip 10.0 (feature level 344).
/// Previously, this permission was controlled by the enum `bot_creation_policy`.
/// Values were 1=Members, 2=Generic bots limited to administrators, 3=Administrators.
realm_can_create_bots_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to create bot users that can only send messages in the organization, i.e. incoming webhooks, in addition to the users who are present in `can_create_bots_group`.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 10.0 (feature level 344).
/// Previously, this permission was controlled by the enum `bot_creation_policy`.
/// Values were 1=Members, 2=Generic bots limited to administrators, 3=Administrators.
realm_can_create_write_only_bots_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to administer all existing groups in this organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: Prior to Zulip 10.0 (feature level 305), only users who were a member of the group or had the moderator role or above could exercise the permission on a given group.
///
/// New in Zulip 10.0 (feature level 299).
/// Previously the `user_group_edit_policy` field controlled the permission to manage user groups.
/// Valid values were as follows:
///
/// - 1 = All members can create and edit user groups
/// - 2 = Only organization administrators can create and edit user groups
/// - 3 = Only [full members](https://zulip.com/api/roles-and-permissions#determining-if-a-user-is-a-full-member) can create and edit user groups.
/// - 4 = Only organization administrators and moderators can create and edit user groups.
realm_can_manage_all_groups: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to manage plans and billing in the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 10.0 (feature level 363).
/// Previously, only owners and users with `is_billing_admin` property set to `true` were allowed to manage plans and billing.
realm_can_manage_billing_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to create public channels in this organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 9.0 (feature level 264).
/// Previously `realm_create_public_stream_policy` field used to control the permission to create public channels.
realm_can_create_public_channel_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to create private channels in this organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 9.0 (feature level 266). Previously `realm_create_private_stream_policy` field used to control the permission to create private channels.
realm_can_create_private_channel_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to create web-public channels in this organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Has no effect and should not be displayed in settings UI unless the Zulip server has the `WEB_PUBLIC_STREAMS_ENABLED`
/// server-level setting enabled and the organization has enabled the `enable_spectator_access` realm setting.
///
/// **Changes**: New in Zulip 10.0 (feature level 280).
/// Previously `realm_create_web_public_stream_policy` field used to control the permission to create web-public channels.
realm_can_create_web_public_channel_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to [resolve topics](https://zulip.com/help/resolve-a-topic) in the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 10.0 (feature level 367).
/// Previously, permission to resolve topics was controlled by the more general `can_move_messages_between_topics_group permission for moving messages`.
realm_can_resolve_topics_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who have permission to fully use direct messages.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Users outside this group can only send direct messages to conversations where all the recipients are in this group, are bots,
/// or are the sender, ensuring that every direct message conversation will be visible to at least one user in this group.
///
/// **Changes**: New in Zulip 9.0 (feature level 270).
///
/// Previously, access to send direct messages was controlled by the `private_message_policy` realm setting, which supported values of 1 (enabled) and 2 (disabled).
realm_direct_message_permission_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who are allowed to create
/// [reusable invitation links](https://zulip.com/help/invite-new-users#create-a-reusable-invitation-link) to the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: Prior to Zulip 10.0 (feature level 314), this value used to be of type integer and did not accept anonymous user groups. New in Zulip 8.0 (feature level 209).
realm_create_multiuse_invite_group: option_ref { GroupSetting },
/// Dictionary of authentication method keys mapped to dictionaries that describe the properties of the named authentication method for the organization
/// - its enabled status and availability for use by the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Clients should use this to implement server-settings UI to change which methods are enabled for the organization.
/// For authentication UI itself, clients should use the pre-authentication metadata returned by [`GET /server_settings`](https://zulip.com/api/get-server-settings).
///
/// **Changes**: In Zulip 9.0 (feature level 241), the values in this dictionary were changed.
/// Previously, the values were a simple boolean indicating whether the backend is enabled or not.
realm_authentication_methods: option_ref { HashMap<String, RealmAuthenticationMethod> },
/// Dictionary where each entry describes a supported [video call provider](https://zulip.com/help/configure-call-provider)
/// that is configured on this server and could be selected by an organization administrator.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Useful for administrative settings UI that allows changing the realm setting `video_chat_provider`.
realm_available_video_chat_providers: option_ref { HashMap<String, RealmAvailableVideoChatProvider> },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who are allowed to access all users in the organization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: Prior to Zulip 10.0 (feature level 314), this value used to be of type integer and did not accept anonymous user groups.
///
/// New in Zulip 8.0 (feature level 225).
realm_can_access_all_users_group: option_ref { GroupSetting },
/// A [group-setting value](https://zulip.com/api/group-setting-values) defining the set of users who are allowed to use AI summarization.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 10.0 (feature level 350).
realm_can_summarize_topics_group: option_ref { GroupSetting },
/// Dictionary where each entry describes a default external account type that can be configured with Zulip's [custom profile fields feature](https://zulip.com/help/custom-profile-fields).
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 2.1.0.
realm_default_external_accounts: option_ref { HashMap<String, RealmDefaultExternalAccount> },
/// Dictionary where each entry describes a valid rating that is configured on this server and could be selected by an organization administrator.
///
/// Present if `realm` is present in `fetch_event_types`.
///
/// Useful for administrative settings UI that allows changing the allowed rating of GIFs.
giphy_rating_options: option_ref { HashMap<String, GiphyRatingOption> },
/// A dictionary containing billing information of the organization.
///
/// Present if `realm_billing` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 10.0 (feature level 363).
realm_billing: option_ref { RealmBilling },
/// A dictionary containing the default values of settings for new users.
///
/// Present if `realm_user_settings_defaults` is present in `fetch_event_types`.
///
/// **Changes**: New in Zulip 5.0 (feature level 95).
realm_user_settings_defaults: option_ref { RealmUserSettingsDefault },
/// Present if `realm` is present in `fetch_event_types`.
///
/// Metadata detailing the valid values for permission settings that
/// use [group-setting values](https://zulip.com/api/group-setting-values). Clients
/// should use these data as explained in the
/// [main documentation](https://zulip.com/api/group-setting-values#permitted-values)
/// to determine what values to present as possible values for these
/// settings in UI components.
///
/// **Changes**: Before Zulip 10.0 (feature level 326), this part of
/// the response had a documented-as-unstable format not suitable
/// for general client use, and should be ignored.
///
/// New in Zulip 8.0 (feature level 221).
server_supported_permission_settings: option_ref { ServerSupportedPermissionSetting },
}
}
impl_default!(Response);
impl_display!(Response);
impl_response!(Response, base);