feat(api): add autoproxy endpoints
This commit is contained in:
@@ -60,6 +60,40 @@ Takes a partial [system guild settings](/api/models#system-guild-settings-model)
|
||||
|
||||
Returns a [system guild settings](/api/models#system-guild-settings-model) object on success.
|
||||
|
||||
### Get System Autoproxy Settings
|
||||
|
||||
GET `/systems/@me/autoproxy`
|
||||
|
||||
Query String Parameters
|
||||
|name|type|
|
||||
|---|---|
|
||||
|guild_id?|snowflake|
|
||||
|channel_id?|snowflake|
|
||||
|
||||
Returns an [autoproxy settings](/api/models/#autoproxy-settings-model) object on success.
|
||||
|
||||
::: warning
|
||||
Currently, only autoproxy with `guild_id` is supported. The API will return an error message if you specify `channel_id`, or do not specify a `guild_id`.
|
||||
:::
|
||||
|
||||
### Update System Autoproxy Settings
|
||||
|
||||
PATCH `/systems/@me/autoproxy`
|
||||
|
||||
Query String Parameters
|
||||
|name|type|
|
||||
|---|---|
|
||||
|guild_id?|snowflake|
|
||||
|channel_id?|snowflake|
|
||||
|
||||
Takes a partial [autoproxy settings](/api/models/#autoproxy-settings-model) object.
|
||||
|
||||
Returns an [autoproxy settings](/api/models/#autoproxy-settings-model) object on success.
|
||||
|
||||
::: warning
|
||||
Currently, only autoproxy with `guild_id` is supported. The API will return an error message if you specify `channel_id`, or do not specify a `guild_id`.
|
||||
:::
|
||||
|
||||
---
|
||||
## Members
|
||||
|
||||
|
@@ -124,7 +124,14 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID.
|
||||
|tag|?string|79-character limit|
|
||||
|tag_enabled|boolean||
|
||||
|
||||
<!--
|
||||
|
||||
### Autoproxy settings model
|
||||
|key|type|notes|
|
||||
|---|---|---|
|
||||
|autoproxy_mode|[autoproxy mode](#autoproxy-mode-enum)||
|
||||
|autoproxy_member|?member id|must be `null` if autoproxy_mode is set to `front`|
|
||||
|last_latch_timestamp|?datetime|read-only|
|
||||
|
||||
#### Autoproxy mode enum
|
||||
|
||||
|key|description|
|
||||
@@ -133,7 +140,6 @@ Every PluralKit entity has two IDs: a short (5-character) ID and a longer UUID.
|
||||
|front|autoproxy is set to the first member in the current fronters list, or disabled if the current switch contains no members|
|
||||
|latch|autoproxy is set to the last member who sent a proxied message in the server|
|
||||
|member|autoproxy is set to a specific member (see `autoproxy_member` key)|
|
||||
-->
|
||||
|
||||
### Member guild settings model
|
||||
|
||||
|
Reference in New Issue
Block a user