@buape/carbon 0.1.0

package/docs/classes/Role.mdx

@@ -0,0 +1,228 @@
+---
+title: Role
+---
+
+## Extends
+
+- `Base`
+
+## Constructors
+
+### new Role()
+
+> **new Role**(`client`, `rawDataOrId`): [`Role`](/carbon/api/classes/Role)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `client` | [`Client`](/carbon/api/classes/Client) |
+| `rawDataOrId` | `string` \| `APIRole` |
+
+#### Returns
+
+[`Role`](/carbon/api/classes/Role)
+
+#### Overrides
+
+`Base.constructor`
+
+## Properties
+
+| Property | Type | Description | Inherited from |
+| ------ | ------ | ------ | ------ |
+| `client` | [`Client`](/carbon/api/classes/Client) | - | `Base.client` |
+| `color?` | `null` \| `number` | The color of the role. | - |
+| `flags?` | `null` \| `RoleFlags` | The flags of this role. **See** https://discord.com/developers/docs/topics/permissions#role-object-role-flags | - |
+| `hoisted?` | `null` \| `boolean` | If this role is hoisted. | - |
+| `icon?` | `null` \| `string` | The icon hash of the role. You can use [Role.iconUrl](/carbon/api/classes/Role#iconurl) to get the URL of the icon. | - |
+| `id` | `string` | The ID of the role. | - |
+| `managed?` | `null` \| `boolean` | If this role is managed by an integration. | - |
+| `mentionable?` | `null` \| `boolean` | If this role is mentionable. | - |
+| `name?` | `null` \| `string` | The name of the role. | - |
+| `partial` | `boolean` | Whether the role is a partial role (meaning it does not have all the data). If this is true, you should use [Role.fetch](/carbon/api/classes/Role#fetch) to get the full data of the role. | - |
+| `permissions?` | `null` \| `string` | The permissions of the role. | - |
+| `position?` | `null` \| `number` | The position of the role. | - |
+| `tags?` | `null` \| `APIRoleTags` | The tags of this role. **See** https://discord.com/developers/docs/topics/permissions#role-object-role-tags-structure | - |
+| `unicodeEmoji?` | `null` \| `string` | The unicode emoji for the role. | - |
+
+## Accessors
+
+### iconUrl
+
+> `get` **iconUrl**(): `null` \| `string`
+
+Get the URL of the role's icon
+
+#### Returns
+
+`null` \| `string`
+
+## Methods
+
+### delete()
+
+> **delete**(`guildId`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `guildId` | `string` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### fetch()
+
+> **fetch**(`guildId`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Fetch updated data for this role.
+If the role is partial, this will fetch all the data for the role and populate the fields.
+If the role is not partial, all fields will be updated with new values from Discord.
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `guildId` | `string` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### setColor()
+
+> **setColor**(`guildId`, `color`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set the color of the role
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `guildId` | `string` |
+| `color` | `number` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### setHoisted()
+
+> **setHoisted**(`guildId`, `hoisted`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set the hoisted status of the role
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `guildId` | `string` |
+| `hoisted` | `boolean` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### setIcon()
+
+> **setIcon**(`guildId`, `icon`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set the icon of the role
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `guildId` | `string` | - |
+| `icon` | `string` | The unicode emoji or icon URL to set |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### setMentionable()
+
+> **setMentionable**(`guildId`, `mentionable`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set the mentionable status of the role
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `guildId` | `string` |
+| `mentionable` | `boolean` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### setName()
+
+> **setName**(`guildId`, `name`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set the name of the role
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `guildId` | `string` |
+| `name` | `string` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### setPermissions()
+
+> **setPermissions**(`guildId`, `permissions`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set the permissions of the role
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `guildId` | `string` | - |
+| `permissions` | `string` | The permissions to set as a BitField string, until a better permission structure is implemented |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+***
+
+### setPosition()
+
+> **setPosition**(`guildId`, `position`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
+
+Set the position of the role
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `guildId` | `string` |
+| `position` | `number` |
+
+#### Returns
+
+[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>

package/docs/classes/RoleSelectMenu.mdx

@@ -0,0 +1,120 @@
+---
+title: RoleSelectMenu
+---
+
+## Extends
+
+- [`AnySelectMenu`](/carbon/api/classes/AnySelectMenu)
+
+## Constructors
+
+### new RoleSelectMenu()
+
+> **new RoleSelectMenu**(`data`?): [`RoleSelectMenu`](/carbon/api/classes/RoleSelectMenu)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `data`? | `object` |
+| `data.additionalData`? | [`ComponentAdditionalData`](/carbon/api/type-aliases/ComponentAdditionalData) |
+
+#### Returns
+
+[`RoleSelectMenu`](/carbon/api/classes/RoleSelectMenu)
+
+#### 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`\>[] | `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` | `RoleSelect` | `ComponentType.RoleSelect` | 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` | [`RoleSelectMenuInteraction`](/carbon/api/classes/RoleSelectMenuInteraction) |
+
+#### 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`\>[] |
+| `type` | `RoleSelect` |
+
+#### Overrides
+
+[`AnySelectMenu`](/carbon/api/classes/AnySelectMenu).[`serializeOptions`](/carbon/api/classes/AnySelectMenu#serializeoptions)

package/docs/classes/RoleSelectMenuInteraction.mdx

@@ -0,0 +1,157 @@
+---
+title: RoleSelectMenuInteraction
+---
+
+This is the base type interaction, all interaction types extend from this
+
+## Extends
+
+- [`AnySelectMenuInteraction`](/carbon/api/classes/AnySelectMenuInteraction)
+
+## Constructors
+
+### new RoleSelectMenuInteraction()
+
+> **new RoleSelectMenuInteraction**(`client`, `data`): [`RoleSelectMenuInteraction`](/carbon/api/classes/RoleSelectMenuInteraction)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `client` | [`Client`](/carbon/api/classes/Client) |
+| `data` | `APIMessageComponentSelectMenuInteraction` |
+
+#### Returns
+
+[`RoleSelectMenuInteraction`](/carbon/api/classes/RoleSelectMenuInteraction)
+
+#### 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/Row.mdx

@@ -0,0 +1,88 @@
+---
+title: Row
+---
+
+## Constructors
+
+### new Row()
+
+> **new Row**(`components`): [`Row`](/carbon/api/classes/Row)
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `components` | [`BaseComponent`](/carbon/api/classes/BaseComponent)[] |
+
+#### Returns
+
+[`Row`](/carbon/api/classes/Row)
+
+## Properties
+
+| Property | Type | Description |
+| ------ | ------ | ------ |
+| `components` | [`BaseComponent`](/carbon/api/classes/BaseComponent)[] | The components in the action row |
+
+## Methods
+
+### addComponent()
+
+> **addComponent**(`component`): `void`
+
+Add a component to the action row
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `component` | [`BaseComponent`](/carbon/api/classes/BaseComponent) | The component to add |
+
+#### Returns
+
+`void`
+
+***
+
+### removeAllComponents()
+
+> **removeAllComponents**(): `void`
+
+Remove all components from the action row
+
+#### Returns
+
+`void`
+
+***
+
+### removeComponent()
+
+> **removeComponent**(`component`): `void`
+
+Remove a component from the action row
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `component` | [`BaseComponent`](/carbon/api/classes/BaseComponent) | The component to remove |
+
+#### Returns
+
+`void`
+
+***
+
+### serialize()
+
+> **serialize**(): `object`
+
+#### Returns
+
+`object`
+
+| Name | Type | Default value |
+| ------ | ------ | ------ |
+| `components` | `APIBaseComponent`\<`ComponentType`\>[] | - |
+| `type` | `number` | 1 |