@buape/carbon 0.1.0

package/docs/classes/MentionableSelectMenu.mdx

@@ -0,0 +1,120 @@
+---
+title: MentionableSelectMenu
+---
+
+## Extends
+
+- [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu)
+
+## Constructors
+
+### new MentionableSelectMenu()
+
+> **new MentionableSelectMenu**(`data`?): [`MentionableSelectMenu`](/carbon/api/classes/MentionableSelectMenu)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data`? | `object` |
+| `data.additionalData`? | [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) |
+
+#### Returns
+
+[`MentionableSelectMenu`](/carbon/api/classes/MentionableSelectMenu)
+
+#### Inherited from
+
+[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`constructor`](/carbon/api/classes/AnySelectMenu#constructors)
+
+## Properties
+
+| Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
+| `additionalData` | `public` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | `null` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`additionalData` |
+| `customId` | `abstract` | `string` | `undefined` | The custom ID of the component | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`customId` |
+| `defaultValues?` | `public` | `APISelectMenuDefaultValue`\<`Role` \| `User`\>[] | `undefined` | - | - | - |
+| `defer` | `public` | `boolean` | `false` | Whether the component response should be automatically deferred | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`defer` |
+| `disabled?` | `public` | `boolean` | `undefined` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`disabled` |
+| `ephemeral` | `public` | `boolean` | `false` | Whether the component response should be ephemeral | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`ephemeral` |
+| `maxValues?` | `public` | `number` | `undefined` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`maxValues` |
+| `minValues?` | `public` | `number` | `undefined` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`minValues` |
+| `placeholder?` | `public` | `string` | `undefined` | - | - | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`placeholder` |
+| `type` | `public` | `MentionableSelect` | `ComponentType.MentionableSelect` | The type of the component | [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).`type` | - |
+
+## Methods
+
+### createId()
+
+> **createId**(`additionalData`): `string`
+
+Create a custom ID to use for this component that embeds additional data that you want to be handed
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `additionalData` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | The additional data that you want to be passed in this component's custom ID |
+
+#### Returns
+
+`string`
+
+The custom ID to use
+
+#### Inherited from
+
+[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`createId`](/carbon/api/classes/AnySelectMenu#createid)
+
+***
+
+### run()
+
+> `abstract` **run**(`interaction`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `interaction` | [`MentionableSelectMenuInteraction`](/carbon/api/classes/MentionableSelectMenuInteraction) |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Overrides
+
+[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`run`](/carbon/api/classes/AnySelectMenu#run)
+
+***
+
+### serialize()
+
+> **serialize**(): `APISelectMenuComponent`
+
+#### Returns
+
+`APISelectMenuComponent`
+
+#### Inherited from
+
+[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`serialize`](/carbon/api/classes/AnySelectMenu#serialize)
+
+***
+
+### serializeOptions()
+
+> **serializeOptions**(): `object`
+
+#### Returns
+
+`object`
+
+| Name | Type |
+| ------ | ------ |
+| `default_values` | `undefined` \| `APISelectMenuDefaultValue`\<`Role` \| `User`\>[] |
+| `type` | `MentionableSelect` |
+
+#### Overrides
+
+[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`serializeOptions`](/carbon/api/classes/AnySelectMenu#serializeoptions)

package/docs/classes/MentionableSelectMenuInteraction.mdx

@@ -0,0 +1,157 @@
+---
+title: MentionableSelectMenuInteraction
+---
+
+This is the base type interaction, all interaction types extend from this
+
+## Extends
+
+- [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction)
+
+## Constructors
+
+### new MentionableSelectMenuInteraction()
+
+> **new MentionableSelectMenuInteraction**(`client`, `data`): [`MentionableSelectMenuInteraction`](/carbon/api/classes/MentionableSelectMenuInteraction)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `client` | [`Client`](/carbon/api/classes/Client) |
+| `data` | `APIMessageComponentSelectMenuInteraction` |
+
+#### Returns
+
+[`MentionableSelectMenuInteraction`](/carbon/api/classes/MentionableSelectMenuInteraction)
+
+#### Overrides
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`constructor`](/carbon/api/classes/AnySelectMenuInteraction#constructors)
+
+## Properties
+
+| Property | Type | Default value | Description | Inherited from |
+| ------ | ------ | ------ | ------ | ------ |
+| `_deferred` | `boolean` | `false` | **`Internal`** Whether the interaction is deferred already | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`_deferred` |
+| `client` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`client` |
+| `componentType` | `ComponentType` | `undefined` | - | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`componentType` |
+| `customId` | `string` | `undefined` | - | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`customId` |
+| `rawData` | `APIMessageComponentInteraction` | `undefined` | The raw data of the interaction | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`rawData` |
+| `type` | `InteractionType` | `undefined` | The type of interaction | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`type` |
+| `userId` | `undefined` \| `string` | `undefined` | The user who sent the interaction | [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).`userId` |
+
+## Accessors
+
+### channel
+
+> `get` **channel**(): `null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)
+
+#### Returns
+
+`null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)
+
+#### Inherited from
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`channel`](/carbon/api/classes/AnySelectMenuInteraction#channel)
+
+***
+
+### guild
+
+> `get` **guild**(): `null` \| [`Guild`](/carbon/api/classes/Guild)
+
+#### Returns
+
+`null` \| [`Guild`](/carbon/api/classes/Guild)
+
+#### Inherited from
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`guild`](/carbon/api/classes/AnySelectMenuInteraction#guild)
+
+***
+
+### message
+
+> `get` **message**(): `null` \| [`Message`](/carbon/api/classes/Message)
+
+#### Returns
+
+`null` \| [`Message`](/carbon/api/classes/Message)
+
+#### Inherited from
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`message`](/carbon/api/classes/AnySelectMenuInteraction#message)
+
+***
+
+### user
+
+> `get` **user**(): `null` \| [`User`](/carbon/api/classes/User)
+
+#### Returns
+
+`null` \| [`User`](/carbon/api/classes/User)
+
+#### Inherited from
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`user`](/carbon/api/classes/AnySelectMenuInteraction#user)
+
+***
+
+### values
+
+> `get` **values**(): `string`[]
+
+The raw IDs of the selected options (either role/string/channel IDs or the IDs you provided in your options)
+
+#### Returns
+
+`string`[]
+
+#### Overrides
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`values`](/carbon/api/classes/AnySelectMenuInteraction#values)
+
+## Methods
+
+### defer()
+
+> **defer**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+**`Internal`**
+
+Defer the interaction response. This is used automatically by commands that are set to defer.
+If the interaction is already deferred, this will do nothing.
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`defer`](/carbon/api/classes/AnySelectMenuInteraction#defer)
+
+***
+
+### reply()
+
+> **reply**(`data`, `options`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Reply to an interaction.
+If the interaction is deferred, this will edit the original response.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `data` | [`InteractionReplyData`](/carbon/api/type-aliases/InteractionReplyData) | The response data |
+| `options` | [`InteractionReplyOptions`](/carbon/api/type-aliases/InteractionReplyOptions) | - |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Inherited from
+
+[`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction).[`reply`](/carbon/api/classes/AnySelectMenuInteraction#reply)

package/docs/classes/Message.mdx

@@ -0,0 +1,126 @@
+---
+title: Message
+---
+
+## Extends
+
+- `Base`
+
+## Constructors
+
+### new Message()
+
+> **new Message**(`client`, `rawDataOrIds`): [`Message`](/carbon/api/classes/Message)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `client` | [`Client`](/carbon/api/classes/Client) |
+| `rawDataOrIds` | `APIMessage` \| `object` |
+
+#### Returns
+
+[`Message`](/carbon/api/classes/Message)
+
+#### Overrides
+
+`Base.constructor`
+
+## Properties
+
+| Property | Type | Description | Inherited from |
+| ------ | ------ | ------ | ------ |
+| `channelId` | `string` | The ID of the channel the message is in | - |
+| `client` | [`Client`](/carbon/api/classes/Client) | - | `Base.client` |
+| `id` | `string` | The ID of the message | - |
+| `partial` | `boolean` | Whether the message is a partial message (meaning it does not have all the data). If this is true, you should use [Message.fetch](/carbon/api/classes/Message#fetch) to get the full data of the message. | - |
+
+## Accessors
+
+### author
+
+> `get` **author**(): `null` \| [`User`](/carbon/api/classes/User)
+
+#### Returns
+
+`null` \| [`User`](/carbon/api/classes/User)
+
+## Methods
+
+### delete()
+
+> **delete**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`unknown`\>
+
+Delete this message from Discord
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`unknown`\>
+
+***
+
+### fetch()
+
+> **fetch**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Fetch updated data for this message.
+If the message is partial, this will fetch all the data for the message and populate the fields.
+If the message is not partial, all fields will be updated with new values from Discord.
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### fetchChannel()
+
+> **fetchChannel**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)\>
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)\>
+
+***
+
+### pin()
+
+> **pin**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Pin this message
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### startThread()
+
+> **startThread**(`data`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\>\>
+
+Start a thread with this message as the associated start message.
+If you want to start a thread without a start message, use [BaseGuildTextChannel.startThread](/carbon/api/classes/BaseGuildTextChannel#startthread)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data` | `RESTPostAPIChannelThreadsJSONBody` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\>\>
+
+***
+
+### unpin()
+
+> **unpin**(): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Unpin this message
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

package/docs/classes/OptionsHandler.mdx

@@ -0,0 +1,203 @@
+---
+title: OptionsHandler
+---
+
+This class is used to parse the options of a command, and provide errors for any missing or invalid options.
+It is used internally by the Command class.
+
+## Extends
+
+- `Base`
+
+## Extended by
+
+- [`AutocompleteOptionsHandler`](/carbon/api/classes/AutocompleteOptionsHandler)
+
+## Constructors
+
+### new OptionsHandler()
+
+> **new OptionsHandler**(`client`, `options`): [`OptionsHandler`](/carbon/api/classes/OptionsHandler)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `client` | [`Client`](/carbon/api/classes/Client) |
+| `options` | `APIApplicationCommandInteractionDataBasicOption`[] |
+
+#### Returns
+
+[`OptionsHandler`](/carbon/api/classes/OptionsHandler)
+
+#### Overrides
+
+`Base.constructor`
+
+## Properties
+
+| Property | Modifier | Type | Default value | Description | Inherited from |
+| ------ | ------ | ------ | ------ | ------ | ------ |
+| `client` | `public` | [`Client`](/carbon/api/classes/Client) | `undefined` | - | `Base.client` |
+| `errors` | `readonly` | `string`[] | `[]` | The errors that were encountered while parsing the options. | - |
+| `raw` | `readonly` | `APIApplicationCommandInteractionDataBasicOption`[] | `undefined` | The raw options that were in the interaction data, before they were parsed. | - |
+
+## Methods
+
+### getBoolean()
+
+> **getBoolean**(`key`): `undefined` \| `true`
+
+Get the value of a boolean option.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The name of the option to get the value of. |
+
+#### Returns
+
+`undefined` \| `true`
+
+The value of the option, or undefined if the option was not provided.
+
+***
+
+### getChannel()
+
+> **getChannel**(`key`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| `null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)\>
+
+Get the value of a channel option.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The name of the option to get the value of. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| `null` \| [`DmChannel`](/carbon/api/classes/DmChannel) \| [`GroupDmChannel`](/carbon/api/classes/GroupDmChannel) \| [`GuildTextChannel`](/carbon/api/classes/GuildTextChannel) \| [`GuildVoiceChannel`](/carbon/api/classes/GuildVoiceChannel) \| [`GuildCategoryChannel`](/carbon/api/classes/GuildCategoryChannel) \| [`GuildAnnouncementChannel`](/carbon/api/classes/GuildAnnouncementChannel) \| [`GuildThreadChannel`](/carbon/api/classes/GuildThreadChannel)\<`ThreadChannelType`\> \| [`GuildStageChannel`](/carbon/api/classes/GuildStageChannel) \| [`GuildForumChannel`](/carbon/api/classes/GuildForumChannel) \| [`GuildMediaChannel`](/carbon/api/classes/GuildMediaChannel)\>
+
+The value of the option, or undefined if the option was not provided.
+
+***
+
+### getInteger()
+
+> **getInteger**(`key`): `undefined` \| `string` \| `number` \| `true`
+
+Get the value of an integer option.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The name of the option to get the value of. |
+
+#### Returns
+
+`undefined` \| `string` \| `number` \| `true`
+
+The value of the option, or undefined if the option was not provided.
+
+***
+
+### getMentionable()
+
+> **getMentionable**(`key`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| [`Role`](/carbon/api/classes/Role) \| [`User`](/carbon/api/classes/User)\>
+
+Get the value of a mentionable option.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The name of the option to get the value of. |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`undefined` \| [`Role`](/carbon/api/classes/Role) \| [`User`](/carbon/api/classes/User)\>
+
+The value of the option, or undefined if the option was not provided.
+
+***
+
+### getNumber()
+
+> **getNumber**(`key`): `undefined` \| `number`
+
+Get the value of a number option.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The name of the option to get the value of. |
+
+#### Returns
+
+`undefined` \| `number`
+
+The value of the option, or undefined if the option was not provided.
+
+***
+
+### getRole()
+
+> **getRole**(`key`): `undefined` \| [`Role`](/carbon/api/classes/Role)
+
+Get the value of a role option.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The name of the option to get the value of. |
+
+#### Returns
+
+`undefined` \| [`Role`](/carbon/api/classes/Role)
+
+The value of the option, or undefined if the option was not provided.
+
+***
+
+### getString()
+
+> **getString**(`key`): `undefined` \| `string`
+
+Get the value of a string option.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The name of the option to get the value of. |
+
+#### Returns
+
+`undefined` \| `string`
+
+The value of the option, or undefined if the option was not provided.
+
+***
+
+### getUser()
+
+> **getUser**(`key`): `undefined` \| [`User`](/carbon/api/classes/User)
+
+Get the value of a user option.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `key` | `string` | The name of the option to get the value of. |
+
+#### Returns
+
+`undefined` \| [`User`](/carbon/api/classes/User)
+
+The value of the option, or undefined if the option was not provided.

package/docs/classes/PremiumButton.mdx

@@ -0,0 +1,84 @@
+---
+title: PremiumButton
+---
+
+## Extends
+
+- `BaseButton`
+
+## Constructors
+
+### new PremiumButton()
+
+> **new PremiumButton**(`data`?): [`PremiumButton`](/carbon/api/classes/PremiumButton)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data`? | `object` |
+| `data.additionalData`? | [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) |
+
+#### Returns
+
+[`PremiumButton`](/carbon/api/classes/PremiumButton)
+
+#### Inherited from
+
+`BaseButton.constructor`
+
+## Properties
+
+| Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
+| ------ | ------ | ------ | ------ | ------ | ------ | ------ |
+| `additionalData` | `public` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | `null` | - | - | `BaseButton.additionalData` |
+| `customId` | `abstract` | `string` | `undefined` | The custom ID of the component | - | `BaseButton.customId` |
+| `defer` | `public` | `boolean` | `false` | Whether the component response should be automatically deferred | - | `BaseButton.defer` |
+| `disabled` | `public` | `boolean` | `false` | The disabled state of the button | - | `BaseButton.disabled` |
+| `emoji?` | `public` | `object` | `undefined` | The emoji of the button | - | `BaseButton.emoji` |
+| `emoji.animated?` | `public` | `boolean` | `undefined` | - | - | - |
+| `emoji.id?` | `public` | `string` | `undefined` | - | - | - |
+| `emoji.name` | `public` | `string` | `undefined` | - | - | - |
+| `ephemeral` | `public` | `boolean` | `false` | Whether the component response should be ephemeral | - | `BaseButton.ephemeral` |
+| `label` | `abstract` | `string` | `undefined` | The label of the button | - | `BaseButton.label` |
+| `sku_id` | `abstract` | `string` | `undefined` | The SKU ID of the button | - | - |
+| `style` | `public` | `Premium` | `ButtonStyle.Premium` | The style of the button | `BaseButton.style` | - |
+| `type` | `public` | `ComponentType` | `ComponentType.Button` | The type of the component | - | `BaseButton.type` |
+
+## Methods
+
+### createId()
+
+> **createId**(`additionalData`): `string`
+
+Create a custom ID to use for this component that embeds additional data that you want to be handed
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `additionalData` | `null` \| [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) | The additional data that you want to be passed in this component's custom ID |
+
+#### Returns
+
+`string`
+
+The custom ID to use
+
+#### Inherited from
+
+`BaseButton.createId`
+
+***
+
+### serialize()
+
+> **serialize**(): `APIButtonComponentWithSKUId`
+
+#### Returns
+
+`APIButtonComponentWithSKUId`
+
+#### Overrides
+
+`BaseButton.serialize`