Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document Guild Scheduled Event structure and HTTP methods #3586

Merged
merged 44 commits into from
Nov 15, 2021
Merged
Changes from 6 commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
4235bc5
Update Guild.md
apacheli Aug 4, 2021
b7b5295
move to Stage_Instance.md
apacheli Aug 5, 2021
d9f6daa
Update docs/resources/Stage_Instance.md
apacheli Aug 5, 2021
c5e4ad2
Update docs/resources/Stage_Instance.md
apacheli Aug 5, 2021
0574af0
fixes + metadata + more POST data
apacheli Aug 5, 2021
3251a74
privacy level
apacheli Aug 6, 2021
82690ab
Update docs/resources/Stage_Instance.md
apacheli Aug 6, 2021
27c37ac
move to Guild_Event.md
apacheli Aug 6, 2021
82a21fe
add guild-events endpoints
apacheli Aug 6, 2021
6a38003
tweaks
apacheli Aug 6, 2021
9d13bc0
entity type
apacheli Aug 6, 2021
a0ca171
event status enum
apacheli Aug 6, 2021
6c37b63
fix review problems
apacheli Aug 22, 2021
180085b
missed this one oops
apacheli Aug 22, 2021
57712e8
MANAGE_EVENTS permission
apacheli Aug 22, 2021
3c30ad7
audit log events
apacheli Aug 24, 2021
17b60f3
gateway websocket events
apacheli Aug 24, 2021
1b7587f
audit log change keys
apacheli Aug 24, 2021
6fcfe71
say inner payload
apacheli Aug 25, 2021
65c0f6b
fix these ones too
apacheli Aug 25, 2021
74cde21
array of snowflakes
apacheli Aug 26, 2021
1918011
Update docs/resources/Guild_Event.md
apacheli Aug 29, 2021
3172122
Update docs/resources/Guild_Event.md
apacheli Aug 29, 2021
931af0b
Update docs/resources/Guild_Event.md
apacheli Aug 29, 2021
de0a208
forgot to commit this one lol
apacheli Sep 1, 2021
ca59e28
GUILD_SCHEDULED_EVENT_USER_*
apacheli Sep 3, 2021
1836db8
Merge branch 'yes' of https://github.com/apacheli/discord-api-docs in…
apacheli Sep 3, 2021
02fd66d
extra notes
apacheli Sep 3, 2021
4c957f5
Update docs/topics/Permissions.md
apacheli Sep 17, 2021
c5d175c
rename to Guild Scheduled Event
apacheli Sep 17, 2021
d51d16a
BREAKING: rename to Guild Scheduled Event
apacheli Sep 17, 2021
c6fe790
new query for invites
apacheli Sep 17, 2021
2abad30
Merge branch 'master' into yes
apacheli Nov 2, 2021
bc9fcc7
creator and creator_id
apacheli Nov 2, 2021
b12c4b6
fix links action
apacheli Nov 2, 2021
9c69a52
missed an anchor
apacheli Nov 2, 2021
a1150ae
BREAKING: reflect new changes
apacheli Nov 14, 2021
5244c36
fix ci issues
apacheli Nov 14, 2021
d3fb801
fix endpoint hyperlinks
apacheli Nov 14, 2021
980a3e0
change entity type LOCATION to EXTERNAL
hemu Nov 14, 2021
645ade4
update guild scheduled event, audit log, invite, and gateway
hemu Nov 15, 2021
60566a5
cleanup Guild Scheduled Event
hemu Nov 15, 2021
c626b86
guild scheduled event cleanup, remove image field
hemu Nov 15, 2021
90e31bd
audit log cleanup, add channel types to permissions
hemu Nov 15, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions docs/resources/Stage_Instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,3 +102,56 @@ Requires the user to be a moderator of the Stage channel.

> info
> This endpoint supports the `X-Audit-Log-Reason` header.

### Guild Stage Event Object

###### Guild Stage Event Structure

| Field | Type | Description |
| --------------------- | ------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| id | snowflake | the id of the stage event |
| guild_id | snowflake | the id of the guild the stage event belongs to |
| channel_id | snowflake | the id of the stage channel the stage event belongs to |
| name | string | the name of the stage event |
| description? | string | the description of the stage event |
| image | ?string | the image of the stage event |
| scheduled_start_time | ISO8601 | the time the stage event will start |
| scheduled_end_time | ?ISO8601 | the time the stage event will end, or `null` if the stage event does not have a scheduled time to end |
| privacy_level | [privacy level](#DOCS_RESOURCES_STAGE_INSTANCE/stage-instance-object-privacy-level) | stage event privacy level |
| status | integer | the status of the stage event |
| entity_type | integer | the entity type of the stage event |
| entity_id | ?snowflake | entity id |
| entity_metadata | [stage entity metadata](#DOCS_RESOURCES_STAGE_INSTANCE/guild-event-object-guild-event-entity-metadata) | metadata for the stage event |
| sku_ids | array of snowflakes | sku ids |
| skus | array | skus |
apacheli marked this conversation as resolved.
Show resolved Hide resolved

###### Guild Event Entity Metadata

| Field | Type | Description |
| ----------- | ------------------- | --------------------------------- |
| speaker_ids | array of snowflakes | the speakers of the stage channel |

## List Guild Stage Events % GET /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/events

Returns a list of [stage events]((#DOCS_RESOURCES_STAGE_INSTANCE/guild-stage-event-object) in the guild.

###### Query String Params

| Field | Type | Description |
| ---------------- | ------- | ---------------------------------------------------- |
| with_user_count? | boolean | the number of users that are interested in the event |

## Create Guild Stage Event % POST /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/events

Create a stage event in the guild.

###### JSON Params

| Field | Type | Description |
| -------------------- | ----------------------------------------------------------------------------------- | ---------------------------------------- |
| channel_id? | snowflake | the stage channel id for the stage event |
| name | string | the name of the stage event |
| privacy_level | [privacy level](#DOCS_RESOURCES_STAGE_INSTANCE/stage-instance-object-privacy-level) | the privacy level of the stage event |
| scheduled_start_time | ISO8601 | the time to schedule the stage event |
| description? | string | the description of the stage event |
| entity_type? | integer | stage event entity type |