-
Notifications
You must be signed in to change notification settings - Fork 852
Expand file tree
/
Copy pathindex.html
More file actions
15304 lines (14916 loc) · 693 KB
/
index.html
File metadata and controls
15304 lines (14916 loc) · 693 KB
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
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.6">
<title>slack_sdk API documentation</title>
<meta name="description" content="* The SDK website: https://slack.dev/python-slack-sdk/
* PyPI package: https://pypi.org/project/slack-sdk/ …">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
/* Collapse source docstrings */
setTimeout(() => {
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
.forEach(el => {
let d = document.createElement('details');
d.classList.add('hljs-string');
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
el.replaceWith(d);
});
}, 100);
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Package <code>slack_sdk</code></h1>
</header>
<section id="section-intro">
<ul>
<li>The SDK website: <a href="https://slack.dev/python-slack-sdk/">https://slack.dev/python-slack-sdk/</a></li>
<li>PyPI package: <a href="https://pypi.org/project/slack-sdk/">https://pypi.org/project/slack-sdk/</a></li>
</ul>
<p>Here is the list of key modules in this SDK:</p>
<h4 id="web-api-client">Web API Client</h4>
<ul>
<li>Web API client: <code><a title="slack_sdk.web.client" href="web/client.html">slack_sdk.web.client</a></code></li>
<li>asyncio-based Web API client: <code><a title="slack_sdk.web.async_client" href="web/async_client.html">slack_sdk.web.async_client</a></code></li>
</ul>
<h4 id="webhook-response_url-client">Webhook / response_url Client</h4>
<ul>
<li>Webhook client: <code><a title="slack_sdk.webhook.client" href="webhook/client.html">slack_sdk.webhook.client</a></code></li>
<li>asyncio-based Webhook client: <code><a title="slack_sdk.webhook.async_client" href="webhook/async_client.html">slack_sdk.webhook.async_client</a></code></li>
</ul>
<h4 id="socket-mode-client">Socket Mode Client</h4>
<ul>
<li>The built-in Socket Mode client: <code><a title="slack_sdk.socket_mode.builtin.client" href="socket_mode/builtin/client.html">slack_sdk.socket_mode.builtin.client</a></code></li>
<li><a href="https://pypi.org/project/aiohttp/">aiohttp</a> based client: <code><a title="slack_sdk.socket_mode.aiohttp" href="socket_mode/aiohttp/index.html">slack_sdk.socket_mode.aiohttp</a></code></li>
<li><a href="https://pypi.org/project/websocket-client/">websocket_client</a> based client: <code><a title="slack_sdk.socket_mode.websocket_client" href="socket_mode/websocket_client/index.html">slack_sdk.socket_mode.websocket_client</a></code></li>
<li><a href="https://pypi.org/project/websockets/">websockets</a> based client: <code><a title="slack_sdk.socket_mode.websockets" href="socket_mode/websockets/index.html">slack_sdk.socket_mode.websockets</a></code></li>
</ul>
<h4 id="oauth">OAuth</h4>
<ul>
<li><code><a title="slack_sdk.oauth.installation_store.installation_store" href="oauth/installation_store/installation_store.html">slack_sdk.oauth.installation_store.installation_store</a></code></li>
<li><code><a title="slack_sdk.oauth.state_store" href="oauth/state_store/index.html">slack_sdk.oauth.state_store</a></code></li>
</ul>
<h4 id="audit-logs-api-client">Audit Logs API Client</h4>
<ul>
<li><code><a title="slack_sdk.audit_logs.v1.client" href="audit_logs/v1/client.html">slack_sdk.audit_logs.v1.client</a></code></li>
<li><code><a title="slack_sdk.audit_logs.v1.async_client" href="audit_logs/v1/async_client.html">slack_sdk.audit_logs.v1.async_client</a></code></li>
</ul>
<h4 id="scim-api-client">SCIM API Client</h4>
<ul>
<li><code><a title="slack_sdk.scim.v1.client" href="scim/v1/client.html">slack_sdk.scim.v1.client</a></code></li>
<li><code><a title="slack_sdk.scim.v1.async_client" href="scim/v1/async_client.html">slack_sdk.scim.v1.async_client</a></code></li>
</ul>
</section>
<section>
<h2 class="section-title" id="header-submodules">Sub-modules</h2>
<dl>
<dt><code class="name"><a title="slack_sdk.aiohttp_version_checker" href="aiohttp_version_checker.html">slack_sdk.aiohttp_version_checker</a></code></dt>
<dd>
<div class="desc"><p>Internal module for checking aiohttp compatibility of async modules</p></div>
</dd>
<dt><code class="name"><a title="slack_sdk.audit_logs" href="audit_logs/index.html">slack_sdk.audit_logs</a></code></dt>
<dd>
<div class="desc"><p>Audit Logs API is a set of APIs for monitoring what’s happening in your Enterprise Grid organization …</p></div>
</dd>
<dt><code class="name"><a title="slack_sdk.errors" href="errors/index.html">slack_sdk.errors</a></code></dt>
<dd>
<div class="desc"><p>Errors that can be raised by this SDK</p></div>
</dd>
<dt><code class="name"><a title="slack_sdk.http_retry" href="http_retry/index.html">slack_sdk.http_retry</a></code></dt>
<dd>
<div class="desc"></div>
</dd>
<dt><code class="name"><a title="slack_sdk.models" href="models/index.html">slack_sdk.models</a></code></dt>
<dd>
<div class="desc"><p>Classes for constructing Slack-specific data structure</p></div>
</dd>
<dt><code class="name"><a title="slack_sdk.oauth" href="oauth/index.html">slack_sdk.oauth</a></code></dt>
<dd>
<div class="desc"><p>Modules for implementing the Slack OAuth flow …</p></div>
</dd>
<dt><code class="name"><a title="slack_sdk.proxy_env_variable_loader" href="proxy_env_variable_loader.html">slack_sdk.proxy_env_variable_loader</a></code></dt>
<dd>
<div class="desc"><p>Internal module for loading proxy-related env variables</p></div>
</dd>
<dt><code class="name"><a title="slack_sdk.rtm" href="rtm/index.html">slack_sdk.rtm</a></code></dt>
<dd>
<div class="desc"><p>A Python module for interacting with Slack's RTM API.</p></div>
</dd>
<dt><code class="name"><a title="slack_sdk.rtm_v2" href="rtm_v2/index.html">slack_sdk.rtm_v2</a></code></dt>
<dd>
<div class="desc"><p>A Python module for interacting with Slack's RTM API.</p></div>
</dd>
<dt><code class="name"><a title="slack_sdk.scim" href="scim/index.html">slack_sdk.scim</a></code></dt>
<dd>
<div class="desc"><p>SCIM API is a set of APIs for provisioning and managing user accounts and groups.
SCIM is used by Single Sign-On (SSO) services and identity providers …</p></div>
</dd>
<dt><code class="name"><a title="slack_sdk.signature" href="signature/index.html">slack_sdk.signature</a></code></dt>
<dd>
<div class="desc"><p>Slack request signature verifier</p></div>
</dd>
<dt><code class="name"><a title="slack_sdk.socket_mode" href="socket_mode/index.html">slack_sdk.socket_mode</a></code></dt>
<dd>
<div class="desc"><p>Socket Mode is a method of connecting your app to Slack’s APIs using WebSockets instead of HTTP.
You can use slack_sdk.socket_mode.SocketModeClient …</p></div>
</dd>
<dt><code class="name"><a title="slack_sdk.version" href="version.html">slack_sdk.version</a></code></dt>
<dd>
<div class="desc"><p>Check the latest version at <a href="https://pypi.org/project/slack-sdk/">https://pypi.org/project/slack-sdk/</a></p></div>
</dd>
<dt><code class="name"><a title="slack_sdk.web" href="web/index.html">slack_sdk.web</a></code></dt>
<dd>
<div class="desc"><p>The Slack Web API allows you to build applications that interact with Slack
in more complex ways than the integrations we provide out of the box.</p></div>
</dd>
<dt><code class="name"><a title="slack_sdk.webhook" href="webhook/index.html">slack_sdk.webhook</a></code></dt>
<dd>
<div class="desc"><p>You can use slack_sdk.webhook.WebhookClient for Incoming Webhooks
and message responses using response_url in payloads.</p></div>
</dd>
</dl>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="slack_sdk.WebClient"><code class="flex name class">
<span>class <span class="ident">WebClient</span></span>
<span>(</span><span>token: str | None = None,<br>base_url: str = 'https://slack.com/api/',<br>timeout: int = 30,<br>ssl: ssl.SSLContext | None = None,<br>proxy: str | None = None,<br>headers: dict | None = None,<br>user_agent_prefix: str | None = None,<br>user_agent_suffix: str | None = None,<br>team_id: str | None = None,<br>logger: logging.Logger | None = None,<br>retry_handlers: List[<a title="slack_sdk.http_retry.handler.RetryHandler" href="http_retry/handler.html#slack_sdk.http_retry.handler.RetryHandler">RetryHandler</a>] | None = None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class WebClient(BaseClient):
"""A WebClient allows apps to communicate with the Slack Platform's Web API.
https://api.slack.com/methods
The Slack Web API is an interface for querying information from
and enacting change in a Slack workspace.
This client handles constructing and sending HTTP requests to Slack
as well as parsing any responses received into a `SlackResponse`.
Attributes:
token (str): A string specifying an `xoxp-*` or `xoxb-*` token.
base_url (str): A string representing the Slack API base URL.
Default is `'https://slack.com/api/'`
timeout (int): The maximum number of seconds the client will wait
to connect and receive a response from Slack.
Default is 30 seconds.
ssl (SSLContext): An [`ssl.SSLContext`][1] instance, helpful for specifying
your own custom certificate chain.
proxy (str): String representing a fully-qualified URL to a proxy through
which to route all requests to the Slack API. Even if this parameter
is not specified, if any of the following environment variables are
present, they will be loaded into this parameter: `HTTPS_PROXY`,
`https_proxy`, `HTTP_PROXY` or `http_proxy`.
headers (dict): Additional request headers to attach to all requests.
Methods:
`api_call`: Constructs a request and executes the API call to Slack.
Example of recommended usage:
```python
import os
from slack_sdk import WebClient
client = WebClient(token=os.environ['SLACK_API_TOKEN'])
response = client.chat_postMessage(
channel='#random',
text="Hello world!")
assert response["ok"]
assert response["message"]["text"] == "Hello world!"
```
Example manually creating an API request:
```python
import os
from slack_sdk import WebClient
client = WebClient(token=os.environ['SLACK_API_TOKEN'])
response = client.api_call(
api_method='chat.postMessage',
json={'channel': '#random','text': "Hello world!"}
)
assert response["ok"]
assert response["message"]["text"] == "Hello world!"
```
Note:
Any attributes or methods prefixed with _underscores are
intended to be "private" internal use only. They may be changed or
removed at anytime.
[1]: https://docs.python.org/3/library/ssl.html#ssl.SSLContext
"""
def admin_analytics_getFile(
self,
*,
type: str,
date: Optional[str] = None,
metadata_only: Optional[bool] = None,
**kwargs,
) -> SlackResponse:
"""Retrieve analytics data for a given date, presented as a compressed JSON file
https://api.slack.com/methods/admin.analytics.getFile
"""
kwargs.update({"type": type})
if date is not None:
kwargs.update({"date": date})
if metadata_only is not None:
kwargs.update({"metadata_only": metadata_only})
return self.api_call("admin.analytics.getFile", params=kwargs)
def admin_apps_approve(
self,
*,
app_id: Optional[str] = None,
request_id: Optional[str] = None,
enterprise_id: Optional[str] = None,
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Approve an app for installation on a workspace.
Either app_id or request_id is required.
These IDs can be obtained either directly via the app_requested event,
or by the admin.apps.requests.list method.
https://api.slack.com/methods/admin.apps.approve
"""
if app_id:
kwargs.update({"app_id": app_id})
elif request_id:
kwargs.update({"request_id": request_id})
else:
raise e.SlackRequestError("The app_id or request_id argument must be specified.")
kwargs.update(
{
"enterprise_id": enterprise_id,
"team_id": team_id,
}
)
return self.api_call("admin.apps.approve", params=kwargs)
def admin_apps_approved_list(
self,
*,
cursor: Optional[str] = None,
limit: Optional[int] = None,
enterprise_id: Optional[str] = None,
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""List approved apps for an org or workspace.
https://api.slack.com/methods/admin.apps.approved.list
"""
kwargs.update(
{
"cursor": cursor,
"limit": limit,
"enterprise_id": enterprise_id,
"team_id": team_id,
}
)
return self.api_call("admin.apps.approved.list", http_verb="GET", params=kwargs)
def admin_apps_clearResolution(
self,
*,
app_id: str,
enterprise_id: Optional[str] = None,
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Clear an app resolution
https://api.slack.com/methods/admin.apps.clearResolution
"""
kwargs.update(
{
"app_id": app_id,
"enterprise_id": enterprise_id,
"team_id": team_id,
}
)
return self.api_call("admin.apps.clearResolution", http_verb="POST", params=kwargs)
def admin_apps_requests_cancel(
self,
*,
request_id: str,
enterprise_id: Optional[str] = None,
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""List app requests for a team/workspace.
https://api.slack.com/methods/admin.apps.requests.cancel
"""
kwargs.update(
{
"request_id": request_id,
"enterprise_id": enterprise_id,
"team_id": team_id,
}
)
return self.api_call("admin.apps.requests.cancel", http_verb="POST", params=kwargs)
def admin_apps_requests_list(
self,
*,
cursor: Optional[str] = None,
limit: Optional[int] = None,
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""List app requests for a team/workspace.
https://api.slack.com/methods/admin.apps.requests.list
"""
kwargs.update(
{
"cursor": cursor,
"limit": limit,
"team_id": team_id,
}
)
return self.api_call("admin.apps.requests.list", http_verb="GET", params=kwargs)
def admin_apps_restrict(
self,
*,
app_id: Optional[str] = None,
request_id: Optional[str] = None,
enterprise_id: Optional[str] = None,
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Restrict an app for installation on a workspace.
Exactly one of the team_id or enterprise_id arguments is required, not both.
Either app_id or request_id is required. These IDs can be obtained either directly
via the app_requested event, or by the admin.apps.requests.list method.
https://api.slack.com/methods/admin.apps.restrict
"""
if app_id:
kwargs.update({"app_id": app_id})
elif request_id:
kwargs.update({"request_id": request_id})
else:
raise e.SlackRequestError("The app_id or request_id argument must be specified.")
kwargs.update(
{
"enterprise_id": enterprise_id,
"team_id": team_id,
}
)
return self.api_call("admin.apps.restrict", params=kwargs)
def admin_apps_restricted_list(
self,
*,
cursor: Optional[str] = None,
limit: Optional[int] = None,
enterprise_id: Optional[str] = None,
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""List restricted apps for an org or workspace.
https://api.slack.com/methods/admin.apps.restricted.list
"""
kwargs.update(
{
"cursor": cursor,
"limit": limit,
"enterprise_id": enterprise_id,
"team_id": team_id,
}
)
return self.api_call("admin.apps.restricted.list", http_verb="GET", params=kwargs)
def admin_apps_uninstall(
self,
*,
app_id: str,
enterprise_id: Optional[str] = None,
team_ids: Optional[Union[str, Sequence[str]]] = None,
**kwargs,
) -> SlackResponse:
"""Uninstall an app from one or many workspaces, or an entire enterprise organization.
With an org-level token, enterprise_id or team_ids is required.
https://api.slack.com/methods/admin.apps.uninstall
"""
kwargs.update({"app_id": app_id})
if enterprise_id is not None:
kwargs.update({"enterprise_id": enterprise_id})
if team_ids is not None:
if isinstance(team_ids, (list, tuple)):
kwargs.update({"team_ids": ",".join(team_ids)})
else:
kwargs.update({"team_ids": team_ids})
return self.api_call("admin.apps.uninstall", http_verb="POST", params=kwargs)
def admin_apps_activities_list(
self,
*,
app_id: Optional[str] = None,
component_id: Optional[str] = None,
component_type: Optional[str] = None,
log_event_type: Optional[str] = None,
max_date_created: Optional[int] = None,
min_date_created: Optional[int] = None,
min_log_level: Optional[str] = None,
sort_direction: Optional[str] = None,
source: Optional[str] = None,
team_id: Optional[str] = None,
trace_id: Optional[str] = None,
cursor: Optional[str] = None,
limit: Optional[int] = None,
**kwargs,
) -> SlackResponse:
"""Get logs for a specified team/org
https://api.slack.com/methods/admin.apps.activities.list
"""
kwargs.update(
{
"app_id": app_id,
"component_id": component_id,
"component_type": component_type,
"log_event_type": log_event_type,
"max_date_created": max_date_created,
"min_date_created": min_date_created,
"min_log_level": min_log_level,
"sort_direction": sort_direction,
"source": source,
"team_id": team_id,
"trace_id": trace_id,
"cursor": cursor,
"limit": limit,
}
)
return self.api_call("admin.apps.activities.list", params=kwargs)
def admin_apps_config_lookup(
self,
*,
app_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
"""Look up the app config for connectors by their IDs
https://api.slack.com/methods/admin.apps.config.lookup
"""
if isinstance(app_ids, (list, tuple)):
kwargs.update({"app_ids": ",".join(app_ids)})
else:
kwargs.update({"app_ids": app_ids})
return self.api_call("admin.apps.config.lookup", params=kwargs)
def admin_apps_config_set(
self,
*,
app_id: str,
domain_restrictions: Optional[Dict[str, Any]] = None,
workflow_auth_strategy: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Set the app config for a connector
https://api.slack.com/methods/admin.apps.config.set
"""
kwargs.update(
{
"app_id": app_id,
"workflow_auth_strategy": workflow_auth_strategy,
}
)
if domain_restrictions is not None:
kwargs.update({"domain_restrictions": json.dumps(domain_restrictions)})
return self.api_call("admin.apps.config.set", params=kwargs)
def admin_auth_policy_getEntities(
self,
*,
policy_name: str,
cursor: Optional[str] = None,
entity_type: Optional[str] = None,
limit: Optional[int] = None,
**kwargs,
) -> SlackResponse:
"""Fetch all the entities assigned to a particular authentication policy by name.
https://api.slack.com/methods/admin.auth.policy.getEntities
"""
kwargs.update({"policy_name": policy_name})
if cursor is not None:
kwargs.update({"cursor": cursor})
if entity_type is not None:
kwargs.update({"entity_type": entity_type})
if limit is not None:
kwargs.update({"limit": limit})
return self.api_call("admin.auth.policy.getEntities", http_verb="POST", params=kwargs)
def admin_auth_policy_assignEntities(
self,
*,
entity_ids: Union[str, Sequence[str]],
policy_name: str,
entity_type: str,
**kwargs,
) -> SlackResponse:
"""Assign entities to a particular authentication policy.
https://api.slack.com/methods/admin.auth.policy.assignEntities
"""
if isinstance(entity_ids, (list, tuple)):
kwargs.update({"entity_ids": ",".join(entity_ids)})
else:
kwargs.update({"entity_ids": entity_ids})
kwargs.update({"policy_name": policy_name})
kwargs.update({"entity_type": entity_type})
return self.api_call("admin.auth.policy.assignEntities", http_verb="POST", params=kwargs)
def admin_auth_policy_removeEntities(
self,
*,
entity_ids: Union[str, Sequence[str]],
policy_name: str,
entity_type: str,
**kwargs,
) -> SlackResponse:
"""Remove specified entities from a specified authentication policy.
https://api.slack.com/methods/admin.auth.policy.removeEntities
"""
if isinstance(entity_ids, (list, tuple)):
kwargs.update({"entity_ids": ",".join(entity_ids)})
else:
kwargs.update({"entity_ids": entity_ids})
kwargs.update({"policy_name": policy_name})
kwargs.update({"entity_type": entity_type})
return self.api_call("admin.auth.policy.removeEntities", http_verb="POST", params=kwargs)
def admin_conversations_createForObjects(
self,
*,
object_id: str,
salesforce_org_id: str,
invite_object_team: Optional[bool] = None,
**kwargs,
) -> SlackResponse:
"""Create a Salesforce channel for the corresponding object provided.
https://api.slack.com/methods/admin.conversations.createForObjects
"""
kwargs.update(
{"object_id": object_id, "salesforce_org_id": salesforce_org_id, "invite_object_team": invite_object_team}
)
return self.api_call("admin.conversations.createForObjects", params=kwargs)
def admin_conversations_linkObjects(
self,
*,
channel: str,
record_id: str,
salesforce_org_id: str,
**kwargs,
) -> SlackResponse:
"""Link a Salesforce record to a channel.
https://api.slack.com/methods/admin.conversations.linkObjects
"""
kwargs.update(
{
"channel": channel,
"record_id": record_id,
"salesforce_org_id": salesforce_org_id,
}
)
return self.api_call("admin.conversations.linkObjects", params=kwargs)
def admin_conversations_unlinkObjects(
self,
*,
channel: str,
new_name: str,
**kwargs,
) -> SlackResponse:
"""Unlink a Salesforce record from a channel.
https://api.slack.com/methods/admin.conversations.unlinkObjects
"""
kwargs.update(
{
"channel": channel,
"new_name": new_name,
}
)
return self.api_call("admin.conversations.unlinkObjects", params=kwargs)
def admin_barriers_create(
self,
*,
barriered_from_usergroup_ids: Union[str, Sequence[str]],
primary_usergroup_id: str,
restricted_subjects: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
"""Create an Information Barrier
https://api.slack.com/methods/admin.barriers.create
"""
kwargs.update({"primary_usergroup_id": primary_usergroup_id})
if isinstance(barriered_from_usergroup_ids, (list, tuple)):
kwargs.update({"barriered_from_usergroup_ids": ",".join(barriered_from_usergroup_ids)})
else:
kwargs.update({"barriered_from_usergroup_ids": barriered_from_usergroup_ids})
if isinstance(restricted_subjects, (list, tuple)):
kwargs.update({"restricted_subjects": ",".join(restricted_subjects)})
else:
kwargs.update({"restricted_subjects": restricted_subjects})
return self.api_call("admin.barriers.create", http_verb="POST", params=kwargs)
def admin_barriers_delete(
self,
*,
barrier_id: str,
**kwargs,
) -> SlackResponse:
"""Delete an existing Information Barrier
https://api.slack.com/methods/admin.barriers.delete
"""
kwargs.update({"barrier_id": barrier_id})
return self.api_call("admin.barriers.delete", http_verb="POST", params=kwargs)
def admin_barriers_update(
self,
*,
barrier_id: str,
barriered_from_usergroup_ids: Union[str, Sequence[str]],
primary_usergroup_id: str,
restricted_subjects: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
"""Update an existing Information Barrier
https://api.slack.com/methods/admin.barriers.update
"""
kwargs.update({"barrier_id": barrier_id, "primary_usergroup_id": primary_usergroup_id})
if isinstance(barriered_from_usergroup_ids, (list, tuple)):
kwargs.update({"barriered_from_usergroup_ids": ",".join(barriered_from_usergroup_ids)})
else:
kwargs.update({"barriered_from_usergroup_ids": barriered_from_usergroup_ids})
if isinstance(restricted_subjects, (list, tuple)):
kwargs.update({"restricted_subjects": ",".join(restricted_subjects)})
else:
kwargs.update({"restricted_subjects": restricted_subjects})
return self.api_call("admin.barriers.update", http_verb="POST", params=kwargs)
def admin_barriers_list(
self,
*,
cursor: Optional[str] = None,
limit: Optional[int] = None,
**kwargs,
) -> SlackResponse:
"""Get all Information Barriers for your organization
https://api.slack.com/methods/admin.barriers.list"""
kwargs.update(
{
"cursor": cursor,
"limit": limit,
}
)
return self.api_call("admin.barriers.list", http_verb="GET", params=kwargs)
def admin_conversations_create(
self,
*,
is_private: bool,
name: str,
description: Optional[str] = None,
org_wide: Optional[bool] = None,
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Create a public or private channel-based conversation.
https://api.slack.com/methods/admin.conversations.create
"""
kwargs.update(
{
"is_private": is_private,
"name": name,
"description": description,
"org_wide": org_wide,
"team_id": team_id,
}
)
return self.api_call("admin.conversations.create", params=kwargs)
def admin_conversations_delete(
self,
*,
channel_id: str,
**kwargs,
) -> SlackResponse:
"""Delete a public or private channel.
https://api.slack.com/methods/admin.conversations.delete
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.delete", params=kwargs)
def admin_conversations_invite(
self,
*,
channel_id: str,
user_ids: Union[str, Sequence[str]],
**kwargs,
) -> SlackResponse:
"""Invite a user to a public or private channel.
https://api.slack.com/methods/admin.conversations.invite
"""
kwargs.update({"channel_id": channel_id})
if isinstance(user_ids, (list, tuple)):
kwargs.update({"user_ids": ",".join(user_ids)})
else:
kwargs.update({"user_ids": user_ids})
# NOTE: the endpoint is unable to handle Content-Type: application/json as of Sep 3, 2020.
return self.api_call("admin.conversations.invite", params=kwargs)
def admin_conversations_archive(
self,
*,
channel_id: str,
**kwargs,
) -> SlackResponse:
"""Archive a public or private channel.
https://api.slack.com/methods/admin.conversations.archive
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.archive", params=kwargs)
def admin_conversations_unarchive(
self,
*,
channel_id: str,
**kwargs,
) -> SlackResponse:
"""Unarchive a public or private channel.
https://api.slack.com/methods/admin.conversations.archive
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.unarchive", params=kwargs)
def admin_conversations_rename(
self,
*,
channel_id: str,
name: str,
**kwargs,
) -> SlackResponse:
"""Rename a public or private channel.
https://api.slack.com/methods/admin.conversations.rename
"""
kwargs.update({"channel_id": channel_id, "name": name})
return self.api_call("admin.conversations.rename", params=kwargs)
def admin_conversations_search(
self,
*,
cursor: Optional[str] = None,
limit: Optional[int] = None,
query: Optional[str] = None,
search_channel_types: Optional[Union[str, Sequence[str]]] = None,
sort: Optional[str] = None,
sort_dir: Optional[str] = None,
team_ids: Optional[Union[str, Sequence[str]]] = None,
**kwargs,
) -> SlackResponse:
"""Search for public or private channels in an Enterprise organization.
https://api.slack.com/methods/admin.conversations.search
"""
kwargs.update(
{
"cursor": cursor,
"limit": limit,
"query": query,
"sort": sort,
"sort_dir": sort_dir,
}
)
if isinstance(search_channel_types, (list, tuple)):
kwargs.update({"search_channel_types": ",".join(search_channel_types)})
else:
kwargs.update({"search_channel_types": search_channel_types})
if isinstance(team_ids, (list, tuple)):
kwargs.update({"team_ids": ",".join(team_ids)})
else:
kwargs.update({"team_ids": team_ids})
return self.api_call("admin.conversations.search", params=kwargs)
def admin_conversations_convertToPrivate(
self,
*,
channel_id: str,
**kwargs,
) -> SlackResponse:
"""Convert a public channel to a private channel.
https://api.slack.com/methods/admin.conversations.convertToPrivate
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.convertToPrivate", params=kwargs)
def admin_conversations_convertToPublic(
self,
*,
channel_id: str,
**kwargs,
) -> SlackResponse:
"""Convert a privte channel to a public channel.
https://api.slack.com/methods/admin.conversations.convertToPublic
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.convertToPublic", params=kwargs)
def admin_conversations_setConversationPrefs(
self,
*,
channel_id: str,
prefs: Union[str, Dict[str, str]],
**kwargs,
) -> SlackResponse:
"""Set the posting permissions for a public or private channel.
https://api.slack.com/methods/admin.conversations.setConversationPrefs
"""
kwargs.update({"channel_id": channel_id})
if isinstance(prefs, dict):
kwargs.update({"prefs": json.dumps(prefs)})
else:
kwargs.update({"prefs": prefs})
return self.api_call("admin.conversations.setConversationPrefs", params=kwargs)
def admin_conversations_getConversationPrefs(
self,
*,
channel_id: str,
**kwargs,
) -> SlackResponse:
"""Get conversation preferences for a public or private channel.
https://api.slack.com/methods/admin.conversations.getConversationPrefs
"""
kwargs.update({"channel_id": channel_id})
return self.api_call("admin.conversations.getConversationPrefs", params=kwargs)
def admin_conversations_disconnectShared(
self,
*,
channel_id: str,
leaving_team_ids: Optional[Union[str, Sequence[str]]] = None,
**kwargs,
) -> SlackResponse:
"""Disconnect a connected channel from one or more workspaces.
https://api.slack.com/methods/admin.conversations.disconnectShared
"""
kwargs.update({"channel_id": channel_id})
if isinstance(leaving_team_ids, (list, tuple)):
kwargs.update({"leaving_team_ids": ",".join(leaving_team_ids)})
else:
kwargs.update({"leaving_team_ids": leaving_team_ids})
return self.api_call("admin.conversations.disconnectShared", params=kwargs)
def admin_conversations_lookup(
self,
*,
last_message_activity_before: int,
team_ids: Union[str, Sequence[str]],
cursor: Optional[str] = None,
limit: Optional[int] = None,
max_member_count: Optional[int] = None,
**kwargs,
) -> SlackResponse:
"""Returns channels on the given team using the filters.
https://api.slack.com/methods/admin.conversations.lookup
"""
kwargs.update(
{
"last_message_activity_before": last_message_activity_before,
"cursor": cursor,
"limit": limit,
"max_member_count": max_member_count,
}
)
if isinstance(team_ids, (list, tuple)):
kwargs.update({"team_ids": ",".join(team_ids)})
else:
kwargs.update({"team_ids": team_ids})
return self.api_call("admin.conversations.lookup", params=kwargs)
def admin_conversations_ekm_listOriginalConnectedChannelInfo(
self,
*,
channel_ids: Optional[Union[str, Sequence[str]]] = None,
cursor: Optional[str] = None,
limit: Optional[int] = None,
team_ids: Optional[Union[str, Sequence[str]]] = None,
**kwargs,
) -> SlackResponse:
"""List all disconnected channels—i.e.,
channels that were once connected to other workspaces and then disconnected—and
the corresponding original channel IDs for key revocation with EKM.
https://api.slack.com/methods/admin.conversations.ekm.listOriginalConnectedChannelInfo
"""
kwargs.update(
{
"cursor": cursor,
"limit": limit,
}
)
if isinstance(channel_ids, (list, tuple)):
kwargs.update({"channel_ids": ",".join(channel_ids)})
else:
kwargs.update({"channel_ids": channel_ids})
if isinstance(team_ids, (list, tuple)):
kwargs.update({"team_ids": ",".join(team_ids)})
else:
kwargs.update({"team_ids": team_ids})
return self.api_call("admin.conversations.ekm.listOriginalConnectedChannelInfo", params=kwargs)
def admin_conversations_restrictAccess_addGroup(
self,
*,
channel_id: str,
group_id: str,
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""Add an allowlist of IDP groups for accessing a channel.
https://api.slack.com/methods/admin.conversations.restrictAccess.addGroup
"""
kwargs.update(
{
"channel_id": channel_id,
"group_id": group_id,
"team_id": team_id,
}
)
return self.api_call(
"admin.conversations.restrictAccess.addGroup",
http_verb="GET",
params=kwargs,
)
def admin_conversations_restrictAccess_listGroups(
self,
*,
channel_id: str,
team_id: Optional[str] = None,
**kwargs,
) -> SlackResponse:
"""List all IDP Groups linked to a channel.
https://api.slack.com/methods/admin.conversations.restrictAccess.listGroups
"""
kwargs.update(
{
"channel_id": channel_id,
"team_id": team_id,
}
)
return self.api_call(
"admin.conversations.restrictAccess.listGroups",
http_verb="GET",
params=kwargs,
)
def admin_conversations_restrictAccess_removeGroup(
self,
*,
channel_id: str,
group_id: str,