Skip to content

Commit 9e73506

Browse files
vegerisvegeris
authored
chore(web-api): release @slack/[email protected] (#2419)
1 parent 9ed8713 commit 9e73506

54 files changed

Lines changed: 2325 additions & 139 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/english/reference/web-api/classes/Methods.md‎

Lines changed: 58 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Abstract Class: Methods
44

5-
Defined in: [src/methods.ts:571](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L571)
5+
Defined in: [src/methods.ts:573](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L573)
66

77
A class that defines all Web API methods, their arguments type, their response type, and binds those methods to the
88
`apiCall` class method.
@@ -23,7 +23,7 @@ A class that defines all Web API methods, their arguments type, their response t
2323
readonly admin: object;
2424
```
2525

26-
Defined in: [src/methods.ts:584](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L584)
26+
Defined in: [src/methods.ts:586](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L586)
2727

2828
#### analytics
2929

@@ -1558,7 +1558,7 @@ Unpublish workflows within the team or enterprise.
15581558
readonly api: object;
15591559
```
15601560

1561-
Defined in: [src/methods.ts:1349](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1349)
1561+
Defined in: [src/methods.ts:1351](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1351)
15621562

15631563
#### test
15641564

@@ -1582,7 +1582,7 @@ Checks API calling code.
15821582
readonly apps: object;
15831583
```
15841584

1585-
Defined in: [src/methods.ts:1386](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1386)
1585+
Defined in: [src/methods.ts:1388](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1388)
15861586

15871587
#### connections
15881588

@@ -1730,7 +1730,7 @@ Uninstalls your app from a workspace.
17301730
readonly assistant: object;
17311731
```
17321732

1733-
Defined in: [src/methods.ts:1357](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1357)
1733+
Defined in: [src/methods.ts:1359](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1359)
17341734

17351735
#### threads
17361736

@@ -1788,7 +1788,7 @@ Set the title of the thread. This is shown when a user views the app's chat hist
17881788
readonly auth: object;
17891789
```
17901790

1791-
Defined in: [src/methods.ts:1448](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1448)
1791+
Defined in: [src/methods.ts:1450](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1450)
17921792

17931793
#### revoke
17941794

@@ -1838,7 +1838,7 @@ test: Method<AuthTestArguments, AuthTestResponse>;
18381838
readonly bookmarks: object;
18391839
```
18401840

1841-
Defined in: [src/methods.ts:1464](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1464)
1841+
Defined in: [src/methods.ts:1466](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1466)
18421842

18431843
#### add
18441844

@@ -1904,7 +1904,7 @@ Remove bookmark from a channel.
19041904
readonly bots: object;
19051905
```
19061906

1907-
Defined in: [src/methods.ts:1487](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1487)
1907+
Defined in: [src/methods.ts:1489](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1489)
19081908

19091909
#### info
19101910

@@ -1928,7 +1928,7 @@ Gets information about a bot user.
19281928
readonly calls: object;
19291929
```
19301930

1931-
Defined in: [src/methods.ts:1495](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1495)
1931+
Defined in: [src/methods.ts:1497](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1497)
19321932

19331933
#### add
19341934

@@ -2020,7 +2020,7 @@ Updates information about a Call.
20202020
readonly canvases: object;
20212021
```
20222022

2023-
Defined in: [src/methods.ts:1529](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1529)
2023+
Defined in: [src/methods.ts:1531](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1531)
20242024

20252025
#### access
20262026

@@ -2126,7 +2126,7 @@ Find sections matching the provided criteria.
21262126
readonly chat: object;
21272127
```
21282128

2129-
Defined in: [src/methods.ts:1569](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1569)
2129+
Defined in: [src/methods.ts:1571](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1571)
21302130

21312131
#### appendStream
21322132

@@ -2312,7 +2312,7 @@ Updates a message.
23122312
readonly conversations: object;
23132313
```
23142314

2315-
Defined in: [src/methods.ts:1645](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1645)
2315+
Defined in: [src/methods.ts:1647](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1647)
23162316

23172317
#### acceptSharedInvite
23182318

@@ -2734,7 +2734,7 @@ Reverses conversation archival.
27342734
readonly dialog: object;
27352735
```
27362736

2737-
Defined in: [src/methods.ts:1838](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1838)
2737+
Defined in: [src/methods.ts:1840](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1840)
27382738

27392739
#### open
27402740

@@ -2758,7 +2758,7 @@ Open a dialog with a user.
27582758
readonly dnd: object;
27592759
```
27602760

2761-
Defined in: [src/methods.ts:1846](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1846)
2761+
Defined in: [src/methods.ts:1848](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1848)
27622762

27632763
#### endDnd
27642764

@@ -2838,7 +2838,7 @@ Retrieves the Do Not Disturb status for up to 50 users on a team.
28382838
readonly emoji: object;
28392839
```
28402840

2841-
Defined in: [src/methods.ts:1874](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1874)
2841+
Defined in: [src/methods.ts:1876](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1876)
28422842

28432843
#### list
28442844

@@ -2856,13 +2856,37 @@ Lists custom emoji for a team.
28562856

28572857
***
28582858

2859+
### entity
2860+
2861+
```ts
2862+
readonly entity: object;
2863+
```
2864+
2865+
Defined in: [src/methods.ts:1884](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1884)
2866+
2867+
#### presentDetails
2868+
2869+
```ts
2870+
presentDetails: MethodWithRequiredArgument<EntityPresentDetailsArguments, EntityPresentDetailsResponse>;
2871+
```
2872+
2873+
##### Description
2874+
2875+
Provide information about the entity to be displayed in the flexpane.
2876+
2877+
##### See
2878+
2879+
[https://docs.slack.dev/reference/methods/entity.presentDetails](https://docs.slack.dev/reference/methods/entity.presentDetails)
2880+
2881+
***
2882+
28592883
### files
28602884

28612885
```ts
28622886
readonly files: object;
28632887
```
28642888

2865-
Defined in: [src/methods.ts:1882](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1882)
2889+
Defined in: [src/methods.ts:1895](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1895)
28662890

28672891
#### comments
28682892

@@ -3121,7 +3145,7 @@ as multiple file uploads property.
31213145
readonly functions: object;
31223146
```
31233147

3124-
Defined in: [src/methods.ts:1991](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L1991)
3148+
Defined in: [src/methods.ts:2004](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2004)
31253149

31263150
#### completeError
31273151

@@ -3159,7 +3183,7 @@ Signal the successful completion of a Custom Function.
31593183
readonly migration: object;
31603184
```
31613185

3162-
Defined in: [src/methods.ts:2010](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2010)
3186+
Defined in: [src/methods.ts:2023](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2023)
31633187

31643188
#### exchange
31653189

@@ -3183,7 +3207,7 @@ For Enterprise Grid workspaces, map local user IDs to global user IDs.
31833207
readonly oauth: object;
31843208
```
31853209

3186-
Defined in: [src/methods.ts:2018](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2018)
3210+
Defined in: [src/methods.ts:2031](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2031)
31873211

31883212
#### ~~access~~
31893213

@@ -3245,7 +3269,7 @@ Exchanges a legacy access token for a new expiring access token and refresh toke
32453269
readonly openid: object;
32463270
```
32473271

3248-
Defined in: [src/methods.ts:2039](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2039)
3272+
Defined in: [src/methods.ts:2052](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2052)
32493273

32503274
#### connect
32513275

@@ -3289,7 +3313,7 @@ Get the identity of a user who has authorized [Sign in with Slack](https://docs.
32893313
readonly pins: object;
32903314
```
32913315

3292-
Defined in: [src/methods.ts:2057](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2057)
3316+
Defined in: [src/methods.ts:2070](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2070)
32933317

32943318
#### add
32953319

@@ -3341,7 +3365,7 @@ Un-pins an item from a channel.
33413365
readonly reactions: object;
33423366
```
33433367

3344-
Defined in: [src/methods.ts:2075](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2075)
3368+
Defined in: [src/methods.ts:2088](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2088)
33453369

33463370
#### add
33473371

@@ -3407,7 +3431,7 @@ Removes a reaction from an item.
34073431
readonly reminders: object;
34083432
```
34093433

3410-
Defined in: [src/methods.ts:2100](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2100)
3434+
Defined in: [src/methods.ts:2113](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2113)
34113435

34123436
#### add
34133437

@@ -3487,7 +3511,7 @@ Lists all reminders created by or for a given user.
34873511
readonly rtm: object;
34883512
```
34893513

3490-
Defined in: [src/methods.ts:2128](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2128)
3514+
Defined in: [src/methods.ts:2141](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2141)
34913515

34923516
#### connect
34933517

@@ -3529,7 +3553,7 @@ Use `rtm.connect` instead. See [our post on retiring \`rtm.start\`](https://docs
35293553
readonly search: object;
35303554
```
35313555

3532-
Defined in: [src/methods.ts:2142](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2142)
3556+
Defined in: [src/methods.ts:2155](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2155)
35333557

35343558
#### all
35353559

@@ -3581,7 +3605,7 @@ Searches for messages matching a query.
35813605
readonly stars: object;
35823606
```
35833607

3584-
Defined in: [src/methods.ts:2384](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2384)
3608+
Defined in: [src/methods.ts:2397](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2397)
35853609

35863610
#### ~~add~~
35873611

@@ -3648,7 +3672,7 @@ See [our post on stars and the Later list](https://docs.slack.dev/changelog/2023
36483672
readonly team: object;
36493673
```
36503674

3651-
Defined in: [src/methods.ts:2160](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2160)
3675+
Defined in: [src/methods.ts:2173](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2173)
36523676

36533677
#### accessLogs
36543678

@@ -3808,7 +3832,7 @@ Retrieve a team's profile.
38083832
readonly tooling: object;
38093833
```
38103834

3811-
Defined in: [src/methods.ts:2231](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2231)
3835+
Defined in: [src/methods.ts:2244](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2244)
38123836

38133837
#### tokens
38143838

@@ -3838,7 +3862,7 @@ Exchanges a refresh token for a new app configuration token.
38383862
readonly usergroups: object;
38393863
```
38403864

3841-
Defined in: [src/methods.ts:2241](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2241)
3865+
Defined in: [src/methods.ts:2254](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2254)
38423866

38433867
#### create
38443868

@@ -3952,7 +3976,7 @@ Update the list of users in a User Group.
39523976
readonly users: object;
39533977
```
39543978

3955-
Defined in: [src/methods.ts:2284](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2284)
3979+
Defined in: [src/methods.ts:2297](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2297)
39563980

39573981
#### conversations
39583982

@@ -4142,7 +4166,7 @@ Manually sets user presence.
41424166
readonly views: object;
41434167
```
41444168

4145-
Defined in: [src/methods.ts:2354](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2354)
4169+
Defined in: [src/methods.ts:2367](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2367)
41464170

41474171
#### open
41484172

@@ -4208,7 +4232,7 @@ Update an existing view.
42084232
readonly workflows: object;
42094233
```
42104234

4211-
Defined in: [src/methods.ts:2408](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2408)
4235+
Defined in: [src/methods.ts:2421](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L2421)
42124236

42134237
#### featured
42144238

@@ -4399,7 +4423,7 @@ EventEmitter.addListener
43994423
abstract apiCall(method, options?): Promise<WebAPICallResult>;
44004424
```
44014425
4402-
Defined in: [src/methods.ts:581](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L581)
4426+
Defined in: [src/methods.ts:583](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L583)
44034427
44044428
#### Parameters
44054429
@@ -4484,7 +4508,7 @@ EventEmitter.eventNames
44844508
abstract filesUploadV2(options): Promise<WebAPICallResult>;
44854509
```
44864510
4487-
Defined in: [src/methods.ts:582](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L582)
4511+
Defined in: [src/methods.ts:584](https://github.com/slackapi/node-slack-sdk/blob/main/packages/web-api/src/methods.ts#L584)
44884512
44894513
#### Parameters
44904514

0 commit comments

Comments
 (0)