diff --git a/docs/resources/Audit_Log.md b/docs/resources/Audit_Log.md index 1c2f27b8d3..e70a84d8ab 100644 --- a/docs/resources/Audit_Log.md +++ b/docs/resources/Audit_Log.md @@ -48,52 +48,55 @@ Whenever an admin action is performed on the API, an entry is added to the respe ###### Audit Log Events -| Event | Value | -| ------------------------ | ----- | -| GUILD_UPDATE | 1 | -| CHANNEL_CREATE | 10 | -| CHANNEL_UPDATE | 11 | -| CHANNEL_DELETE | 12 | -| CHANNEL_OVERWRITE_CREATE | 13 | -| CHANNEL_OVERWRITE_UPDATE | 14 | -| CHANNEL_OVERWRITE_DELETE | 15 | -| MEMBER_KICK | 20 | -| MEMBER_PRUNE | 21 | -| MEMBER_BAN_ADD | 22 | -| MEMBER_BAN_REMOVE | 23 | -| MEMBER_UPDATE | 24 | -| MEMBER_ROLE_UPDATE | 25 | -| MEMBER_MOVE | 26 | -| MEMBER_DISCONNECT | 27 | -| BOT_ADD | 28 | -| ROLE_CREATE | 30 | -| ROLE_UPDATE | 31 | -| ROLE_DELETE | 32 | -| INVITE_CREATE | 40 | -| INVITE_UPDATE | 41 | -| INVITE_DELETE | 42 | -| WEBHOOK_CREATE | 50 | -| WEBHOOK_UPDATE | 51 | -| WEBHOOK_DELETE | 52 | -| EMOJI_CREATE | 60 | -| EMOJI_UPDATE | 61 | -| EMOJI_DELETE | 62 | -| MESSAGE_DELETE | 72 | -| MESSAGE_BULK_DELETE | 73 | -| MESSAGE_PIN | 74 | -| MESSAGE_UNPIN | 75 | -| INTEGRATION_CREATE | 80 | -| INTEGRATION_UPDATE | 81 | -| INTEGRATION_DELETE | 82 | -| STAGE_INSTANCE_CREATE | 83 | -| STAGE_INSTANCE_UPDATE | 84 | -| STAGE_INSTANCE_DELETE | 85 | -| STICKER_CREATE | 90 | -| STICKER_UPDATE | 91 | -| STICKER_DELETE | 92 | -| THREAD_CREATE | 110 | -| THREAD_UPDATE | 111 | -| THREAD_DELETE | 112 | +| Event | Value | +| ---------------------------- | ----- | +| GUILD_UPDATE | 1 | +| CHANNEL_CREATE | 10 | +| CHANNEL_UPDATE | 11 | +| CHANNEL_DELETE | 12 | +| CHANNEL_OVERWRITE_CREATE | 13 | +| CHANNEL_OVERWRITE_UPDATE | 14 | +| CHANNEL_OVERWRITE_DELETE | 15 | +| MEMBER_KICK | 20 | +| MEMBER_PRUNE | 21 | +| MEMBER_BAN_ADD | 22 | +| MEMBER_BAN_REMOVE | 23 | +| MEMBER_UPDATE | 24 | +| MEMBER_ROLE_UPDATE | 25 | +| MEMBER_MOVE | 26 | +| MEMBER_DISCONNECT | 27 | +| BOT_ADD | 28 | +| ROLE_CREATE | 30 | +| ROLE_UPDATE | 31 | +| ROLE_DELETE | 32 | +| INVITE_CREATE | 40 | +| INVITE_UPDATE | 41 | +| INVITE_DELETE | 42 | +| WEBHOOK_CREATE | 50 | +| WEBHOOK_UPDATE | 51 | +| WEBHOOK_DELETE | 52 | +| EMOJI_CREATE | 60 | +| EMOJI_UPDATE | 61 | +| EMOJI_DELETE | 62 | +| MESSAGE_DELETE | 72 | +| MESSAGE_BULK_DELETE | 73 | +| MESSAGE_PIN | 74 | +| MESSAGE_UNPIN | 75 | +| INTEGRATION_CREATE | 80 | +| INTEGRATION_UPDATE | 81 | +| INTEGRATION_DELETE | 82 | +| STAGE_INSTANCE_CREATE | 83 | +| STAGE_INSTANCE_UPDATE | 84 | +| STAGE_INSTANCE_DELETE | 85 | +| STICKER_CREATE | 90 | +| STICKER_UPDATE | 91 | +| STICKER_DELETE | 92 | +| GUILD_SCHEDULED_EVENT_CREATE | 100 | +| GUILD_SCHEDULED_EVENT_UPDATE | 101 | +| GUILD_SCHEDULED_EVENT_DELETE | 102 | +| THREAD_CREATE | 110 | +| THREAD_UPDATE | 111 | +| THREAD_DELETE | 112 | ###### Optional Audit Entry Info @@ -135,16 +138,17 @@ Whenever an admin action is performed on the API, an entry is added to the respe | avatar_hash | [user](#DOCS_RESOURCES_USER/user-object) | string | user avatar changed | | banner_hash | [guild](#DOCS_RESOURCES_GUILD/guild-object) | string | guild banner changed | | bitrate | [channel](#DOCS_RESOURCES_CHANNEL/channel-object) | integer | voice channel bitrate changed | -| channel_id | [invite](#DOCS_RESOURCES_INVITE/invite-object) | snowflake | channel for invite code changed | +| channel_id | [invite](#DOCS_RESOURCES_INVITE/invite-object) or [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) | snowflake | channel for invite code or guild scheduled event changed | | code | [invite](#DOCS_RESOURCES_INVITE/invite-object) | string | invite code changed | | color | [role](#DOCS_TOPICS_PERMISSIONS/role-object) | integer | role color changed | | deaf | [user](#DOCS_RESOURCES_USER/user-object) | boolean | user server deafened/undeafened | | default_auto_archive_duration | [channel](#DOCS_RESOURCES_CHANNEL/channel-object) | integer | default auto archive duration for newly created threads changed | | default_message_notifications | [guild](#DOCS_RESOURCES_GUILD/guild-object) | integer | default [message notification level](#DOCS_RESOURCES_GUILD/guild-object-default-message-notification-level) changed | | deny | [role](#DOCS_TOPICS_PERMISSIONS/role-object) | string | a permission on a text or voice channel was denied for a role | -| description | [guild](#DOCS_RESOURCES_GUILD/guild-object) or [sticker](#DOCS_RESOURCES_STICKER/sticker-object) | string | description changed | +| description | [guild](#DOCS_RESOURCES_GUILD/guild-object) or [sticker](#DOCS_RESOURCES_STICKER/sticker-object) or [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) | string | description changed | | discovery_splash_hash | [guild](#DOCS_RESOURCES_GUILD/guild-object) | string | discovery splash changed | | enable_emoticons | [integration](#DOCS_RESOURCES_GUILD/integration-object) | boolean | integration emoticons enabled/disabled | +| entity_type | [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) | integer | entity type of guild scheduled event was changed | | expire_behavior | [integration](#DOCS_RESOURCES_GUILD/integration-object) | integer | integration expiring subscriber behavior changed | | expire_grace_period | [integration](#DOCS_RESOURCES_GUILD/integration-object) | integer | integration expire grace period changed | | explicit_content_filter | [guild](#DOCS_RESOURCES_GUILD/guild-object) | integer | change in [whose messages](#DOCS_RESOURCES_GUILD/guild-object-explicit-content-filter-level) are scanned and deleted for explicit content in the server | @@ -154,6 +158,7 @@ Whenever an admin action is performed on the API, an entry is added to the respe | icon_hash | [guild](#DOCS_RESOURCES_GUILD/guild-object) or [role](#DOCS_TOPICS_PERMISSIONS/role-object) | string | icon changed | | id | any | snowflake | the id of the changed entity - sometimes used in conjunction with other keys | | inviter_id | [invite](#DOCS_RESOURCES_INVITE/invite-metadata-object) | snowflake | person who created invite code changed | +| location | [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-entity-metadata) | string | change in channel id for guild scheduled event | | locked | [thread](#DOCS_RESOURCES_CHANNEL/thread-metadata-object) | bool | thread is now locked/unlocked | | max_age | [invite](#DOCS_RESOURCES_INVITE/invite-metadata-object) | integer | how long invite code lasts changed | | max_uses | [invite](#DOCS_RESOURCES_INVITE/invite-metadata-object) | integer | change to max number of times invite code can be used | @@ -168,13 +173,14 @@ Whenever an admin action is performed on the API, an entry is added to the respe | permissions | [role](#DOCS_TOPICS_PERMISSIONS/role-object) | string | [permissions](#DOCS_TOPICS_PERMISSIONS/permissions-bitwise-permission-flags) for a role changed | | position | [channel](#DOCS_RESOURCES_CHANNEL/channel-object) | integer | text or voice channel position changed | | preferred_locale | [guild](#DOCS_RESOURCES_GUILD/guild-object) | string | preferred locale changed | -| privacy_level | [stage instance](#DOCS_RESOURCES_STAGE_INSTANCE/stage-instance-object) | integer ([privacy level](#DOCS_RESOURCES_STAGE_INSTANCE/stage-instance-object-privacy-level)) | privacy level of the stage instance changed | +| privacy_level | [stage instance](#DOCS_RESOURCES_STAGE_INSTANCE/stage-instance-object) or [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) | integer ([privacy level](#DOCS_RESOURCES_STAGE_INSTANCE/stage-instance-object-privacy-level)) | privacy level of the stage instance changed | | prune_delete_days | [guild](#DOCS_RESOURCES_GUILD/guild-object) | integer | change in number of days after which inactive and role-unassigned members are kicked | | public_updates_channel_id | [guild](#DOCS_RESOURCES_GUILD/guild-object) | snowflake | id of the public updates channel changed | | rate_limit_per_user | [channel](#DOCS_RESOURCES_CHANNEL/channel-object) | integer | amount of seconds a user has to wait before sending another message changed | | region | [guild](#DOCS_RESOURCES_GUILD/guild-object) | string | region changed | | rules_channel_id | [guild](#DOCS_RESOURCES_GUILD/guild-object) | snowflake | id of the rules channel changed | | splash_hash | [guild](#DOCS_RESOURCES_GUILD/guild-object) | string | invite splash page artwork changed | +| status | [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) | integer [(status)](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-status) | status of guild scheduled event was changed | | system_channel_id | [guild](#DOCS_RESOURCES_GUILD/guild-object) | snowflake | id of the system channel changed | | tags | [sticker](#DOCS_RESOURCES_STICKER/sticker-object) | string | related emoji of sticker changed | | temporary | [invite](#DOCS_RESOURCES_INVITE/invite-metadata-object) | boolean | invite code is temporary/never expires | diff --git a/docs/resources/Guild_Scheduled_Event.md b/docs/resources/Guild_Scheduled_Event.md new file mode 100644 index 0000000000..ef31003aec --- /dev/null +++ b/docs/resources/Guild_Scheduled_Event.md @@ -0,0 +1,136 @@ +# Guild Scheduled Event + +A representation of a scheduled event in a [guild](#DOCS_RESOURCES_GUILD/). + +### Guild Scheduled Event Object + +###### Guild Scheduled Event Structure + +| Field | Type | Description | +| -------------------- | ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------- | +| id | snowflake | the id of the scheduled event | +| guild_id | snowflake | the guild id which the scheduled event belongs to | +| channel_id | ?snowflake | the channel id in which the scheduled event will be hosted, or `null` if [scheduled entity type](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-entity-types) is `EXTERNAL` | +| creator_id? | snowflake | the id of the user that created the scheduled event | +| name | string | the name of the scheduled event | +| description? | string | the description of the scheduled event | +| scheduled_start_time | ISO8601 timestamp | the time the scheduled event will start | +| scheduled_end_time | ?ISO8601 timestamp | the time the scheduled event will end, or `null` if the event does not have a scheduled time to end | +| privacy_level | [privacy level](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-privacy-level) | the privacy level of the scheduled event | +| status | [event status](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-status) | the status of the scheduled event | +| entity_type | [scheduled entity type](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-entity-types) | the type of hosting entity associated with a scheduled event, e.g. voice channel or stage channel | +| entity_id | ?snowflake | any additional id of the hosting entity associated with event, e.g. [stage instance id](#DOCS_RESOURCES_STAGE_INSTANCE/stage-instance-object)) | +| entity_metadata | ?[entity metadata](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-entity-metadata) | the entity metadata for the scheduled event | +| creator? | [user](#DOCS_RESOURCES_USER/user-object) object | the user that created the scheduled event | +| user_count? | integer | the number of users subscribed to the scheduled event | + +###### Guild Scheduled Event Privacy Level + +| Level | Value | Description | +| ---------- | ----- | -------------------------------------------------------- | +| PUBLIC | 1 | the scheduled event is public and available in discovery | +| GUILD_ONLY | 2 | the scheduled event is only accessible to guild members | + +###### Guild Scheduled Event Entity Types + +| Type | Value | +| -------------- | ----- | +| NONE | 0 | +| STAGE_INSTANCE | 1 | +| VOICE | 2 | +| EXTERNAL | 3 | + +###### Guild Scheduled Event Status + +| Type | Value | +| --------- | ----- | +| SCHEDULED | 1 | +| ACTIVE | 2 | +| COMPLETED | 3 | +| CANCELED | 4 | + +###### Guild Scheduled Event Entity Metadata + +| Field | Type | Description | +| ------------ | ------------------- | --------------------------------- | +| speaker_ids? | array of snowflakes | the speakers of the stage channel | +| location? | string | location of the event | + +## List Scheduled Events for Guild % GET /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/scheduled-events + +Returns a list of [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) objects for the given guild. + +###### Query String Params + +| Field | Type | Description | +| ---------------- | ------- | ------------------------------------------------ | +| with_user_count? | boolean | include number of users subscribed to each event | + +## Create Guild Scheduled Event % POST /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/scheduled-events + +Create a guild scheduled event in the guild. Returns a [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) object on success. + +> info +> A guild can have a maximum of 100 events with `SCHEDULED` or `ACTIVE` status at any time. + +###### JSON Params + +| Field | Type | Description | +| -------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| channel_id? | snowflake | the channel id of the scheduled event, if for a stage instance of voice channel | +| entity_metadata? | [entity metadata](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-entity-metadata) | the entity metadata of the scheduled event | +| name | string | the name of the scheduled event | +| privacy_level | [privacy level](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-privacy-level) | the privacy level of the scheduled event | +| scheduled_start_time | ISO8601 timestamp | the time to schedule the scheduled event | +| scheduled_end_time? | ISO8601 timestamp | the time when the scheduled event is scheduled to end | +| description? | string | the description of the scheduled event | +| entity_type | [entity type](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-entity-types) | the entity type of the scheduled event | + +## Get Guild Scheduled Event % GET /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/scheduled-events/{guild_scheduled_event.id#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object} + +Get a guild scheduled event. Returns a [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) object on success. + +## Modify Guild Scheduled Event % PATCH /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/scheduled-events/{guild_scheduled_event.id#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object} + +Modify a guild scheduled event. Returns the modified [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) object on success. + +> info +> All parameters to this endpoint are optional + +> info +> To start or end an event, use this endpoint to modify the event's [status](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-status) field. + +###### JSON Params + +| Field | Type | Description | +| -------------------- | --------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | +| channel_id | snowflake | the channel id of the scheduled event, required if [entity_type](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-entity-types) is `STAGE_INSTANCE` or `VOICE` +| entity_metadata | [entity metadata](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-entity-metadata) | the entity metadata of the scheduled event | +| name | string | the name of the scheduled event | +| privacy_level | [privacy level](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-privacy-level) | the privacy level of the scheduled event | +| scheduled_start_time | ISO8601 timestamp | the time to schedule the scheduled event | +| scheduled_end_time | ISO8601 timestamp | the time when the scheduled event is scheduled to end | +| description | string | the description of the scheduled event | +| entity_type | [event entity type](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-entity-types) | the entity type of the scheduled event | +| status | [event status](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-status) | the status of the scheduled event | + +## Delete Guild Scheduled Event % DELETE /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/scheduled-events/{guild_scheduled_event.id#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object} + +Delete a guild scheduled event. Returns a `204` on success. + +## Get Guild Scheduled Event Users % GET /guilds/{guild.id#DOCS_RESOURCES_GUILD/guild-object}/scheduled-events/{guild_scheduled_event.id#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object}/users + +Get a list of users RSVP'd to the guild scheduled event. Returns a list of [user](#DOCS_RESOURCES_USER/user-object) objects on success with an optional `guild_member` property for each user if `with_member` query parameter is passed in. + +###### Query String Params + +| Field | Type | Description | Default | +| ------------ | ------- | ------------------------------------------------------------------------------ | ------- | +| limit? | number | how many users to receive from the event | 100 | +| with_member? | boolean | include guild member data. attaches `guild_member` property to the user object | false | + +###### Response Structure + +| Field | Type | +| ------------- | ---------------------------------------------------------------------------------------------------------------- | +| users | array of [user](#DOCS_RESOURCES_USER/user-object) objects with an optional `guild_member` property for each user | diff --git a/docs/resources/Invite.md b/docs/resources/Invite.md index 6d6894656a..67dd9b2923 100644 --- a/docs/resources/Invite.md +++ b/docs/resources/Invite.md @@ -6,19 +6,20 @@ Represents a code that when used, adds a user to a guild or group DM channel. ###### Invite Structure -| Field | Type | Description | -|-----------------------------|-------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------| -| code | string | the invite code (unique ID) | -| guild? | partial [guild](#DOCS_RESOURCES_GUILD/guild-object) object | the guild this invite is for | -| channel | partial [channel](#DOCS_RESOURCES_CHANNEL/channel-object) object | the channel this invite is for | -| inviter? | [user](#DOCS_RESOURCES_USER/user-object) object | the user who created the invite | -| target_type? | integer | the [type of target](#DOCS_RESOURCES_INVITE/invite-object-invite-target-types) for this voice channel invite | -| target_user? | [user](#DOCS_RESOURCES_USER/user-object) object | the user whose stream to display for this voice channel stream invite | -| target_application? | partial [application](#DOCS_RESOURCES_APPLICATION/application-object) object | the embedded application to open for this voice channel embedded application invite | -| approximate_presence_count? | integer | approximate count of online members, returned from the `GET /invites/` endpoint when `with_counts` is `true` | -| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/` endpoint when `with_counts` is `true` | -| expires_at? | ?ISO8601 timestamp | the expiration date of this invite, returned from the `GET /invites/` endpoint when `with_expiration` is `true` | -| stage_instance? | [invite stage instance](#DOCS_RESOURCES_INVITE/invite-stage-instance-object) object | stage instance data if there is a [public Stage instance](#DOCS_RESOURCES_STAGE_INSTANCE) in the Stage channel this invite is for | +| Field | Type | Description | +| --------------------------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | +| code | string | the invite code (unique ID) | +| guild? | partial [guild](#DOCS_RESOURCES_GUILD/guild-object) object | the guild this invite is for | +| channel | partial [channel](#DOCS_RESOURCES_CHANNEL/channel-object) object | the channel this invite is for | +| inviter? | [user](#DOCS_RESOURCES_USER/user-object) object | the user who created the invite | +| target_type? | integer | the [type of target](#DOCS_RESOURCES_INVITE/invite-object-invite-target-types) for this voice channel invite | +| target_user? | [user](#DOCS_RESOURCES_USER/user-object) object | the user whose stream to display for this voice channel stream invite | +| target_application? | partial [application](#DOCS_RESOURCES_APPLICATION/application-object) object | the embedded application to open for this voice channel embedded application invite | +| approximate_presence_count? | integer | approximate count of online members, returned from the `GET /invites/` endpoint when `with_counts` is `true` | +| approximate_member_count? | integer | approximate count of total members, returned from the `GET /invites/` endpoint when `with_counts` is `true` | +| expires_at? | ?ISO8601 timestamp | the expiration date of this invite, returned from the `GET /invites/` endpoint when `with_expiration` is `true` | +| stage_instance? | [invite stage instance](#DOCS_RESOURCES_INVITE/invite-stage-instance-object) object | stage instance data if there is a [public Stage instance](#DOCS_RESOURCES_STAGE_INSTANCE) in the Stage channel this invite is for | +| guild_scheduled_event? | [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) object | guild scheduled event data, only included if `guild_scheduled_event_id` contains a valid guild scheduled event id | ###### Invite Target Types @@ -130,10 +131,11 @@ Returns an [invite](#DOCS_RESOURCES_INVITE/invite-object) object for the given c ###### Query String Params -| Field | Type | Description | -| ---------------- | ------- | ----------------------------------------------------------- | -| with_counts? | boolean | whether the invite should contain approximate member counts | -| with_expiration? | boolean | whether the invite should contain the expiration date | +| Field | Type | Description | +| ------------------------- | --------- | ----------------------------------------------------------- | +| with_counts? | boolean | whether the invite should contain approximate member counts | +| with_expiration? | boolean | whether the invite should contain the expiration date | +| guild_scheduled_event_id? | snowflake | the guild scheduled event to include with the invite | ## Delete Invite % DELETE /invites/{invite.code#DOCS_RESOURCES_INVITE/invite-object} diff --git a/docs/topics/Gateway.md b/docs/topics/Gateway.md index b5ee1a9d9c..73c948f2a2 100644 --- a/docs/topics/Gateway.md +++ b/docs/topics/Gateway.md @@ -302,10 +302,19 @@ DIRECT_MESSAGE_REACTIONS (1 << 13) DIRECT_MESSAGE_TYPING (1 << 14) - TYPING_START + +GUILD_SCHEDULED_EVENTS (1 << 16) + - GUILD_SCHEDULED_EVENT_CREATE + - GUILD_SCHEDULED_EVENT_UPDATE + - GUILD_SCHEDULED_EVENT_DELETE + - GUILD_SCHEDULED_EVENT_USER_ADD ** + - GUILD_SCHEDULED_EVENT_USER_REMOVE ** ``` \* [Thread Members Update](#DOCS_TOPICS_GATEWAY/thread-members-update) contains different data depending on which intents are used. +\*\* [Guild Scheduled Event User Add](#DOCS_TOPICS_GATEWAY/guild-scheduled-event-user-add) and [Guild Scheduled Event User Remove](#DOCS_TOPICS_GATEWAY/guild-scheduled-event-user-remove) are currently experimental and not officially supported. + ### Caveats Any [events not defined in an intent](#DOCS_TOPICS_GATEWAY/commands-and-events-gateway-events) are considered "passthrough" and will always be sent to you. @@ -504,6 +513,11 @@ Events are payloads sent over the socket to a client that correspond to events i | [Guild Role Create](#DOCS_TOPICS_GATEWAY/guild-role-create) | guild role was created | | [Guild Role Update](#DOCS_TOPICS_GATEWAY/guild-role-update) | guild role was updated | | [Guild Role Delete](#DOCS_TOPICS_GATEWAY/guild-role-delete) | guild role was deleted | +| [Guild Scheduled Event Create](#DOCS_TOPICS_GATEWAY/guild-scheduled-event-create) | guild scheduled event was created | +| [Guild Scheduled Event Update](#DOCS_TOPICS_GATEWAY/guild-scheduled-event-update) | guild scheduled event was updated | +| [Guild Scheduled Event Delete](#DOCS_TOPICS_GATEWAY/guild-scheduled-event-delete) | guild scheduled event was deleted | +| [Guild Scheduled Event User Add](#DOCS_TOPICS_GATEWAY/guild-scheduled-event-user-add) | user subscribed to a guild scheduled event | +| [Guild Scheduled Event User Remove](#DOCS_TOPICS_GATEWAY/guild-scheduled-event-user-remove) | user unsubscribed from a guild scheduled event | | [Integration Create](#DOCS_TOPICS_GATEWAY/integration-create) | guild integration was created | | [Integration Update](#DOCS_TOPICS_GATEWAY/integration-update) | guild integration was updated | | [Integration Delete](#DOCS_TOPICS_GATEWAY/integration-delete) | guild integration was deleted | @@ -519,9 +533,9 @@ Events are payloads sent over the socket to a client that correspond to events i | [Message Reaction Remove All](#DOCS_TOPICS_GATEWAY/message-reaction-remove-all) | all reactions were explicitly removed from a message | | [Message Reaction Remove Emoji](#DOCS_TOPICS_GATEWAY/message-reaction-remove-emoji) | all reactions for a given emoji were explicitly removed from a message | | [Presence Update](#DOCS_TOPICS_GATEWAY/presence-update) | user was updated | -| [Stage Instance Create](#DOCS_TOPICS_GATEWAY/stage-instance-create) | stage instance was created | -| [Stage Instance Delete](#DOCS_TOPICS_GATEWAY/stage-instance-delete) | stage instance was deleted or closed | -| [Stage Instance Update](#DOCS_TOPICS_GATEWAY/stage-instance-update) | stage instance was updated | +| [Stage Instance Create](#DOCS_TOPICS_GATEWAY/stage-instance-create) | stage instance was created | +| [Stage Instance Delete](#DOCS_TOPICS_GATEWAY/stage-instance-delete) | stage instance was deleted or closed | +| [Stage Instance Update](#DOCS_TOPICS_GATEWAY/stage-instance-update) | stage instance was updated | | [Typing Start](#DOCS_TOPICS_GATEWAY/typing-start) | user started typing in a channel | | [User Update](#DOCS_TOPICS_GATEWAY/user-update) | properties about the user changed | | [Voice State Update](#DOCS_TOPICS_GATEWAY/voice-state-update) | someone joined, left, or moved a voice channel | @@ -1054,6 +1068,48 @@ Sent when a guild role is deleted. | guild_id | snowflake | id of the guild | | role_id | snowflake | id of the role | +### Guild Scheduled Event Create + +Sent when a guild scheduled event is created. The inner payload is a [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) object. + +### Guild Scheduled Event Update + +Sent when a guild scheduled event is updated. The inner payload is a [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) object. + +### Guild Scheduled Event Delete + +Sent when a guild scheduled event is deleted. The inner payload is a [guild scheduled event](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object) object. See [Guild Scheduled Event Status](#DOCS_RESOURCES_GUILD_SCHEDULED_EVENT/guild-scheduled-event-object-guild-scheduled-event-status) to determine how the event was deleted. + +### Guild Scheduled Event User Add + +Sent when a user has subscribed to a guild scheduled event. + +> info +> NOTE: this event is currently experimental and not officially supported + +###### Guild Scheduled Event User Add Event Fields + +| Field | Type | Description | +| ------------------------ | --------- | ------------------------------- | +| guild_scheduled_event_id | snowflake | id of the guild scheduled event | +| user_id | snowflake | id of the user | +| guild_id | snowflake | id of the guild | + +### Guild Scheduled Event User Remove + +Sent when a user has unsubscribed from a guild scheduled event. + +> info +> NOTE: this event is currently experimental and not officially supported + +###### Guild Scheduled Event User Remove Event Fields + +| Field | Type | Description | +| ------------------------ | --------- | ------------------------------- | +| guild_scheduled_event_id | snowflake | id of the guild scheduled event | +| user_id | snowflake | id of the user | +| guild_id | snowflake | id of the guild | + ### Integrations #### Integration Create diff --git a/docs/topics/Permissions.md b/docs/topics/Permissions.md index b653155491..c06707ddfd 100644 --- a/docs/topics/Permissions.md +++ b/docs/topics/Permissions.md @@ -61,6 +61,7 @@ Below is a table of all current permissions, their integer values in hexadecimal | MANAGE_EMOJIS_AND_STICKERS \* | `0x0040000000` `(1 << 30)` | Allows management and editing of emojis and stickers | | | USE_APPLICATION_COMMANDS | `0x0080000000` `(1 << 31)` | Allows members to use application commands, including slash commands and context menu commands. | T | | REQUEST_TO_SPEAK | `0x0100000000` `(1 << 32)` | Allows for requesting to speak in stage channels. (_This permission is under active development and may be changed or removed._) | S | +| MANAGE_EVENTS | `0x0200000000` `(1 << 33)` | Allows for creating, editing, and deleting scheduled events | V, S | | MANAGE_THREADS \* | `0x0400000000` `(1 << 34)` | Allows for deleting and archiving threads, and viewing all private threads | T | | CREATE_PUBLIC_THREADS | `0x0800000000` `(1 << 35)` | Allows for creating threads | T | | CREATE_PRIVATE_THREADS | `0x1000000000` `(1 << 36)` | Allows for creating private threads | T |