136 lines
4.9 KiB
Plaintext
136 lines
4.9 KiB
Plaintext
---
|
|
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<`2`, `3`> | 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<`2`, `3`> | 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<`emoji`, `sticker`> | 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<`emoji`, `sticker`> | The type of pack (emoji or sticker) |
|
|
| updated_at | string (date-time) | ISO8601 timestamp of when the pack was last updated |
|
|
|