fluxerapp/fluxer
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

refactor progress

Browse Source
This commit is contained in:
Hampus Kraft
2026-02-17 12:22:36 +00:00
parent cb31608523
commit d5abd1a7e4
8257 changed files with 1190207 additions and 761040 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3095
fluxer_docs/resources/admin.mdx Normal file
View File

File diff suppressed because it is too large Load Diff

483
fluxer_docs/resources/auth.mdx Normal file
View File

@@ -0,0 +1,483 @@
---
title: 'Auth'
description: 'Auth object schemas from the Fluxer API.'
---
<a id="authenticatortype"></a>
## AuthenticatorType
The type of authenticator
| Value | Description |
|-------|-------------|
| `0` | Time-based one-time password authenticator |
| `1` | SMS-based authenticator |
| `2` | WebAuthn authenticator |
<a id="authloginresponse"></a>
## AuthLoginResponse
**Related endpoints**
- [`POST /auth/email-revert`](/api-reference/auth/revert-email-change)
- [`POST /auth/login`](/api-reference/auth/login-account)
- [`POST /auth/reset`](/api-reference/auth/reset-password)
Type: [AuthTokenWithUserIdResponse](#authtokenwithuseridresponse) \| [AuthMfaRequiredResponse](#authmfarequiredresponse)
<a id="authmfarequiredresponse"></a>
## AuthMfaRequiredResponse
| Field | Type | Description |
|-------|------|-------------|
| allowed_methods | string[] | List of allowed MFA methods |
| mfa | enum&lt;`true`&gt; | Indicates MFA is required to complete authentication |
| sms | boolean | Whether SMS MFA is available |
| sms_phone_hint? | ?string | Masked phone number hint for SMS MFA |
| ticket | string | MFA ticket to use when completing MFA verification |
| totp | boolean | Whether TOTP authenticator MFA is available |
| webauthn | boolean | Whether WebAuthn security key MFA is available |
<a id="authorizeiprequest"></a>
## AuthorizeIpRequest
**Related endpoints**
- [`POST /auth/authorize-ip`](/api-reference/auth/authorize-ip-address)
| Field | Type | Description |
|-------|------|-------------|
| token | string | The IP authorization token from email |
<a id="authregisterresponse"></a>
## AuthRegisterResponse
**Related endpoints**
- [`POST /auth/register`](/api-reference/auth/register-account)
Type: [AuthTokenWithUserIdResponse](#authtokenwithuseridresponse) \| [AuthMfaRequiredResponse](#authmfarequiredresponse)
<a id="authsessionclientinfo"></a>
## AuthSessionClientInfo
| Field | Type | Description |
|-------|------|-------------|
| browser? | ?string | The browser reported by the client |
| location? | ?[AuthSessionLocation](#authsessionlocation) | The geolocation data sent by the client |
| os? | ?string | The operating system reported by the client |
| platform? | ?string | The platform reported by the client |
<a id="authsessionlocation"></a>
## AuthSessionLocation
| Field | Type | Description |
|-------|------|-------------|
| city? | ?string | The city name reported by the client |
| country? | ?string | The country reported by the client |
| region? | ?string | The region reported by the client |
<a id="authsessionresponse"></a>
## AuthSessionResponse
| Field | Type | Description |
|-------|------|-------------|
| approx_last_used_at? | ?string (date-time) | Approximate timestamp of the last session activity |
| client_info? | ?[AuthSessionClientInfo](#authsessionclientinfo) | Client metadata recorded for this session |
| current | boolean | Whether this is the current session making the request |
| id_hash | [SnowflakeType](#snowflaketype) | The base64url-encoded session id hash |
<a id="authsessionsresponse"></a>
## AuthSessionsResponse
**Related endpoints**
- [`GET /auth/sessions`](/api-reference/auth/list-auth-sessions)
Type: [AuthSessionResponse](#authsessionresponse)[]
<a id="authtokenwithuseridresponse"></a>
## AuthTokenWithUserIdResponse
**Related endpoints**
- [`POST /auth/login/mfa/sms`](/api-reference/auth/login-with-sms-mfa)
- [`POST /auth/login/mfa/totp`](/api-reference/auth/login-with-totp)
- [`POST /auth/login/mfa/webauthn`](/api-reference/auth/login-with-webauthn-mfa)
- [`POST /auth/webauthn/authenticate`](/api-reference/auth/authenticate-with-webauthn)
| Field | Type | Description |
|-------|------|-------------|
| token | string | Authentication token for API requests |
| user_id | [SnowflakeType](#snowflaketype) | ID of the authenticated user |
<a id="emailrevertrequest"></a>
## EmailRevertRequest
**Related endpoints**
- [`POST /auth/email-revert`](/api-reference/auth/revert-email-change)
| Field | Type | Description |
|-------|------|-------------|
| password | [PasswordType](#passwordtype) | |
| token | string | Email revert token from email |
<a id="forgotpasswordrequest"></a>
## ForgotPasswordRequest
**Related endpoints**
- [`POST /auth/forgot`](/api-reference/auth/forgot-password)
| Field | Type | Description |
|-------|------|-------------|
| email | [EmailType](#emailtype) | |
<a id="handoffcompleterequest"></a>
## HandoffCompleteRequest
**Related endpoints**
- [`POST /auth/handoff/complete`](/api-reference/auth/complete-handoff)
| Field | Type | Description |
|-------|------|-------------|
| code | string | The handoff code from the initiating session |
| token | string | The authentication token to transfer |
| user_id | [SnowflakeType](#snowflaketype) | The user ID associated with the token |
<a id="handoffinitiateresponse"></a>
## HandoffInitiateResponse
**Related endpoints**
- [`POST /auth/handoff/initiate`](/api-reference/auth/initiate-handoff)
| Field | Type | Description |
|-------|------|-------------|
| code | string | Handoff code to share with the receiving device |
| expires_at | string (date-time) | ISO 8601 timestamp when the handoff code expires |
<a id="handoffstatusresponse"></a>
## HandoffStatusResponse
**Related endpoints**
- [`GET /auth/handoff/{code}/status`](/api-reference/auth/get-handoff-status)
| Field | Type | Description |
|-------|------|-------------|
| status | string | Current status of the handoff (pending, completed, expired) |
| token? | ?string | Authentication token if handoff is complete |
| user_id? | ?[SnowflakeType](#snowflaketype) | User ID if handoff is complete |
<a id="ipauthorizationpollresponse"></a>
## IpAuthorizationPollResponse
**Related endpoints**
- [`GET /auth/ip-authorization/poll`](/api-reference/auth/poll-ip-authorization)
| Field | Type | Description |
|-------|------|-------------|
| completed | boolean | Whether the IP authorization has been completed |
| token? | ?string | Authentication token if authorization is complete |
| user_id? | ?[SnowflakeType](#snowflaketype) | User ID if authorization is complete |
<a id="loginrequest"></a>
## LoginRequest
**Related endpoints**
- [`POST /auth/login`](/api-reference/auth/login-account)
| Field | Type | Description |
|-------|------|-------------|
| email | [EmailType](#emailtype) | |
| invite_code? | ?string | Guild invite code to join after login |
| password | [PasswordType](#passwordtype) | |
<a id="logoutauthsessionsrequest"></a>
## LogoutAuthSessionsRequest
**Related endpoints**
- [`POST /auth/sessions/logout`](/api-reference/auth/logout-all-sessions)
| Field | Type | Description |
|-------|------|-------------|
| password? | [PasswordType](#passwordtype) | |
| session_id_hashes | [SnowflakeType](#snowflaketype)[] | Array of session ID hashes to log out (max 100) |
<a id="mfabackupcoderesponse"></a>
## MfaBackupCodeResponse
| Field | Type | Description |
|-------|------|-------------|
| code | string | The backup code |
| consumed | boolean | Whether the code has been used |
<a id="mfasmsrequest"></a>
## MfaSmsRequest
**Related endpoints**
- [`POST /auth/login/mfa/sms`](/api-reference/auth/login-with-sms-mfa)
| Field | Type | Description |
|-------|------|-------------|
| code | string | The SMS verification code |
| ticket | string | The MFA ticket from the login response |
<a id="mfaticketrequest"></a>
## MfaTicketRequest
**Related endpoints**
- [`POST /auth/ip-authorization/resend`](/api-reference/auth/resend-ip-authorization)
- [`POST /auth/login/mfa/sms/send`](/api-reference/auth/send-sms-mfa-code)
- [`POST /auth/login/mfa/webauthn/authentication-options`](/api-reference/auth/get-webauthn-mfa-options)
| Field | Type | Description |
|-------|------|-------------|
| ticket | string | The MFA ticket from the login response |
<a id="mfatotprequest"></a>
## MfaTotpRequest
**Related endpoints**
- [`POST /auth/login/mfa/totp`](/api-reference/auth/login-with-totp)
| Field | Type | Description |
|-------|------|-------------|
| code | string | The TOTP code from the authenticator app |
| ticket | string | The MFA ticket from the login response |
<a id="registerrequest"></a>
## RegisterRequest
**Related endpoints**
- [`POST /auth/register`](/api-reference/auth/register-account)
| Field | Type | Description |
|-------|------|-------------|
| consent | boolean | Whether user consents to terms of service |
| date_of_birth | string | Date of birth in YYYY-MM-DD format |
| email? | [EmailType](#emailtype) | |
| global_name? | string | Display name shown to other users |
| invite_code? | ?string | Guild invite code to join after registration |
| password? | [PasswordType](#passwordtype) | |
| username? | [UsernameType](#usernametype) | |
<a id="resetpasswordrequest"></a>
## ResetPasswordRequest
**Related endpoints**
- [`POST /auth/reset`](/api-reference/auth/reset-password)
| Field | Type | Description |
|-------|------|-------------|
| password | [PasswordType](#passwordtype) | |
| token | string | Password reset token from email |
<a id="ssocompleterequest"></a>
## SsoCompleteRequest
**Related endpoints**
- [`POST /auth/sso/complete`](/api-reference/auth/complete-sso)
| Field | Type | Description |
|-------|------|-------------|
| code | string | Authorization code from the SSO provider |
| state | string | State parameter for CSRF protection |
<a id="ssocompleteresponse"></a>
## SsoCompleteResponse
**Related endpoints**
- [`POST /auth/sso/complete`](/api-reference/auth/complete-sso)
| Field | Type | Description |
|-------|------|-------------|
| redirect_to | string | URL to redirect the user to after completion |
| token | string | Authentication token for the session |
| user_id | [SnowflakeType](#snowflaketype) | ID of the authenticated user |
<a id="ssoconfigresponse"></a>
## SsoConfigResponse
| Field | Type | Description |
|-------|------|-------------|
| allowed_domains | string[] | |
| authorization_url | ?string | |
| auto_provision | boolean | |
| client_id | ?[SnowflakeType](#snowflaketype) | |
| client_secret_set | boolean | |
| display_name | ?string | |
| enabled | boolean | |
| issuer | ?string | |
| jwks_url | ?string | |
| redirect_uri | ?string | |
| scope | ?string | |
| token_url | ?string | |
| userinfo_url | ?string | |
<a id="ssostartrequest"></a>
## SsoStartRequest
**Related endpoints**
- [`POST /auth/sso/start`](/api-reference/auth/start-sso)
| Field | Type | Description |
|-------|------|-------------|
| redirect_to? | ?string | URL to redirect to after SSO completion |
<a id="ssostartresponse"></a>
## SsoStartResponse
**Related endpoints**
- [`POST /auth/sso/start`](/api-reference/auth/start-sso)
| Field | Type | Description |
|-------|------|-------------|
| authorization_url | string | URL to redirect user to for SSO authentication |
| redirect_uri | string | Redirect URI after SSO completion |
| state | string | State parameter for CSRF protection |
<a id="ssostatusresponse"></a>
## SsoStatusResponse
**Related endpoints**
- [`GET /auth/sso/status`](/api-reference/auth/get-sso-status)
| Field | Type | Description |
|-------|------|-------------|
| display_name | ?string | Display name of the SSO provider |
| enabled | boolean | Whether SSO is enabled for this instance |
| enforced | boolean | Whether SSO is required for all users |
| redirect_uri | string | OAuth redirect URI for SSO |
<a id="usernamesuggestionsrequest"></a>
## UsernameSuggestionsRequest
**Related endpoints**
- [`POST /auth/username-suggestions`](/api-reference/auth/get-username-suggestions)
| Field | Type | Description |
|-------|------|-------------|
| global_name | string | Display name to generate username suggestions from |
<a id="usernamesuggestionsresponse"></a>
## UsernameSuggestionsResponse
**Related endpoints**
- [`POST /auth/username-suggestions`](/api-reference/auth/get-username-suggestions)
| Field | Type | Description |
|-------|------|-------------|
| suggestions | string[] | List of suggested usernames |
<a id="verifyemailrequest"></a>
## VerifyEmailRequest
**Related endpoints**
- [`POST /auth/verify`](/api-reference/auth/verify-email)
| Field | Type | Description |
|-------|------|-------------|
| token | string | Email verification token from email |
<a id="webauthnauthenticaterequest"></a>
## WebAuthnAuthenticateRequest
**Related endpoints**
- [`POST /auth/webauthn/authenticate`](/api-reference/auth/authenticate-with-webauthn)
| Field | Type | Description |
|-------|------|-------------|
| challenge | string | The challenge string from authentication options |
| response | JSON value | WebAuthn authentication response |
<a id="webauthnauthenticationoptionsresponse"></a>
## WebAuthnAuthenticationOptionsResponse
**Related endpoints**
- [`POST /auth/login/mfa/webauthn/authentication-options`](/api-reference/auth/get-webauthn-mfa-options)
- [`POST /auth/webauthn/authentication-options`](/api-reference/auth/get-webauthn-authentication-options)
Type: JSON value
<a id="webauthncredentialresponse"></a>
## WebAuthnCredentialResponse
| Field | Type | Description |
|-------|------|-------------|
| created_at | string | When the credential was registered |
| id | [SnowflakeType](#snowflaketype) | The credential ID |
| last_used_at | ?string | When the credential was last used |
| name | string | User-assigned name for the credential |
<a id="webauthnmfarequest"></a>
## WebAuthnMfaRequest
**Related endpoints**
- [`POST /auth/login/mfa/webauthn`](/api-reference/auth/login-with-webauthn-mfa)
| Field | Type | Description |
|-------|------|-------------|
| challenge | string | The challenge string from authentication options |
| response | JSON value | WebAuthn authentication response |
| ticket | string | The MFA ticket from the login response |

44
fluxer_docs/resources/billing.mdx Normal file
View File

@@ -0,0 +1,44 @@
---
title: 'Billing'
description: 'Billing object schemas from the Fluxer API.'
---
<a id="createcheckoutsessionrequest"></a>
## CreateCheckoutSessionRequest
**Related endpoints**
- [`POST /stripe/checkout/gift`](/api-reference/billing/create-gift-checkout-session)
- [`POST /stripe/checkout/subscription`](/api-reference/billing/create-checkout-session)
| Field | Type | Description |
|-------|------|-------------|
| price_id | [SnowflakeType](#snowflaketype) | The Stripe price ID for the subscription plan |
<a id="urlresponse"></a>
## UrlResponse
**Related endpoints**
- [`POST /premium/customer-portal`](/api-reference/premium/create-customer-portal)
- [`POST /stripe/checkout/gift`](/api-reference/billing/create-gift-checkout-session)
- [`POST /stripe/checkout/subscription`](/api-reference/billing/create-checkout-session)
| Field | Type | Description |
|-------|------|-------------|
| url | string | The URL to redirect to |
<a id="webhookreceivedresponse"></a>
## WebhookReceivedResponse
**Related endpoints**
- [`POST /stripe/webhook`](/api-reference/billing/process-stripe-webhook)
| Field | Type | Description |
|-------|------|-------------|
| received | boolean | Whether the webhook was successfully received |

1108
fluxer_docs/resources/channels.mdx Normal file
View File

File diff suppressed because it is too large Load Diff

644
fluxer_docs/resources/common.mdx Normal file
View File

@@ -0,0 +1,644 @@
---
title: 'Common'
description: 'Common object schemas from the Fluxer API.'
---
<a id="base64imagetype"></a>
## Base64ImageType
Base64-encoded image data
Type: string (byte)
<a id="blueskyauthorizerequest"></a>
## BlueskyAuthorizeRequest
**Related endpoints**
- [`POST /users/@me/connections/bluesky/authorize`](/api-reference/connections/start-bluesky-oauth-flow)
| Field | Type | Description |
|-------|------|-------------|
| handle | string | The Bluesky handle to connect (e.g. alice.bsky.social) |
<a id="blueskyauthorizeresponse"></a>
## BlueskyAuthorizeResponse
**Related endpoints**
- [`POST /users/@me/connections/bluesky/authorize`](/api-reference/connections/start-bluesky-oauth-flow)
| Field | Type | Description |
|-------|------|-------------|
| authorize_url | string | The URL to redirect the user to for Bluesky authorisation |
<a id="connectionlistresponse"></a>
## ConnectionListResponse
**Related endpoints**
- [`GET /users/@me/connections`](/api-reference/connections/list-user-connections)
Type: [ConnectionResponse](#connectionresponse)[]
<a id="connectionresponse"></a>
## ConnectionResponse
**Related endpoints**
- [`POST /users/@me/connections/{type}/{connection_id}/verify`](/api-reference/connections/verify-connection)
- [`POST /users/@me/connections/verify`](/api-reference/connections/verify-and-create-connection)
| Field | Type | Description |
|-------|------|-------------|
| id | [SnowflakeType](#snowflaketype) | The unique identifier for this connection |
| name | string | The display name of the connection (handle or domain) |
| sort_order | integer (int32) | The display order of this connection |
| type | enum&lt;`bsky`, `domain`&gt; | The type of connection |
| verified | boolean | Whether the connection has been verified |
| visibility_flags | integer (int32) | Bitfield controlling who can see this connection |
<a id="connectionverificationresponse"></a>
## ConnectionVerificationResponse
**Related endpoints**
- [`POST /users/@me/connections`](/api-reference/connections/initiate-connection)
| Field | Type | Description |
|-------|------|-------------|
| id | [SnowflakeType](#snowflaketype) | The connection identifier (handle or domain) |
| initiation_token | string | Signed token the client sends back at verify time |
| instructions | string | Human-readable instructions for completing verification |
| token | string | The verification token to place in DNS or profile |
| type | enum&lt;`bsky`, `domain`&gt; | The type of connection being verified |
<a id="createconnectionrequest"></a>
## CreateConnectionRequest
**Related endpoints**
- [`POST /users/@me/connections`](/api-reference/connections/initiate-connection)
| Field | Type | Description |
|-------|------|-------------|
| identifier | [SnowflakeType](#snowflaketype) | The connection identifier (handle or domain) |
| type | enum&lt;`bsky`, `domain`&gt; | The type of connection to create |
| visibility_flags? | [Int32Type](#int32type) | |
<a id="discoveryapplicationpatchrequest"></a>
## DiscoveryApplicationPatchRequest
**Related endpoints**
- [`PATCH /guilds/{guild_id}/discovery`](/api-reference/discovery/edit-discovery-application)
| Field | Type | Description |
|-------|------|-------------|
| category_id? | integer (int32) | Updated discovery category ID |
| description? | string | Updated description for discovery listing |
<a id="discoveryapplicationrequest"></a>
## DiscoveryApplicationRequest
**Related endpoints**
- [`POST /guilds/{guild_id}/discovery`](/api-reference/discovery/apply-for-guild-discovery)
| Field | Type | Description |
|-------|------|-------------|
| category_id | integer (int32) | Discovery category ID |
| description | string | Description for discovery listing |
<a id="discoverycategorylistresponse"></a>
## DiscoveryCategoryListResponse
**Related endpoints**
- [`GET /discovery/categories`](/api-reference/discovery/list-discovery-categories)
Type: [DiscoveryCategoryResponse](#discoverycategoryresponse)[]
<a id="discoverycategoryresponse"></a>
## DiscoveryCategoryResponse
| Field | Type | Description |
|-------|------|-------------|
| id | number | Category ID |
| name | string | Category display name |
<a id="discoveryguildlistresponse"></a>
## DiscoveryGuildListResponse
**Related endpoints**
- [`GET /discovery/guilds`](/api-reference/discovery/search-discoverable-guilds)
| Field | Type | Description |
|-------|------|-------------|
| guilds | [DiscoveryGuildResponse](#discoveryguildresponse)[] | Discovery guild results |
| total | number | Total number of matching guilds |
<a id="discoveryguildresponse"></a>
## DiscoveryGuildResponse
| Field | Type | Description |
|-------|------|-------------|
| category_id | number | Discovery category ID |
| description? | ?string | Discovery description |
| features | string[] | Guild feature flags |
| icon? | ?string | Guild icon hash |
| id | [SnowflakeType](#snowflaketype) | Guild ID |
| member_count | number | Approximate member count |
| name | string | Guild name |
| online_count | number | Approximate online member count |
| verification_level | number | Verification level |
<a id="donationcheckoutrequest"></a>
## DonationCheckoutRequest
**Related endpoints**
- [`POST /donations/checkout`](/api-reference/donations/create-donation-checkout-session)
| Field | Type | Description |
|-------|------|-------------|
| amount_cents | integer (int32) | Donation amount in cents (500-100000) |
| currency | [DonationCheckoutRequestCurrency](#donationcheckoutrequestcurrency) | Currency for the donation |
| email | string (email) | Donor email address |
| interval | ?[DonationCheckoutRequestInterval](#donationcheckoutrequestinterval) | Billing interval (null for one-time donation) |
<a id="donationcheckoutresponse"></a>
## DonationCheckoutResponse
**Related endpoints**
- [`POST /donations/checkout`](/api-reference/donations/create-donation-checkout-session)
| Field | Type | Description |
|-------|------|-------------|
| url | string (uri) | Stripe checkout URL to redirect the user to |
<a id="donationrequestlinkrequest"></a>
## DonationRequestLinkRequest
**Related endpoints**
- [`POST /donations/request-link`](/api-reference/donations/request-donation-management-link)
| Field | Type | Description |
|-------|------|-------------|
| email | string (email) | Email address to send the magic link to |
<a id="emailtype"></a>
## EmailType
Type: string (email)
<a id="int64stringtype"></a>
## Int64StringType
Type: string (int64)
<a id="int64type"></a>
## Int64Type
Type: string (int64)
<a id="ipbanlistentryschema"></a>
## IpBanListEntrySchema
| Field | Type | Description |
|-------|------|-------------|
| ip | string | Banned IPv4/IPv6 address or CIDR range |
| reverse_dns | ?string | Reverse DNS hostname for the IP, if available |
<a id="passwordtype"></a>
## PasswordType
Type: string
<a id="phonenumbertype"></a>
## PhoneNumberType
Type: string
<a id="renderspoilers"></a>
## RenderSpoilers
Spoiler rendering preference
| Value | Description |
|-------|-------------|
| `0` | Always reveal spoiler content |
| `1` | Reveal spoiler content on click |
| `2` | Reveal spoiler content if moderator |
<a id="reorderconnectionsrequest"></a>
## ReorderConnectionsRequest
**Related endpoints**
- [`PATCH /users/@me/connections/reorder`](/api-reference/connections/reorder-connections)
| Field | Type | Description |
|-------|------|-------------|
| connection_ids | [SnowflakeType](#snowflaketype)[] | Ordered list of connection IDs defining the new display order |
<a id="tenorcategorytagresponse"></a>
## TenorCategoryTagResponse
| Field | Type | Description |
|-------|------|-------------|
| name | string | The category search term |
| proxy_src | string | Proxied URL to the category preview image |
| src | string | URL to the category preview image |
<a id="tenorfeaturedresponse"></a>
## TenorFeaturedResponse
**Related endpoints**
- [`GET /tenor/featured`](/api-reference/tenor/get-featured-tenor-gifs)
| Field | Type | Description |
|-------|------|-------------|
| categories | [TenorCategoryTagResponse](#tenorcategorytagresponse)[] | Array of GIF categories |
| gifs | [TenorGifResponse](#tenorgifresponse)[] | Array of featured GIFs |
<a id="tenorgifresponse"></a>
## TenorGifResponse
**Related endpoints**
- [`GET /tenor/search`](/api-reference/tenor/search-tenor-gifs)
- [`GET /tenor/trending-gifs`](/api-reference/tenor/get-trending-tenor-gifs)
| Field | Type | Description |
|-------|------|-------------|
| height | integer (int32) | Height of the GIF in pixels |
| id | [SnowflakeType](#snowflaketype) | The unique Tenor result id |
| proxy_src | string | Proxied URL to the GIF media file |
| src | string | Direct URL to the GIF media file |
| title | string | The title/description of the GIF |
| url | string | The Tenor page URL for the GIF |
| width | integer (int32) | Width of the GIF in pixels |
<a id="tenorregistersharerequest"></a>
## TenorRegisterShareRequest
**Related endpoints**
- [`POST /tenor/register-share`](/api-reference/tenor/register-tenor-gif-share)
| Field | Type | Description |
|-------|------|-------------|
| id | [SnowflakeType](#snowflaketype) | The Tenor result id |
| locale? | [Locale](#locale) | |
| q? | ?string | The search query used to find the GIF |
<a id="timeformattypes"></a>
## TimeFormatTypes
Time format preference
| Value | Description |
|-------|-------------|
| `0` | Automatically detect time format based on locale |
| `1` | Use 12-hour time format (AM/PM) |
| `2` | Use 24-hour time format |
<a id="unsignedint64type"></a>
## UnsignedInt64Type
Type: string (int64)
<a id="updateconnectionrequest"></a>
## UpdateConnectionRequest
**Related endpoints**
- [`PATCH /users/@me/connections/{type}/{connection_id}`](/api-reference/connections/update-connection)
| Field | Type | Description |
|-------|------|-------------|
| sort_order? | [Int32Type](#int32type) | |
| visibility_flags? | [Int32Type](#int32type) | |
<a id="validationerrorcodeschema"></a>
## ValidationErrorCodeSchema
Error codes for field validation issues
| Value | Description |
|-------|-------------|
| `ACCENT_COLOR_CHANGED_TOO_MANY_TIMES` | Accent colour has been changed too many times recently |
| `ACCOUNT_ALREADY_VERIFIED` | Account is already verified |
| `AFK_CHANNEL_MUST_BE_IN_GUILD` | AFK channel must be in the same guild |
| `AFK_CHANNEL_MUST_BE_VOICE` | AFK channel must be a voice channel |
| `ALL_CHANNELS_MUST_BELONG_TO_GUILD` | All channels must belong to the same guild |
| `ANIMATED_AVATARS_REQUIRE_PREMIUM` | Animated avatars require premium |
| `ANIMATED_GUILD_BANNER_REQUIRES_FEATURE` | Animated guild banners require the feature to be enabled |
| `AT_LEAST_ONE_ENTRY_IS_REQUIRED` | At least one entry is required |
| `AT_LEAST_ONE_RECIPIENT_REQUIRED` | At least one recipient is required |
| `ATTACHMENT_FIELDS_REQUIRED` | Attachment fields are required |
| `ATTACHMENT_ID_NOT_FOUND_IN_MESSAGE` | Attachment ID was not found in the message |
| `ATTACHMENT_IDS_MUST_BE_VALID_INTEGERS` | Attachment IDs must be valid integers |
| `ATTACHMENT_METADATA_WITHOUT_FILES` | Attachment metadata provided without files |
| `ATTACHMENT_MUST_BE_IMAGE` | Attachment must be an image |
| `ATTACHMENTS_METADATA_REQUIRED_WHEN_UPLOADING` | Attachments metadata is required when uploading files |
| `ATTACHMENTS_NOT_ALLOWED_FOR_MESSAGE` | Attachments are not allowed for this message type |
| `AVATAR_CHANGED_TOO_MANY_TIMES` | Avatar has been changed too many times recently |
| `BANNER_CHANGED_TOO_MANY_TIMES` | Banner has been changed too many times recently |
| `BANNERS_REQUIRE_PREMIUM` | Banners require premium |
| `BASE64_LENGTH_INVALID` | Invalid base64 length |
| `BIO_CHANGED_TOO_MANY_TIMES` | Bio has been changed too many times recently |
| `BUCKET_IS_REQUIRED` | Bucket is required |
| `CANNOT_ADD_YOURSELF_TO_GROUP_DM` | Cannot add yourself to a group DM |
| `CANNOT_DELETE_MORE_THAN_100_MESSAGES` | Cannot delete more than 100 messages at once |
| `CANNOT_DM_YOURSELF` | Cannot send a direct message to yourself |
| `CANNOT_EDIT_ATTACHMENT_METADATA` | Users with MANAGE_MESSAGES can only edit attachment descriptions, not other metadata |
| `CANNOT_LEAVE_GUILD_AS_OWNER` | Cannot leave guild as the owner |
| `CANNOT_POSITION_CHANNEL_RELATIVE_TO_ITSELF` | Cannot position channel relative to itself |
| `CANNOT_PRELOAD_MORE_THAN_100_CHANNELS` | Cannot preload more than 100 channels |
| `CANNOT_REFERENCE_ATTACHMENTS_WITHOUT_ATTACHMENTS` | Cannot reference attachments without providing attachments |
| `CANNOT_REORDER_EVERYONE_ROLE` | Cannot reorder the everyone role |
| `CANNOT_REPLY_TO_SYSTEM_MESSAGE` | Cannot reply to a system message |
| `CANNOT_SET_HOIST_FOR_EVERYONE_ROLE` | Cannot set hoist for the everyone role |
| `CANNOT_SPECIFY_BOTH_BEFORE_AND_AFTER` | Cannot specify both before and after parameters |
| `CANNOT_USE_SAME_ROLE_AS_PRECEDING` | Cannot use the same role as preceding |
| `CATEGORIES_CANNOT_HAVE_PARENT_CHANNEL` | Categories cannot have a parent channel |
| `CATEGORIES_CANNOT_HAVE_PARENTS` | Categories cannot have parents |
| `CHANGING_DISCRIMINATOR_REQUIRES_PREMIUM` | Changing discriminator requires premium |
| `CHANNEL_DOES_NOT_EXIST` | Channel does not exist |
| `CHANNEL_ID_IS_REQUIRED` | Channel ID is required |
| `CHANNEL_MUST_BE_DM_OR_GROUP_DM` | Channel must be a DM or group DM |
| `CHANNEL_MUST_BE_VOICE` | Channel must be a voice channel |
| `CHANNEL_NAME_EMPTY_AFTER_NORMALIZATION` | Channel name is empty after normalisation |
| `CHANNEL_NOT_FOUND` | Channel was not found |
| `COLOR_VALUE_TOO_HIGH` | Colour value is too high |
| `COLOR_VALUE_TOO_LOW` | Colour value is too low |
| `CONTENT_EXCEEDS_MAX_LENGTH` | Content exceeds maximum length |
| `CONTEXT_CHANNEL_OR_GUILD_ID_REQUIRED` | Context channel or guild ID is required |
| `CUSTOM_EMOJI_NOT_FOUND` | Custom emoji was not found |
| `CUSTOM_EMOJIS_REQUIRE_PREMIUM_OUTSIDE_SOURCE` | Custom emojis require premium when used outside their source |
| `CUSTOM_STICKER_NOT_FOUND` | Custom sticker was not found |
| `CUSTOM_STICKERS_IN_DMS_REQUIRE_PREMIUM` | Custom stickers in DMs require premium |
| `CUSTOM_STICKERS_REQUIRE_PREMIUM_OUTSIDE_SOURCE` | Custom stickers require premium when used outside their source |
| `DISCRIMINATOR_INVALID_FORMAT` | Discriminator has an invalid format |
| `DISCRIMINATOR_OUT_OF_RANGE` | Discriminator is out of valid range |
| `DUPLICATE_ATTACHMENT_IDS_NOT_ALLOWED` | Duplicate attachment IDs are not allowed |
| `DUPLICATE_FILE_INDEX` | Duplicate file index |
| `DUPLICATE_RECIPIENTS_NOT_ALLOWED` | Duplicate recipients are not allowed |
| `VOICE_MESSAGES_ATTACHMENT_MUST_BE_AUDIO` | Voice message attachment must be audio |
| `VOICE_MESSAGES_ATTACHMENT_WAVEFORM_REQUIRED` | Voice message attachment waveform is required |
| `VOICE_MESSAGES_ATTACHMENT_DURATION_REQUIRED` | Voice message attachment duration is required |
| `VOICE_MESSAGES_CANNOT_HAVE_CONTENT` | Voice messages cannot have content |
| `VOICE_MESSAGES_CANNOT_HAVE_EMBEDS` | Voice messages cannot have embeds |
| `VOICE_MESSAGES_CANNOT_HAVE_FAVORITE_MEMES` | Voice messages cannot have favourite memes |
| `VOICE_MESSAGES_CANNOT_HAVE_STICKERS` | Voice messages cannot have stickers |
| `VOICE_MESSAGES_DURATION_EXCEEDS_LIMIT` | Voice message duration exceeds limit |
| `VOICE_MESSAGES_REQUIRE_SINGLE_ATTACHMENT` | Voice messages require a single attachment |
| `EMAIL_ALREADY_IN_USE` | Email address is already in use |
| `EMAIL_IS_REQUIRED` | Email address is required |
| `EMAIL_LENGTH_INVALID` | Email address length is invalid |
| `EMAIL_MUST_BE_CHANGED_VIA_TOKEN` | Email must be changed via verification token |
| `EMAIL_TOKEN_EXPIRED` | Email verification token has expired |
| `EMBED_INDEX_OUT_OF_BOUNDS` | Embed index is out of bounds |
| `EMBED_SPLASH_REQUIRES_FEATURE` | Embed splash requires the feature to be enabled |
| `EMBEDS_EXCEED_MAX_CHARACTERS` | Embeds exceed maximum character count |
| `EMOJI_REQUIRES_GUILD_OR_PACK_ACCESS` | Emoji requires guild or pack access |
| `FAILED_TO_PARSE_MULTIPART_FORM_DATA` | Failed to parse multipart form data |
| `FAILED_TO_PARSE_MULTIPART_PAYLOAD` | Failed to parse multipart payload |
| `FAILED_TO_UPLOAD_IMAGE` | Failed to upload image |
| `FAVORITE_MEME_NAME_REQUIRED` | Favourite meme name is required |
| `FAVORITE_MEME_NOT_FOUND` | Favourite meme was not found |
| `FILE_INDEX_EXCEEDS_MAXIMUM` | File index exceeds maximum |
| `FILE_NOT_FOUND_FOR_SCANNING` | File not found for scanning |
| `FILE_NOT_FOUND` | File was not found |
| `FILENAME_EMPTY_AFTER_NORMALIZATION` | Filename is empty after normalisation |
| `FILENAME_INVALID_CHARACTERS` | Filename contains invalid characters |
| `FILENAME_LENGTH_INVALID` | Filename length is invalid |
| `FILENAME_MISMATCH_FOR_ATTACHMENT` | Filename mismatch for attachment |
| `FORWARD_MESSAGES_CANNOT_CONTAIN_CONTENT` | Forward messages cannot contain content |
| `FORWARD_REFERENCE_REQUIRES_CHANNEL_AND_MESSAGE` | Forward reference requires channel and message |
| `GLOBAL_NAME_CANNOT_CONTAIN_RESERVED_TERMS` | Display name cannot contain reserved terms |
| `GLOBAL_NAME_LENGTH_INVALID` | Display name length is invalid |
| `GLOBAL_NAME_RESERVED_VALUE` | Display name is a reserved value |
| `GUILD_BANNER_REQUIRES_FEATURE` | Guild banner requires the feature to be enabled |
| `GUILD_ID_MUST_MATCH_REFERENCED_MESSAGE` | Guild ID must match referenced message |
| `IMAGE_SIZE_EXCEEDS_LIMIT` | Image size exceeds limit |
| `INTEGER_OUT_OF_INT64_RANGE` | Integer is out of 64-bit range |
| `SNOWFLAKE_OUT_OF_RANGE` | Snowflake is out of valid range |
| `INVALID_AUDIT_LOG_REASON` | Invalid audit log reason |
| `INVALID_BASE64_FORMAT` | Invalid base64 format |
| `INVALID_CHANNEL_ID` | Invalid channel ID |
| `INVALID_CHANNEL` | Invalid channel |
| `INVALID_CODE` | Invalid code |
| `INVALID_CURRENT_PASSWORD` | Invalid current password |
| `INVALID_DATE_OF_BIRTH_FORMAT` | Invalid date of birth format |
| `INVALID_DATETIME_FOR_SCHEDULED_SEND` | Invalid datetime for scheduled send |
| `INVALID_EMAIL_ADDRESS` | Invalid email address |
| `INVALID_EMAIL_FORMAT` | Invalid email format |
| `INVALID_EMAIL_LOCAL_PART` | Invalid email local part |
| `INVALID_EMAIL_OR_PASSWORD` | Invalid email or password |
| `INVALID_EMAIL_TOKEN` | Invalid email verification token |
| `INVALID_FILE_FIELD_NAME` | Invalid file field name |
| `INVALID_FORMAT` | Invalid format |
| `INVALID_IMAGE_DATA` | Invalid image data |
| `INVALID_IMAGE_FORMAT` | Invalid image format |
| `INVALID_INTEGER_FORMAT` | Invalid integer format |
| `INVALID_SNOWFLAKE_FORMAT` | Invalid snowflake format |
| `INVALID_ISO_TIMESTAMP` | Invalid ISO timestamp |
| `INVALID_JOB_ID` | Invalid job ID |
| `INVALID_JSON_IN_PAYLOAD_JSON` | Invalid JSON in payload_json field |
| `INVALID_MESSAGE_DATA` | Invalid message data |
| `INVALID_MFA_CODE` | Invalid MFA code |
| `INVALID_OR_EXPIRED_AUTHORIZATION_TICKET` | Invalid or expired authorisation ticket |
| `INVALID_OR_EXPIRED_AUTHORIZATION_TOKEN` | Invalid or expired authorisation token |
| `INVALID_OR_EXPIRED_RESET_TOKEN` | Invalid or expired password reset token |
| `INVALID_OR_EXPIRED_REVERT_TOKEN` | Invalid or expired revert token |
| `INVALID_OR_EXPIRED_TICKET` | Invalid or expired ticket |
| `INVALID_OR_EXPIRED_VERIFICATION_TOKEN` | Invalid or expired verification token |
| `INVALID_OR_RESTRICTED_RTC_REGION` | Invalid or restricted RTC region |
| `INVALID_PARENT_CHANNEL` | Invalid parent channel |
| `INVALID_PASSWORD` | Invalid password |
| `INVALID_PROOF_TOKEN` | Invalid proof token |
| `INVALID_ROLE_ID` | Invalid role ID |
| `INVALID_RTC_REGION` | Invalid RTC region |
| `INVALID_SCHEDULED_MESSAGE_PAYLOAD` | Invalid scheduled message payload |
| `INVALID_SNOWFLAKE` | Invalid snowflake |
| `INVALID_TIMEOUT_VALUE` | Invalid timeout value |
| `INVALID_TIMEZONE_IDENTIFIER` | Invalid timezone identifier |
| `INVALID_URL_FORMAT` | Invalid URL format |
| `INVALID_URL_OR_ATTACHMENT_FORMAT` | Invalid URL or attachment format |
| `INVALID_VERIFICATION_CODE` | Invalid verification code |
| `INVITE_SPLASH_REQUIRES_FEATURE` | Invite splash requires the feature to be enabled |
| `JOB_ID_IS_REQUIRED` | Job ID is required |
| `JOB_IS_ALREADY_PROCESSED` | Job has already been processed |
| `JOB_NOT_FOUND` | Job was not found |
| `MEDIA_ALREADY_IN_FAVORITE_MEMES` | Media is already in favourite memes |
| `MESSAGE_HISTORY_CUTOFF_BEFORE_GUILD_CREATION` | Message history cutoff cannot be before the guild was created |
| `MESSAGE_HISTORY_CUTOFF_IN_FUTURE` | Message history cutoff cannot be in the future |
| `MESSAGE_IDS_CANNOT_BE_EMPTY` | Message IDs cannot be empty |
| `MESSAGES_ARRAY_REQUIRED_AND_NOT_EMPTY` | Messages array is required and cannot be empty |
| `MESSAGES_WITH_SNAPSHOTS_CANNOT_BE_EDITED` | Messages with snapshots cannot be edited |
| `MESSAGE_TOTAL_ATTACHMENT_SIZE_TOO_LARGE` | Total attachment size exceeds the maximum allowed |
| `MULTIPLE_FILES_FOR_INDEX_NOT_ALLOWED` | Multiple files for the same index are not allowed |
| `MUST_AGREE_TO_TOS_AND_PRIVACY_POLICY` | Must agree to terms of service and privacy policy |
| `MUST_BE_MINIMUM_AGE` | Must be minimum age to use this service |
| `MUST_ENABLE_2FA_BEFORE_REQUIRING_FOR_MODS` | Must enable 2FA before requiring it for moderators |
| `MUST_HAVE_EMAIL_TO_CHANGE_IT` | Must have an email to change it |
| `MUST_START_SESSION_BEFORE_SENDING` | Must start session before sending |
| `NAME_EMPTY_AFTER_NORMALIZATION` | Name is empty after normalisation |
| `NEW_EMAIL_MUST_BE_DIFFERENT` | New email must be different from current email |
| `NO_FILE_FOR_ATTACHMENT_METADATA` | No file provided for attachment metadata |
| `NO_FILE_FOR_ATTACHMENT` | No file provided for attachment |
| `NO_METADATA_FOR_FILE` | No metadata provided for file |
| `NO_NEW_EMAIL_REQUESTED` | No new email has been requested |
| `NO_ORIGINAL_EMAIL_ON_RECORD` | No original email on record |
| `NO_VALID_MEDIA_IN_MESSAGE` | No valid media in message |
| `NOT_A_VALID_UNICODE_EMOJI` | Not a valid Unicode emoji |
| `ORIGINAL_EMAIL_ALREADY_VERIFIED` | Original email is already verified |
| `ORIGINAL_EMAIL_MUST_BE_VERIFIED_FIRST` | Original email must be verified first |
| `ORIGINAL_VERIFICATION_NOT_REQUIRED` | Original verification is not required |
| `PARENT_CHANNEL_NOT_IN_GUILD` | Parent channel is not in the guild |
| `PARENT_MUST_BE_CATEGORY` | Parent channel must be a category |
| `PARSE_AND_USERS_OR_ROLES_CANNOT_BE_USED_TOGETHER` | Parse and users/roles cannot be used together |
| `PASSWORD_IS_TOO_COMMON` | Password is too common |
| `PASSWORD_LENGTH_INVALID` | Password length is invalid |
| `PASSWORD_NOT_SET` | Password is not set |
| `PAYLOAD_JSON_REQUIRED_FOR_MULTIPART` | payload_json is required for multipart requests |
| `PHONE_NUMBER_INVALID_FORMAT` | Phone number has an invalid format |
| `PRECEDING_CHANNEL_MUST_SHARE_PARENT` | Preceding channel must share the same parent |
| `PRECEDING_CHANNEL_NOT_IN_GUILD` | Preceding channel is not in the guild |
| `PRECEDING_ROLE_NOT_IN_GUILD` | Preceding role is not in the guild |
| `PREMIUM_REQUIRED_FOR_CUSTOM_EMOJI` | Premium is required for custom emoji |
| `PRONOUNS_CHANGED_TOO_MANY_TIMES` | Pronouns have been changed too many times recently |
| `RECIPIENT_IDS_CANNOT_BE_EMPTY` | Recipient IDs cannot be empty |
| `RECIPIENT_IDS_MUST_BE_STRINGS` | Recipient IDs must be strings |
| `RECIPIENT_IDS_MUST_BE_VALID_SNOWFLAKES` | Recipient IDs must be valid snowflakes |
| `REFERENCED_ATTACHMENT_NOT_FOUND` | Referenced attachment was not found |
| `ROWS_IS_REQUIRED` | Rows field is required |
| `SCHEDULED_MESSAGES_MAX_30_DAYS` | Scheduled messages must be within 30 days |
| `SCHEDULED_TIME_MUST_BE_FUTURE` | Scheduled time must be in the future |
| `SESSION_TIMEOUT` | Session has timed out |
| `SIZE_BYTES_MUST_BE_VALID_INTEGER` | Size in bytes must be a valid integer |
| `STRING_LENGTH_EXACT` | String must be exactly the required length |
| `STRING_LENGTH_INVALID` | String length is invalid |
| `SYSTEM_CHANNEL_MUST_BE_IN_GUILD` | System channel must be in the guild |
| `SYSTEM_CHANNEL_MUST_BE_TEXT` | System channel must be a text channel |
| `TAG_ALREADY_TAKEN` | Tag is already taken |
| `THIS_VANITY_URL_IS_ALREADY_TAKEN` | This vanity URL is already taken |
| `TICKET_ALREADY_COMPLETED` | Ticket has already been completed |
| `TIMEOUT_CANNOT_EXCEED_365_DAYS` | Timeout cannot exceed 365 days |
| `TOO_MANY_EMBEDS` | Too many embeds |
| `TOO_MANY_FILES` | Too many files |
| `TOO_MANY_USERS_WITH_THIS_USERNAME` | Too many users with this username |
| `TOO_MANY_USERS_WITH_USERNAME_TRY_DIFFERENT` | Too many users with this username, try a different one |
| `UNCLAIMED_ACCOUNTS_CAN_ONLY_SET_EMAIL_VIA_TOKEN` | Unclaimed accounts can only set email via verification token |
| `UNKNOWN_IMAGE_FORMAT` | Unknown image format |
| `UNRESOLVED_ATTACHMENT_URL` | Unresolved attachment URL |
| `UPLOADED_ATTACHMENT_NOT_FOUND` | Uploaded attachment was not found |
| `URL_LENGTH_INVALID` | URL length is invalid |
| `USER_DOES_NOT_HAVE_AN_EMAIL_ADDRESS` | User does not have an email address |
| `USER_IS_NOT_BANNED` | User is not banned |
| `USER_MUST_BE_A_BOT_TO_BE_MARKED_AS_A_SYSTEM_USER` | User must be a bot to be marked as a system user |
| `USER_NOT_IN_CHANNEL` | User is not in the channel |
| `USERNAME_CANNOT_CONTAIN_RESERVED_TERMS` | Username cannot contain reserved terms |
| `USERNAME_CHANGED_TOO_MANY_TIMES` | Username has been changed too many times recently |
| `USERNAME_INVALID_CHARACTERS` | Username contains invalid characters |
| `USERNAME_LENGTH_INVALID` | Username length is invalid |
| `USERNAME_RESERVED_VALUE` | Username is a reserved value |
| `VALUE_MUST_BE_INTEGER_IN_RANGE` | Value must be an integer in the valid range |
| `VALUE_TOO_SMALL` | Value is too small |
| `VANITY_URL_CODE_ALREADY_TAKEN` | Vanity URL code is already taken |
| `VANITY_URL_CODE_CANNOT_CONTAIN_FLUXER` | Vanity URL code cannot contain fluxer |
| `VANITY_URL_CODE_LENGTH_INVALID` | Vanity URL code length is invalid |
| `VANITY_URL_INVALID_CHARACTERS` | Vanity URL contains invalid characters |
| `VANITY_URL_REQUIRES_FEATURE` | Vanity URL requires the feature to be enabled |
| `VERIFICATION_CODE_EXPIRED` | Verification code has expired |
| `VERIFICATION_CODE_NOT_ISSUED` | Verification code was not issued |
| `VISIONARY_REQUIRED_FOR_BOT_DISCRIMINATOR` | Visionary subscription required for bot discriminator |
| `VISIONARY_REQUIRED_FOR_DISCRIMINATOR` | Visionary subscription required for discriminator |
| `BOT_DISCRIMINATOR_CANNOT_BE_CHANGED` | Bot discriminator cannot be changed |
| `VOICE_CHANNELS_CANNOT_BE_ABOVE_TEXT_CHANNELS` | Voice channels cannot be positioned above text channels |
| `WEBHOOK_NAME_LENGTH_INVALID` | Webhook name length is invalid |
<a id="validationerroritem"></a>
## ValidationErrorItem
| Field | Type | Description |
|-------|------|-------------|
| code? | [ValidationErrorCodeSchema](#validationerrorcodeschema) | |
| message | string | A human-readable description of the validation issue |
| path | string | The field path where the validation error occurred |
<a id="verifyandcreateconnectionrequest"></a>
## VerifyAndCreateConnectionRequest
**Related endpoints**
- [`POST /users/@me/connections/verify`](/api-reference/connections/verify-and-create-connection)
| Field | Type | Description |
|-------|------|-------------|
| initiation_token | string | The signed initiation token returned from the create endpoint |
| visibility_flags? | [Int32Type](#int32type) | |
<a id="donationcheckoutrequestcurrency"></a>
## DonationCheckoutRequestCurrency
Currency for the donation
| Value | Description |
|-------|-------------|
| `usd` | - |
| `eur` | - |
<a id="donationcheckoutrequestinterval"></a>
## DonationCheckoutRequestInterval
Billing interval (null for one-time donation)
| Value | Description |
|-------|-------------|
| `month` | - |
| `year` | - |

44
fluxer_docs/resources/gateway.mdx Normal file
View File

@@ -0,0 +1,44 @@
---
title: 'Gateway'
description: 'Gateway object schemas from the Fluxer API.'
---
<a id="customstatusresponse"></a>
## CustomStatusResponse
| Field | Type | Description |
|-------|------|-------------|
| emoji_animated | boolean | Whether the status emoji is animated |
| emoji_id? | ?[SnowflakeType](#snowflaketype) | The ID of the custom emoji used in the status |
| emoji_name? | ?string | The name of the emoji used in the status |
| expires_at? | ?string (date-time) | ISO8601 timestamp of when the custom status expires |
| text? | ?string | The custom status message text |
<a id="gatewaybotresponse"></a>
## GatewayBotResponse
**Related endpoints**
- [`GET /gateway/bot`](/api-reference/gateway/get-gateway-information)
| Field | Type | Description |
|-------|------|-------------|
| session_start_limit | [GatewayBotResponseSessionStartLimit](#gatewaybotresponsesessionstartlimit) | Session start rate limit information |
| shards | integer (int53) | Recommended number of shards to use when connecting |
| url | string | WebSocket URL to connect to the gateway |
<a id="gatewaybotresponsesessionstartlimit"></a>
## GatewayBotResponseSessionStartLimit
Session start rate limit information
| Field | Type | Description |
|-------|------|-------------|
| max_concurrency | integer (int53) | Maximum number of concurrent IDENTIFY requests |
| remaining | integer (int53) | Remaining number of session starts |
| reset_after | integer (int53) | Milliseconds until the limit resets |
| total | integer (int53) | Total number of session starts allowed |

20
fluxer_docs/resources/gifts.mdx Normal file
View File

@@ -0,0 +1,20 @@
---
title: 'Gifts'
description: 'Gifts object schemas from the Fluxer API.'
---
<a id="giftcoderesponse"></a>
## GiftCodeResponse
**Related endpoints**
- [`GET /gifts/{code}`](/api-reference/gifts/get-gift-code)
| Field | Type | Description |
|-------|------|-------------|
| code | string | The unique gift code string |
| created_by? | ?[UserPartialResponse](#userpartialresponse) | The user who created the gift code |
| duration_months | integer (int53) | Duration of the subscription gift in months |
| redeemed | boolean | Whether the gift code has been redeemed |

1264
fluxer_docs/resources/guilds.mdx Normal file
View File

File diff suppressed because it is too large Load Diff

157
fluxer_docs/resources/instance.mdx Normal file
View File

@@ -0,0 +1,157 @@
---
title: 'Instance'
description: 'Instance object schemas from the Fluxer API.'
---
<a id="wellknownfluxerresponse"></a>
## WellKnownFluxerResponse
**Related endpoints**
- [`GET /.well-known/fluxer`](/api-reference/instance/get-instance-discovery-document)
| Field | Type | Description |
|-------|------|-------------|
| api_code_version | integer (int53) | Version of the API server code |
| app_public | [WellKnownFluxerResponseAppPublic](#wellknownfluxerresponseapppublic) | Public application configuration for client-side features |
| captcha | [WellKnownFluxerResponseCaptcha](#wellknownfluxerresponsecaptcha) | Captcha configuration |
| endpoints | [WellKnownFluxerResponseEndpoints](#wellknownfluxerresponseendpoints) | Endpoint URLs for various services |
| features | [WellKnownFluxerResponseFeatures](#wellknownfluxerresponsefeatures) | Feature flags for this instance |
| federation? | [WellKnownFluxerResponseFederation](#wellknownfluxerresponsefederation) | Federation configuration |
| gif | [WellKnownFluxerResponseGif](#wellknownfluxerresponsegif) | GIF provider configuration for clients |
| limits | [WellKnownFluxerResponseLimits](#wellknownfluxerresponselimits) | Limit configuration with rules and trait definitions |
| oauth2? | [WellKnownFluxerResponseOauth2](#wellknownfluxerresponseoauth2) | OAuth2 endpoints for federation |
| public_key? | [WellKnownFluxerResponsePublicKey](#wellknownfluxerresponsepublickey) | Public key for E2E encryption |
| push | [WellKnownFluxerResponsePush](#wellknownfluxerresponsepush) | Push notification configuration |
| sso | [SsoStatusResponse](#ssostatusresponse) | Single sign-on configuration |
<a id="wellknownfluxerresponseapppublic"></a>
## WellKnownFluxerResponseAppPublic
Public application configuration for client-side features
| Field | Type | Description |
|-------|------|-------------|
| sentry_dsn | string | Sentry DSN for client-side error reporting |
| sentry_project_id | [SnowflakeType](#snowflaketype) | Sentry project ID |
| sentry_proxy_path | string | Proxy path for Sentry requests |
| sentry_public_key | string | Sentry public key |
| sentry_report_host | string | Host for Sentry error reports |
<a id="wellknownfluxerresponsecaptcha"></a>
## WellKnownFluxerResponseCaptcha
Captcha configuration
| Field | Type | Description |
|-------|------|-------------|
| hcaptcha_site_key | ?string | hCaptcha site key if using hCaptcha |
| provider | string | Captcha provider name (hcaptcha, turnstile, none) |
| turnstile_site_key | ?string | Cloudflare Turnstile site key if using Turnstile |
<a id="wellknownfluxerresponseendpoints"></a>
## WellKnownFluxerResponseEndpoints
Endpoint URLs for various services
| Field | Type | Description |
|-------|------|-------------|
| admin | string | Base URL for the admin panel |
| api | string | Base URL for authenticated API requests |
| api_client | string | Base URL for client API requests |
| api_public | string | Base URL for public API requests |
| gateway | string | WebSocket URL for the gateway |
| gift | string | Base URL for gift links |
| invite | string | Base URL for invite links |
| marketing | string | Base URL for the marketing website |
| media | string | Base URL for the media proxy |
| static_cdn | string | Base URL for static assets (avatars, emojis, etc.) |
| webapp | string | Base URL for the web application |
<a id="wellknownfluxerresponsefeatures"></a>
## WellKnownFluxerResponseFeatures
Feature flags for this instance
| Field | Type | Description |
|-------|------|-------------|
| manual_review_enabled | boolean | Whether manual review mode is enabled for registrations |
| self_hosted | boolean | Whether this is a self-hosted instance |
| sms_mfa_enabled | boolean | Whether SMS-based MFA is available |
| stripe_enabled | boolean | Whether Stripe payments are enabled |
| voice_enabled | boolean | Whether voice/video calling is enabled |
<a id="wellknownfluxerresponsefederation"></a>
## WellKnownFluxerResponseFederation
Federation configuration
| Field | Type | Description |
|-------|------|-------------|
| enabled | boolean | Whether federation is enabled on this instance |
| version | integer (int53) | Federation protocol version |
<a id="wellknownfluxerresponsegif"></a>
## WellKnownFluxerResponseGif
GIF provider configuration for clients
| Field | Type | Description |
|-------|------|-------------|
| provider | [WellKnownFluxerResponseGifProvider](#wellknownfluxerresponsegifprovider) | GIF provider used by the instance GIF picker |
<a id="wellknownfluxerresponselimits"></a>
## WellKnownFluxerResponseLimits
Limit configuration with rules and trait definitions
| Field | Type | Description |
|-------|------|-------------|
| defaultsHash | string | Hash of the default limit values for cache invalidation |
| rules | [LimitRuleResponse](#limitruleresponse)[] | Array of limit rules to evaluate |
| traitDefinitions | string[] | Available trait definitions (e.g., "premium") |
| version | enum&lt;`2`&gt; | Wire format version |
<a id="wellknownfluxerresponseoauth2"></a>
## WellKnownFluxerResponseOauth2
OAuth2 endpoints for federation
| Field | Type | Description |
|-------|------|-------------|
| authorization_endpoint | string | OAuth2 authorization endpoint URL |
| scopes_supported | string[] | Supported OAuth2 scopes |
| token_endpoint | string | OAuth2 token endpoint URL |
| userinfo_endpoint | string | OAuth2 userinfo endpoint URL |
<a id="wellknownfluxerresponsepublickey"></a>
## WellKnownFluxerResponsePublicKey
Public key for E2E encryption
| Field | Type | Description |
|-------|------|-------------|
| algorithm | enum&lt;`x25519`&gt; | Key algorithm |
| id | [SnowflakeType](#snowflaketype) | Key identifier |
| public_key_base64 | string | Base64-encoded public key |
<a id="wellknownfluxerresponsepush"></a>
## WellKnownFluxerResponsePush
Push notification configuration
| Field | Type | Description |
|-------|------|-------------|
| public_vapid_key | ?string | VAPID public key for web push notifications |

59
fluxer_docs/resources/invites.mdx Normal file
View File

@@ -0,0 +1,59 @@
---
title: 'Invites'
description: 'Invites object schemas from the Fluxer API.'
---
<a id="channelinvitecreaterequest"></a>
## ChannelInviteCreateRequest
**Related endpoints**
- [`POST /channels/{channel_id}/invites`](/api-reference/invites/create-channel-invite)
| Field | Type | Description |
|-------|------|-------------|
| max_age? | ?integer (int32) | Duration in seconds before the invite expires (0 for never) |
| max_uses? | ?integer (int32) | Maximum number of times this invite can be used (0 for unlimited) |
| temporary? | ?boolean | Whether members that joined via this invite should be kicked after disconnecting |
| unique? | ?boolean | Whether to create a new unique invite or reuse an existing one |
<a id="invitemetadataresponseschema"></a>
## InviteMetadataResponseSchema
**Related endpoints**
- [`GET /channels/{channel_id}/invites`](/api-reference/invites/list-channel-invites)
- [`GET /guilds/{guild_id}/invites`](/api-reference/invites/list-guild-invites)
- [`GET /packs/{pack_id}/invites`](/api-reference/invites/list-pack-invites)
- [`POST /channels/{channel_id}/invites`](/api-reference/invites/create-channel-invite)
- [`POST /packs/{pack_id}/invites`](/api-reference/invites/create-pack-invite)
Type: [GuildInviteMetadataResponse](#guildinvitemetadataresponse) \| [GroupDmInviteMetadataResponse](#groupdminvitemetadataresponse) \| [PackInviteMetadataResponse](#packinvitemetadataresponse)
<a id="inviteresponseschema"></a>
## InviteResponseSchema
**Related endpoints**
- [`GET /invites/{invite_code}`](/api-reference/invites/get-invite-information)
- [`POST /invites/{invite_code}`](/api-reference/invites/accept-invite)
Type: [GuildInviteResponse](#guildinviteresponse) \| [GroupDmInviteResponse](#groupdminviteresponse) \| [PackInviteResponse](#packinviteresponse)
<a id="packinvitecreaterequest"></a>
## PackInviteCreateRequest
**Related endpoints**
- [`POST /packs/{pack_id}/invites`](/api-reference/invites/create-pack-invite)
| Field | Type | Description |
|-------|------|-------------|
| max_age? | ?integer (int32) | Duration in seconds before the invite expires (0 for never) |
| max_uses? | ?integer (int32) | Maximum number of times this invite can be used (0 for unlimited) |
| unique? | ?boolean | Whether to create a new unique invite or reuse an existing one |

115
fluxer_docs/resources/klipy.mdx Normal file
View File

@@ -0,0 +1,115 @@
---
title: 'Klipy'
description: 'Klipy object schemas from the Fluxer API.'
---
<a id="klipycategorytagresponse"></a>
## KlipyCategoryTagResponse
| Field | Type | Description |
|-------|------|-------------|
| name | string | The category/tag name |
| proxy_src | string | Proxied URL to the category preview image |
| src | string | URL to the category preview image |
<a id="klipyfeaturedresponse"></a>
## KlipyFeaturedResponse
**Related endpoints**
- [`GET /klipy/featured`](/api-reference/klipy/get-featured-klipy-gifs)
| Field | Type | Description |
|-------|------|-------------|
| categories | [KlipyCategoryTagResponse](#klipycategorytagresponse)[] | Array of clip categories |
| gifs | [KlipyGifResponse](#klipygifresponse)[] | Array of featured/trending clips |
<a id="klipygifresponse"></a>
## KlipyGifResponse
**Related endpoints**
- [`GET /klipy/search`](/api-reference/klipy/search-klipy-gifs)
- [`GET /klipy/trending-gifs`](/api-reference/klipy/get-trending-klipy-gifs)
| Field | Type | Description |
|-------|------|-------------|
| height | integer (int32) | Height of the clip in pixels |
| id | [SnowflakeType](#snowflaketype) | The unique Klipy clip slug |
| proxy_src | string | Proxied URL to the clip media file |
| src | string | Direct URL to the clip media file |
| title | string | The title/description of the clip |
| url | string | The Klipy page URL for the clip |
| width | integer (int32) | Width of the clip in pixels |
<a id="klipyregistersharerequest"></a>
## KlipyRegisterShareRequest
**Related endpoints**
- [`POST /klipy/register-share`](/api-reference/klipy/register-klipy-gif-share)
| Field | Type | Description |
|-------|------|-------------|
| id | [SnowflakeType](#snowflaketype) | The Klipy clip slug |
| locale? | [Locale](#locale) | |
| q? | ?string | The search query used to find the clip |
<a id="locale"></a>
## Locale
The locale code for the user interface language
**Related endpoints**
- [`GET /klipy/featured`](/api-reference/klipy/get-featured-klipy-gifs)
- [`GET /klipy/search`](/api-reference/klipy/search-klipy-gifs)
- [`GET /klipy/suggest`](/api-reference/klipy/get-klipy-search-suggestions)
- [`GET /klipy/trending-gifs`](/api-reference/klipy/get-trending-klipy-gifs)
- [`GET /tenor/featured`](/api-reference/tenor/get-featured-tenor-gifs)
- [`GET /tenor/search`](/api-reference/tenor/search-tenor-gifs)
- [`GET /tenor/suggest`](/api-reference/tenor/get-tenor-search-suggestions)
- [`GET /tenor/trending-gifs`](/api-reference/tenor/get-trending-tenor-gifs)
| Value | Description |
|-------|-------------|
| `ar` | Arabic |
| `bg` | Bulgarian |
| `cs` | Czech |
| `da` | Danish |
| `de` | German |
| `el` | Greek |
| `en-GB` | English (United Kingdom) |
| `en-US` | English (United States) |
| `es-ES` | Spanish (Spain) |
| `es-419` | Spanish (Latin America) |
| `fi` | Finnish |
| `fr` | French |
| `he` | Hebrew |
| `hi` | Hindi |
| `hr` | Croatian |
| `hu` | Hungarian |
| `id` | Indonesian |
| `it` | Italian |
| `ja` | Japanese |
| `ko` | Korean |
| `lt` | Lithuanian |
| `nl` | Dutch |
| `no` | Norwegian |
| `pl` | Polish |
| `pt-BR` | Portuguese (Brazil) |
| `ro` | Romanian |
| `ru` | Russian |
| `sv-SE` | Swedish |
| `th` | Thai |
| `tr` | Turkish |
| `uk` | Ukrainian |
| `vi` | Vietnamese |
| `zh-CN` | Chinese (Simplified) |
| `zh-TW` | Chinese (Traditional) |

342
fluxer_docs/resources/media_proxy.mdx Normal file
View File

@@ -0,0 +1,342 @@
---
title: 'Media proxy'
description: 'Object schemas used by the Fluxer media proxy.'
---
The media proxy serves all user-generated content for Fluxer, including avatars, icons, attachments, emojis, stickers, and external media. All public routes are served from `https://fluxerusercontent.com`.
See the [Media Proxy API reference](/media-proxy-api) for the full list of available endpoints.
## Field notation
Resource tables use a compact notation:
| Notation | Meaning |
|----------|----------|
| `field` | Required field |
| `field?` | Optional field (may be omitted) |
| `?type` | Nullable (value can be `null`) |
## Enums
<a id="imagesizeenum"></a>
### ImageSizeEnum
Allowed image sizes in pixels.
**Related endpoints**
- [`GET /avatars/{id}/{filename}`](/media-proxy-api/images/get-user-or-guild-avatar)
- [`GET /icons/{id}/{filename}`](/media-proxy-api/images/get-guild-icon)
- [`GET /banners/{id}/{filename}`](/media-proxy-api/images/get-user-or-guild-banner)
- [`GET /emojis/{id}`](/media-proxy-api/content/get-custom-emoji)
- [`GET /stickers/{id}`](/media-proxy-api/content/get-sticker)
- [`GET /attachments/{channel_id}/{attachment_id}/{filename}`](/media-proxy-api/content/get-message-attachment)
| Value | Description |
|-------|-------------|
| `16` | 16 pixels |
| `20` | 20 pixels |
| `22` | 22 pixels |
| `24` | 24 pixels |
| `28` | 28 pixels |
| `32` | 32 pixels |
| `40` | 40 pixels |
| `44` | 44 pixels |
| `48` | 48 pixels |
| `56` | 56 pixels |
| `60` | 60 pixels |
| `64` | 64 pixels |
| `80` | 80 pixels |
| `96` | 96 pixels |
| `100` | 100 pixels |
| `128` | 128 pixels |
| `160` | 160 pixels |
| `240` | 240 pixels |
| `256` | 256 pixels |
| `300` | 300 pixels |
| `320` | 320 pixels |
| `480` | 480 pixels |
| `512` | 512 pixels |
| `600` | 600 pixels |
| `640` | 640 pixels |
| `1024` | 1024 pixels |
| `1280` | 1280 pixels |
| `1536` | 1536 pixels |
| `2048` | 2048 pixels |
| `3072` | 3072 pixels |
| `4096` | 4096 pixels |
<a id="imageformatenum"></a>
### ImageFormatEnum
Allowed image output formats.
**Related endpoints**
- [`GET /avatars/{id}/{filename}`](/media-proxy-api/images/get-user-or-guild-avatar)
- [`GET /external/{signature}/{timestamp}/{url}`](/media-proxy-api/external/proxy-external-media)
| Value | Description |
|-------|-------------|
| `png` | PNG format |
| `jpg` | JPEG format |
| `jpeg` | JPEG format (alias) |
| `webp` | WebP format (default, recommended) |
| `gif` | GIF format (for animated images) |
<a id="imagequalityenum"></a>
### ImageQualityEnum
Image quality levels.
**Related endpoints**
- [`GET /avatars/{id}/{filename}`](/media-proxy-api/images/get-user-or-guild-avatar)
- [`GET /external/{signature}/{timestamp}/{url}`](/media-proxy-api/external/proxy-external-media)
| Value | Description |
|-------|-------------|
| `high` | High quality compression, good balance of size and fidelity (default for most images) |
| `low` | Lower quality for smaller file sizes, suitable for thumbnails |
| `lossless` | No quality loss, largest file sizes (default for external media) |
---
## Query parameter schemas
<a id="imagequeryparams"></a>
## ImageQueryParams
Standard query parameters for image routes.
**Related endpoints**
- [`GET /avatars/{id}/{filename}`](/media-proxy-api/images/get-user-or-guild-avatar)
- [`GET /icons/{id}/{filename}`](/media-proxy-api/images/get-guild-icon)
- [`GET /emojis/{id}`](/media-proxy-api/content/get-custom-emoji)
| Field | Type | Description |
|-------|------|-------------|
| size? | [ImageSizeEnum](#imagesizeenum) | Target image size in pixels. Default: `128` |
| format? | [ImageFormatEnum](#imageformatenum) | Output image format. Default: `webp` |
| quality? | [ImageQualityEnum](#imagequalityenum) | Image quality level. Default: `high` |
| animated? | boolean | Whether to return animated images (GIF, APNG) if available. Default: `false` |
<a id="externalmediaqueryparams"></a>
## ExternalMediaQueryParams
Query parameters for the external media proxy.
**Related endpoints**
- [`GET /external/{signature}/{timestamp}/{url}`](/media-proxy-api/external/proxy-external-media)
| Field | Type | Description |
|-------|------|-------------|
| width? | integer | Target width in pixels (1-4096). If only width is specified, height is calculated to maintain aspect ratio. |
| height? | integer | Target height in pixels (1-4096). If only height is specified, width is calculated to maintain aspect ratio. |
| format? | [ImageFormatEnum](#imageformatenum) | Output image format. If not specified, the original format is preserved. |
| quality? | [ImageQualityEnum](#imagequalityenum) | Image quality level. Default: `lossless` |
| animated? | boolean | Whether to preserve animation for GIF images. Default: `false` |
---
## Response schemas
<a id="metadataresponse"></a>
## MetadataResponse
Response from metadata extraction.
**Related endpoints**
- [`POST /_metadata`](/media-proxy-api/internal/extract-media-metadata)
| Field | Type | Description |
|-------|------|-------------|
| format | string | Detected media format (e.g., `png`, `jpeg`, `gif`, `mp4`) |
| content_type | string | MIME content type |
| content_hash | string | SHA-256 hash of the content |
| size | integer | File size in bytes |
| width? | integer | Image or video width in pixels |
| height? | integer | Image or video height in pixels |
| duration? | number | Video or audio duration in seconds |
| placeholder? | string | BlurHash placeholder string for progressive loading |
| base64? | string | Base64-encoded content (if `with_base64` was requested) |
| animated? | boolean | Whether the image is animated (GIF, APNG) |
| nsfw | boolean | Whether the content was flagged as NSFW |
| nsfw_probability? | number | NSFW probability score (0-1) |
| nsfw_predictions? | map&lt;string, number&gt; | Per-category NSFW predictions |
<a id="thumbnailresponse"></a>
## ThumbnailResponse
Response from thumbnail generation.
**Related endpoints**
- [`POST /_thumbnail`](/media-proxy-api/internal/generate-video-thumbnail)
| Field | Type | Description |
|-------|------|-------------|
| thumbnail | string | Base64-encoded thumbnail image (JPEG) |
| mime_type | string | MIME type of the thumbnail (always `image/jpeg`) |
<a id="frameresponse"></a>
## FrameResponse
Response from frame extraction.
**Related endpoints**
- [`POST /_frames`](/media-proxy-api/internal/extract-video-frames)
| Field | Type | Description |
|-------|------|-------------|
| frames | [ExtractedFrame](#extractedframe)[] | Extracted video frames |
<a id="extractedframe"></a>
## ExtractedFrame
Single extracted video frame.
| Field | Type | Description |
|-------|------|-------------|
| timestamp | number | Frame timestamp in seconds |
| mime_type | string | MIME type of the frame image |
| base64 | string | Base64-encoded frame image |
---
## Request schemas
<a id="metadatarequest"></a>
### MetadataRequest
Discriminated union for metadata extraction requests. The `type` field determines which variant is used.
**Related endpoints**
- [`POST /_metadata`](/media-proxy-api/internal/extract-media-metadata)
| Type | Description |
|------|-------------|
| [MetadataRequestExternal](#metadatarequestexternal) | Fetch metadata from an external URL |
| [MetadataRequestUpload](#metadatarequestupload) | Get metadata from an uploaded file |
| [MetadataRequestBase64](#metadatarequestbase64) | Get metadata from base64-encoded data |
| [MetadataRequestS3](#metadatarequests3) | Get metadata from an S3 object |
<a id="metadatarequestexternal"></a>
## MetadataRequestExternal
Metadata request for external URLs.
| Field | Type | Description |
|-------|------|-------------|
| type | string | Must be `"external"` |
| url | string | External URL to fetch |
| with_base64? | boolean | Include base64-encoded content in response |
| isNSFWAllowed | boolean | Whether NSFW content is permitted |
<a id="metadatarequestupload"></a>
## MetadataRequestUpload
Metadata request for uploaded files.
| Field | Type | Description |
|-------|------|-------------|
| type | string | Must be `"upload"` |
| upload_filename | string | Filename in the uploads bucket |
| isNSFWAllowed | boolean | Whether NSFW content is permitted |
<a id="metadatarequestbase64"></a>
## MetadataRequestBase64
Metadata request for base64-encoded data.
| Field | Type | Description |
|-------|------|-------------|
| type | string | Must be `"base64"` |
| base64 | string | Base64-encoded media data |
| isNSFWAllowed | boolean | Whether NSFW content is permitted |
<a id="metadatarequests3"></a>
## MetadataRequestS3
Metadata request for S3 objects.
| Field | Type | Description |
|-------|------|-------------|
| type | string | Must be `"s3"` |
| bucket | string | S3 bucket name |
| key | string | S3 object key |
| with_base64? | boolean | Include base64-encoded content in response |
| isNSFWAllowed | boolean | Whether NSFW content is permitted |
<a id="framerequest"></a>
### FrameRequest
Discriminated union for frame extraction requests. The `type` field determines which variant is used.
**Related endpoints**
- [`POST /_frames`](/media-proxy-api/internal/extract-video-frames)
| Type | Description |
|------|-------------|
| [FrameRequestUpload](#framerequestupload) | Extract frames from an uploaded file |
| [FrameRequestS3](#framerequests3) | Extract frames from an S3 object |
<a id="framerequestupload"></a>
## FrameRequestUpload
Frame extraction request for uploaded files.
| Field | Type | Description |
|-------|------|-------------|
| type | string | Must be `"upload"` |
| upload_filename | string | Filename in the uploads bucket |
<a id="framerequests3"></a>
## FrameRequestS3
Frame extraction request for S3 objects.
| Field | Type | Description |
|-------|------|-------------|
| type | string | Must be `"s3"` |
| bucket | string | S3 bucket name |
| key | string | S3 object key |
<a id="thumbnailrequestbody"></a>
## ThumbnailRequestBody
Request body for thumbnail generation.
**Related endpoints**
- [`POST /_thumbnail`](/media-proxy-api/internal/generate-video-thumbnail)
| Field | Type | Description |
|-------|------|-------------|
| upload_filename | string | Filename of the uploaded video in the uploads bucket |

447
fluxer_docs/resources/oauth2.mdx Normal file
View File

@@ -0,0 +1,447 @@
---
title: 'OAuth2'
description: 'OAuth2 object schemas from the Fluxer API.'
---
<a id="applicationbotresponse"></a>
## ApplicationBotResponse
Detailed bot user metadata
| Field | Type | Description |
|-------|------|-------------|
| authenticator_types? | [AuthenticatorType](#authenticatortype)[] | The types of authenticators enabled |
| avatar? | ?string | The avatar hash of the bot |
| banner? | ?string | The banner hash of the bot |
| bio | ?string | The bio or description of the bot |
| discriminator | string | The discriminator of the bot |
| flags | [BotFlags](#botflags) | |
| id | [SnowflakeType](#snowflaketype) | The unique identifier of the bot user |
| mfa_enabled? | boolean | Whether the bot has MFA enabled |
| token? | string | The bot token for authentication |
| username | string | The username of the bot |
<a id="applicationcreaterequest"></a>
## ApplicationCreateRequest
**Related endpoints**
- [`POST /oauth2/applications`](/api-reference/oauth2/create-oauth2-application)
| Field | Type | Description |
|-------|------|-------------|
| bot_public? | boolean | Whether the bot can be invited by anyone |
| bot_require_code_grant? | boolean | Whether the bot requires OAuth2 code grant |
| name | string | The name of the application |
| redirect_uris? | ?[OAuth2RedirectURICreateType](#oauth2redirecturicreatetype)[] | The redirect URIs for OAuth2 flows |
<a id="applicationflags"></a>
## ApplicationFlags
The application flags
Type: integer (int32)
<a id="applicationlistresponse"></a>
## ApplicationListResponse
**Related endpoints**
- [`GET /oauth2/applications/@me`](/api-reference/oauth2/list-user-applications)
- [`GET /users/@me/applications`](/api-reference/oauth2/list-user-applications)
Type: [ApplicationResponse](#applicationresponse)[]
<a id="applicationpublicresponse"></a>
## ApplicationPublicResponse
**Related endpoints**
- [`GET /oauth2/applications/{id}/public`](/api-reference/oauth2/get-public-application)
| Field | Type | Description |
|-------|------|-------------|
| bot | ?[ApplicationBotResponse](#applicationbotresponse) | The bot user associated with the application |
| bot_public | boolean | Whether the bot can be invited by anyone |
| description | null | The description of the application |
| icon | ?string | The icon hash of the application |
| id | [SnowflakeType](#snowflaketype) | The unique identifier of the application |
| name | string | The name of the application |
| redirect_uris | string[] | The registered redirect URIs for OAuth2 |
| scopes | string[] | The available OAuth2 scopes |
<a id="applicationresponse"></a>
## ApplicationResponse
**Related endpoints**
- [`GET /oauth2/applications/{id}`](/api-reference/oauth2/get-application)
- [`POST /oauth2/applications`](/api-reference/oauth2/create-oauth2-application)
- [`POST /oauth2/applications/{id}/client-secret/reset`](/api-reference/oauth2/reset-client-secret)
- [`PATCH /oauth2/applications/{id}`](/api-reference/oauth2/update-application)
| Field | Type | Description |
|-------|------|-------------|
| bot? | [ApplicationBotResponse](#applicationbotresponse) | |
| bot_public | boolean | Whether the bot can be invited by anyone |
| bot_require_code_grant | boolean | Whether the bot requires OAuth2 code grant |
| client_secret? | string | The client secret for OAuth2 authentication |
| id | [SnowflakeType](#snowflaketype) | The unique identifier of the application |
| name | string | The name of the application |
| redirect_uris | string[] | The registered redirect URIs for OAuth2 |
<a id="applicationsmeresponse"></a>
## ApplicationsMeResponse
**Related endpoints**
- [`GET /applications/@me`](/api-reference/oauth2/list-current-user-applications)
| Field | Type | Description |
|-------|------|-------------|
| bot? | [ApplicationBotResponse](#applicationbotresponse) | |
| bot_public | boolean | Whether the bot can be invited by anyone |
| bot_require_code_grant | boolean | Whether the bot requires OAuth2 code grant |
| description | null | The description of the application |
| flags | [ApplicationFlags](#applicationflags) | |
| icon | null | The icon hash of the application |
| id | [SnowflakeType](#snowflaketype) | The unique identifier of the application |
| name | string | The name of the application |
<a id="applicationupdaterequest"></a>
## ApplicationUpdateRequest
**Related endpoints**
- [`PATCH /oauth2/applications/{id}`](/api-reference/oauth2/update-application)
| Field | Type | Description |
|-------|------|-------------|
| bot_public? | boolean | Whether the bot can be invited by anyone |
| bot_require_code_grant? | boolean | Whether the bot requires OAuth2 code grant |
| name? | string | The name of the application |
| redirect_uris? | ?[OAuth2RedirectURIUpdateType](#oauth2redirecturiupdatetype)[] | The redirect URIs for OAuth2 flows |
<a id="authorizeconsentrequest"></a>
## AuthorizeConsentRequest
**Related endpoints**
- [`POST /oauth2/authorize/consent`](/api-reference/oauth2/grant-oauth2-consent)
| Field | Type | Description |
|-------|------|-------------|
| client_id | [SnowflakeType](#snowflaketype) | |
| guild_id? | [SnowflakeType](#snowflaketype) | |
| permissions? | string | The bot permissions to request |
| redirect_uri? | string | The URI to redirect to after authorization |
| response_type? | string | The OAuth2 response type |
| scope | string | The space-separated list of requested scopes |
| state? | string | A random string for CSRF protection |
<a id="botflags"></a>
## BotFlags
The bot user flags
Type: Bitflags32
| Flag | Value | Description |
|------|-------|-------------|
| FRIENDLY_BOT | `16` | Bot accepts friend requests from users |
| FRIENDLY_BOT_MANUAL_APPROVAL | `32` | Bot requires manual approval for friend requests |
<a id="botprofileresponse"></a>
## BotProfileResponse
**Related endpoints**
- [`PATCH /oauth2/applications/{id}/bot`](/api-reference/oauth2/update-bot-profile)
| Field | Type | Description |
|-------|------|-------------|
| avatar | ?string | The avatar hash of the bot |
| banner | ?string | The banner hash of the bot |
| bio | ?string | The bio or description of the bot |
| discriminator | string | The discriminator of the bot |
| id | [SnowflakeType](#snowflaketype) | The unique identifier of the bot user |
| username | string | The username of the bot |
<a id="botprofileupdaterequest"></a>
## BotProfileUpdateRequest
**Related endpoints**
- [`PATCH /oauth2/applications/{id}/bot`](/api-reference/oauth2/update-bot-profile)
| Field | Type | Description |
|-------|------|-------------|
| avatar? | ?[Base64ImageType](#base64imagetype) | The avatar image as base64 |
| banner? | ?[Base64ImageType](#base64imagetype) | The banner image as base64 |
| bio? | ?string | The bio or description of the bot |
| bot_flags? | [BotFlags](#botflags) | |
| discriminator? | string | The discriminator of the bot |
| username? | [UsernameType](#usernametype) | |
<a id="bottokenresetresponse"></a>
## BotTokenResetResponse
**Related endpoints**
- [`POST /oauth2/applications/{id}/bot/reset-token`](/api-reference/oauth2/reset-bot-token)
| Field | Type | Description |
|-------|------|-------------|
| bot | [ApplicationBotResponse](#applicationbotresponse) | |
| token | string | The new bot token |
<a id="introspectrequestform"></a>
## IntrospectRequestForm
**Related endpoints**
- [`POST /oauth2/introspect`](/api-reference/oauth2/introspect-oauth2-token)
| Field | Type | Description |
|-------|------|-------------|
| client_id? | [SnowflakeType](#snowflaketype) | |
| client_secret? | string | The application client secret |
| token | string | The token to introspect |
<a id="oauth2authorizationresponse"></a>
## OAuth2AuthorizationResponse
| Field | Type | Description |
|-------|------|-------------|
| application | [OAuth2AuthorizationResponseApplication](#oauth2authorizationresponseapplication) | The application that was authorized |
| authorized_at | string | The timestamp when the authorization was granted |
| scopes | string[] | The list of granted OAuth2 scopes |
<a id="oauth2authorizationslistresponse"></a>
## OAuth2AuthorizationsListResponse
**Related endpoints**
- [`GET /oauth2/@me/authorizations`](/api-reference/oauth2/list-user-oauth2-authorizations)
Type: [OAuth2AuthorizationResponse](#oauth2authorizationresponse)[]
<a id="oauth2consentresponse"></a>
## OAuth2ConsentResponse
**Related endpoints**
- [`POST /oauth2/authorize/consent`](/api-reference/oauth2/grant-oauth2-consent)
| Field | Type | Description |
|-------|------|-------------|
| redirect_to | string | The URL to redirect the user to after consent |
<a id="oauth2introspectresponse"></a>
## OAuth2IntrospectResponse
**Related endpoints**
- [`POST /oauth2/introspect`](/api-reference/oauth2/introspect-oauth2-token)
| Field | Type | Description |
|-------|------|-------------|
| active | boolean | Whether the token is currently active |
| client_id? | [SnowflakeType](#snowflaketype) | |
| exp? | [Int32Type](#int32type) | |
| iat? | [Int32Type](#int32type) | |
| scope? | string | The space-separated list of scopes |
| sub? | [SnowflakeType](#snowflaketype) | |
| token_type? | string | The type of token |
| username? | string | The username of the token owner |
<a id="oauth2meresponse"></a>
## OAuth2MeResponse
**Related endpoints**
- [`GET /oauth2/@me`](/api-reference/oauth2/get-current-oauth2-user)
| Field | Type | Description |
|-------|------|-------------|
| application | [OAuth2MeResponseApplication](#oauth2meresponseapplication) | The application associated with the token |
| expires | string | The expiration timestamp of the token |
| scopes | string[] | The list of granted OAuth2 scopes |
| user? | [OAuth2MeResponseUser](#oauth2meresponseuser) | The user associated with the token |
<a id="oauth2redirecturicreatetype"></a>
## OAuth2RedirectURICreateType
Type: string
<a id="oauth2redirecturiupdatetype"></a>
## OAuth2RedirectURIUpdateType
Type: string
<a id="oauth2tokenresponse"></a>
## OAuth2TokenResponse
**Related endpoints**
- [`POST /oauth2/token`](/api-reference/oauth2/exchange-oauth2-token)
| Field | Type | Description |
|-------|------|-------------|
| access_token | string | The access token for API authorization |
| expires_in | integer (int32) | The number of seconds until the access token expires |
| refresh_token | string | The refresh token for obtaining new access tokens |
| scope | string | The space-separated list of granted scopes |
| token_type | string | The type of token, typically "Bearer" |
<a id="oauth2userinforesponse"></a>
## OAuth2UserInfoResponse
**Related endpoints**
- [`GET /oauth2/userinfo`](/api-reference/oauth2/get-oauth2-user-information)
| Field | Type | Description |
|-------|------|-------------|
| avatar | ?string | The avatar hash of the user |
| discriminator | string | The discriminator of the user |
| email? | ?string | The email address of the user |
| flags? | [PublicUserFlags](#publicuserflags) | |
| global_name | ?string | The global display name of the user |
| id | [SnowflakeType](#snowflaketype) | The unique identifier of the user |
| sub | [SnowflakeType](#snowflaketype) | The subject identifier of the user |
| username | string | The username of the user |
| verified? | ?boolean | Whether the user has verified their email |
<a id="revokerequestform"></a>
## RevokeRequestForm
**Related endpoints**
- [`POST /oauth2/token/revoke`](/api-reference/oauth2/revoke-oauth2-token)
| Field | Type | Description |
|-------|------|-------------|
| client_id? | [SnowflakeType](#snowflaketype) | |
| client_secret? | string | The application client secret |
| token | string | The token to revoke |
| token_type_hint? | [RevokeRequestFormTokenTypeHint](#revokerequestformtokentypehint) | A hint about the type of token being revoked |
<a id="tokenrequest"></a>
## TokenRequest
**Related endpoints**
- [`POST /oauth2/token`](/api-reference/oauth2/exchange-oauth2-token)
Type: [TokenRequestOneOf0](#tokenrequestoneof0) \| [TokenRequestOneOf1](#tokenrequestoneof1)
<a id="revokerequestformtokentypehint"></a>
## RevokeRequestFormTokenTypeHint
A hint about the type of token being revoked
| Value | Description |
|-------|-------------|
| `access_token` | An OAuth2 access token |
| `refresh_token` | An OAuth2 refresh token |
<a id="oauth2authorizationresponseapplication"></a>
## OAuth2AuthorizationResponseApplication
The application that was authorized
| Field | Type | Description |
|-------|------|-------------|
| bot_public | boolean | Whether the bot can be invited by anyone |
| description | null | The description of the application |
| icon | ?string | The icon hash of the application |
| id | [SnowflakeType](#snowflaketype) | The unique identifier of the application |
| name | string | The name of the application |
<a id="oauth2meresponseapplication"></a>
## OAuth2MeResponseApplication
The application associated with the token
| Field | Type | Description |
|-------|------|-------------|
| bot_public | boolean | Whether the bot can be invited by anyone |
| bot_require_code_grant | boolean | Whether the bot requires OAuth2 code grant |
| description | null | The description of the application |
| flags | [ApplicationFlags](#applicationflags) | |
| icon | null | The icon hash of the application |
| id | [SnowflakeType](#snowflaketype) | The unique identifier of the application |
| name | string | The name of the application |
<a id="oauth2meresponseuser"></a>
## OAuth2MeResponseUser
The user associated with the token
| Field | Type | Description |
|-------|------|-------------|
| avatar | ?string | The avatar hash of the user |
| avatar_color | ?[Int32Type](#int32type) | The default avatar color of the user |
| bot? | boolean | Whether the user is a bot |
| discriminator | string | The discriminator of the user |
| email? | ?string | The email address of the user |
| flags | [PublicUserFlags](#publicuserflags) | |
| global_name | ?string | The global display name of the user |
| id | [SnowflakeType](#snowflaketype) | The unique identifier of the user |
| system? | boolean | Whether the user is a system user |
| username | string | The username of the user |
| verified? | ?boolean | Whether the user has verified their email |
<a id="tokenrequestoneof0"></a>
## TokenRequestOneOf0
| Field | Type | Description |
|-------|------|-------------|
| client_id? | [SnowflakeType](#snowflaketype) | |
| client_secret? | string | The application client secret |
| code | string | The authorization code received from the authorize endpoint |
| grant_type | enum&lt;`authorization_code`&gt; | The grant type for exchanging an authorization code |
| redirect_uri | string | The redirect URI used in the authorization request |
<a id="tokenrequestoneof1"></a>
## TokenRequestOneOf1
| Field | Type | Description |
|-------|------|-------------|
| client_id? | [SnowflakeType](#snowflaketype) | |
| client_secret? | string | The application client secret |
| grant_type | enum&lt;`refresh_token`&gt; | The grant type for refreshing an access token |
| refresh_token | string | The refresh token to exchange for a new access token |

603
fluxer_docs/resources/overview.mdx Normal file
View File

@@ -0,0 +1,603 @@
---
title: 'Overview'
description: 'Object schemas extracted from the OpenAPI schema.'
---
This section contains all resource schemas (data types) used by the Fluxer API.
## Field notation
Resource tables use a compact notation:
| Notation | Meaning |
|----------|----------|
| `field` | Required field |
| `field?` | Optional field (may be omitted) |
| `?type` | Nullable (value can be `null`) |
| `field?` with `?type` | Optional and nullable |
## Resources by domain
- [Admin](/resources/admin) (169 schemas)
- [Auth](/resources/auth) (37 schemas)
- [Billing](/resources/billing) (3 schemas)
- [Channels](/resources/channels) (66 schemas)
- [Common](/resources/common) (34 schemas)
- [Gateway](/resources/gateway) (2 schemas)
- [Gifts](/resources/gifts) (1 schemas)
- [Guilds](/resources/guilds) (63 schemas)
- [Instance](/resources/instance) (1 schemas)
- [Invites](/resources/invites) (4 schemas)
- [Klipy](/resources/klipy) (5 schemas)
- [Oauth2](/resources/oauth2) (25 schemas)
- [Packs](/resources/packs) (7 schemas)
- [Premium](/resources/premium) (2 schemas)
- [Read states](/resources/read_states) (1 schemas)
- [Reports](/resources/reports) (14 schemas)
- [Saved media](/resources/saved_media) (5 schemas)
- [Search](/resources/search) (2 schemas)
- [Themes](/resources/themes) (2 schemas)
- [Users](/resources/users) (81 schemas)
- [Webhooks](/resources/webhooks) (9 schemas)
## All schemas
- [AddSnowflakeReservationRequest](/resources/admin#addsnowflakereservationrequest)
- [AdminArchiveResponseSchema](/resources/admin#adminarchiveresponseschema)
- [AdminAuditLogResponseSchema](/resources/common#adminauditlogresponseschema)
- [AdminUserDmChannelSchema](/resources/common#adminuserdmchannelschema)
- [AdminUsersMeResponse](/resources/admin#adminusersmeresponse)
- [APIErrorCode](/resources/common#apierrorcode)
- [ApplicationBotResponse](/resources/common#applicationbotresponse)
- [ApplicationCreateRequest](/resources/oauth2#applicationcreaterequest)
- [ApplicationFlags](/resources/common#applicationflags)
- [ApplicationListResponse](/resources/oauth2#applicationlistresponse)
- [ApplicationPublicResponse](/resources/oauth2#applicationpublicresponse)
- [ApplicationResponse](/resources/oauth2#applicationresponse)
- [ApplicationsMeResponse](/resources/oauth2#applicationsmeresponse)
- [ApplicationUpdateRequest](/resources/oauth2#applicationupdaterequest)
- [AuditLogActionType](/resources/guilds#auditlogactiontype)
- [AuditLogChangeSchema](/resources/common#auditlogchangeschema)
- [AuditLogsListResponseSchema](/resources/admin#auditlogslistresponseschema)
- [AuditLogWebhookResponse](/resources/common#auditlogwebhookresponse)
- [AuthenticatorType](/resources/common#authenticatortype)
- [AuthLoginResponse](/resources/auth#authloginresponse)
- [AuthMfaRequiredResponse](/resources/common#authmfarequiredresponse)
- [AuthorizeConsentRequest](/resources/oauth2#authorizeconsentrequest)
- [AuthorizeIpRequest](/resources/auth#authorizeiprequest)
- [AuthRegisterResponse](/resources/auth#authregisterresponse)
- [AuthSessionClientInfo](/resources/common#authsessionclientinfo)
- [AuthSessionLocation](/resources/common#authsessionlocation)
- [AuthSessionResponse](/resources/common#authsessionresponse)
- [AuthSessionsResponse](/resources/auth#authsessionsresponse)
- [AuthTokenWithUserIdResponse](/resources/auth#authtokenwithuseridresponse)
- [BanCheckResponseSchema](/resources/admin#bancheckresponseschema)
- [BanEmailRequest](/resources/admin#banemailrequest)
- [BanGuildMemberRequest](/resources/admin#banguildmemberrequest)
- [BanIpRequest](/resources/admin#baniprequest)
- [BanPhoneRequest](/resources/admin#banphonerequest)
- [Base64ImageType](/resources/common#base64imagetype)
- [BlueskyAuthorizeRequest](/resources/common#blueskyauthorizerequest)
- [BlueskyAuthorizeResponse](/resources/common#blueskyauthorizeresponse)
- [BotFlags](/resources/common#botflags)
- [BotProfileResponse](/resources/oauth2#botprofileresponse)
- [BotProfileUpdateRequest](/resources/oauth2#botprofileupdaterequest)
- [BotTokenResetResponse](/resources/oauth2#bottokenresetresponse)
- [BulkAddGuildMembersRequest](/resources/admin#bulkaddguildmembersrequest)
- [BulkDeleteMessagesRequest](/resources/channels#bulkdeletemessagesrequest)
- [BulkOperationFailedResponse](/resources/common#bulkoperationfailedresponse)
- [BulkOperationResponse](/resources/admin#bulkoperationresponse)
- [BulkScheduleUserDeletionRequest](/resources/admin#bulkscheduleuserdeletionrequest)
- [BulkUpdateGuildFeaturesRequest](/resources/admin#bulkupdateguildfeaturesrequest)
- [BulkUpdateUserFlagsRequest](/resources/admin#bulkupdateuserflagsrequest)
- [CallEligibilityResponse](/resources/channels#calleligibilityresponse)
- [CallRingBodySchema](/resources/channels#callringbodyschema)
- [CallUpdateBodySchema](/resources/channels#callupdatebodyschema)
- [CancelBulkMessageDeletionRequest](/resources/admin#cancelbulkmessagedeletionrequest)
- [ChangeDobRequest](/resources/admin#changedobrequest)
- [ChangeEmailRequest](/resources/admin#changeemailrequest)
- [ChangeUsernameRequest](/resources/admin#changeusernamerequest)
- [ChannelCreateCategoryRequest](/resources/common#channelcreatecategoryrequest)
- [ChannelCreateLinkRequest](/resources/common#channelcreatelinkrequest)
- [ChannelCreateRequest](/resources/guilds#channelcreaterequest)
- [ChannelCreateTextRequest](/resources/common#channelcreatetextrequest)
- [ChannelCreateVoiceRequest](/resources/common#channelcreatevoicerequest)
- [ChannelInviteCreateRequest](/resources/invites#channelinvitecreaterequest)
- [ChannelNicknameOverrides](/resources/common#channelnicknameoverrides)
- [ChannelOverwriteRequest](/resources/common#channeloverwriterequest)
- [ChannelOverwriteResponse](/resources/common#channeloverwriteresponse)
- [ChannelPartialRecipientResponse](/resources/common#channelpartialrecipientresponse)
- [ChannelPartialResponse](/resources/common#channelpartialresponse)
- [ChannelPinMessageResponse](/resources/common#channelpinmessageresponse)
- [ChannelPinResponse](/resources/common#channelpinresponse)
- [ChannelPinsResponse](/resources/channels#channelpinsresponse)
- [ChannelPositionUpdateRequest](/resources/guilds#channelpositionupdaterequest)
- [ChannelResponse](/resources/channels#channelresponse)
- [ChannelUpdateCategoryRequest](/resources/common#channelupdatecategoryrequest)
- [ChannelUpdateGroupDmRequest](/resources/common#channelupdategroupdmrequest)
- [ChannelUpdateLinkRequest](/resources/common#channelupdatelinkrequest)
- [ChannelUpdateRequest](/resources/channels#channelupdaterequest)
- [ChannelUpdateTextRequest](/resources/common#channelupdatetextrequest)
- [ChannelUpdateVoiceRequest](/resources/common#channelupdatevoicerequest)
- [ClearGuildFieldsRequest](/resources/admin#clearguildfieldsrequest)
- [ClearUserFieldsRequest](/resources/admin#clearuserfieldsrequest)
- [CodesResponse](/resources/admin#codesresponse)
- [ConnectionListResponse](/resources/common#connectionlistresponse)
- [ConnectionResponse](/resources/common#connectionresponse)
- [ConnectionVerificationResponse](/resources/common#connectionverificationresponse)
- [CreateAdminApiKeyRequest](/resources/admin#createadminapikeyrequest)
- [CreateAdminApiKeyResponse](/resources/admin#createadminapikeyresponse)
- [CreateCheckoutSessionRequest](/resources/billing#createcheckoutsessionrequest)
- [CreateConnectionRequest](/resources/common#createconnectionrequest)
- [CreateFavoriteMemeBodySchema](/resources/saved_media#createfavoritememebodyschema)
- [CreateFavoriteMemeFromUrlBodySchema](/resources/saved_media#createfavoritememefromurlbodyschema)
- [CreatePrivateChannelRequest](/resources/users#createprivatechannelrequest)
- [CreateSystemDmJobRequest](/resources/admin#createsystemdmjobrequest)
- [CreateVoiceRegionRequest](/resources/admin#createvoiceregionrequest)
- [CreateVoiceRegionResponse](/resources/admin#createvoiceregionresponse)
- [CreateVoiceServerRequest](/resources/admin#createvoiceserverrequest)
- [CreateVoiceServerResponse](/resources/admin#createvoiceserverresponse)
- [CustomStatusPayload](/resources/common#customstatuspayload)
- [CustomStatusResponse](/resources/common#customstatusresponse)
- [DefaultMessageNotifications](/resources/common#defaultmessagenotifications)
- [DeleteAllUserMessagesRequest](/resources/admin#deleteallusermessagesrequest)
- [DeleteAllUserMessagesResponse](/resources/admin#deleteallusermessagesresponse)
- [DeleteApiKeyResponse](/resources/admin#deleteapikeyresponse)
- [DeleteGuildRequest](/resources/admin#deleteguildrequest)
- [DeleteMessageRequest](/resources/admin#deletemessagerequest)
- [DeleteMessageResponse](/resources/admin#deletemessageresponse)
- [DeleteSnowflakeReservationRequest](/resources/admin#deletesnowflakereservationrequest)
- [DeleteVoiceRegionRequest](/resources/admin#deletevoiceregionrequest)
- [DeleteVoiceResponse](/resources/admin#deletevoiceresponse)
- [DeleteVoiceServerRequest](/resources/admin#deletevoiceserverrequest)
- [DisableForSuspiciousActivityRequest](/resources/admin#disableforsuspiciousactivityrequest)
- [DisableMfaRequest](/resources/admin#disablemfarequest)
- [DisableTotpRequest](/resources/users#disabletotprequest)
- [DiscoveryAdminRejectRequest](/resources/admin#discoveryadminrejectrequest)
- [DiscoveryAdminRemoveRequest](/resources/admin#discoveryadminremoverequest)
- [DiscoveryAdminReviewRequest](/resources/admin#discoveryadminreviewrequest)
- [DiscoveryApplicationPatchRequest](/resources/common#discoveryapplicationpatchrequest)
- [DiscoveryApplicationRequest](/resources/common#discoveryapplicationrequest)
- [DiscoveryApplicationResponse](/resources/admin#discoveryapplicationresponse)
- [DiscoveryCategoryListResponse](/resources/common#discoverycategorylistresponse)
- [DiscoveryCategoryResponse](/resources/common#discoverycategoryresponse)
- [DiscoveryGuildListResponse](/resources/common#discoveryguildlistresponse)
- [DiscoveryGuildResponse](/resources/common#discoveryguildresponse)
- [DonationCheckoutRequest](/resources/common#donationcheckoutrequest)
- [DonationCheckoutResponse](/resources/common#donationcheckoutresponse)
- [DonationRequestLinkRequest](/resources/common#donationrequestlinkrequest)
- [DownloadUrlResponseSchema](/resources/admin#downloadurlresponseschema)
- [DsaReportEmailSendRequest](/resources/reports#dsareportemailsendrequest)
- [DsaReportEmailVerifyRequest](/resources/reports#dsareportemailverifyrequest)
- [DsaReportGuildRequest](/resources/common#dsareportguildrequest)
- [DsaReportMessageRequest](/resources/common#dsareportmessagerequest)
- [DsaReportRequest](/resources/reports#dsareportrequest)
- [DsaReportUserRequest](/resources/common#dsareportuserrequest)
- [EmailChangeBouncedRequestNewRequest](/resources/users#emailchangebouncedrequestnewrequest)
- [EmailChangeBouncedVerifyNewRequest](/resources/users#emailchangebouncedverifynewrequest)
- [EmailChangeRequestNewRequest](/resources/users#emailchangerequestnewrequest)
- [EmailChangeRequestNewResponse](/resources/users#emailchangerequestnewresponse)
- [EmailChangeStartResponse](/resources/users#emailchangestartresponse)
- [EmailChangeTicketRequest](/resources/users#emailchangeticketrequest)
- [EmailChangeVerifyNewRequest](/resources/users#emailchangeverifynewrequest)
- [EmailChangeVerifyOriginalRequest](/resources/users#emailchangeverifyoriginalrequest)
- [EmailChangeVerifyOriginalResponse](/resources/users#emailchangeverifyoriginalresponse)
- [EmailRevertRequest](/resources/auth#emailrevertrequest)
- [EmailTokenResponse](/resources/users#emailtokenresponse)
- [EmailType](/resources/common#emailtype)
- [EmbedAuthorResponse](/resources/common#embedauthorresponse)
- [EmbedFieldResponse](/resources/common#embedfieldresponse)
- [EmbedFooterResponse](/resources/common#embedfooterresponse)
- [EmbedMediaFlags](/resources/common#embedmediaflags)
- [EmbedMediaResponse](/resources/common#embedmediaresponse)
- [EmptyBodyRequest](/resources/users#emptybodyrequest)
- [EnabledToggleRequest](/resources/guilds#enabledtogglerequest)
- [EnableMfaTotpRequest](/resources/users#enablemfatotprequest)
- [Error](/resources/admin#error)
- [ExpandVisionarySlotsRequest](/resources/admin#expandvisionaryslotsrequest)
- [FavoriteMemeListResponse](/resources/saved_media#favoritememelistresponse)
- [FavoriteMemeResponse](/resources/saved_media#favoritememeresponse)
- [ForceAddUserToGuildRequest](/resources/admin#forceaddusertoguildrequest)
- [ForgotPasswordRequest](/resources/auth#forgotpasswordrequest)
- [FriendRequestByTagRequest](/resources/users#friendrequestbytagrequest)
- [FriendSourceFlags](/resources/common#friendsourceflags)
- [GatewayBotResponse](/resources/gateway#gatewaybotresponse)
- [GenerateGiftCodesRequest](/resources/admin#generategiftcodesrequest)
- [GetArchiveResponseSchema](/resources/admin#getarchiveresponseschema)
- [GetIndexRefreshStatusRequest](/resources/admin#getindexrefreshstatusrequest)
- [GetProcessMemoryStatsRequest](/resources/admin#getprocessmemorystatsrequest)
- [GetVoiceRegionRequest](/resources/admin#getvoiceregionrequest)
- [GetVoiceRegionResponse](/resources/admin#getvoiceregionresponse)
- [GetVoiceServerRequest](/resources/admin#getvoiceserverrequest)
- [GetVoiceServerResponse](/resources/admin#getvoiceserverresponse)
- [GiftCodeMetadataResponse](/resources/users#giftcodemetadataresponse)
- [GiftCodeResponse](/resources/gifts#giftcoderesponse)
- [GitHubWebhook](/resources/webhooks#githubwebhook)
- [GlobalSearchMessagesRequest](/resources/search#globalsearchmessagesrequest)
- [GroupDmAddPermissionFlags](/resources/common#groupdmaddpermissionflags)
- [GroupDmInviteMetadataResponse](/resources/common#groupdminvitemetadataresponse)
- [GroupDmInviteResponse](/resources/common#groupdminviteresponse)
- [GuildAdminResponse](/resources/common#guildadminresponse)
- [GuildAssetItemSchema](/resources/common#guildassetitemschema)
- [GuildAuditLogEntryResponse](/resources/common#guildauditlogentryresponse)
- [GuildAuditLogListResponse](/resources/guilds#guildauditloglistresponse)
- [GuildBanCreateRequest](/resources/guilds#guildbancreaterequest)
- [GuildBanResponse](/resources/guilds#guildbanresponse)
- [GuildCreateRequest](/resources/guilds#guildcreaterequest)
- [GuildDeleteRequest](/resources/guilds#guilddeleterequest)
- [GuildEmojiBulkCreateRequest](/resources/guilds#guildemojibulkcreaterequest)
- [GuildEmojiBulkCreateResponse](/resources/guilds#guildemojibulkcreateresponse)
- [GuildEmojiCreateRequest](/resources/guilds#guildemojicreaterequest)
- [GuildEmojiResponse](/resources/guilds#guildemojiresponse)
- [GuildEmojiUpdateRequest](/resources/guilds#guildemojiupdaterequest)
- [GuildEmojiWithUserListResponse](/resources/guilds#guildemojiwithuserlistresponse)
- [GuildEmojiWithUserResponse](/resources/common#guildemojiwithuserresponse)
- [GuildExplicitContentFilter](/resources/common#guildexplicitcontentfilter)
- [GuildFeatureSchema](/resources/common#guildfeatureschema)
- [GuildFolderFlags](/resources/common#guildfolderflags)
- [GuildInviteMetadataResponse](/resources/common#guildinvitemetadataresponse)
- [GuildInviteResponse](/resources/common#guildinviteresponse)
- [GuildMemberProfileFlags](/resources/common#guildmemberprofileflags)
- [GuildMemberResponse](/resources/guilds#guildmemberresponse)
- [GuildMemberSearchRequest](/resources/guilds#guildmembersearchrequest)
- [GuildMemberSearchResponse](/resources/guilds#guildmembersearchresponse)
- [GuildMemberSearchResult](/resources/common#guildmembersearchresult)
- [GuildMemberUpdateRequest](/resources/guilds#guildmemberupdaterequest)
- [GuildMemoryStatsResponse](/resources/admin#guildmemorystatsresponse)
- [GuildMFALevel](/resources/common#guildmfalevel)
- [GuildOperations](/resources/common#guildoperations)
- [GuildReportCategoryEnum](/resources/common#guildreportcategoryenum)
- [GuildResponse](/resources/guilds#guildresponse)
- [GuildRoleCreateRequest](/resources/guilds#guildrolecreaterequest)
- [GuildRoleHoistPositionItem](/resources/common#guildrolehoistpositionitem)
- [GuildRoleHoistPositionsRequest](/resources/guilds#guildrolehoistpositionsrequest)
- [GuildRolePositionItem](/resources/common#guildrolepositionitem)
- [GuildRolePositionsRequest](/resources/guilds#guildrolepositionsrequest)
- [GuildRoleResponse](/resources/guilds#guildroleresponse)
- [GuildRoleUpdateRequest](/resources/guilds#guildroleupdaterequest)
- [GuildStickerBulkCreateRequest](/resources/guilds#guildstickerbulkcreaterequest)
- [GuildStickerBulkCreateResponse](/resources/guilds#guildstickerbulkcreateresponse)
- [GuildStickerCreateRequest](/resources/guilds#guildstickercreaterequest)
- [GuildStickerResponse](/resources/guilds#guildstickerresponse)
- [GuildStickerUpdateRequest](/resources/guilds#guildstickerupdaterequest)
- [GuildStickerWithUserListResponse](/resources/guilds#guildstickerwithuserlistresponse)
- [GuildStickerWithUserResponse](/resources/common#guildstickerwithuserresponse)
- [GuildTransferOwnershipRequest](/resources/guilds#guildtransferownershiprequest)
- [GuildUpdateRequest](/resources/guilds#guildupdaterequest)
- [GuildUpdateResponse](/resources/admin#guildupdateresponse)
- [GuildVanityURLResponse](/resources/guilds#guildvanityurlresponse)
- [GuildVanityURLUpdateRequest](/resources/guilds#guildvanityurlupdaterequest)
- [GuildVanityURLUpdateResponse](/resources/guilds#guildvanityurlupdateresponse)
- [GuildVerificationLevel](/resources/common#guildverificationlevel)
- [HandoffCompleteRequest](/resources/auth#handoffcompleterequest)
- [HandoffInitiateResponse](/resources/auth#handoffinitiateresponse)
- [HandoffStatusResponse](/resources/auth#handoffstatusresponse)
- [HarvestCreationResponseSchema](/resources/users#harvestcreationresponseschema)
- [HarvestDownloadUrlResponse](/resources/users#harvestdownloadurlresponse)
- [HarvestStatusEnum](/resources/common#harveststatusenum)
- [HarvestStatusResponseSchema](/resources/users#harveststatusresponseschema)
- [HarvestStatusResponseSchemaNullable](/resources/users#harveststatusresponseschemanullable)
- [IncomingCallFlags](/resources/common#incomingcallflags)
- [IndexRefreshStatusResponse](/resources/admin#indexrefreshstatusresponse)
- [InstanceConfigResponse](/resources/admin#instanceconfigresponse)
- [InstanceConfigUpdateRequest](/resources/admin#instanceconfigupdaterequest)
- [Int32Type](/resources/guilds#int32type)
- [Int64StringType](/resources/common#int64stringtype)
- [Int64Type](/resources/common#int64type)
- [IntrospectRequestForm](/resources/oauth2#introspectrequestform)
- [InviteMetadataResponseSchema](/resources/invites#invitemetadataresponseschema)
- [InviteResponseSchema](/resources/invites#inviteresponseschema)
- [IpAuthorizationPollResponse](/resources/auth#ipauthorizationpollresponse)
- [IpBanListEntrySchema](/resources/common#ipbanlistentryschema)
- [JoinSourceType](/resources/common#joinsourcetype)
- [KickGuildMemberRequest](/resources/admin#kickguildmemberrequest)
- [KlipyCategoryTagResponse](/resources/common#klipycategorytagresponse)
- [KlipyFeaturedResponse](/resources/klipy#klipyfeaturedresponse)
- [KlipyGifResponse](/resources/klipy#klipygifresponse)
- [KlipyRegisterShareRequest](/resources/klipy#klipyregistersharerequest)
- [LegalHoldRequest](/resources/admin#legalholdrequest)
- [LegalHoldResponse](/resources/admin#legalholdresponse)
- [LimitConfigGetResponse](/resources/admin#limitconfiggetresponse)
- [LimitConfigUpdateRequest](/resources/admin#limitconfigupdaterequest)
- [LimitFilterResponse](/resources/common#limitfilterresponse)
- [LimitRuleResponse](/resources/common#limitruleresponse)
- [ListAdminApiKeyResponse](/resources/admin#listadminapikeyresponse)
- [ListArchivesRequest](/resources/admin#listarchivesrequest)
- [ListArchivesResponseSchema](/resources/admin#listarchivesresponseschema)
- [ListAuditLogsRequest](/resources/admin#listauditlogsrequest)
- [ListBansRequest](/resources/admin#listbansrequest)
- [ListEmailBansResponseSchema](/resources/admin#listemailbansresponseschema)
- [ListGuildEmojisResponse](/resources/admin#listguildemojisresponse)
- [ListGuildMembersRequest](/resources/admin#listguildmembersrequest)
- [ListGuildMembersResponse](/resources/admin#listguildmembersresponse)
- [ListGuildStickersResponse](/resources/admin#listguildstickersresponse)
- [ListIpBansResponseSchema](/resources/admin#listipbansresponseschema)
- [ListPhoneBansResponseSchema](/resources/admin#listphonebansresponseschema)
- [ListReportsRequest](/resources/admin#listreportsrequest)
- [ListReportsResponse](/resources/admin#listreportsresponse)
- [ListSnowflakeReservationsResponse](/resources/admin#listsnowflakereservationsresponse)
- [ListSystemDmJobsResponse](/resources/admin#listsystemdmjobsresponse)
- [ListUserChangeLogRequest](/resources/admin#listuserchangelogrequest)
- [ListUserChangeLogResponseSchema](/resources/admin#listuserchangelogresponseschema)
- [ListUserDmChannelsRequest](/resources/admin#listuserdmchannelsrequest)
- [ListUserDmChannelsResponse](/resources/admin#listuserdmchannelsresponse)
- [ListUserGuildsRequest](/resources/admin#listuserguildsrequest)
- [ListUserGuildsResponse](/resources/admin#listuserguildsresponse)
- [ListUserSessionsRequest](/resources/admin#listusersessionsrequest)
- [ListUserSessionsResponse](/resources/admin#listusersessionsresponse)
- [ListVisionarySlotsResponse](/resources/admin#listvisionaryslotsresponse)
- [ListVoiceRegionsRequest](/resources/admin#listvoiceregionsrequest)
- [ListVoiceRegionsResponse](/resources/admin#listvoiceregionsresponse)
- [ListVoiceServersRequest](/resources/admin#listvoiceserversrequest)
- [ListVoiceServersResponse](/resources/admin#listvoiceserversresponse)
- [Locale](/resources/klipy#locale)
- [LoginRequest](/resources/auth#loginrequest)
- [LogoutAuthSessionsRequest](/resources/auth#logoutauthsessionsrequest)
- [LookupGuildRequest](/resources/admin#lookupguildrequest)
- [LookupGuildResponse](/resources/admin#lookupguildresponse)
- [LookupMessageByAttachmentRequest](/resources/admin#lookupmessagebyattachmentrequest)
- [LookupMessageRequest](/resources/admin#lookupmessagerequest)
- [LookupMessageResponse](/resources/admin#lookupmessageresponse)
- [LookupUserByIdsRequest](/resources/common#lookupuserbyidsrequest)
- [LookupUserByQueryRequest](/resources/common#lookupuserbyqueryrequest)
- [LookupUserRequest](/resources/admin#lookupuserrequest)
- [LookupUserResponse](/resources/admin#lookupuserresponse)
- [MessageAckRequest](/resources/channels#messageackrequest)
- [MessageAttachmentFlags](/resources/common#messageattachmentflags)
- [MessageAttachmentResponse](/resources/common#messageattachmentresponse)
- [MessageAuthorType](/resources/common#messageauthortype)
- [MessageBaseResponseSchema](/resources/common#messagebaseresponseschema)
- [MessageCallResponse](/resources/common#messagecallresponse)
- [MessageContentType](/resources/common#messagecontenttype)
- [MessageEmbedChildResponse](/resources/common#messageembedchildresponse)
- [MessageEmbedResponse](/resources/common#messageembedresponse)
- [MessageEmbedType](/resources/common#messageembedtype)
- [MessageFlags](/resources/common#messageflags)
- [MessageListResponse](/resources/users#messagelistresponse)
- [MessageReactionResponse](/resources/common#messagereactionresponse)
- [MessageReferenceResponse](/resources/common#messagereferenceresponse)
- [MessageReferenceType](/resources/common#messagereferencetype)
- [MessageReportCategoryEnum](/resources/common#messagereportcategoryenum)
- [MessageResponseSchema](/resources/channels#messageresponseschema)
- [MessageSearchIndexingResponse](/resources/common#messagesearchindexingresponse)
- [MessageSearchResponse](/resources/search#messagesearchresponse)
- [MessageSearchResultsResponse](/resources/common#messagesearchresultsresponse)
- [MessageSearchScope](/resources/common#messagesearchscope)
- [MessageShredRequest](/resources/admin#messageshredrequest)
- [MessageShredResponse](/resources/admin#messageshredresponse)
- [MessageShredStatusNotFoundResponse](/resources/common#messageshredstatusnotfoundresponse)
- [MessageShredStatusProgressResponse](/resources/common#messageshredstatusprogressresponse)
- [MessageShredStatusRequest](/resources/admin#messageshredstatusrequest)
- [MessageShredStatusResponse](/resources/admin#messageshredstatusresponse)
- [MessageSnapshotResponse](/resources/common#messagesnapshotresponse)
- [MessageSortField](/resources/common#messagesortfield)
- [MessageSortOrder](/resources/common#messagesortorder)
- [MessageStickerResponse](/resources/common#messagestickerresponse)
- [MfaBackupCodeResponse](/resources/common#mfabackupcoderesponse)
- [MfaBackupCodesRequest](/resources/users#mfabackupcodesrequest)
- [MfaBackupCodesResponse](/resources/users#mfabackupcodesresponse)
- [MfaSmsRequest](/resources/auth#mfasmsrequest)
- [MfaTicketRequest](/resources/auth#mfaticketrequest)
- [MfaTotpRequest](/resources/auth#mfatotprequest)
- [MutualGuildResponse](/resources/common#mutualguildresponse)
- [MyGuildMemberUpdateRequest](/resources/guilds#myguildmemberupdaterequest)
- [NcmecSubmissionStatusResponse](/resources/admin#ncmecsubmissionstatusresponse)
- [NcmecSubmitResultResponse](/resources/admin#ncmecsubmitresultresponse)
- [NodeStatsResponse](/resources/admin#nodestatsresponse)
- [NSFWLevel](/resources/common#nsfwlevel)
- [OAuth2AuthorizationResponse](/resources/common#oauth2authorizationresponse)
- [OAuth2AuthorizationsListResponse](/resources/oauth2#oauth2authorizationslistresponse)
- [OAuth2ConsentResponse](/resources/oauth2#oauth2consentresponse)
- [OAuth2IntrospectResponse](/resources/oauth2#oauth2introspectresponse)
- [OAuth2MeResponse](/resources/oauth2#oauth2meresponse)
- [OAuth2RedirectURICreateType](/resources/common#oauth2redirecturicreatetype)
- [OAuth2RedirectURIUpdateType](/resources/common#oauth2redirecturiupdatetype)
- [OAuth2TokenResponse](/resources/oauth2#oauth2tokenresponse)
- [OAuth2UserInfoResponse](/resources/oauth2#oauth2userinforesponse)
- [OkResponse](/resources/reports#okresponse)
- [PackCreateRequest](/resources/packs#packcreaterequest)
- [PackDashboardResponse](/resources/packs#packdashboardresponse)
- [PackInviteCreateRequest](/resources/invites#packinvitecreaterequest)
- [PackInviteMetadataResponse](/resources/common#packinvitemetadataresponse)
- [PackInviteResponse](/resources/common#packinviteresponse)
- [PackSummaryResponse](/resources/packs#packsummaryresponse)
- [PackUpdateRequest](/resources/packs#packupdaterequest)
- [PasswordChangeCompleteRequest](/resources/users#passwordchangecompleterequest)
- [PasswordChangeStartResponse](/resources/users#passwordchangestartresponse)
- [PasswordChangeTicketRequest](/resources/users#passwordchangeticketrequest)
- [PasswordChangeVerifyRequest](/resources/users#passwordchangeverifyrequest)
- [PasswordChangeVerifyResponse](/resources/users#passwordchangeverifyresponse)
- [PasswordType](/resources/common#passwordtype)
- [PermissionOverwriteCreateRequest](/resources/channels#permissionoverwritecreaterequest)
- [PhoneAddRequest](/resources/users#phoneaddrequest)
- [PhoneNumberType](/resources/common#phonenumbertype)
- [PhoneSendVerificationRequest](/resources/users#phonesendverificationrequest)
- [PhoneVerifyRequest](/resources/users#phoneverifyrequest)
- [PhoneVerifyResponse](/resources/users#phoneverifyresponse)
- [PreloadMessagesRequest](/resources/users#preloadmessagesrequest)
- [PreloadMessagesResponse](/resources/users#preloadmessagesresponse)
- [PriceIdsResponse](/resources/premium#priceidsresponse)
- [PublicUserFlags](/resources/common#publicuserflags)
- [PurgeGuildAssetErrorSchema](/resources/common#purgeguildasseterrorschema)
- [PurgeGuildAssetResultSchema](/resources/common#purgeguildassetresultschema)
- [PurgeGuildAssetsRequest](/resources/admin#purgeguildassetsrequest)
- [PurgeGuildAssetsResponseSchema](/resources/admin#purgeguildassetsresponseschema)
- [PushSubscribeRequest](/resources/users#pushsubscriberequest)
- [PushSubscribeResponse](/resources/users#pushsubscriberesponse)
- [PushSubscriptionItemResponse](/resources/common#pushsubscriptionitemresponse)
- [PushSubscriptionsListResponse](/resources/users#pushsubscriptionslistresponse)
- [ReactionUsersListResponse](/resources/channels#reactionuserslistresponse)
- [ReadStateAckBulkRequest](/resources/read_states#readstateackbulkrequest)
- [RefreshSearchIndexRequest](/resources/admin#refreshsearchindexrequest)
- [RefreshSearchIndexResponse](/resources/admin#refreshsearchindexresponse)
- [RegisterRequest](/resources/auth#registerrequest)
- [RelationshipNicknameUpdateRequest](/resources/users#relationshipnicknameupdaterequest)
- [RelationshipResponse](/resources/users#relationshipresponse)
- [RelationshipTypePutRequest](/resources/users#relationshiptypeputrequest)
- [RelationshipTypes](/resources/common#relationshiptypes)
- [ReloadAllGuildsResponse](/resources/admin#reloadallguildsresponse)
- [ReloadGuildRequest](/resources/admin#reloadguildrequest)
- [ReloadGuildsRequest](/resources/admin#reloadguildsrequest)
- [RenderSpoilers](/resources/common#renderspoilers)
- [ReorderConnectionsRequest](/resources/common#reorderconnectionsrequest)
- [ReportAdminResponseSchema](/resources/admin#reportadminresponseschema)
- [ReportGuildRequest](/resources/reports#reportguildrequest)
- [ReportMessageRequest](/resources/reports#reportmessagerequest)
- [ReportResponse](/resources/reports#reportresponse)
- [ReportStatus](/resources/common#reportstatus)
- [ReportType](/resources/common#reporttype)
- [ReportUserRequest](/resources/reports#reportuserrequest)
- [ReserveVisionarySlotRequest](/resources/admin#reservevisionaryslotrequest)
- [ResetPasswordRequest](/resources/auth#resetpasswordrequest)
- [ResolveReportRequest](/resources/admin#resolvereportrequest)
- [ResolveReportResponse](/resources/admin#resolvereportresponse)
- [RevokeRequestForm](/resources/oauth2#revokerequestform)
- [RtcRegionResponse](/resources/channels#rtcregionresponse)
- [SavedMessageEntryListResponse](/resources/users#savedmessageentrylistresponse)
- [SavedMessageEntryResponse](/resources/common#savedmessageentryresponse)
- [SaveMessageRequest](/resources/users#savemessagerequest)
- [ScheduleAccountDeletionRequest](/resources/admin#scheduleaccountdeletionrequest)
- [ScheduledMessageAllowedMentionsSchema](/resources/common#scheduledmessageallowedmentionsschema)
- [ScheduledMessageReferenceSchema](/resources/common#scheduledmessagereferenceschema)
- [ScheduledMessageResponseSchema](/resources/users#scheduledmessageresponseschema)
- [SearchAuditLogsRequest](/resources/admin#searchauditlogsrequest)
- [SearchGuildsRequest](/resources/admin#searchguildsrequest)
- [SearchGuildsResponse](/resources/admin#searchguildsresponse)
- [SearchReportsRequest](/resources/admin#searchreportsrequest)
- [SearchReportsResponse](/resources/admin#searchreportsresponse)
- [SearchUsersRequest](/resources/admin#searchusersrequest)
- [SearchUsersResponse](/resources/admin#searchusersresponse)
- [SendPasswordResetRequest](/resources/admin#sendpasswordresetrequest)
- [SentryWebhook](/resources/webhooks#sentrywebhook)
- [SetUserAclsRequest](/resources/admin#setuseraclsrequest)
- [SetUserBotStatusRequest](/resources/admin#setuserbotstatusrequest)
- [SetUserSystemStatusRequest](/resources/admin#setusersystemstatusrequest)
- [SetUserTraitsRequest](/resources/admin#setusertraitsrequest)
- [ShrinkVisionarySlotsRequest](/resources/admin#shrinkvisionaryslotsrequest)
- [ShutdownGuildRequest](/resources/admin#shutdownguildrequest)
- [SlackWebhookRequest](/resources/webhooks#slackwebhookrequest)
- [SnowflakeReservationEntry](/resources/common#snowflakereservationentry)
- [SnowflakeType](/resources/guilds#snowflaketype)
- [SsoCompleteRequest](/resources/auth#ssocompleterequest)
- [SsoCompleteResponse](/resources/auth#ssocompleteresponse)
- [SsoConfigResponse](/resources/common#ssoconfigresponse)
- [SsoStartRequest](/resources/auth#ssostartrequest)
- [SsoStartResponse](/resources/auth#ssostartresponse)
- [SsoStatusResponse](/resources/auth#ssostatusresponse)
- [StickerAnimationOptions](/resources/common#stickeranimationoptions)
- [StreamPreviewUploadBodySchema](/resources/channels#streampreviewuploadbodyschema)
- [StreamUpdateBodySchema](/resources/channels#streamupdatebodyschema)
- [SuccessResponse](/resources/admin#successresponse)
- [SudoMfaMethodsResponse](/resources/users#sudomfamethodsresponse)
- [SudoVerificationSchema](/resources/users#sudoverificationschema)
- [SuspiciousActivityFlags](/resources/common#suspiciousactivityflags)
- [SwapVisionarySlotsRequest](/resources/admin#swapvisionaryslotsrequest)
- [SystemChannelFlags](/resources/common#systemchannelflags)
- [SystemDmJobResponse](/resources/admin#systemdmjobresponse)
- [TempBanUserRequest](/resources/admin#tempbanuserrequest)
- [TenorCategoryTagResponse](/resources/common#tenorcategorytagresponse)
- [TenorFeaturedResponse](/resources/common#tenorfeaturedresponse)
- [TenorGifResponse](/resources/common#tenorgifresponse)
- [TenorRegisterShareRequest](/resources/common#tenorregistersharerequest)
- [TerminateSessionsRequest](/resources/admin#terminatesessionsrequest)
- [TerminateSessionsResponse](/resources/admin#terminatesessionsresponse)
- [ThemeCreateRequest](/resources/themes#themecreaterequest)
- [ThemeCreateResponse](/resources/themes#themecreateresponse)
- [TicketResponse](/resources/reports#ticketresponse)
- [TimeFormatTypes](/resources/common#timeformattypes)
- [TokenRequest](/resources/oauth2#tokenrequest)
- [TransferGuildOwnershipRequest](/resources/admin#transferguildownershiprequest)
- [TriggerGuildArchiveRequest](/resources/admin#triggerguildarchiverequest)
- [TriggerUserArchiveRequest](/resources/admin#triggeruserarchiverequest)
- [UnlinkPhoneRequest](/resources/admin#unlinkphonerequest)
- [UnsignedInt64Type](/resources/common#unsignedint64type)
- [UpdateConnectionRequest](/resources/common#updateconnectionrequest)
- [UpdateFavoriteMemeBodySchema](/resources/saved_media#updatefavoritememebodyschema)
- [UpdateGuildFeaturesRequest](/resources/admin#updateguildfeaturesrequest)
- [UpdateGuildNameRequest](/resources/admin#updateguildnamerequest)
- [UpdateGuildSettingsRequest](/resources/admin#updateguildsettingsrequest)
- [UpdateGuildVanityRequest](/resources/admin#updateguildvanityrequest)
- [UpdateSuspiciousActivityFlagsRequest](/resources/admin#updatesuspiciousactivityflagsrequest)
- [UpdateUserFlagsRequest](/resources/admin#updateuserflagsrequest)
- [UpdateVoiceRegionRequest](/resources/admin#updatevoiceregionrequest)
- [UpdateVoiceRegionResponse](/resources/admin#updatevoiceregionresponse)
- [UpdateVoiceServerRequest](/resources/admin#updatevoiceserverrequest)
- [UpdateVoiceServerResponse](/resources/admin#updatevoiceserverresponse)
- [UrlResponse](/resources/billing#urlresponse)
- [UserAdminResponseSchema](/resources/common#useradminresponseschema)
- [UserAuthenticatorTypes](/resources/common#userauthenticatortypes)
- [UserContactChangeLogEntrySchema](/resources/common#usercontactchangelogentryschema)
- [UserFlags](/resources/common#userflags)
- [UserGuildSettingsResponse](/resources/users#userguildsettingsresponse)
- [UserGuildSettingsUpdateRequest](/resources/users#userguildsettingsupdaterequest)
- [UserMutationResponse](/resources/admin#usermutationresponse)
- [UsernameSuggestionsRequest](/resources/auth#usernamesuggestionsrequest)
- [UsernameSuggestionsResponse](/resources/auth#usernamesuggestionsresponse)
- [UsernameType](/resources/users#usernametype)
- [UserNoteResponse](/resources/users#usernoteresponse)
- [UserNotesRecordResponse](/resources/users#usernotesrecordresponse)
- [UserNoteUpdateRequest](/resources/users#usernoteupdaterequest)
- [UserNotificationSettings](/resources/common#usernotificationsettings)
- [UserPartialResponse](/resources/users#userpartialresponse)
- [UserPremiumTypes](/resources/common#userpremiumtypes)
- [UserPrivateResponse](/resources/users#userprivateresponse)
- [UserProfileFullResponse](/resources/users#userprofilefullresponse)
- [UserReportCategoryEnum](/resources/common#userreportcategoryenum)
- [UserSessionResponse](/resources/common#usersessionresponse)
- [UserSettingsResponse](/resources/users#usersettingsresponse)
- [UserSettingsUpdateRequest](/resources/users#usersettingsupdaterequest)
- [UserStatusType](/resources/common#userstatustype)
- [UserTagCheckResponse](/resources/users#usertagcheckresponse)
- [UserThemeType](/resources/common#userthemetype)
- [UserUpdateWithVerificationRequest](/resources/users#userupdatewithverificationrequest)
- [ValidationErrorCodeSchema](/resources/common#validationerrorcodeschema)
- [ValidationErrorItem](/resources/common#validationerroritem)
- [VerifyAndCreateConnectionRequest](/resources/common#verifyandcreateconnectionrequest)
- [VerifyEmailRequest](/resources/auth#verifyemailrequest)
- [VerifyUserEmailRequest](/resources/admin#verifyuseremailrequest)
- [VisionarySlotOperationResponse](/resources/admin#visionaryslotoperationresponse)
- [VisionarySlotSchema](/resources/common#visionaryslotschema)
- [VoiceRegionAdminResponse](/resources/common#voiceregionadminresponse)
- [VoiceRegionWithServersResponse](/resources/common#voiceregionwithserversresponse)
- [VoiceServerAdminResponse](/resources/common#voiceserveradminresponse)
- [WebAuthnAuthenticateRequest](/resources/auth#webauthnauthenticaterequest)
- [WebAuthnAuthenticationOptionsResponse](/resources/auth#webauthnauthenticationoptionsresponse)
- [WebAuthnChallengeResponse](/resources/users#webauthnchallengeresponse)
- [WebAuthnCredentialListResponse](/resources/users#webauthncredentiallistresponse)
- [WebAuthnCredentialResponse](/resources/common#webauthncredentialresponse)
- [WebAuthnCredentialUpdateRequest](/resources/users#webauthncredentialupdaterequest)
- [WebAuthnMfaRequest](/resources/auth#webauthnmfarequest)
- [WebAuthnRegisterRequest](/resources/users#webauthnregisterrequest)
- [WebhookCreateRequest](/resources/webhooks#webhookcreaterequest)
- [WebhookReceivedResponse](/resources/billing#webhookreceivedresponse)
- [WebhookResponse](/resources/webhooks#webhookresponse)
- [WebhookTokenResponse](/resources/webhooks#webhooktokenresponse)
- [WebhookTokenUpdateRequest](/resources/webhooks#webhooktokenupdaterequest)
- [WebhookType](/resources/common#webhooktype)
- [WebhookUpdateRequest](/resources/webhooks#webhookupdaterequest)
- [WellKnownFluxerResponse](/resources/instance#wellknownfluxerresponse)
- [AdminArchiveResponseSchemaSubjectType](#adminarchiveresponseschemasubjecttype)
- [ListArchivesRequestSubjectType](#listarchivesrequestsubjecttype)
- [PurgeGuildAssetResultSchemaAssetType](#purgeguildassetresultschemaassettype)
- [SearchAuditLogsRequestSortBy](#searchauditlogsrequestsortby)
- [SearchAuditLogsRequestSortOrder](#searchauditlogsrequestsortorder)
- [MessageShredStatusProgressResponseStatus](#messageshredstatusprogressresponsestatus)
- [SearchReportsRequestSortBy](#searchreportsrequestsortby)
- [NcmecSubmissionStatusResponseStatus](#ncmecsubmissionstatusresponsestatus)
- [RefreshSearchIndexRequestIndexType](#refreshsearchindexrequestindextype)
- [SystemDmJobResponseStatus](#systemdmjobresponsestatus)
- [ChannelUpdateTextRequestType](#channelupdatetextrequesttype)
- [ChannelOverwriteRequestType](#channeloverwriterequesttype)
- [ChannelUpdateVoiceRequestType](#channelupdatevoicerequesttype)
- [ChannelUpdateCategoryRequestType](#channelupdatecategoryrequesttype)
- [ChannelUpdateLinkRequestType](#channelupdatelinkrequesttype)
- [ChannelUpdateGroupDmRequestType](#channelupdategroupdmrequesttype)
- [MessageResponseSchemaType](#messageresponseschematype)
- [DonationCheckoutRequestCurrency](#donationcheckoutrequestcurrency)
- [DonationCheckoutRequestInterval](#donationcheckoutrequestinterval)
- [GuildUpdateRequestSplashCardAlignment](#guildupdaterequestsplashcardalignment)
- [GuildUpdateRequestMfaMethod](#guildupdaterequestmfamethod)
- [GuildMemberSearchRequestSortBy](#guildmembersearchrequestsortby)
- [RevokeRequestFormTokenTypeHint](#revokerequestformtokentypehint)
- [PriceIdsResponseCurrency](#priceidsresponsecurrency)

135
fluxer_docs/resources/packs.mdx Normal file
View File

@@ -0,0 +1,135 @@
---
title: 'Packs'
description: 'Packs object schemas from the Fluxer API.'
---
<a id="packcreaterequest"></a>
## PackCreateRequest
**Related endpoints**
- [`POST /packs/{pack_type}`](/api-reference/packs/create-pack)
| Field | Type | Description |
|-------|------|-------------|
| description? | ?string | The description of the pack |
| name | string | The name of the pack |
<a id="packdashboardresponse"></a>
## PackDashboardResponse
**Related endpoints**
- [`GET /packs`](/api-reference/packs/list-user-packs)
| Field | Type | Description |
|-------|------|-------------|
| emoji | [PackDashboardResponseEmoji](#packdashboardresponseemoji) | Dashboard section for emoji packs |
| sticker | [PackDashboardResponseEmoji](#packdashboardresponseemoji) | Dashboard section for sticker packs |
<a id="packinvitemetadataresponse"></a>
## PackInviteMetadataResponse
| Field | Type | Description |
|-------|------|-------------|
| code | string | The unique invite code |
| created_at | string (date-time) | ISO8601 timestamp of when the invite was created |
| expires_at? | ?string (date-time) | ISO8601 timestamp of when the invite expires |
| inviter? | ?[UserPartialResponse](#userpartialresponse) | The user who created the invite |
| max_uses | integer (int32) | The maximum number of times this invite can be used |
| pack | [PackInviteMetadataResponsePack](#packinvitemetadataresponsepack) | The pack this invite is for |
| temporary | boolean | Whether the invite grants temporary access |
| type | enum&lt;`2`, `3`&gt; | The type of pack invite (emoji or sticker pack) |
| uses | integer (int32) | The number of times this invite has been used |
<a id="packinviteresponse"></a>
## PackInviteResponse
| Field | Type | Description |
|-------|------|-------------|
| code | string | The unique invite code |
| expires_at? | ?string (date-time) | ISO8601 timestamp of when the invite expires |
| inviter? | ?[UserPartialResponse](#userpartialresponse) | The user who created the invite |
| pack | [PackInviteMetadataResponsePack](#packinvitemetadataresponsepack) | The pack this invite is for |
| temporary | boolean | Whether the invite grants temporary access |
| type | enum&lt;`2`, `3`&gt; | The type of pack invite (emoji or sticker pack) |
<a id="packsummaryresponse"></a>
## PackSummaryResponse
**Related endpoints**
- [`POST /packs/{pack_type}`](/api-reference/packs/create-pack)
- [`PATCH /packs/{pack_id}`](/api-reference/packs/update-pack)
| Field | Type | Description |
|-------|------|-------------|
| created_at | string (date-time) | ISO8601 timestamp of when the pack was created |
| creator_id | [SnowflakeType](#snowflaketype) | The ID of the user who created the pack |
| description | ?string | The description of the pack |
| id | [SnowflakeType](#snowflaketype) | The unique identifier (snowflake) for the pack |
| installed_at? | string (date-time) | ISO8601 timestamp of when the pack was installed by the user |
| name | string | The display name of the pack |
| type | enum&lt;`emoji`, `sticker`&gt; | The type of expression pack (emoji or sticker) |
| updated_at | string (date-time) | ISO8601 timestamp of when the pack was last updated |
<a id="packupdaterequest"></a>
## PackUpdateRequest
**Related endpoints**
- [`PATCH /packs/{pack_id}`](/api-reference/packs/update-pack)
| Field | Type | Description |
|-------|------|-------------|
| description? | ?string | The new description of the pack |
| name? | string | The new name of the pack |
<a id="stickeranimationoptions"></a>
## StickerAnimationOptions
Sticker animation preference
| Value | Description |
|-------|-------------|
| `0` | Always animate stickers |
| `1` | Animate stickers on hover/interaction |
| `2` | Never animate stickers |
<a id="packdashboardresponseemoji"></a>
## PackDashboardResponseEmoji
Dashboard section for emoji packs
| Field | Type | Description |
|-------|------|-------------|
| created | [PackSummaryResponse](#packsummaryresponse)[] | List of packs the user has created |
| created_limit | integer (int32) | Maximum number of packs the user can create |
| installed | [PackSummaryResponse](#packsummaryresponse)[] | List of packs the user has installed |
| installed_limit | integer (int32) | Maximum number of packs the user can install |
<a id="packinvitemetadataresponsepack"></a>
## PackInviteMetadataResponsePack
The pack this invite is for
| Field | Type | Description |
|-------|------|-------------|
| created_at | string (date-time) | ISO8601 timestamp of when the pack was created |
| creator | [UserPartialResponse](#userpartialresponse) | |
| creator_id | [SnowflakeType](#snowflaketype) | The ID of the user who created the pack |
| description? | ?string | The description of the pack |
| id | [SnowflakeType](#snowflaketype) | The unique identifier for the pack |
| name | string | The display name of the pack |
| type | enum&lt;`emoji`, `sticker`&gt; | The type of pack (emoji or sticker) |
| updated_at | string (date-time) | ISO8601 timestamp of when the pack was last updated |

41
fluxer_docs/resources/premium.mdx Normal file
View File

@@ -0,0 +1,41 @@
---
title: 'Premium'
description: 'Premium object schemas from the Fluxer API.'
---
<a id="priceidsresponse"></a>
## PriceIdsResponse
**Related endpoints**
- [`GET /premium/price-ids`](/api-reference/premium/get-stripe-price-ids)
| Field | Type | Description |
|-------|------|-------------|
| currency | [PriceIdsResponseCurrency](#priceidsresponsecurrency) | Currency for the prices |
| gift_1_month? | ?[SnowflakeType](#snowflaketype) | Stripe price ID for the 1 month gift |
| gift_1_year? | ?[SnowflakeType](#snowflaketype) | Stripe price ID for the 1 year gift |
| monthly? | ?[SnowflakeType](#snowflaketype) | Stripe price ID for the monthly subscription |
| yearly? | ?[SnowflakeType](#snowflaketype) | Stripe price ID for the yearly subscription |
<a id="visionaryslotschema"></a>
## VisionarySlotSchema
| Field | Type | Description |
|-------|------|-------------|
| slot_index | integer (int32) | The slot index |
| user_id | ?[SnowflakeType](#snowflaketype) \| enum&lt;`-1`&gt; | User ID that reserved this slot, or null if unreserved (special value -1 is also valid) |
<a id="priceidsresponsecurrency"></a>
## PriceIdsResponseCurrency
Currency for the prices
| Value | Description |
|-------|-------------|
| `USD` | - |
| `EUR` | - |

17
fluxer_docs/resources/read_states.mdx Normal file
View File

@@ -0,0 +1,17 @@
---
title: 'Read states'
description: 'Read states object schemas from the Fluxer API.'
---
<a id="readstateackbulkrequest"></a>
## ReadStateAckBulkRequest
**Related endpoints**
- [`POST /read-states/ack-bulk`](/api-reference/read-states/mark-channels-as-read)
| Field | Type | Description |
|-------|------|-------------|
| read_states | [DeleteMessageRequest](#deletemessagerequest)[] | Array of channel/message pairs to acknowledge |

196
fluxer_docs/resources/reports.mdx Normal file
View File

@@ -0,0 +1,196 @@
---
title: 'Reports'
description: 'Reports object schemas from the Fluxer API.'
---
<a id="dsareportemailsendrequest"></a>
## DsaReportEmailSendRequest
**Related endpoints**
- [`POST /reports/dsa/email/send`](/api-reference/reports/send-dsa-report-email)
| Field | Type | Description |
|-------|------|-------------|
| email | [EmailType](#emailtype) | |
<a id="dsareportemailverifyrequest"></a>
## DsaReportEmailVerifyRequest
**Related endpoints**
- [`POST /reports/dsa/email/verify`](/api-reference/reports/verify-dsa-report-email)
| Field | Type | Description |
|-------|------|-------------|
| code | string | Verification code received via email |
| email | [EmailType](#emailtype) | |
<a id="dsareportguildrequest"></a>
## DsaReportGuildRequest
| Field | Type | Description |
|-------|------|-------------|
| additional_info? | string | Additional context or details about the report |
| category | [GuildReportCategoryEnum](#guildreportcategoryenum) | |
| guild_id | [SnowflakeType](#snowflaketype) | |
| invite_code? | string | Invite code used to access the guild |
| report_type | enum&lt;`guild`&gt; | Type of report |
| reporter_country_of_residence | enum&lt;`AT`, `BE`, `BG`, `HR`, `CY`, `CZ`, `DK`, `EE`, `FI`, `FR`, `DE`, `GR`, `HU`, `IE`, `IT`, `LV`, `LT`, `LU`, `MT`, `NL`, `PL`, `PT`, `RO`, `SK`, `SI`, `ES`, `SE`&gt; | EU country code of the reporter residence |
| reporter_fluxer_tag? | string | Fluxer tag of the reporter if they have an account |
| reporter_full_legal_name | string | Full legal name of the person filing the report |
| ticket | string | Verification ticket obtained from email verification |
<a id="dsareportmessagerequest"></a>
## DsaReportMessageRequest
| Field | Type | Description |
|-------|------|-------------|
| additional_info? | string | Additional context or details about the report |
| category | [MessageReportCategoryEnum](#messagereportcategoryenum) | |
| message_link | string | Link to the message being reported |
| report_type | enum&lt;`message`&gt; | Type of report |
| reported_user_tag? | string | Fluxer tag of the user who sent the message |
| reporter_country_of_residence | enum&lt;`AT`, `BE`, `BG`, `HR`, `CY`, `CZ`, `DK`, `EE`, `FI`, `FR`, `DE`, `GR`, `HU`, `IE`, `IT`, `LV`, `LT`, `LU`, `MT`, `NL`, `PL`, `PT`, `RO`, `SK`, `SI`, `ES`, `SE`&gt; | EU country code of the reporter residence |
| reporter_fluxer_tag? | string | Fluxer tag of the reporter if they have an account |
| reporter_full_legal_name | string | Full legal name of the person filing the report |
| ticket | string | Verification ticket obtained from email verification |
<a id="dsareportrequest"></a>
## DsaReportRequest
**Related endpoints**
- [`POST /reports/dsa`](/api-reference/reports/create-dsa-report)
Type: [DsaReportMessageRequest](#dsareportmessagerequest) \| [DsaReportUserRequest](#dsareportuserrequest) \| [DsaReportGuildRequest](#dsareportguildrequest)
<a id="dsareportuserrequest"></a>
## DsaReportUserRequest
| Field | Type | Description |
|-------|------|-------------|
| additional_info? | string | Additional context or details about the report |
| category | [UserReportCategoryEnum](#userreportcategoryenum) | |
| report_type | enum&lt;`user`&gt; | Type of report |
| reporter_country_of_residence | enum&lt;`AT`, `BE`, `BG`, `HR`, `CY`, `CZ`, `DK`, `EE`, `FI`, `FR`, `DE`, `GR`, `HU`, `IE`, `IT`, `LV`, `LT`, `LU`, `MT`, `NL`, `PL`, `PT`, `RO`, `SK`, `SI`, `ES`, `SE`&gt; | EU country code of the reporter residence |
| reporter_fluxer_tag? | string | Fluxer tag of the reporter if they have an account |
| reporter_full_legal_name | string | Full legal name of the person filing the report |
| ticket | string | Verification ticket obtained from email verification |
| user_id? | [SnowflakeType](#snowflaketype) | |
| user_tag? | string | Fluxer tag of the user being reported |
<a id="okresponse"></a>
## OkResponse
**Related endpoints**
- [`POST /reports/dsa/email/send`](/api-reference/reports/send-dsa-report-email)
| Field | Type | Description |
|-------|------|-------------|
| ok | boolean | Whether the operation was successful |
<a id="reportguildrequest"></a>
## ReportGuildRequest
**Related endpoints**
- [`POST /reports/guild`](/api-reference/reports/report-guild)
| Field | Type | Description |
|-------|------|-------------|
| additional_info? | string | Additional context or details about the report |
| category | [GuildReportCategoryEnum](#guildreportcategoryenum) | |
| guild_id | [SnowflakeType](#snowflaketype) | |
<a id="reportmessagerequest"></a>
## ReportMessageRequest
**Related endpoints**
- [`POST /reports/message`](/api-reference/reports/report-message)
| Field | Type | Description |
|-------|------|-------------|
| additional_info? | string | Additional context or details about the report |
| category | [MessageReportCategoryEnum](#messagereportcategoryenum) | |
| channel_id | [SnowflakeType](#snowflaketype) | |
| message_id | [SnowflakeType](#snowflaketype) | |
<a id="reportresponse"></a>
## ReportResponse
**Related endpoints**
- [`POST /reports/dsa`](/api-reference/reports/create-dsa-report)
- [`POST /reports/guild`](/api-reference/reports/report-guild)
- [`POST /reports/message`](/api-reference/reports/report-message)
- [`POST /reports/user`](/api-reference/reports/report-user)
| Field | Type | Description |
|-------|------|-------------|
| report_id | [SnowflakeType](#snowflaketype) | The unique identifier for this report |
| reported_at | string | ISO 8601 timestamp when the report was submitted |
| status | string | Current status of the report (pending, reviewed, resolved) |
<a id="reportstatus"></a>
## ReportStatus
The status of the report
| Value | Description |
|-------|-------------|
| `0` | Report is pending review |
| `1` | Report has been resolved |
<a id="reporttype"></a>
## ReportType
The type of entity being reported
| Value | Description |
|-------|-------------|
| `0` | Report of a message |
| `1` | Report of a user |
| `2` | Report of a guild |
<a id="reportuserrequest"></a>
## ReportUserRequest
**Related endpoints**
- [`POST /reports/user`](/api-reference/reports/report-user)
| Field | Type | Description |
|-------|------|-------------|
| additional_info? | string | Additional context or details about the report |
| category | [UserReportCategoryEnum](#userreportcategoryenum) | |
| guild_id? | [SnowflakeType](#snowflaketype) | |
| user_id | [SnowflakeType](#snowflaketype) | |
<a id="ticketresponse"></a>
## TicketResponse
**Related endpoints**
- [`POST /reports/dsa/email/verify`](/api-reference/reports/verify-dsa-report-email)
| Field | Type | Description |
|-------|------|-------------|
| ticket | string | A temporary ticket token for subsequent operations |

93
fluxer_docs/resources/saved_media.mdx Normal file
View File

@@ -0,0 +1,93 @@
---
title: 'Saved media'
description: 'Saved media object schemas from the Fluxer API.'
---
<a id="createfavoritememebodyschema"></a>
## CreateFavoriteMemeBodySchema
**Related endpoints**
- [`POST /channels/{channel_id}/messages/{message_id}/memes`](/api-reference/saved-media/create-meme-from-message)
| Field | Type | Description |
|-------|------|-------------|
| alt_text? | ?string | Alternative text description for accessibility |
| attachment_id? | ?[SnowflakeType](#snowflaketype) | ID of the message attachment to save as a meme |
| embed_index? | ?integer (int64) | Index of the message embed to save as a meme |
| name | string | Display name for the meme |
| tags? | ?string[] | Tags for categorizing and searching the meme |
<a id="createfavoritememefromurlbodyschema"></a>
## CreateFavoriteMemeFromUrlBodySchema
**Related endpoints**
- [`POST /users/@me/memes`](/api-reference/saved-media/create-meme-from-url)
| Field | Type | Description |
|-------|------|-------------|
| alt_text? | ?string | Alternative text description for accessibility |
| klipy_slug? | ?string | Klipy clip slug if the URL is from Klipy |
| name? | ?string | Display name for the meme |
| tags? | ?string[] | Tags for categorizing and searching the meme |
| tenor_slug_id? | ?[SnowflakeType](#snowflaketype) | Tenor view/&lt;slug&gt;-&lt;id&gt; identifier if the URL is from Tenor |
| url | string (uri) | URL of the image or video to save as a favorite meme |
<a id="favoritememelistresponse"></a>
## FavoriteMemeListResponse
**Related endpoints**
- [`GET /users/@me/memes`](/api-reference/saved-media/list-favorite-memes)
Type: [FavoriteMemeResponse](#favoritememeresponse)[]
<a id="favoritememeresponse"></a>
## FavoriteMemeResponse
**Related endpoints**
- [`GET /users/@me/memes/{meme_id}`](/api-reference/saved-media/get-favorite-meme)
- [`POST /channels/{channel_id}/messages/{message_id}/memes`](/api-reference/saved-media/create-meme-from-message)
- [`POST /users/@me/memes`](/api-reference/saved-media/create-meme-from-url)
- [`PATCH /users/@me/memes/{meme_id}`](/api-reference/saved-media/update-favorite-meme)
| Field | Type | Description |
|-------|------|-------------|
| alt_text? | ?string | Alternative text description for accessibility |
| attachment_id | [SnowflakeType](#snowflaketype) | ID of the attachment storing the meme |
| content_hash? | ?string | Hash of the file content for deduplication |
| content_type | string | MIME type of the meme file |
| duration? | ?number | Duration of the video in seconds |
| filename | string | Original filename of the meme |
| height? | ?integer (int53) | Height of the image or video in pixels |
| id | [SnowflakeType](#snowflaketype) | Unique identifier for the favorite meme |
| is_gifv? | boolean | Whether the meme is a video converted from GIF |
| klipy_slug? | ?string | Klipy clip slug if the meme was sourced from Klipy |
| name | string | Display name of the meme |
| size | number | File size in bytes |
| tags | string[] | Tags for categorizing and searching the meme |
| tenor_slug_id? | ?[SnowflakeType](#snowflaketype) | Tenor view/&lt;slug&gt;-&lt;id&gt; identifier if the meme was sourced from Tenor |
| url | string | CDN URL to access the meme |
| user_id | [SnowflakeType](#snowflaketype) | ID of the user who owns this favorite meme |
| width? | ?integer (int53) | Width of the image or video in pixels |
<a id="updatefavoritememebodyschema"></a>
## UpdateFavoriteMemeBodySchema
**Related endpoints**
- [`PATCH /users/@me/memes/{meme_id}`](/api-reference/saved-media/update-favorite-meme)
| Field | Type | Description |
|-------|------|-------------|
| alt_text? | ?string | Alternative text description for accessibility |
| name? | string | Display name for the meme |
| tags? | ?string[] | New tags for categorizing and searching the meme |

62
fluxer_docs/resources/search.mdx Normal file
View File

@@ -0,0 +1,62 @@
---
title: 'Search'
description: 'Search object schemas from the Fluxer API.'
---
<a id="globalsearchmessagesrequest"></a>
## GlobalSearchMessagesRequest
**Related endpoints**
- [`POST /search/messages`](/api-reference/search/search-messages)
| Field | Type | Description |
|-------|------|-------------|
| attachment_extension? | string[] | File extensions to filter by |
| attachment_filename? | string[] | Attachment filenames to filter by |
| author_id? | [SnowflakeType](#snowflaketype)[] | Author user IDs to filter by |
| author_type? | [MessageAuthorType](#messageauthortype)[] | Author types to filter by |
| channel_id? | [SnowflakeType](#snowflaketype)[] | Channel IDs to search in |
| channel_ids? | [SnowflakeType](#snowflaketype)[] | Specific channel IDs to search in |
| content? | string | Text content to search for |
| contents? | string[] | Multiple content queries to search for |
| context_channel_id? | [SnowflakeType](#snowflaketype) | |
| context_guild_id? | [SnowflakeType](#snowflaketype) | |
| embed_provider? | string[] | Embed providers to filter by |
| embed_type? | [MessageEmbedType](#messageembedtype)[] | Embed types to filter by |
| exact_phrases? | string[] | Exact phrases that must appear contiguously in message content |
| exclude_attachment_extension? | string[] | File extensions to exclude |
| exclude_attachment_filename? | string[] | Attachment filenames to exclude |
| exclude_author_id? | [SnowflakeType](#snowflaketype)[] | Author user IDs to exclude |
| exclude_author_type? | [MessageAuthorType](#messageauthortype)[] | Author types to exclude |
| exclude_channel_id? | [SnowflakeType](#snowflaketype)[] | Channel IDs to exclude from search |
| exclude_embed_provider? | string[] | Embed providers to exclude |
| exclude_embed_type? | [MessageEmbedType](#messageembedtype)[] | Embed types to exclude |
| exclude_has? | [MessageContentType](#messagecontenttype)[] | Content types the message must not have |
| exclude_link_hostname? | string[] | Link hostnames to exclude |
| exclude_mentions? | [SnowflakeType](#snowflaketype)[] | User IDs that must not be mentioned |
| has? | [MessageContentType](#messagecontenttype)[] | Content types the message must have |
| hits_per_page? | integer (int32) | Number of results per page (1-25) |
| include_nsfw? | boolean | Whether to include NSFW channel results |
| link_hostname? | string[] | Link hostnames to filter by |
| max_id? | [SnowflakeType](#snowflaketype) | |
| mention_everyone? | boolean | Filter by whether message mentions everyone |
| mentions? | [SnowflakeType](#snowflaketype)[] | User IDs that must be mentioned |
| min_id? | [SnowflakeType](#snowflaketype) | |
| page? | integer (int64) | Page number for pagination |
| pinned? | boolean | Filter by pinned status |
| scope? | [MessageSearchScope](#messagesearchscope) | |
| sort_by? | [MessageSortField](#messagesortfield) | |
| sort_order? | [MessageSortOrder](#messagesortorder) | |
<a id="messagesearchresponse"></a>
## MessageSearchResponse
**Related endpoints**
- [`POST /search/messages`](/api-reference/search/search-messages)
Type: [MessageSearchResultsResponse](#messagesearchresultsresponse) \| [MessageSearchIndexingResponse](#messagesearchindexingresponse)

29
fluxer_docs/resources/themes.mdx Normal file
View File

@@ -0,0 +1,29 @@
---
title: 'Themes'
description: 'Themes object schemas from the Fluxer API.'
---
<a id="themecreaterequest"></a>
## ThemeCreateRequest
**Related endpoints**
- [`POST /users/@me/themes`](/api-reference/themes/create-theme)
| Field | Type | Description |
|-------|------|-------------|
| css | string | CSS text to store and share |
<a id="themecreateresponse"></a>
## ThemeCreateResponse
**Related endpoints**
- [`POST /users/@me/themes`](/api-reference/themes/create-theme)
| Field | Type | Description |
|-------|------|-------------|
| id | [SnowflakeType](#snowflaketype) | The unique identifier for the created theme |

1468
fluxer_docs/resources/users.mdx Normal file
View File

File diff suppressed because it is too large Load Diff

325
fluxer_docs/resources/webhooks.mdx Normal file
View File

@@ -0,0 +1,325 @@
---
title: 'Webhooks'
description: 'Webhooks object schemas from the Fluxer API.'
---
<a id="githubwebhook"></a>
## GitHubWebhook
**Related endpoints**
- [`POST /webhooks/{webhook_id}/{token}/github`](/api-reference/webhooks/execute-github-webhook)
| Field | Type | Description |
|-------|------|-------------|
| action? | ?string | |
| answer? | ?[GitHubWebhookAnswer](#githubwebhookanswer) | |
| check_run? | ?[GitHubWebhookCheckRun](#githubwebhookcheckrun) | |
| check_suite? | ?[GitHubWebhookCheckSuite](#githubwebhookchecksuite) | |
| comment? | ?[GitHubWebhookAnswer](#githubwebhookanswer) | |
| commits? | ?[GitHubWebhookCommitsItem](#githubwebhookcommitsitem)[] | |
| compare? | ?string | |
| discussion? | ?[GitHubWebhookDiscussion](#githubwebhookdiscussion) | |
| forced? | ?boolean | |
| forkee? | ?[GitHubWebhookForkee](#githubwebhookforkee) | |
| head_commit? | ?[GitHubWebhookCommitsItem](#githubwebhookcommitsitem) | |
| issue? | ?[GitHubWebhookIssue](#githubwebhookissue) | |
| member? | ?[GitHubWebhookMember](#githubwebhookmember) | |
| pull_request? | ?[GitHubWebhookIssue](#githubwebhookissue) | |
| ref? | ?string | |
| ref_type? | ?string | |
| release? | ?[GitHubWebhookRelease](#githubwebhookrelease) | |
| repository? | ?[GitHubWebhookForkee](#githubwebhookforkee) | |
| review? | ?[GitHubWebhookReview](#githubwebhookreview) | |
| sender | [GitHubWebhookMember](#githubwebhookmember) | |
<a id="sentrywebhook"></a>
## SentryWebhook
**Related endpoints**
- [`POST /webhooks/{webhook_id}/{token}/sentry`](/api-reference/webhooks/execute-sentry-webhook)
| Field | Type | Description |
|-------|------|-------------|
| action? | ?string | |
| actor? | ?[SentryWebhookActor](#sentrywebhookactor) | |
| data? | ?[SentryWebhookData](#sentrywebhookdata) | |
| installation? | ?[SentryWebhookInstallation](#sentrywebhookinstallation) | |
<a id="slackwebhookrequest"></a>
## SlackWebhookRequest
**Related endpoints**
- [`POST /webhooks/{webhook_id}/{token}/slack`](/api-reference/webhooks/execute-slack-webhook)
| Field | Type | Description |
|-------|------|-------------|
| attachments? | [SlackWebhookRequestAttachmentsItem](#slackwebhookrequestattachmentsitem)[] | Array of attachment objects |
| icon_url? | string | Override the default icon of the webhook |
| text? | string | Main text content of the message |
| username? | string | Override the default username of the webhook |
<a id="webhookcreaterequest"></a>
## WebhookCreateRequest
**Related endpoints**
- [`POST /channels/{channel_id}/webhooks`](/api-reference/webhooks/create-webhook)
| Field | Type | Description |
|-------|------|-------------|
| avatar? | ?[Base64ImageType](#base64imagetype) | The avatar image as a base64-encoded data URI |
| name | string | The name of the webhook |
<a id="webhookresponse"></a>
## WebhookResponse
**Related endpoints**
- [`GET /channels/{channel_id}/webhooks`](/api-reference/webhooks/list-channel-webhooks)
- [`GET /guilds/{guild_id}/webhooks`](/api-reference/webhooks/list-guild-webhooks)
- [`GET /webhooks/{webhook_id}`](/api-reference/webhooks/get-webhook)
- [`POST /channels/{channel_id}/webhooks`](/api-reference/webhooks/create-webhook)
- [`PATCH /webhooks/{webhook_id}`](/api-reference/webhooks/update-webhook)
| Field | Type | Description |
|-------|------|-------------|
| avatar? | ?string | The hash of the webhook avatar image |
| channel_id | [SnowflakeType](#snowflaketype) | The ID of the channel this webhook posts to |
| guild_id | [SnowflakeType](#snowflaketype) | The ID of the guild this webhook belongs to |
| id | [SnowflakeType](#snowflaketype) | The unique identifier (snowflake) for the webhook |
| name | string | The display name of the webhook |
| token | string | The secure token used to execute the webhook |
| user | [UserPartialResponse](#userpartialresponse) | |
<a id="webhooktokenresponse"></a>
## WebhookTokenResponse
**Related endpoints**
- [`GET /webhooks/{webhook_id}/{token}`](/api-reference/webhooks/get-webhook-with-token)
- [`PATCH /webhooks/{webhook_id}/{token}`](/api-reference/webhooks/update-webhook-with-token)
| Field | Type | Description |
|-------|------|-------------|
| avatar? | ?string | The hash of the webhook avatar image |
| channel_id | [SnowflakeType](#snowflaketype) | The ID of the channel this webhook posts to |
| guild_id | [SnowflakeType](#snowflaketype) | The ID of the guild this webhook belongs to |
| id | [SnowflakeType](#snowflaketype) | The unique identifier (snowflake) for the webhook |
| name | string | The display name of the webhook |
| token | string | The secure token used to execute the webhook |
<a id="webhooktokenupdaterequest"></a>
## WebhookTokenUpdateRequest
**Related endpoints**
- [`PATCH /webhooks/{webhook_id}/{token}`](/api-reference/webhooks/update-webhook-with-token)
| Field | Type | Description |
|-------|------|-------------|
| avatar? | ?[Base64ImageType](#base64imagetype) | The new avatar image as a base64-encoded data URI |
| name? | string | The new name of the webhook |
<a id="webhooktype"></a>
## WebhookType
The type of webhook
| Value | Description |
|-------|-------------|
| `1` | Incoming webhook |
| `2` | Channel follower webhook |
<a id="webhookupdaterequest"></a>
## WebhookUpdateRequest
**Related endpoints**
- [`PATCH /webhooks/{webhook_id}`](/api-reference/webhooks/update-webhook)
| Field | Type | Description |
|-------|------|-------------|
| avatar? | ?[Base64ImageType](#base64imagetype) | The new avatar image as a base64-encoded data URI |
| channel_id? | [SnowflakeType](#snowflaketype) | |
| name? | string | The new name of the webhook |
<a id="githubwebhookanswer"></a>
## GitHubWebhookAnswer
| Field | Type | Description |
|-------|------|-------------|
| body | string | |
| commit_id? | ?[SnowflakeType](#snowflaketype) | |
| html_url | string | |
| id | [Int64Type](#int64type) | |
| user | [GitHubWebhookMember](#githubwebhookmember) | |
<a id="githubwebhookcheckrun"></a>
## GitHubWebhookCheckRun
| Field | Type | Description |
|-------|------|-------------|
| check_suite | [GitHubWebhookCheckSuite](#githubwebhookchecksuite) | |
| conclusion? | ?string | |
| details_url? | ?string | |
| html_url | string | |
| name | string | |
| output? | ?[GitHubWebhookCheckRunOutput](#githubwebhookcheckrunoutput) | |
| pull_requests? | ?[GitHubWebhookCheckRunPullRequestsItem](#githubwebhookcheckrunpullrequestsitem)[] | |
<a id="githubwebhookchecksuite"></a>
## GitHubWebhookCheckSuite
| Field | Type | Description |
|-------|------|-------------|
| app | [GuildEmojiUpdateRequest](#guildemojiupdaterequest) | |
| conclusion? | ?string | |
| head_branch? | ?string | |
| head_sha | string | |
| pull_requests? | ?[GitHubWebhookCheckRunPullRequestsItem](#githubwebhookcheckrunpullrequestsitem)[] | |
<a id="githubwebhookcommitsitem"></a>
## GitHubWebhookCommitsItem
| Field | Type | Description |
|-------|------|-------------|
| author | [GitHubWebhookCommitsItemAuthor](#githubwebhookcommitsitemauthor) | |
| id | [SnowflakeType](#snowflaketype) | |
| message | string | |
| url | string | |
<a id="githubwebhookdiscussion"></a>
## GitHubWebhookDiscussion
| Field | Type | Description |
|-------|------|-------------|
| answer_html_url? | ?string | |
| body? | ?string | |
| html_url | string | |
| number | [Int32Type](#int32type) | |
| title | string | |
| user | [GitHubWebhookMember](#githubwebhookmember) | |
<a id="githubwebhookforkee"></a>
## GitHubWebhookForkee
| Field | Type | Description |
|-------|------|-------------|
| full_name | string | |
| html_url | string | |
| id | [Int32Type](#int32type) | |
| name | string | |
<a id="githubwebhookissue"></a>
## GitHubWebhookIssue
| Field | Type | Description |
|-------|------|-------------|
| body? | ?string | |
| html_url | string | |
| id | [Int64Type](#int64type) | |
| number | [Int32Type](#int32type) | |
| title | string | |
| user | [GitHubWebhookMember](#githubwebhookmember) | |
<a id="githubwebhookmember"></a>
## GitHubWebhookMember
| Field | Type | Description |
|-------|------|-------------|
| avatar_url | string | |
| html_url | string | |
| id | [Int32Type](#int32type) | |
| login | string | |
<a id="githubwebhookrelease"></a>
## GitHubWebhookRelease
| Field | Type | Description |
|-------|------|-------------|
| body? | ?string | |
| html_url | string | |
| id | [Int32Type](#int32type) | |
| tag_name | string | |
<a id="githubwebhookreview"></a>
## GitHubWebhookReview
| Field | Type | Description |
|-------|------|-------------|
| body? | ?string | |
| html_url | string | |
| state | string | |
| user | [GitHubWebhookMember](#githubwebhookmember) | |
<a id="sentrywebhookactor"></a>
## SentryWebhookActor
| Field | Type | Description |
|-------|------|-------------|
| id | [SnowflakeType](#snowflaketype) | |
| name | string | |
| type | string | |
<a id="sentrywebhookdata"></a>
## SentryWebhookData
| Field | Type | Description |
|-------|------|-------------|
| issue | [SentryWebhookDataIssue](#sentrywebhookdataissue) | |
<a id="sentrywebhookinstallation"></a>
## SentryWebhookInstallation
| Field | Type | Description |
|-------|------|-------------|
| uuid | string | |
<a id="slackwebhookrequestattachmentsitem"></a>
## SlackWebhookRequestAttachmentsItem
Array of attachment objects
| Field | Type | Description |
|-------|------|-------------|
| author_icon? | string | URL for the author icon image |
| author_link? | string | URL to link from the author name |
| author_name? | string | Name of the author |
| color? | string | Colour of the attachment sidebar (hex code or preset) |
| fallback? | string | Fallback text for notifications |
| fields? | [SlackWebhookRequestAttachmentsItemFieldsItem](#slackwebhookrequestattachmentsitemfieldsitem)[] | Array of field objects |
| footer? | string | Footer text displayed at the bottom |
| image_url? | string | URL of the main image to display |
| pretext? | string | Text that appears above the attachment block |
| text? | string | Main text content of the attachment |
| thumb_url? | string | URL of a thumbnail image |
| title? | string | Title of the attachment |
| title_link? | string | URL to link from the title |
| ts? | integer (int64) | Unix timestamp for the attachment footer |