eightball/PluralKit
1
0
Fork 0
mirror of https://github.com/PluralKit/PluralKit.git synced 2026-02-17 03:00:13 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix(docs): add dispatch event and updated model for autoproxy settings

Browse source
This commit is contained in:
ambdroid 2024-02-20 20:08:40 -05:00
parent 3cddd06efa
commit e8718196a8
2 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/content/api/dispatch.md
View file

@ -55,3 +55,4 @@ PluralKit will send invalid requests to your endpoint, with `PING` event type, o
|DELETE_SWITCH|a switch was deleted|null|old switch ID can be found in top-level `id` key| |DELETE_SWITCH|a switch was deleted|null|old switch ID can be found in top-level `id` key|
|DELETE_ALL_SWITCHES|your system's switches were bulk deleted|null| |DELETE_ALL_SWITCHES|your system's switches were bulk deleted|null|
|SUCCESSFUL_IMPORT|some information was successfully imported through the `pk;import` command to your system|null| |SUCCESSFUL_IMPORT|some information was successfully imported through the `pk;import` command to your system|null|
|UPDATE_AUTOPROXY|your system's autoproxy in a specific server and/or channel was updated|[autoproxy settings](/api/models#autoproxy-settings-model) with only modified keys|

2
docs/content/api/models.md
View file

@ -134,6 +134,8 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID.
### Autoproxy settings model ### Autoproxy settings model
|key|type|notes| |key|type|notes|
|---|---|---| |---|---|---|
|?guild_id|snowflake|only sent if the guild ID isn't already known (in dispatch payloads)|
|?channel_id|snowflake|only sent if the channel ID isn't already known (in dispatch payloads)|
|autoproxy_mode|[autoproxy mode](#autoproxy-mode-enum)|| |autoproxy_mode|[autoproxy mode](#autoproxy-mode-enum)||
|autoproxy_member|?member id|must be `null` if autoproxy_mode is set to `front`| |autoproxy_member|?member id|must be `null` if autoproxy_mode is set to `front`|
|last_latch_timestamp|?datetime|read-only| |last_latch_timestamp|?datetime|read-only|