Skip to content

Commit a1112e3

Browse files
docs: updates reference docs to match source (#2469)
1 parent 844cee7 commit a1112e3

Some content is hidden

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

43 files changed

+392
-2023
lines changed

docs/english/reference/types/interfaces/AppMentionEvent.md

Lines changed: 326 additions & 8 deletions
Large diffs are not rendered by default.

docs/english/reference/types/interfaces/AppRateLimitedEvent.md

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

33
# Interface: AppRateLimitedEvent
44

5-
Defined in: [events/app.ts:151](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L151)
5+
Defined in: [events/app.ts:206](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L206)
66

77
## Properties
88

@@ -12,7 +12,7 @@ Defined in: [events/app.ts:151](https://github.com/slackapi/node-slack-sdk/blob/
1212
api_app_id: string;
1313
```
1414

15-
Defined in: [events/app.ts:156](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L156)
15+
Defined in: [events/app.ts:211](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L211)
1616

1717
***
1818

@@ -22,7 +22,7 @@ Defined in: [events/app.ts:156](https://github.com/slackapi/node-slack-sdk/blob/
2222
minute_rate_limited: number;
2323
```
2424

25-
Defined in: [events/app.ts:155](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L155)
25+
Defined in: [events/app.ts:210](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L210)
2626

2727
***
2828

@@ -32,7 +32,7 @@ Defined in: [events/app.ts:155](https://github.com/slackapi/node-slack-sdk/blob/
3232
team_id: string;
3333
```
3434

35-
Defined in: [events/app.ts:154](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L154)
35+
Defined in: [events/app.ts:209](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L209)
3636

3737
***
3838

@@ -42,7 +42,7 @@ Defined in: [events/app.ts:154](https://github.com/slackapi/node-slack-sdk/blob/
4242
token: string;
4343
```
4444

45-
Defined in: [events/app.ts:153](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L153)
45+
Defined in: [events/app.ts:208](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L208)
4646

4747
***
4848

@@ -52,4 +52,4 @@ Defined in: [events/app.ts:153](https://github.com/slackapi/node-slack-sdk/blob/
5252
type: "app_rate_limited";
5353
```
5454

55-
Defined in: [events/app.ts:152](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L152)
55+
Defined in: [events/app.ts:207](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L207)

docs/english/reference/types/interfaces/AppUninstalledEvent.md

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

33
# Interface: AppUninstalledEvent
44

5-
Defined in: [events/app.ts:165](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L165)
5+
Defined in: [events/app.ts:220](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L220)
66

77
## Properties
88

@@ -12,4 +12,4 @@ Defined in: [events/app.ts:165](https://github.com/slackapi/node-slack-sdk/blob/
1212
type: "app_uninstalled";
1313
```
1414

15-
Defined in: [events/app.ts:166](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L166)
15+
Defined in: [events/app.ts:221](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/app.ts#L221)

docs/english/reference/types/interfaces/MemberJoinedChannelEvent.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,23 @@ Defined in: [events/member.ts:5](https://github.com/slackapi/node-slack-sdk/blob
2626

2727
***
2828

29+
### enterprise?
30+
31+
```ts
32+
optional enterprise: string;
33+
```
34+
35+
Defined in: [events/member.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L8)
36+
37+
***
38+
2939
### event\_ts
3040

3141
```ts
3242
event_ts: string;
3343
```
3444

35-
Defined in: [events/member.ts:8](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L8)
45+
Defined in: [events/member.ts:9](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L9)
3646

3747
***
3848

docs/english/reference/types/interfaces/MemberLeftChannelEvent.md

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

33
# Interface: MemberLeftChannelEvent
44

5-
Defined in: [events/member.ts:11](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L11)
5+
Defined in: [events/member.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L12)
66

77
## Properties
88

@@ -12,7 +12,7 @@ Defined in: [events/member.ts:11](https://github.com/slackapi/node-slack-sdk/blo
1212
channel: string;
1313
```
1414

15-
Defined in: [events/member.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L14)
15+
Defined in: [events/member.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L15)
1616

1717
***
1818

@@ -22,7 +22,7 @@ Defined in: [events/member.ts:14](https://github.com/slackapi/node-slack-sdk/blo
2222
channel_type: string;
2323
```
2424

25-
Defined in: [events/member.ts:15](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L15)
25+
Defined in: [events/member.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L16)
2626

2727
***
2828

@@ -32,7 +32,7 @@ Defined in: [events/member.ts:15](https://github.com/slackapi/node-slack-sdk/blo
3232
event_ts: string;
3333
```
3434

35-
Defined in: [events/member.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L17)
35+
Defined in: [events/member.ts:18](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L18)
3636

3737
***
3838

@@ -42,7 +42,7 @@ Defined in: [events/member.ts:17](https://github.com/slackapi/node-slack-sdk/blo
4242
team: string;
4343
```
4444

45-
Defined in: [events/member.ts:16](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L16)
45+
Defined in: [events/member.ts:17](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L17)
4646

4747
***
4848

@@ -52,7 +52,7 @@ Defined in: [events/member.ts:16](https://github.com/slackapi/node-slack-sdk/blo
5252
type: "member_left_channel";
5353
```
5454

55-
Defined in: [events/member.ts:12](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L12)
55+
Defined in: [events/member.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L13)
5656

5757
***
5858

@@ -62,4 +62,4 @@ Defined in: [events/member.ts:12](https://github.com/slackapi/node-slack-sdk/blo
6262
user: string;
6363
```
6464

65-
Defined in: [events/member.ts:13](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L13)
65+
Defined in: [events/member.ts:14](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/member.ts#L14)

docs/english/reference/types/interfaces/UserHuddleChangedEvent.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Defined in: [events/user.ts:85](https://github.com/slackapi/node-slack-sdk/blob/
1212
cache_ts: number;
1313
```
1414

15-
Defined in: [events/user.ts:163](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L163)
15+
Defined in: [events/user.ts:164](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L164)
1616

1717
***
1818

@@ -22,7 +22,7 @@ Defined in: [events/user.ts:163](https://github.com/slackapi/node-slack-sdk/blob
2222
event_ts: string;
2323
```
2424

25-
Defined in: [events/user.ts:164](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L164)
25+
Defined in: [events/user.ts:165](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L165)
2626

2727
***
2828

@@ -253,6 +253,12 @@ first_name: string;
253253
huddle_state: string;
254254
```
255255

256+
##### profile.huddle\_state\_call\_id?
257+
258+
```ts
259+
optional huddle_state_call_id: string;
260+
```
261+
256262
##### profile.huddle\_state\_expiration\_ts
257263

258264
```ts

docs/english/reference/types/interfaces/UserProfileChangedEvent.md

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

33
# Interface: UserProfileChangedEvent
44

5-
Defined in: [events/user.ts:167](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L167)
5+
Defined in: [events/user.ts:168](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L168)
66

77
## Properties
88

@@ -12,7 +12,7 @@ Defined in: [events/user.ts:167](https://github.com/slackapi/node-slack-sdk/blob
1212
cache_ts: number;
1313
```
1414

15-
Defined in: [events/user.ts:245](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L245)
15+
Defined in: [events/user.ts:246](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L246)
1616

1717
***
1818

@@ -22,7 +22,7 @@ Defined in: [events/user.ts:245](https://github.com/slackapi/node-slack-sdk/blob
2222
event_ts: string;
2323
```
2424

25-
Defined in: [events/user.ts:246](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L246)
25+
Defined in: [events/user.ts:247](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L247)
2626

2727
***
2828

@@ -32,7 +32,7 @@ Defined in: [events/user.ts:246](https://github.com/slackapi/node-slack-sdk/blob
3232
type: "user_profile_changed";
3333
```
3434

35-
Defined in: [events/user.ts:168](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L168)
35+
Defined in: [events/user.ts:169](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L169)
3636

3737
***
3838

@@ -42,7 +42,7 @@ Defined in: [events/user.ts:168](https://github.com/slackapi/node-slack-sdk/blob
4242
user: object;
4343
```
4444

45-
Defined in: [events/user.ts:169](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L169)
45+
Defined in: [events/user.ts:170](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L170)
4646

4747
#### color
4848

docs/english/reference/types/interfaces/UserStatusChangedEvent.md

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

33
# Interface: UserStatusChangedEvent
44

5-
Defined in: [events/user.ts:249](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L249)
5+
Defined in: [events/user.ts:250](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L250)
66

77
## Properties
88

@@ -12,7 +12,7 @@ Defined in: [events/user.ts:249](https://github.com/slackapi/node-slack-sdk/blob
1212
cache_ts: number;
1313
```
1414

15-
Defined in: [events/user.ts:325](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L325)
15+
Defined in: [events/user.ts:326](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L326)
1616

1717
***
1818

@@ -22,7 +22,7 @@ Defined in: [events/user.ts:325](https://github.com/slackapi/node-slack-sdk/blob
2222
event_ts: string;
2323
```
2424

25-
Defined in: [events/user.ts:326](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L326)
25+
Defined in: [events/user.ts:327](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L327)
2626

2727
***
2828

@@ -32,7 +32,7 @@ Defined in: [events/user.ts:326](https://github.com/slackapi/node-slack-sdk/blob
3232
type: "user_status_changed";
3333
```
3434

35-
Defined in: [events/user.ts:250](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L250)
35+
Defined in: [events/user.ts:251](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L251)
3636

3737
***
3838

@@ -42,7 +42,7 @@ Defined in: [events/user.ts:250](https://github.com/slackapi/node-slack-sdk/blob
4242
user: object;
4343
```
4444

45-
Defined in: [events/user.ts:251](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L251)
45+
Defined in: [events/user.ts:252](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/events/user.ts#L252)
4646

4747
#### color
4848

docs/english/reference/web-api/enumerations/CustomFieldType.md

Lines changed: 0 additions & 95 deletions
This file was deleted.

0 commit comments

Comments
 (0)