slack-web-api 0.2.1

Typed async Slack Web API client for Rust: all 330 methods incl. admin, Block Kit, pagination, file upload, rate-limit retry (reqwest + rustls, no OpenSSL)
Documentation
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
// このファイルは codegen/generate.py が生成する。手で編集しない

#![allow(unused_imports)]

use crate::objects::*;
use crate::{
    CursorPaginated, NextCursor, ResponseMetadata, SlackApiMethod, SlackClient, SlackError,
};
use serde::{Deserialize, Serialize};

/// Arguments for the Slack Web API method [`users.conversations`](https://docs.slack.dev/reference/methods/users.conversations): List conversations the calling user is a member of.
///
/// Send it with [`SlackClient::users_conversations`].
#[doc(alias = "users.conversations")]
#[derive(Debug, Clone, PartialEq, Serialize, Default)]
#[non_exhaustive]
pub struct UsersConversationsRequest {
    /// Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](https://docs.slack.dev/apis/web-api/pagination.md) for more detail.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cursor: Option<String>,
    /// Set to `true` to exclude archived channels from the list
    #[serde(skip_serializing_if = "Option::is_none")]
    pub exclude_archived: Option<bool>,
    /// Set to `true` to exclude muted channels from the list
    #[serde(skip_serializing_if = "Option::is_none")]
    pub exclude_muted: Option<bool>,
    /// The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the list hasn't been reached. Must be an integer with a max value of 999.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
    /// encoded team id to list conversations in, required if org token is used
    #[serde(skip_serializing_if = "Option::is_none")]
    pub team_id: Option<String>,
    /// Mix and match channel types by providing a comma-separated list of any combination of `public_channel`, `private_channel`, `mpim`, `im`
    #[serde(skip_serializing_if = "Option::is_none")]
    pub types: Option<String>,
    /// Browse conversations by a specific user ID's membership. Non-public channels are restricted to those where the calling user shares membership.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user: Option<String>,
}

impl UsersConversationsRequest {
    pub fn new() -> Self {
        Self {
            cursor: None,
            exclude_archived: None,
            exclude_muted: None,
            limit: None,
            team_id: None,
            types: None,
            user: None,
        }
    }

    pub fn cursor(mut self, cursor: impl Into<String>) -> Self {
        self.cursor = Some(cursor.into());
        self
    }

    pub fn exclude_archived(mut self, exclude_archived: bool) -> Self {
        self.exclude_archived = Some(exclude_archived);
        self
    }

    pub fn exclude_muted(mut self, exclude_muted: bool) -> Self {
        self.exclude_muted = Some(exclude_muted);
        self
    }

    pub fn limit(mut self, limit: i64) -> Self {
        self.limit = Some(limit);
        self
    }

    pub fn team_id(mut self, team_id: impl Into<String>) -> Self {
        self.team_id = Some(team_id.into());
        self
    }

    pub fn types(mut self, types: impl Into<String>) -> Self {
        self.types = Some(types.into());
        self
    }

    pub fn user(mut self, user: impl Into<String>) -> Self {
        self.user = Some(user.into());
        self
    }
}

impl SlackApiMethod for UsersConversationsRequest {
    const METHOD: &'static str = "users.conversations";
    type Response = UsersConversationsResponse;
}

impl CursorPaginated for UsersConversationsRequest {
    fn set_cursor(&mut self, cursor: String) {
        self.cursor = Some(cursor);
    }
}

impl NextCursor for UsersConversationsResponse {
    fn next_cursor(&self) -> Option<&str> {
        self.response_metadata.as_ref()?.next_cursor.as_deref()
    }
}

/// Successful response of the Slack Web API method [`users.conversations`](https://docs.slack.dev/reference/methods/users.conversations).
#[doc(alias = "users.conversations")]
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersConversationsResponse {
    #[serde(
        default,
        deserialize_with = "crate::de::vec",
        skip_serializing_if = "Vec::is_empty"
    )]
    pub channels: Vec<Conversation>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub response_metadata: Option<ResponseMetadata>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub warning: Option<String>,
}

/// Arguments for the Slack Web API method [`users.deletePhoto`](https://docs.slack.dev/reference/methods/users.deletePhoto): Delete the user profile photo
///
/// Send it with [`SlackClient::users_delete_photo`].
#[doc(alias = "users.deletePhoto")]
#[derive(Debug, Clone, PartialEq, Serialize, Default)]
#[non_exhaustive]
pub struct UsersDeletePhotoRequest {}

impl UsersDeletePhotoRequest {
    pub fn new() -> Self {
        Self {}
    }
}

impl SlackApiMethod for UsersDeletePhotoRequest {
    const METHOD: &'static str = "users.deletePhoto";
    type Response = UsersDeletePhotoResponse;
}

/// Successful response of the Slack Web API method [`users.deletePhoto`](https://docs.slack.dev/reference/methods/users.deletePhoto).
#[doc(alias = "users.deletePhoto")]
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersDeletePhotoResponse {
    /// Fields returned by Slack. This method has no documented response example.
    #[serde(flatten)]
    pub extra: serde_json::Map<String, serde_json::Value>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub response_metadata: Option<ResponseMetadata>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub warning: Option<String>,
}

/// Arguments for the Slack Web API method [`users.discoverableContacts.lookup`](https://docs.slack.dev/reference/methods/users.discoverableContacts.lookup): Look up an email address to see if someone is discoverable on Slack
///
/// Send it with [`SlackClient::users_discoverable_contacts_lookup`].
#[doc(alias = "users.discoverableContacts.lookup")]
#[derive(Debug, Clone, PartialEq, Serialize)]
#[non_exhaustive]
pub struct UsersDiscoverableContactsLookupRequest {
    pub email: String,
}

impl UsersDiscoverableContactsLookupRequest {
    pub fn new(email: impl Into<String>) -> Self {
        Self {
            email: email.into(),
        }
    }
}

impl SlackApiMethod for UsersDiscoverableContactsLookupRequest {
    const METHOD: &'static str = "users.discoverableContacts.lookup";
    type Response = UsersDiscoverableContactsLookupResponse;
}

/// Successful response of the Slack Web API method [`users.discoverableContacts.lookup`](https://docs.slack.dev/reference/methods/users.discoverableContacts.lookup).
#[doc(alias = "users.discoverableContacts.lookup")]
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersDiscoverableContactsLookupResponse {
    #[serde(
        default,
        deserialize_with = "crate::de::opt_bool",
        skip_serializing_if = "Option::is_none"
    )]
    pub is_discoverable: Option<bool>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub response_metadata: Option<ResponseMetadata>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub warning: Option<String>,
}

/// Arguments for the Slack Web API method [`users.getPresence`](https://docs.slack.dev/reference/methods/users.getPresence): Gets user presence information.
///
/// Send it with [`SlackClient::users_get_presence`].
#[doc(alias = "users.getPresence")]
#[derive(Debug, Clone, PartialEq, Serialize, Default)]
#[non_exhaustive]
pub struct UsersGetPresenceRequest {
    /// User to get presence info on. Defaults to the authed user.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user: Option<String>,
}

impl UsersGetPresenceRequest {
    pub fn new() -> Self {
        Self { user: None }
    }

    pub fn user(mut self, user: impl Into<String>) -> Self {
        self.user = Some(user.into());
        self
    }
}

impl SlackApiMethod for UsersGetPresenceRequest {
    const METHOD: &'static str = "users.getPresence";
    type Response = UsersGetPresenceResponse;
}

/// Successful response of the Slack Web API method [`users.getPresence`](https://docs.slack.dev/reference/methods/users.getPresence).
#[doc(alias = "users.getPresence")]
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersGetPresenceResponse {
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub presence: Option<String>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_bool",
        skip_serializing_if = "Option::is_none"
    )]
    pub online: Option<bool>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_bool",
        skip_serializing_if = "Option::is_none"
    )]
    pub auto_away: Option<bool>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_bool",
        skip_serializing_if = "Option::is_none"
    )]
    pub manual_away: Option<bool>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_i64",
        skip_serializing_if = "Option::is_none"
    )]
    pub connection_count: Option<i64>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_i64",
        skip_serializing_if = "Option::is_none"
    )]
    pub last_activity: Option<i64>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub response_metadata: Option<ResponseMetadata>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub warning: Option<String>,
}

/// Arguments for the Slack Web API method [`users.identity`](https://docs.slack.dev/reference/methods/users.identity): Get a user's identity.
///
/// Send it with [`SlackClient::users_identity`].
#[doc(alias = "users.identity")]
#[derive(Debug, Clone, PartialEq, Serialize, Default)]
#[non_exhaustive]
pub struct UsersIdentityRequest {}

impl UsersIdentityRequest {
    pub fn new() -> Self {
        Self {}
    }
}

impl SlackApiMethod for UsersIdentityRequest {
    const METHOD: &'static str = "users.identity";
    type Response = UsersIdentityResponse;
}

/// Successful response of the Slack Web API method [`users.identity`](https://docs.slack.dev/reference/methods/users.identity).
#[doc(alias = "users.identity")]
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersIdentityResponse {
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub user: Option<UsersIdentityResponseUser>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub team: Option<UsersIdentityResponseTeam>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub response_metadata: Option<ResponseMetadata>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub warning: Option<String>,
}

#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersIdentityResponseUser {
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub name: Option<String>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub id: Option<String>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub email: Option<String>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub image_24: Option<String>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub image_32: Option<String>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub image_48: Option<String>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub image_72: Option<String>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub image_192: Option<String>,
}

#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersIdentityResponseTeam {
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub id: Option<String>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub name: Option<String>,
}

/// Arguments for the Slack Web API method [`users.info`](https://docs.slack.dev/reference/methods/users.info): Gets information about a user.
///
/// Send it with [`SlackClient::users_info`].
#[doc(alias = "users.info")]
#[derive(Debug, Clone, PartialEq, Serialize, Default)]
#[non_exhaustive]
pub struct UsersInfoRequest {
    /// Set this to `true` to receive the locale for this user. Defaults to `false`
    #[serde(skip_serializing_if = "Option::is_none")]
    pub include_locale: Option<bool>,
    /// User to get info on
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user: Option<String>,
}

impl UsersInfoRequest {
    pub fn new() -> Self {
        Self {
            include_locale: None,
            user: None,
        }
    }

    pub fn include_locale(mut self, include_locale: bool) -> Self {
        self.include_locale = Some(include_locale);
        self
    }

    pub fn user(mut self, user: impl Into<String>) -> Self {
        self.user = Some(user.into());
        self
    }
}

impl SlackApiMethod for UsersInfoRequest {
    const METHOD: &'static str = "users.info";
    type Response = UsersInfoResponse;
}

/// Successful response of the Slack Web API method [`users.info`](https://docs.slack.dev/reference/methods/users.info).
#[doc(alias = "users.info")]
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersInfoResponse {
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub user: Option<User>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub response_metadata: Option<ResponseMetadata>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub warning: Option<String>,
}

/// Arguments for the Slack Web API method [`users.list`](https://docs.slack.dev/reference/methods/users.list): Lists all users in a Slack team.
///
/// Send it with [`SlackClient::users_list`].
#[doc(alias = "users.list")]
#[derive(Debug, Clone, PartialEq, Serialize, Default)]
#[non_exhaustive]
pub struct UsersListRequest {
    /// Paginate through collections of data by setting the `cursor` parameter to a `next_cursor` attribute returned by a previous request's `response_metadata`. Default value fetches the first "page" of the collection. See [pagination](https://docs.slack.dev/apis/web-api/pagination.md) for more detail.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cursor: Option<String>,
    /// Set this to `true` to receive the locale for users. Defaults to `false`
    #[serde(skip_serializing_if = "Option::is_none")]
    pub include_locale: Option<bool>,
    /// The maximum number of items to return. Fewer than the requested number of items may be returned, even if the end of the users list hasn't been reached. Providing no `limit` value will result in Slack attempting to deliver you the entire result set. If the collection is too large you may experience `limit_required` or HTTP 500 errors.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub limit: Option<i64>,
    /// encoded team id to list users in, required if org token is used
    #[serde(skip_serializing_if = "Option::is_none")]
    pub team_id: Option<String>,
}

impl UsersListRequest {
    pub fn new() -> Self {
        Self {
            cursor: None,
            include_locale: None,
            limit: None,
            team_id: None,
        }
    }

    pub fn cursor(mut self, cursor: impl Into<String>) -> Self {
        self.cursor = Some(cursor.into());
        self
    }

    pub fn include_locale(mut self, include_locale: bool) -> Self {
        self.include_locale = Some(include_locale);
        self
    }

    pub fn limit(mut self, limit: i64) -> Self {
        self.limit = Some(limit);
        self
    }

    pub fn team_id(mut self, team_id: impl Into<String>) -> Self {
        self.team_id = Some(team_id.into());
        self
    }
}

impl SlackApiMethod for UsersListRequest {
    const METHOD: &'static str = "users.list";
    type Response = UsersListResponse;
}

impl CursorPaginated for UsersListRequest {
    fn set_cursor(&mut self, cursor: String) {
        self.cursor = Some(cursor);
    }
}

impl NextCursor for UsersListResponse {
    fn next_cursor(&self) -> Option<&str> {
        self.response_metadata.as_ref()?.next_cursor.as_deref()
    }
}

/// Successful response of the Slack Web API method [`users.list`](https://docs.slack.dev/reference/methods/users.list).
#[doc(alias = "users.list")]
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersListResponse {
    #[serde(
        default,
        deserialize_with = "crate::de::vec",
        skip_serializing_if = "Vec::is_empty"
    )]
    pub members: Vec<User>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_i64",
        skip_serializing_if = "Option::is_none"
    )]
    pub cache_ts: Option<i64>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub response_metadata: Option<ResponseMetadata>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub warning: Option<String>,
}

/// Arguments for the Slack Web API method [`users.lookupByEmail`](https://docs.slack.dev/reference/methods/users.lookupByEmail): Find a user with an email address.
///
/// Send it with [`SlackClient::users_lookup_by_email`].
#[doc(alias = "users.lookupByEmail")]
#[derive(Debug, Clone, PartialEq, Serialize)]
#[non_exhaustive]
pub struct UsersLookupByEmailRequest {
    /// An email address belonging to a user in the workspace
    pub email: String,
}

impl UsersLookupByEmailRequest {
    pub fn new(email: impl Into<String>) -> Self {
        Self {
            email: email.into(),
        }
    }
}

impl SlackApiMethod for UsersLookupByEmailRequest {
    const METHOD: &'static str = "users.lookupByEmail";
    type Response = UsersLookupByEmailResponse;
}

/// Successful response of the Slack Web API method [`users.lookupByEmail`](https://docs.slack.dev/reference/methods/users.lookupByEmail).
#[doc(alias = "users.lookupByEmail")]
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersLookupByEmailResponse {
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub user: Option<User>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub response_metadata: Option<ResponseMetadata>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub warning: Option<String>,
}

/// Arguments for the Slack Web API method [`users.profile.get`](https://docs.slack.dev/reference/methods/users.profile.get): Retrieve a user's profile information, including their custom status.
///
/// Send it with [`SlackClient::users_profile_get`].
#[doc(alias = "users.profile.get")]
#[derive(Debug, Clone, PartialEq, Serialize, Default)]
#[non_exhaustive]
pub struct UsersProfileGetRequest {
    /// Include labels for each ID in custom profile fields. Using this parameter will heavily rate-limit your requests and is not recommended.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub include_labels: Option<bool>,
    /// User to retrieve profile info for
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user: Option<String>,
}

impl UsersProfileGetRequest {
    pub fn new() -> Self {
        Self {
            include_labels: None,
            user: None,
        }
    }

    pub fn include_labels(mut self, include_labels: bool) -> Self {
        self.include_labels = Some(include_labels);
        self
    }

    pub fn user(mut self, user: impl Into<String>) -> Self {
        self.user = Some(user.into());
        self
    }
}

impl SlackApiMethod for UsersProfileGetRequest {
    const METHOD: &'static str = "users.profile.get";
    type Response = UsersProfileGetResponse;
}

/// Successful response of the Slack Web API method [`users.profile.get`](https://docs.slack.dev/reference/methods/users.profile.get).
#[doc(alias = "users.profile.get")]
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersProfileGetResponse {
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub profile: Option<UserProfile>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub response_metadata: Option<ResponseMetadata>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub warning: Option<String>,
}

/// Arguments for the Slack Web API method [`users.profile.set`](https://docs.slack.dev/reference/methods/users.profile.set): Set a user's profile information, including custom status.
///
/// Send it with [`SlackClient::users_profile_set`].
#[doc(alias = "users.profile.set")]
#[derive(Debug, Clone, PartialEq, Serialize, Default)]
#[non_exhaustive]
pub struct UsersProfileSetRequest {
    /// Name of a single key to set. Usable only if `profile` is not passed.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Collection of key:value pairs presented as a URL-encoded JSON hash. At most 50 fields may be set. Each field name is limited to 255 characters.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub profile: Option<String>,
    /// ID of user to change. This argument may only be specified by admins on paid teams.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub user: Option<String>,
    /// Value to set a single key to. Usable only if `profile` is not passed.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub value: Option<String>,
}

impl UsersProfileSetRequest {
    pub fn new() -> Self {
        Self {
            name: None,
            profile: None,
            user: None,
            value: None,
        }
    }

    pub fn name(mut self, name: impl Into<String>) -> Self {
        self.name = Some(name.into());
        self
    }

    pub fn profile(mut self, profile: impl Into<String>) -> Self {
        self.profile = Some(profile.into());
        self
    }

    pub fn user(mut self, user: impl Into<String>) -> Self {
        self.user = Some(user.into());
        self
    }

    pub fn value(mut self, value: impl Into<String>) -> Self {
        self.value = Some(value.into());
        self
    }
}

impl SlackApiMethod for UsersProfileSetRequest {
    const METHOD: &'static str = "users.profile.set";
    type Response = UsersProfileSetResponse;
}

/// Successful response of the Slack Web API method [`users.profile.set`](https://docs.slack.dev/reference/methods/users.profile.set).
#[doc(alias = "users.profile.set")]
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersProfileSetResponse {
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub profile: Option<UserProfile>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub response_metadata: Option<ResponseMetadata>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub warning: Option<String>,
}

/// Arguments for the Slack Web API method [`users.setActive`](https://docs.slack.dev/reference/methods/users.setActive): Marked a user as active. Deprecated and non-functional.
///
/// Send it with [`SlackClient::users_set_active`].
#[doc(alias = "users.setActive")]
#[derive(Debug, Clone, PartialEq, Serialize, Default)]
#[non_exhaustive]
pub struct UsersSetActiveRequest {}

impl UsersSetActiveRequest {
    pub fn new() -> Self {
        Self {}
    }
}

impl SlackApiMethod for UsersSetActiveRequest {
    const METHOD: &'static str = "users.setActive";
    type Response = UsersSetActiveResponse;
}

/// Successful response of the Slack Web API method [`users.setActive`](https://docs.slack.dev/reference/methods/users.setActive).
#[doc(alias = "users.setActive")]
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersSetActiveResponse {
    /// Fields returned by Slack. This method has no documented response example.
    #[serde(flatten)]
    pub extra: serde_json::Map<String, serde_json::Value>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub response_metadata: Option<ResponseMetadata>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub warning: Option<String>,
}

/// Arguments for the Slack Web API method [`users.setPhoto`](https://docs.slack.dev/reference/methods/users.setPhoto): Set the user profile photo
///
/// Send it with [`SlackClient::users_set_photo`].
#[doc(alias = "users.setPhoto")]
#[derive(Debug, Clone, PartialEq, Serialize, Default)]
#[non_exhaustive]
pub struct UsersSetPhotoRequest {
    /// Width/height of crop box (always square)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub crop_w: Option<String>,
    /// X coordinate of top-left corner of crop box
    #[serde(skip_serializing_if = "Option::is_none")]
    pub crop_x: Option<String>,
    /// Y coordinate of top-left corner of crop box
    #[serde(skip_serializing_if = "Option::is_none")]
    pub crop_y: Option<String>,
    /// File contents via `multipart/form-data`.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub image: Option<String>,
}

impl UsersSetPhotoRequest {
    pub fn new() -> Self {
        Self {
            crop_w: None,
            crop_x: None,
            crop_y: None,
            image: None,
        }
    }

    pub fn crop_w(mut self, crop_w: impl Into<String>) -> Self {
        self.crop_w = Some(crop_w.into());
        self
    }

    pub fn crop_x(mut self, crop_x: impl Into<String>) -> Self {
        self.crop_x = Some(crop_x.into());
        self
    }

    pub fn crop_y(mut self, crop_y: impl Into<String>) -> Self {
        self.crop_y = Some(crop_y.into());
        self
    }

    pub fn image(mut self, image: impl Into<String>) -> Self {
        self.image = Some(image.into());
        self
    }
}

impl SlackApiMethod for UsersSetPhotoRequest {
    const METHOD: &'static str = "users.setPhoto";
    type Response = UsersSetPhotoResponse;
}

/// Successful response of the Slack Web API method [`users.setPhoto`](https://docs.slack.dev/reference/methods/users.setPhoto).
#[doc(alias = "users.setPhoto")]
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersSetPhotoResponse {
    /// Fields returned by Slack. This method has no documented response example.
    #[serde(flatten)]
    pub extra: serde_json::Map<String, serde_json::Value>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub response_metadata: Option<ResponseMetadata>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub warning: Option<String>,
}

/// Arguments for the Slack Web API method [`users.setPresence`](https://docs.slack.dev/reference/methods/users.setPresence): Manually sets user presence.
///
/// Send it with [`SlackClient::users_set_presence`].
#[doc(alias = "users.setPresence")]
#[derive(Debug, Clone, PartialEq, Serialize)]
#[non_exhaustive]
pub struct UsersSetPresenceRequest {
    /// Either `auto` or `away`
    pub presence: String,
}

impl UsersSetPresenceRequest {
    pub fn new(presence: impl Into<String>) -> Self {
        Self {
            presence: presence.into(),
        }
    }
}

impl SlackApiMethod for UsersSetPresenceRequest {
    const METHOD: &'static str = "users.setPresence";
    type Response = UsersSetPresenceResponse;
}

/// Successful response of the Slack Web API method [`users.setPresence`](https://docs.slack.dev/reference/methods/users.setPresence).
#[doc(alias = "users.setPresence")]
#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize)]
pub struct UsersSetPresenceResponse {
    /// Fields returned by Slack. This method has no documented response example.
    #[serde(flatten)]
    pub extra: serde_json::Map<String, serde_json::Value>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_object",
        skip_serializing_if = "Option::is_none"
    )]
    pub response_metadata: Option<ResponseMetadata>,
    #[serde(
        default,
        deserialize_with = "crate::de::opt_string",
        skip_serializing_if = "Option::is_none"
    )]
    pub warning: Option<String>,
}

impl SlackClient {
    /// Calls the Slack Web API method [`users.conversations`](https://docs.slack.dev/reference/methods/users.conversations): List conversations the calling user is a member of.
    ///
    /// Required scopes:
    ///
    /// - bot token: `groups:read`, `im:read`, `mpim:read`, `channels:read`
    /// - user token: `groups:read`, `im:read`, `mpim:read`, `channels:read`
    ///
    /// Rate limit: Tier 3 (<https://docs.slack.dev/apis/web-api/rate-limits>).
    ///
    /// # Errors
    ///
    /// Returns [`SlackError::Api`] when Slack answers `"ok": false`; see [`SlackClient::call`] for the other cases.
    #[doc(alias = "users.conversations")]
    pub async fn users_conversations(
        &self,
        request: &UsersConversationsRequest,
    ) -> Result<UsersConversationsResponse, SlackError> {
        self.call(request).await
    }

    /// Calls the Slack Web API method [`users.deletePhoto`](https://docs.slack.dev/reference/methods/users.deletePhoto): Delete the user profile photo
    ///
    /// Required scopes:
    ///
    /// - user token: `users.profile:write`
    ///
    /// Rate limit: Tier 2 (<https://docs.slack.dev/apis/web-api/rate-limits>).
    ///
    /// # Errors
    ///
    /// Returns [`SlackError::Api`] when Slack answers `"ok": false`; see [`SlackClient::call`] for the other cases.
    #[doc(alias = "users.deletePhoto")]
    pub async fn users_delete_photo(
        &self,
        request: &UsersDeletePhotoRequest,
    ) -> Result<UsersDeletePhotoResponse, SlackError> {
        self.call(request).await
    }

    /// Calls the Slack Web API method [`users.discoverableContacts.lookup`](https://docs.slack.dev/reference/methods/users.discoverableContacts.lookup): Look up an email address to see if someone is discoverable on Slack
    ///
    /// Required scopes:
    ///
    /// - bot token: `conversations.connect:manage`, `team:read`
    ///
    /// Rate limit: Tier 2 (<https://docs.slack.dev/apis/web-api/rate-limits>).
    ///
    /// # Errors
    ///
    /// Returns [`SlackError::Api`] when Slack answers `"ok": false`; see [`SlackClient::call`] for the other cases.
    #[doc(alias = "users.discoverableContacts.lookup")]
    pub async fn users_discoverable_contacts_lookup(
        &self,
        request: &UsersDiscoverableContactsLookupRequest,
    ) -> Result<UsersDiscoverableContactsLookupResponse, SlackError> {
        self.call(request).await
    }

    /// Calls the Slack Web API method [`users.getPresence`](https://docs.slack.dev/reference/methods/users.getPresence): Gets user presence information.
    ///
    /// Required scopes:
    ///
    /// - bot token: `users:read`
    /// - user token: `users:read`
    ///
    /// Rate limit: Tier 3 (<https://docs.slack.dev/apis/web-api/rate-limits>).
    ///
    /// # Errors
    ///
    /// Returns [`SlackError::Api`] when Slack answers `"ok": false`; see [`SlackClient::call`] for the other cases.
    #[doc(alias = "users.getPresence")]
    pub async fn users_get_presence(
        &self,
        request: &UsersGetPresenceRequest,
    ) -> Result<UsersGetPresenceResponse, SlackError> {
        self.call(request).await
    }

    /// Calls the Slack Web API method [`users.identity`](https://docs.slack.dev/reference/methods/users.identity): Get a user's identity.
    ///
    /// Required scopes:
    ///
    /// - user token: `identity:read`
    ///
    /// Rate limit: Tier 3 (<https://docs.slack.dev/apis/web-api/rate-limits>).
    ///
    /// # Errors
    ///
    /// Returns [`SlackError::Api`] when Slack answers `"ok": false`; see [`SlackClient::call`] for the other cases.
    #[doc(alias = "users.identity")]
    pub async fn users_identity(
        &self,
        request: &UsersIdentityRequest,
    ) -> Result<UsersIdentityResponse, SlackError> {
        self.call(request).await
    }

    /// Calls the Slack Web API method [`users.info`](https://docs.slack.dev/reference/methods/users.info): Gets information about a user.
    ///
    /// Required scopes:
    ///
    /// - bot token: `users:read`
    /// - user token: `users:read`
    ///
    /// Rate limit: Tier 4 (<https://docs.slack.dev/apis/web-api/rate-limits>).
    ///
    /// # Errors
    ///
    /// Returns [`SlackError::Api`] when Slack answers `"ok": false`; see [`SlackClient::call`] for the other cases.
    #[doc(alias = "users.info")]
    pub async fn users_info(
        &self,
        request: &UsersInfoRequest,
    ) -> Result<UsersInfoResponse, SlackError> {
        self.call(request).await
    }

    /// Calls the Slack Web API method [`users.list`](https://docs.slack.dev/reference/methods/users.list): Lists all users in a Slack team.
    ///
    /// Required scopes:
    ///
    /// - bot token: `users:read`
    /// - user token: `users:read`
    ///
    /// Rate limit: Tier 2 (<https://docs.slack.dev/apis/web-api/rate-limits>).
    ///
    /// # Errors
    ///
    /// Returns [`SlackError::Api`] when Slack answers `"ok": false`; see [`SlackClient::call`] for the other cases.
    #[doc(alias = "users.list")]
    pub async fn users_list(
        &self,
        request: &UsersListRequest,
    ) -> Result<UsersListResponse, SlackError> {
        self.call(request).await
    }

    /// Calls the Slack Web API method [`users.lookupByEmail`](https://docs.slack.dev/reference/methods/users.lookupByEmail): Find a user with an email address.
    ///
    /// Required scopes:
    ///
    /// - bot token: `users:read.email`
    /// - user token: `users:read.email`
    ///
    /// Rate limit: Tier 3 (<https://docs.slack.dev/apis/web-api/rate-limits>).
    ///
    /// # Errors
    ///
    /// Returns [`SlackError::Api`] when Slack answers `"ok": false`; see [`SlackClient::call`] for the other cases.
    #[doc(alias = "users.lookupByEmail")]
    pub async fn users_lookup_by_email(
        &self,
        request: &UsersLookupByEmailRequest,
    ) -> Result<UsersLookupByEmailResponse, SlackError> {
        self.call(request).await
    }

    /// Calls the Slack Web API method [`users.profile.get`](https://docs.slack.dev/reference/methods/users.profile.get): Retrieve a user's profile information, including their custom status.
    ///
    /// Required scopes:
    ///
    /// - bot token: `users.profile:read`
    /// - user token: `users.profile:read`
    ///
    /// Rate limit: Tier 4 (<https://docs.slack.dev/apis/web-api/rate-limits>).
    ///
    /// # Errors
    ///
    /// Returns [`SlackError::Api`] when Slack answers `"ok": false`; see [`SlackClient::call`] for the other cases.
    #[doc(alias = "users.profile.get")]
    pub async fn users_profile_get(
        &self,
        request: &UsersProfileGetRequest,
    ) -> Result<UsersProfileGetResponse, SlackError> {
        self.call(request).await
    }

    /// Calls the Slack Web API method [`users.profile.set`](https://docs.slack.dev/reference/methods/users.profile.set): Set a user's profile information, including custom status.
    ///
    /// Required scopes:
    ///
    /// - user token: `users.profile:write`
    ///
    /// Rate limit: Tier 3 (<https://docs.slack.dev/apis/web-api/rate-limits>).
    ///
    /// # Errors
    ///
    /// Returns [`SlackError::Api`] when Slack answers `"ok": false`; see [`SlackClient::call`] for the other cases.
    #[doc(alias = "users.profile.set")]
    pub async fn users_profile_set(
        &self,
        request: &UsersProfileSetRequest,
    ) -> Result<UsersProfileSetResponse, SlackError> {
        self.call(request).await
    }

    /// Calls the Slack Web API method [`users.setActive`](https://docs.slack.dev/reference/methods/users.setActive): Marked a user as active. Deprecated and non-functional.
    ///
    /// Required scopes:
    ///
    /// - bot token: `users:write`
    /// - user token: `users:write`
    ///
    /// Rate limit: Tier 2 (<https://docs.slack.dev/apis/web-api/rate-limits>).
    ///
    /// # Errors
    ///
    /// Returns [`SlackError::Api`] when Slack answers `"ok": false`; see [`SlackClient::call`] for the other cases.
    #[doc(alias = "users.setActive")]
    pub async fn users_set_active(
        &self,
        request: &UsersSetActiveRequest,
    ) -> Result<UsersSetActiveResponse, SlackError> {
        self.call(request).await
    }

    /// Calls the Slack Web API method [`users.setPhoto`](https://docs.slack.dev/reference/methods/users.setPhoto): Set the user profile photo
    ///
    /// Required scopes:
    ///
    /// - user token: `users.profile:write`
    ///
    /// Rate limit: Tier 2 (<https://docs.slack.dev/apis/web-api/rate-limits>).
    ///
    /// # Errors
    ///
    /// Returns [`SlackError::Api`] when Slack answers `"ok": false`; see [`SlackClient::call`] for the other cases.
    #[doc(alias = "users.setPhoto")]
    pub async fn users_set_photo(
        &self,
        request: &UsersSetPhotoRequest,
    ) -> Result<UsersSetPhotoResponse, SlackError> {
        self.call(request).await
    }

    /// Calls the Slack Web API method [`users.setPresence`](https://docs.slack.dev/reference/methods/users.setPresence): Manually sets user presence.
    ///
    /// Required scopes:
    ///
    /// - bot token: `users:write`
    /// - user token: `users:write`
    ///
    /// Rate limit: Tier 2 (<https://docs.slack.dev/apis/web-api/rate-limits>).
    ///
    /// # Errors
    ///
    /// Returns [`SlackError::Api`] when Slack answers `"ok": false`; see [`SlackClient::call`] for the other cases.
    #[doc(alias = "users.setPresence")]
    pub async fn users_set_presence(
        &self,
        request: &UsersSetPresenceRequest,
    ) -> Result<UsersSetPresenceResponse, SlackError> {
        self.call(request).await
    }
}