guilded-api-typings
Advanced tools
Comparing version 0.3.0 to 0.3.1
# guilded-api-typings | ||
## 0.3.1 | ||
### Patch Changes | ||
- # Features | ||
- Add `APIError` | ||
## 0.3.0 | ||
@@ -4,0 +12,0 @@ |
@@ -1,44 +0,33 @@ | ||
'use strict'; | ||
var __createBinding = | ||
(this && this.__createBinding) || | ||
(Object.create | ||
? function (o, m, k, k2) { | ||
if (k2 === undefined) k2 = k; | ||
var desc = Object.getOwnPropertyDescriptor(m, k); | ||
if (!desc || ('get' in desc ? !m.__esModule : desc.writable || desc.configurable)) { | ||
desc = { | ||
enumerable: true, | ||
get: function () { | ||
return m[k]; | ||
}, | ||
}; | ||
} | ||
Object.defineProperty(o, k2, desc); | ||
} | ||
: function (o, m, k, k2) { | ||
if (k2 === undefined) k2 = k; | ||
o[k2] = m[k]; | ||
}); | ||
var __exportStar = | ||
(this && this.__exportStar) || | ||
function (m, exports) { | ||
for (var p in m) | ||
if (p !== 'default' && !Object.prototype.hasOwnProperty.call(exports, p)) | ||
__createBinding(exports, m, p); | ||
}; | ||
Object.defineProperty(exports, '__esModule', { value: true }); | ||
"use strict"; | ||
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { | ||
if (k2 === undefined) k2 = k; | ||
var desc = Object.getOwnPropertyDescriptor(m, k); | ||
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { | ||
desc = { enumerable: true, get: function() { return m[k]; } }; | ||
} | ||
Object.defineProperty(o, k2, desc); | ||
}) : (function(o, m, k, k2) { | ||
if (k2 === undefined) k2 = k; | ||
o[k2] = m[k]; | ||
})); | ||
var __exportStar = (this && this.__exportStar) || function(m, exports) { | ||
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p); | ||
}; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
// Structures | ||
__exportStar(require('./structures/Channel'), exports); | ||
__exportStar(require('./structures/Doc'), exports); | ||
__exportStar(require('./structures/Embed'), exports); | ||
__exportStar(require('./structures/ListItem'), exports); | ||
__exportStar(require('./structures/Message'), exports); | ||
__exportStar(require('./structures/Server'), exports); | ||
__exportStar(require('./structures/Topic'), exports); | ||
__exportStar(require('./structures/User'), exports); | ||
__exportStar(require('./structures/Webhook'), exports); | ||
__exportStar(require("./structures/Channel"), exports); | ||
__exportStar(require("./structures/Doc"), exports); | ||
__exportStar(require("./structures/Embed"), exports); | ||
__exportStar(require("./structures/ListItem"), exports); | ||
__exportStar(require("./structures/Message"), exports); | ||
__exportStar(require("./structures/Server"), exports); | ||
__exportStar(require("./structures/Topic"), exports); | ||
__exportStar(require("./structures/User"), exports); | ||
__exportStar(require("./structures/Webhook"), exports); | ||
// WS | ||
__exportStar(require('./WS'), exports); | ||
__exportStar(require("./WS"), exports); | ||
// REST | ||
__exportStar(require("./REST"), exports); | ||
// Routes | ||
__exportStar(require('./Routes'), exports); | ||
//# sourceMappingURL=index.js.map | ||
__exportStar(require("./Routes"), exports); | ||
//# sourceMappingURL=index.js.map |
@@ -1,224 +0,220 @@ | ||
'use strict'; | ||
Object.defineProperty(exports, '__esModule', { value: true }); | ||
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.Routes = void 0; | ||
/** The REST API endpoints for Guilded. */ | ||
exports.Routes = { | ||
/** | ||
* The enpoint for channels on Guilded. | ||
* | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelCreate | ||
*/ | ||
channels: () => `/channels`, | ||
/** | ||
* The endpoint for a channel on Guilded. | ||
* @param channelId The ID of the channel. | ||
* | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelRead | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelUpdate | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelDelete | ||
*/ | ||
channel: (channelId) => `/channels/${channelId}`, | ||
/** | ||
* The endpoint for a server on Guilded. | ||
* @param serverId The ID of the server. | ||
* | ||
* @see https://www.guilded.gg/docs/api/servers/ServerRead | ||
*/ | ||
server: (serverId) => `/servers/${serverId}`, | ||
/** | ||
* The endpoint for messages on Guilded. | ||
* @param channelId The ID of the channel the messages belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageCreate | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageReadMany | ||
*/ | ||
messages: (channelId) => `/channels/${channelId}/messages`, | ||
/** | ||
* The endpoint for a message on Guilded. | ||
* @param channelId The ID of the channel the message belongs to. | ||
* @param messageId The ID of the message. | ||
* | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageRead | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageUpdate | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageDelete | ||
*/ | ||
message: (channelId, messageId) => `/channels/${channelId}/messages/${messageId}`, | ||
/** | ||
* The endpoint for a server nickname on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/members/MemberNicknameUpdate | ||
* @see https://www.guilded.gg/docs/api/members/MemberNicknameDelete | ||
*/ | ||
serverNickname: (serverId, memberId) => `/servers/${serverId}/members/${memberId}/nickname`, | ||
/** | ||
* The endpoint for a server member on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/members/ServerMemberRead | ||
* @see https://www.guilded.gg/docs/api/members/ServerMemberDelete | ||
*/ | ||
serverMember: (serverId, memberId) => `/servers/${serverId}/members/${memberId}`, | ||
/** | ||
* The endpoint for server members on Guilded. | ||
* @param serverId The ID of the server the members belong to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/members/ServerMemberReadMany | ||
*/ | ||
serverMembers: (serverId) => `/servers/${serverId}/members`, | ||
/** | ||
* The endpoint for a server ban on Guilded. | ||
* @param serverId The ID of the server the ban belongs to. | ||
* @param banId The ID of the ban. | ||
* | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanCreate | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanRead | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanDelete | ||
*/ | ||
serverBan: (serverId, banId) => `/servers/${serverId}/bans/${banId}`, | ||
/** | ||
* The endpoint for server bans on Guilded. | ||
* @param serverId The ID of the server the bans belong to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanReadMany | ||
*/ | ||
serverBans: (serverId) => `/servers/${serverId}/bans`, | ||
/** | ||
* The endpoint for topics. | ||
* @param channelId The ID of the channel the topics belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/forums/ForumTopicCreate | ||
*/ | ||
topics: (channelId) => `/channels/${channelId}/topics`, | ||
/** | ||
* The endpoint for list items on Guilded. | ||
* @param channelId The ID of the channel the list items belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemCreate | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemReadMany | ||
*/ | ||
listItems: (channelId) => `/channels/${channelId}/items`, | ||
/** | ||
* The endpoint for a list item on Guilded. | ||
* @param channelId The ID of the channel the list item belongs to. | ||
* @param listItemId The ID of the list item. | ||
* | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemRead | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemUpdate | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemDelete | ||
*/ | ||
listItem: (channelId, listItemId) => `/channels/${channelId}/items/${listItemId}`, | ||
/** | ||
* The endpoint for list item completions on Guilded. | ||
* @param channelId The ID of the channel the list item belongs to. | ||
* @param listItemId The ID of the list item. | ||
* | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemCompleteCreate | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemCompleteDelete | ||
*/ | ||
listItemComplete: (channelId, listItemId) => | ||
`/channels/${channelId}/items/${listItemId}/complete`, | ||
/** | ||
* The endpoint for docs on Guilded. | ||
* @param channelId The ID of the channel the docs belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/docs/DocCreate | ||
* @see https://www.guilded.gg/docs/api/docs/DocReadMany | ||
*/ | ||
docs: (channelId) => `/channels/${channelId}/docs`, | ||
/** | ||
* The endpoint for a doc on Guilded. | ||
* @param channelId The ID of the channel the doc belongs to. | ||
* @param docId The ID of the doc. | ||
* | ||
* @see https://www.guilded.gg/docs/api/docs/DocRead | ||
* @see https://www.guilded.gg/docs/api/docs/DocUpdate | ||
* @see https://www.guilded.gg/docs/api/docs/DocDelete | ||
*/ | ||
doc: (channelId, docId) => `/channels/${channelId}/docs/${docId}`, | ||
/** | ||
* The endpoint for a content reaction on Guilded. | ||
* @param channelId The ID of the channel the content belongs to. | ||
* @param contentId The ID of the content. | ||
* @param emoteId The ID of the emote. | ||
* | ||
* @see https://www.guilded.gg/docs/api/reactions/ContentReactionCreate | ||
*/ | ||
reaction: (channelId, contentId, emoteId) => | ||
`/channels/${channelId}/content/${contentId}/emotes/${emoteId}`, | ||
/** | ||
* The endpoint for server member XP on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/server-xp/ServerXpForUserCreate | ||
*/ | ||
serverMemberXp: (serverId, memberId) => `/servers/${serverId}/members/${memberId}/xp`, | ||
/** | ||
* The endpoint for server role XP on Guilded. | ||
* @param serverId The ID of the server the role belongs to. | ||
* @param roleId The ID of the role. | ||
* | ||
* @see https://www.guilded.gg/docs/api/server-xp/ServerXpForRoleCreate | ||
*/ | ||
serverRoleXp: (serverId, roleId) => `/servers/${serverId}/roles/${roleId}/xp`, | ||
/** | ||
* The endpoint for a server member social link on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* @param type The type of social link. | ||
* | ||
* @see https://www.guilded.gg/docs/api/socialLinks/MemberSocialLinkRead | ||
*/ | ||
socialLink: (serverId, memberId, type) => | ||
`/servers/${serverId}/members/${memberId}/social-links/${type}`, | ||
/** | ||
* The endpoint for a group member on Guilded. | ||
* @param groupId The ID of the group the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/groupMembership/GroupMembershipCreate | ||
* @see https://www.guilded.gg/docs/api/groupMembership/GroupMembershipDelete | ||
*/ | ||
groupMember: (groupId, memberId) => `/groups/${groupId}/members/${memberId}`, | ||
/** | ||
* The endpoint for a server member role on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* @param roleId The ID of the role. | ||
* | ||
* @see https://www.guilded.gg/docs/api/roleMembership/RoleMembershipCreate | ||
* @see https://www.guilded.gg/docs/api/roleMembership/RoleMembershipDelete | ||
*/ | ||
serverMemberRole: (serverId, memberId, roleId) => | ||
`/servers/${serverId}/members/${memberId}/roles/${roleId}`, | ||
/** | ||
* The endpoint for server member roles on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/roleMembership/RoleMembershipReadMany | ||
*/ | ||
serverMemberRoles: (serverId, memberId) => `/servers/${serverId}/members/${memberId}/roles`, | ||
/** | ||
* The endpoint for webhooks on Guilded. | ||
* @param serverId The ID of the server the webhooks belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookCreate | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookReadMany | ||
*/ | ||
webhooks: (serverId) => `/servers/${serverId}/webhooks`, | ||
/** | ||
* The endpoint for a webhook on Guilded. | ||
* @param serverId The ID of the server the webhook belongs to. | ||
* @param webhookId The ID of the webhook. | ||
* | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookRead | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookUpdate | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookDelete | ||
*/ | ||
webhook: (serverId, webhookId) => `/servers/${serverId}/webhooks/${webhookId}`, | ||
/** | ||
* The enpoint for channels on Guilded. | ||
* | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelCreate | ||
*/ | ||
channels: () => `/channels`, | ||
/** | ||
* The endpoint for a channel on Guilded. | ||
* @param channelId The ID of the channel. | ||
* | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelRead | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelUpdate | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelDelete | ||
*/ | ||
channel: (channelId) => `/channels/${channelId}`, | ||
/** | ||
* The endpoint for a server on Guilded. | ||
* @param serverId The ID of the server. | ||
* | ||
* @see https://www.guilded.gg/docs/api/servers/ServerRead | ||
*/ | ||
server: (serverId) => `/servers/${serverId}`, | ||
/** | ||
* The endpoint for messages on Guilded. | ||
* @param channelId The ID of the channel the messages belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageCreate | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageReadMany | ||
*/ | ||
messages: (channelId) => `/channels/${channelId}/messages`, | ||
/** | ||
* The endpoint for a message on Guilded. | ||
* @param channelId The ID of the channel the message belongs to. | ||
* @param messageId The ID of the message. | ||
* | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageRead | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageUpdate | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageDelete | ||
*/ | ||
message: (channelId, messageId) => `/channels/${channelId}/messages/${messageId}`, | ||
/** | ||
* The endpoint for a server nickname on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/members/MemberNicknameUpdate | ||
* @see https://www.guilded.gg/docs/api/members/MemberNicknameDelete | ||
*/ | ||
serverNickname: (serverId, memberId) => `/servers/${serverId}/members/${memberId}/nickname`, | ||
/** | ||
* The endpoint for a server member on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/members/ServerMemberRead | ||
* @see https://www.guilded.gg/docs/api/members/ServerMemberDelete | ||
*/ | ||
serverMember: (serverId, memberId) => `/servers/${serverId}/members/${memberId}`, | ||
/** | ||
* The endpoint for server members on Guilded. | ||
* @param serverId The ID of the server the members belong to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/members/ServerMemberReadMany | ||
*/ | ||
serverMembers: (serverId) => `/servers/${serverId}/members`, | ||
/** | ||
* The endpoint for a server ban on Guilded. | ||
* @param serverId The ID of the server the ban belongs to. | ||
* @param banId The ID of the ban. | ||
* | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanCreate | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanRead | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanDelete | ||
*/ | ||
serverBan: (serverId, banId) => `/servers/${serverId}/bans/${banId}`, | ||
/** | ||
* The endpoint for server bans on Guilded. | ||
* @param serverId The ID of the server the bans belong to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanReadMany | ||
*/ | ||
serverBans: (serverId) => `/servers/${serverId}/bans`, | ||
/** | ||
* The endpoint for topics. | ||
* @param channelId The ID of the channel the topics belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/forums/ForumTopicCreate | ||
*/ | ||
topics: (channelId) => `/channels/${channelId}/topics`, | ||
/** | ||
* The endpoint for list items on Guilded. | ||
* @param channelId The ID of the channel the list items belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemCreate | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemReadMany | ||
*/ | ||
listItems: (channelId) => `/channels/${channelId}/items`, | ||
/** | ||
* The endpoint for a list item on Guilded. | ||
* @param channelId The ID of the channel the list item belongs to. | ||
* @param listItemId The ID of the list item. | ||
* | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemRead | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemUpdate | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemDelete | ||
*/ | ||
listItem: (channelId, listItemId) => `/channels/${channelId}/items/${listItemId}`, | ||
/** | ||
* The endpoint for list item completions on Guilded. | ||
* @param channelId The ID of the channel the list item belongs to. | ||
* @param listItemId The ID of the list item. | ||
* | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemCompleteCreate | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemCompleteDelete | ||
*/ | ||
listItemComplete: (channelId, listItemId) => `/channels/${channelId}/items/${listItemId}/complete`, | ||
/** | ||
* The endpoint for docs on Guilded. | ||
* @param channelId The ID of the channel the docs belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/docs/DocCreate | ||
* @see https://www.guilded.gg/docs/api/docs/DocReadMany | ||
*/ | ||
docs: (channelId) => `/channels/${channelId}/docs`, | ||
/** | ||
* The endpoint for a doc on Guilded. | ||
* @param channelId The ID of the channel the doc belongs to. | ||
* @param docId The ID of the doc. | ||
* | ||
* @see https://www.guilded.gg/docs/api/docs/DocRead | ||
* @see https://www.guilded.gg/docs/api/docs/DocUpdate | ||
* @see https://www.guilded.gg/docs/api/docs/DocDelete | ||
*/ | ||
doc: (channelId, docId) => `/channels/${channelId}/docs/${docId}`, | ||
/** | ||
* The endpoint for a content reaction on Guilded. | ||
* @param channelId The ID of the channel the content belongs to. | ||
* @param contentId The ID of the content. | ||
* @param emoteId The ID of the emote. | ||
* | ||
* @see https://www.guilded.gg/docs/api/reactions/ContentReactionCreate | ||
*/ | ||
reaction: (channelId, contentId, emoteId) => `/channels/${channelId}/content/${contentId}/emotes/${emoteId}`, | ||
/** | ||
* The endpoint for server member XP on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/server-xp/ServerXpForUserCreate | ||
*/ | ||
serverMemberXp: (serverId, memberId) => `/servers/${serverId}/members/${memberId}/xp`, | ||
/** | ||
* The endpoint for server role XP on Guilded. | ||
* @param serverId The ID of the server the role belongs to. | ||
* @param roleId The ID of the role. | ||
* | ||
* @see https://www.guilded.gg/docs/api/server-xp/ServerXpForRoleCreate | ||
*/ | ||
serverRoleXp: (serverId, roleId) => `/servers/${serverId}/roles/${roleId}/xp`, | ||
/** | ||
* The endpoint for a server member social link on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* @param type The type of social link. | ||
* | ||
* @see https://www.guilded.gg/docs/api/socialLinks/MemberSocialLinkRead | ||
*/ | ||
socialLink: (serverId, memberId, type) => `/servers/${serverId}/members/${memberId}/social-links/${type}`, | ||
/** | ||
* The endpoint for a group member on Guilded. | ||
* @param groupId The ID of the group the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/groupMembership/GroupMembershipCreate | ||
* @see https://www.guilded.gg/docs/api/groupMembership/GroupMembershipDelete | ||
*/ | ||
groupMember: (groupId, memberId) => `/groups/${groupId}/members/${memberId}`, | ||
/** | ||
* The endpoint for a server member role on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* @param roleId The ID of the role. | ||
* | ||
* @see https://www.guilded.gg/docs/api/roleMembership/RoleMembershipCreate | ||
* @see https://www.guilded.gg/docs/api/roleMembership/RoleMembershipDelete | ||
*/ | ||
serverMemberRole: (serverId, memberId, roleId) => `/servers/${serverId}/members/${memberId}/roles/${roleId}`, | ||
/** | ||
* The endpoint for server member roles on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/roleMembership/RoleMembershipReadMany | ||
*/ | ||
serverMemberRoles: (serverId, memberId) => `/servers/${serverId}/members/${memberId}/roles`, | ||
/** | ||
* The endpoint for webhooks on Guilded. | ||
* @param serverId The ID of the server the webhooks belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookCreate | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookReadMany | ||
*/ | ||
webhooks: (serverId) => `/servers/${serverId}/webhooks`, | ||
/** | ||
* The endpoint for a webhook on Guilded. | ||
* @param serverId The ID of the server the webhook belongs to. | ||
* @param webhookId The ID of the webhook. | ||
* | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookRead | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookUpdate | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookDelete | ||
*/ | ||
webhook: (serverId, webhookId) => `/servers/${serverId}/webhooks/${webhookId}`, | ||
}; | ||
//# sourceMappingURL=Routes.js.map | ||
//# sourceMappingURL=Routes.js.map |
@@ -1,3 +0,3 @@ | ||
'use strict'; | ||
Object.defineProperty(exports, '__esModule', { value: true }); | ||
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.APIChannelType = void 0; | ||
@@ -10,13 +10,13 @@ /** | ||
(function (APIChannelType) { | ||
APIChannelType['Announcements'] = 'announcements'; | ||
APIChannelType['Chat'] = 'chat'; | ||
APIChannelType['Calendar'] = 'calendar'; | ||
APIChannelType['Forums'] = 'forums'; | ||
APIChannelType['Media'] = 'media'; | ||
APIChannelType['Docs'] = 'docs'; | ||
APIChannelType['Voice'] = 'voice'; | ||
APIChannelType['List'] = 'list'; | ||
APIChannelType['Scheduling'] = 'scheduling'; | ||
APIChannelType['Stream'] = 'stream'; | ||
})((APIChannelType = exports.APIChannelType || (exports.APIChannelType = {}))); | ||
//# sourceMappingURL=Channel.js.map | ||
APIChannelType["Announcements"] = "announcements"; | ||
APIChannelType["Chat"] = "chat"; | ||
APIChannelType["Calendar"] = "calendar"; | ||
APIChannelType["Forums"] = "forums"; | ||
APIChannelType["Media"] = "media"; | ||
APIChannelType["Docs"] = "docs"; | ||
APIChannelType["Voice"] = "voice"; | ||
APIChannelType["List"] = "list"; | ||
APIChannelType["Scheduling"] = "scheduling"; | ||
APIChannelType["Stream"] = "stream"; | ||
})(APIChannelType = exports.APIChannelType || (exports.APIChannelType = {})); | ||
//# sourceMappingURL=Channel.js.map |
@@ -1,3 +0,3 @@ | ||
'use strict'; | ||
Object.defineProperty(exports, '__esModule', { value: true }); | ||
//# sourceMappingURL=Doc.js.map | ||
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
//# sourceMappingURL=Doc.js.map |
@@ -1,3 +0,3 @@ | ||
'use strict'; | ||
Object.defineProperty(exports, '__esModule', { value: true }); | ||
//# sourceMappingURL=Embed.js.map | ||
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
//# sourceMappingURL=Embed.js.map |
@@ -1,3 +0,3 @@ | ||
'use strict'; | ||
Object.defineProperty(exports, '__esModule', { value: true }); | ||
//# sourceMappingURL=ListItem.js.map | ||
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
//# sourceMappingURL=ListItem.js.map |
@@ -1,3 +0,3 @@ | ||
'use strict'; | ||
Object.defineProperty(exports, '__esModule', { value: true }); | ||
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.APIMessageType = void 0; | ||
@@ -10,5 +10,5 @@ /** | ||
(function (APIMessageType) { | ||
APIMessageType['Default'] = 'default'; | ||
APIMessageType['System'] = 'system'; | ||
})((APIMessageType = exports.APIMessageType || (exports.APIMessageType = {}))); | ||
//# sourceMappingURL=Message.js.map | ||
APIMessageType["Default"] = "default"; | ||
APIMessageType["System"] = "system"; | ||
})(APIMessageType = exports.APIMessageType || (exports.APIMessageType = {})); | ||
//# sourceMappingURL=Message.js.map |
@@ -1,3 +0,3 @@ | ||
'use strict'; | ||
Object.defineProperty(exports, '__esModule', { value: true }); | ||
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.APIServerType = void 0; | ||
@@ -10,11 +10,11 @@ /** | ||
(function (APIServerType) { | ||
APIServerType['Team'] = 'team'; | ||
APIServerType['Organization'] = 'organization'; | ||
APIServerType['Community'] = 'community'; | ||
APIServerType['Clan'] = 'clan'; | ||
APIServerType['Guild'] = 'guild'; | ||
APIServerType['Friends'] = 'friends'; | ||
APIServerType['Streaming'] = 'streaming'; | ||
APIServerType['Other'] = 'other'; | ||
})((APIServerType = exports.APIServerType || (exports.APIServerType = {}))); | ||
//# sourceMappingURL=Server.js.map | ||
APIServerType["Team"] = "team"; | ||
APIServerType["Organization"] = "organization"; | ||
APIServerType["Community"] = "community"; | ||
APIServerType["Clan"] = "clan"; | ||
APIServerType["Guild"] = "guild"; | ||
APIServerType["Friends"] = "friends"; | ||
APIServerType["Streaming"] = "streaming"; | ||
APIServerType["Other"] = "other"; | ||
})(APIServerType = exports.APIServerType || (exports.APIServerType = {})); | ||
//# sourceMappingURL=Server.js.map |
@@ -1,3 +0,3 @@ | ||
'use strict'; | ||
Object.defineProperty(exports, '__esModule', { value: true }); | ||
//# sourceMappingURL=Topic.js.map | ||
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
//# sourceMappingURL=Topic.js.map |
@@ -1,3 +0,3 @@ | ||
'use strict'; | ||
Object.defineProperty(exports, '__esModule', { value: true }); | ||
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.APIUserType = void 0; | ||
@@ -11,5 +11,5 @@ /** | ||
(function (APIUserType) { | ||
APIUserType['Bot'] = 'bot'; | ||
APIUserType['User'] = 'user'; | ||
})((APIUserType = exports.APIUserType || (exports.APIUserType = {}))); | ||
//# sourceMappingURL=User.js.map | ||
APIUserType["Bot"] = "bot"; | ||
APIUserType["User"] = "user"; | ||
})(APIUserType = exports.APIUserType || (exports.APIUserType = {})); | ||
//# sourceMappingURL=User.js.map |
@@ -1,3 +0,3 @@ | ||
'use strict'; | ||
Object.defineProperty(exports, '__esModule', { value: true }); | ||
//# sourceMappingURL=Webhook.js.map | ||
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
//# sourceMappingURL=Webhook.js.map |
@@ -1,3 +0,3 @@ | ||
'use strict'; | ||
Object.defineProperty(exports, '__esModule', { value: true }); | ||
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.WSOpCodes = void 0; | ||
@@ -7,7 +7,7 @@ /** The Guilded WebSocket API operation codes. */ | ||
(function (WSOpCodes) { | ||
/** The ready operation code. */ | ||
WSOpCodes[(WSOpCodes['Ready'] = 0)] = 'Ready'; | ||
/** The event operation code. */ | ||
WSOpCodes[(WSOpCodes['Event'] = 1)] = 'Event'; | ||
})((WSOpCodes = exports.WSOpCodes || (exports.WSOpCodes = {}))); | ||
//# sourceMappingURL=WS.js.map | ||
/** The ready operation code. */ | ||
WSOpCodes[WSOpCodes["Ready"] = 0] = "Ready"; | ||
/** The event operation code. */ | ||
WSOpCodes[WSOpCodes["Event"] = 1] = "Event"; | ||
})(WSOpCodes = exports.WSOpCodes || (exports.WSOpCodes = {})); | ||
//# sourceMappingURL=WS.js.map |
{ | ||
"name": "guilded-api-typings", | ||
"version": "0.3.0", | ||
"version": "0.3.1", | ||
"description": "Type definitions for the Guilded API.", | ||
@@ -5,0 +5,0 @@ "main": "lib/index.js", |
@@ -11,3 +11,4 @@ export * from './structures/Channel'; | ||
export * from './WS'; | ||
export * from './REST'; | ||
export * from './Routes'; | ||
//# sourceMappingURL=index.d.ts.map | ||
//# sourceMappingURL=index.d.ts.map |
/** The REST API endpoints for Guilded. */ | ||
export declare const Routes: { | ||
/** | ||
* The enpoint for channels on Guilded. | ||
* | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelCreate | ||
*/ | ||
channels: () => '/channels'; | ||
/** | ||
* The endpoint for a channel on Guilded. | ||
* @param channelId The ID of the channel. | ||
* | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelRead | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelUpdate | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelDelete | ||
*/ | ||
channel: (channelId: string) => `/channels/${string}`; | ||
/** | ||
* The endpoint for a server on Guilded. | ||
* @param serverId The ID of the server. | ||
* | ||
* @see https://www.guilded.gg/docs/api/servers/ServerRead | ||
*/ | ||
server: (serverId: string) => `/servers/${string}`; | ||
/** | ||
* The endpoint for messages on Guilded. | ||
* @param channelId The ID of the channel the messages belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageCreate | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageReadMany | ||
*/ | ||
messages: (channelId: string) => `/channels/${string}/messages`; | ||
/** | ||
* The endpoint for a message on Guilded. | ||
* @param channelId The ID of the channel the message belongs to. | ||
* @param messageId The ID of the message. | ||
* | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageRead | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageUpdate | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageDelete | ||
*/ | ||
message: (channelId: string, messageId: string) => `/channels/${string}/messages/${string}`; | ||
/** | ||
* The endpoint for a server nickname on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/members/MemberNicknameUpdate | ||
* @see https://www.guilded.gg/docs/api/members/MemberNicknameDelete | ||
*/ | ||
serverNickname: ( | ||
serverId: string, | ||
memberId: string, | ||
) => `/servers/${string}/members/${string}/nickname`; | ||
/** | ||
* The endpoint for a server member on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/members/ServerMemberRead | ||
* @see https://www.guilded.gg/docs/api/members/ServerMemberDelete | ||
*/ | ||
serverMember: (serverId: string, memberId: string) => `/servers/${string}/members/${string}`; | ||
/** | ||
* The endpoint for server members on Guilded. | ||
* @param serverId The ID of the server the members belong to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/members/ServerMemberReadMany | ||
*/ | ||
serverMembers: (serverId: string) => `/servers/${string}/members`; | ||
/** | ||
* The endpoint for a server ban on Guilded. | ||
* @param serverId The ID of the server the ban belongs to. | ||
* @param banId The ID of the ban. | ||
* | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanCreate | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanRead | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanDelete | ||
*/ | ||
serverBan: (serverId: string, banId: string) => `/servers/${string}/bans/${string}`; | ||
/** | ||
* The endpoint for server bans on Guilded. | ||
* @param serverId The ID of the server the bans belong to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanReadMany | ||
*/ | ||
serverBans: (serverId: string) => `/servers/${string}/bans`; | ||
/** | ||
* The endpoint for topics. | ||
* @param channelId The ID of the channel the topics belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/forums/ForumTopicCreate | ||
*/ | ||
topics: (channelId: string) => `/channels/${string}/topics`; | ||
/** | ||
* The endpoint for list items on Guilded. | ||
* @param channelId The ID of the channel the list items belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemCreate | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemReadMany | ||
*/ | ||
listItems: (channelId: string) => `/channels/${string}/items`; | ||
/** | ||
* The endpoint for a list item on Guilded. | ||
* @param channelId The ID of the channel the list item belongs to. | ||
* @param listItemId The ID of the list item. | ||
* | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemRead | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemUpdate | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemDelete | ||
*/ | ||
listItem: (channelId: string, listItemId: string) => `/channels/${string}/items/${string}`; | ||
/** | ||
* The endpoint for list item completions on Guilded. | ||
* @param channelId The ID of the channel the list item belongs to. | ||
* @param listItemId The ID of the list item. | ||
* | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemCompleteCreate | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemCompleteDelete | ||
*/ | ||
listItemComplete: ( | ||
channelId: string, | ||
listItemId: string, | ||
) => `/channels/${string}/items/${string}/complete`; | ||
/** | ||
* The endpoint for docs on Guilded. | ||
* @param channelId The ID of the channel the docs belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/docs/DocCreate | ||
* @see https://www.guilded.gg/docs/api/docs/DocReadMany | ||
*/ | ||
docs: (channelId: string) => `/channels/${string}/docs`; | ||
/** | ||
* The endpoint for a doc on Guilded. | ||
* @param channelId The ID of the channel the doc belongs to. | ||
* @param docId The ID of the doc. | ||
* | ||
* @see https://www.guilded.gg/docs/api/docs/DocRead | ||
* @see https://www.guilded.gg/docs/api/docs/DocUpdate | ||
* @see https://www.guilded.gg/docs/api/docs/DocDelete | ||
*/ | ||
doc: (channelId: string, docId: number) => `/channels/${string}/docs/${number}`; | ||
/** | ||
* The endpoint for a content reaction on Guilded. | ||
* @param channelId The ID of the channel the content belongs to. | ||
* @param contentId The ID of the content. | ||
* @param emoteId The ID of the emote. | ||
* | ||
* @see https://www.guilded.gg/docs/api/reactions/ContentReactionCreate | ||
*/ | ||
reaction: ( | ||
channelId: string, | ||
contentId: string, | ||
emoteId: number, | ||
) => `/channels/${string}/content/${string}/emotes/${number}`; | ||
/** | ||
* The endpoint for server member XP on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/server-xp/ServerXpForUserCreate | ||
*/ | ||
serverMemberXp: ( | ||
serverId: string, | ||
memberId: string, | ||
) => `/servers/${string}/members/${string}/xp`; | ||
/** | ||
* The endpoint for server role XP on Guilded. | ||
* @param serverId The ID of the server the role belongs to. | ||
* @param roleId The ID of the role. | ||
* | ||
* @see https://www.guilded.gg/docs/api/server-xp/ServerXpForRoleCreate | ||
*/ | ||
serverRoleXp: (serverId: string, roleId: number) => `/servers/${string}/roles/${number}/xp`; | ||
/** | ||
* The endpoint for a server member social link on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* @param type The type of social link. | ||
* | ||
* @see https://www.guilded.gg/docs/api/socialLinks/MemberSocialLinkRead | ||
*/ | ||
socialLink: ( | ||
serverId: string, | ||
memberId: string, | ||
type: string, | ||
) => `/servers/${string}/members/${string}/social-links/${string}`; | ||
/** | ||
* The endpoint for a group member on Guilded. | ||
* @param groupId The ID of the group the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/groupMembership/GroupMembershipCreate | ||
* @see https://www.guilded.gg/docs/api/groupMembership/GroupMembershipDelete | ||
*/ | ||
groupMember: (groupId: string, memberId: string) => `/groups/${string}/members/${string}`; | ||
/** | ||
* The endpoint for a server member role on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* @param roleId The ID of the role. | ||
* | ||
* @see https://www.guilded.gg/docs/api/roleMembership/RoleMembershipCreate | ||
* @see https://www.guilded.gg/docs/api/roleMembership/RoleMembershipDelete | ||
*/ | ||
serverMemberRole: ( | ||
serverId: string, | ||
memberId: string, | ||
roleId: number, | ||
) => `/servers/${string}/members/${string}/roles/${number}`; | ||
/** | ||
* The endpoint for server member roles on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/roleMembership/RoleMembershipReadMany | ||
*/ | ||
serverMemberRoles: ( | ||
serverId: string, | ||
memberId: string, | ||
) => `/servers/${string}/members/${string}/roles`; | ||
/** | ||
* The endpoint for webhooks on Guilded. | ||
* @param serverId The ID of the server the webhooks belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookCreate | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookReadMany | ||
*/ | ||
webhooks: (serverId: string) => `/servers/${string}/webhooks`; | ||
/** | ||
* The endpoint for a webhook on Guilded. | ||
* @param serverId The ID of the server the webhook belongs to. | ||
* @param webhookId The ID of the webhook. | ||
* | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookRead | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookUpdate | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookDelete | ||
*/ | ||
webhook: (serverId: string, webhookId: string) => `/servers/${string}/webhooks/${string}`; | ||
/** | ||
* The enpoint for channels on Guilded. | ||
* | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelCreate | ||
*/ | ||
channels: () => '/channels'; | ||
/** | ||
* The endpoint for a channel on Guilded. | ||
* @param channelId The ID of the channel. | ||
* | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelRead | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelUpdate | ||
* @see https://www.guilded.gg/docs/api/channels/ChannelDelete | ||
*/ | ||
channel: (channelId: string) => `/channels/${string}`; | ||
/** | ||
* The endpoint for a server on Guilded. | ||
* @param serverId The ID of the server. | ||
* | ||
* @see https://www.guilded.gg/docs/api/servers/ServerRead | ||
*/ | ||
server: (serverId: string) => `/servers/${string}`; | ||
/** | ||
* The endpoint for messages on Guilded. | ||
* @param channelId The ID of the channel the messages belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageCreate | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageReadMany | ||
*/ | ||
messages: (channelId: string) => `/channels/${string}/messages`; | ||
/** | ||
* The endpoint for a message on Guilded. | ||
* @param channelId The ID of the channel the message belongs to. | ||
* @param messageId The ID of the message. | ||
* | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageRead | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageUpdate | ||
* @see https://www.guilded.gg/docs/api/chat/ChannelMessageDelete | ||
*/ | ||
message: (channelId: string, messageId: string) => `/channels/${string}/messages/${string}`; | ||
/** | ||
* The endpoint for a server nickname on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/members/MemberNicknameUpdate | ||
* @see https://www.guilded.gg/docs/api/members/MemberNicknameDelete | ||
*/ | ||
serverNickname: (serverId: string, memberId: string) => `/servers/${string}/members/${string}/nickname`; | ||
/** | ||
* The endpoint for a server member on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/members/ServerMemberRead | ||
* @see https://www.guilded.gg/docs/api/members/ServerMemberDelete | ||
*/ | ||
serverMember: (serverId: string, memberId: string) => `/servers/${string}/members/${string}`; | ||
/** | ||
* The endpoint for server members on Guilded. | ||
* @param serverId The ID of the server the members belong to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/members/ServerMemberReadMany | ||
*/ | ||
serverMembers: (serverId: string) => `/servers/${string}/members`; | ||
/** | ||
* The endpoint for a server ban on Guilded. | ||
* @param serverId The ID of the server the ban belongs to. | ||
* @param banId The ID of the ban. | ||
* | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanCreate | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanRead | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanDelete | ||
*/ | ||
serverBan: (serverId: string, banId: string) => `/servers/${string}/bans/${string}`; | ||
/** | ||
* The endpoint for server bans on Guilded. | ||
* @param serverId The ID of the server the bans belong to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/member-bans/ServerMemberBanReadMany | ||
*/ | ||
serverBans: (serverId: string) => `/servers/${string}/bans`; | ||
/** | ||
* The endpoint for topics. | ||
* @param channelId The ID of the channel the topics belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/forums/ForumTopicCreate | ||
*/ | ||
topics: (channelId: string) => `/channels/${string}/topics`; | ||
/** | ||
* The endpoint for list items on Guilded. | ||
* @param channelId The ID of the channel the list items belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemCreate | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemReadMany | ||
*/ | ||
listItems: (channelId: string) => `/channels/${string}/items`; | ||
/** | ||
* The endpoint for a list item on Guilded. | ||
* @param channelId The ID of the channel the list item belongs to. | ||
* @param listItemId The ID of the list item. | ||
* | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemRead | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemUpdate | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemDelete | ||
*/ | ||
listItem: (channelId: string, listItemId: string) => `/channels/${string}/items/${string}`; | ||
/** | ||
* The endpoint for list item completions on Guilded. | ||
* @param channelId The ID of the channel the list item belongs to. | ||
* @param listItemId The ID of the list item. | ||
* | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemCompleteCreate | ||
* @see https://www.guilded.gg/docs/api/listItems/ListItemCompleteDelete | ||
*/ | ||
listItemComplete: (channelId: string, listItemId: string) => `/channels/${string}/items/${string}/complete`; | ||
/** | ||
* The endpoint for docs on Guilded. | ||
* @param channelId The ID of the channel the docs belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/docs/DocCreate | ||
* @see https://www.guilded.gg/docs/api/docs/DocReadMany | ||
*/ | ||
docs: (channelId: string) => `/channels/${string}/docs`; | ||
/** | ||
* The endpoint for a doc on Guilded. | ||
* @param channelId The ID of the channel the doc belongs to. | ||
* @param docId The ID of the doc. | ||
* | ||
* @see https://www.guilded.gg/docs/api/docs/DocRead | ||
* @see https://www.guilded.gg/docs/api/docs/DocUpdate | ||
* @see https://www.guilded.gg/docs/api/docs/DocDelete | ||
*/ | ||
doc: (channelId: string, docId: number) => `/channels/${string}/docs/${number}`; | ||
/** | ||
* The endpoint for a content reaction on Guilded. | ||
* @param channelId The ID of the channel the content belongs to. | ||
* @param contentId The ID of the content. | ||
* @param emoteId The ID of the emote. | ||
* | ||
* @see https://www.guilded.gg/docs/api/reactions/ContentReactionCreate | ||
*/ | ||
reaction: (channelId: string, contentId: string, emoteId: number) => `/channels/${string}/content/${string}/emotes/${number}`; | ||
/** | ||
* The endpoint for server member XP on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/server-xp/ServerXpForUserCreate | ||
*/ | ||
serverMemberXp: (serverId: string, memberId: string) => `/servers/${string}/members/${string}/xp`; | ||
/** | ||
* The endpoint for server role XP on Guilded. | ||
* @param serverId The ID of the server the role belongs to. | ||
* @param roleId The ID of the role. | ||
* | ||
* @see https://www.guilded.gg/docs/api/server-xp/ServerXpForRoleCreate | ||
*/ | ||
serverRoleXp: (serverId: string, roleId: number) => `/servers/${string}/roles/${number}/xp`; | ||
/** | ||
* The endpoint for a server member social link on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* @param type The type of social link. | ||
* | ||
* @see https://www.guilded.gg/docs/api/socialLinks/MemberSocialLinkRead | ||
*/ | ||
socialLink: (serverId: string, memberId: string, type: string) => `/servers/${string}/members/${string}/social-links/${string}`; | ||
/** | ||
* The endpoint for a group member on Guilded. | ||
* @param groupId The ID of the group the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/groupMembership/GroupMembershipCreate | ||
* @see https://www.guilded.gg/docs/api/groupMembership/GroupMembershipDelete | ||
*/ | ||
groupMember: (groupId: string, memberId: string) => `/groups/${string}/members/${string}`; | ||
/** | ||
* The endpoint for a server member role on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* @param roleId The ID of the role. | ||
* | ||
* @see https://www.guilded.gg/docs/api/roleMembership/RoleMembershipCreate | ||
* @see https://www.guilded.gg/docs/api/roleMembership/RoleMembershipDelete | ||
*/ | ||
serverMemberRole: (serverId: string, memberId: string, roleId: number) => `/servers/${string}/members/${string}/roles/${number}`; | ||
/** | ||
* The endpoint for server member roles on Guilded. | ||
* @param serverId The ID of the server the member belongs to. | ||
* @param memberId The ID of the member. | ||
* | ||
* @see https://www.guilded.gg/docs/api/roleMembership/RoleMembershipReadMany | ||
*/ | ||
serverMemberRoles: (serverId: string, memberId: string) => `/servers/${string}/members/${string}/roles`; | ||
/** | ||
* The endpoint for webhooks on Guilded. | ||
* @param serverId The ID of the server the webhooks belongs to. | ||
* | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookCreate | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookReadMany | ||
*/ | ||
webhooks: (serverId: string) => `/servers/${string}/webhooks`; | ||
/** | ||
* The endpoint for a webhook on Guilded. | ||
* @param serverId The ID of the server the webhook belongs to. | ||
* @param webhookId The ID of the webhook. | ||
* | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookRead | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookUpdate | ||
* @see https://www.guilded.gg/docs/api/webhook/WebhookDelete | ||
*/ | ||
webhook: (serverId: string, webhookId: string) => `/servers/${string}/webhooks/${string}`; | ||
}; | ||
//# sourceMappingURL=Routes.d.ts.map | ||
//# sourceMappingURL=Routes.d.ts.map |
@@ -6,30 +6,30 @@ /** | ||
export interface APIChannel { | ||
/** The ID of the channel. */ | ||
id: string; | ||
/** The type of the channel. */ | ||
type: APIChannelTypeString; | ||
/** The name of the channel. */ | ||
name: string; | ||
/** The topic of the channel. */ | ||
topic?: string; | ||
/** The date the channel was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the channel. */ | ||
createdBy: string; | ||
/** The date the channel was edited. */ | ||
updatedAt?: string; | ||
/** The ID of the server the channel belongs to. */ | ||
serverId: string; | ||
/** The ID of the parent channel the channel belongs to. */ | ||
parentId?: string; | ||
/** The ID of the category the channel belongs to. */ | ||
categoryId?: number; | ||
/** The ID of the group the channel belongs to. */ | ||
groupId: string; | ||
/** Whether the channel is public. */ | ||
isPublic?: boolean; | ||
/** The ID of the user that archived the channel. */ | ||
archivedBy?: string; | ||
/** The date the channel was archived. */ | ||
archivedAt?: string; | ||
/** The ID of the channel. */ | ||
id: string; | ||
/** The type of the channel. */ | ||
type: APIChannelTypeString; | ||
/** The name of the channel. */ | ||
name: string; | ||
/** The topic of the channel. */ | ||
topic?: string; | ||
/** The date the channel was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the channel. */ | ||
createdBy: string; | ||
/** The date the channel was edited. */ | ||
updatedAt?: string; | ||
/** The ID of the server the channel belongs to. */ | ||
serverId: string; | ||
/** The ID of the parent channel the channel belongs to. */ | ||
parentId?: string; | ||
/** The ID of the category the channel belongs to. */ | ||
categoryId?: number; | ||
/** The ID of the group the channel belongs to. */ | ||
groupId: string; | ||
/** Whether the channel is public. */ | ||
isPublic?: boolean; | ||
/** The ID of the user that archived the channel. */ | ||
archivedBy?: string; | ||
/** The date the channel was archived. */ | ||
archivedAt?: string; | ||
} | ||
@@ -41,12 +41,12 @@ /** | ||
export declare enum APIChannelType { | ||
Announcements = 'announcements', | ||
Chat = 'chat', | ||
Calendar = 'calendar', | ||
Forums = 'forums', | ||
Media = 'media', | ||
Docs = 'docs', | ||
Voice = 'voice', | ||
List = 'list', | ||
Scheduling = 'scheduling', | ||
Stream = 'stream', | ||
Announcements = "announcements", | ||
Chat = "chat", | ||
Calendar = "calendar", | ||
Forums = "forums", | ||
Media = "media", | ||
Docs = "docs", | ||
Voice = "voice", | ||
List = "list", | ||
Scheduling = "scheduling", | ||
Stream = "stream" | ||
} | ||
@@ -63,12 +63,12 @@ /** | ||
export interface APIChannelPayload extends APIChannelEditPayload { | ||
/** The name of the channel. */ | ||
name: string; | ||
/** The type of the channel. */ | ||
type: APIChannelTypeString; | ||
/** The ID of the server the channel belongs to. */ | ||
serverId?: string; | ||
/** The ID of the group the channel belongs to. */ | ||
groupId?: string; | ||
/** The ID of the category the channel belongs to. */ | ||
categoryId?: number; | ||
/** The name of the channel. */ | ||
name: string; | ||
/** The type of the channel. */ | ||
type: APIChannelTypeString; | ||
/** The ID of the server the channel belongs to. */ | ||
serverId?: string; | ||
/** The ID of the group the channel belongs to. */ | ||
groupId?: string; | ||
/** The ID of the category the channel belongs to. */ | ||
categoryId?: number; | ||
} | ||
@@ -80,8 +80,8 @@ /** | ||
export interface APIChannelEditPayload { | ||
/** The name of the channel. */ | ||
name?: string; | ||
/** The topic of the channel. */ | ||
topic?: string; | ||
/** Whether the channel is public. */ | ||
isPublic?: boolean; | ||
/** The name of the channel. */ | ||
name?: string; | ||
/** The topic of the channel. */ | ||
topic?: string; | ||
/** Whether the channel is public. */ | ||
isPublic?: boolean; | ||
} | ||
@@ -93,18 +93,18 @@ /** | ||
export interface APIMentions { | ||
/** The users that were mentioned. */ | ||
users?: { | ||
id: string; | ||
}[]; | ||
/** The channels that were mentioned. */ | ||
channels?: { | ||
id: string; | ||
}[]; | ||
/** The roles that were mentioned. */ | ||
roles?: { | ||
id: number; | ||
}[]; | ||
/** Whether everyone was mentioned. */ | ||
everyone?: boolean; | ||
/** Whether here was mentioned. */ | ||
here?: boolean; | ||
/** The users that were mentioned. */ | ||
users?: { | ||
id: string; | ||
}[]; | ||
/** The channels that were mentioned. */ | ||
channels?: { | ||
id: string; | ||
}[]; | ||
/** The roles that were mentioned. */ | ||
roles?: { | ||
id: number; | ||
}[]; | ||
/** Whether everyone was mentioned. */ | ||
everyone?: boolean; | ||
/** Whether here was mentioned. */ | ||
here?: boolean; | ||
} | ||
@@ -116,13 +116,13 @@ /** | ||
export interface APIReaction { | ||
/** The ID of the reaction. */ | ||
id: number; | ||
/** The ID of the server the reaction belongs to. */ | ||
serverId?: string; | ||
/** The date the reaction was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the reaction. */ | ||
createdBy: string; | ||
/** The ID of the webhook that created the reaction. */ | ||
createdByWebhookId?: string; | ||
/** The ID of the reaction. */ | ||
id: number; | ||
/** The ID of the server the reaction belongs to. */ | ||
serverId?: string; | ||
/** The date the reaction was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the reaction. */ | ||
createdBy: string; | ||
/** The ID of the webhook that created the reaction. */ | ||
createdByWebhookId?: string; | ||
} | ||
//# sourceMappingURL=Channel.d.ts.map | ||
//# sourceMappingURL=Channel.d.ts.map |
@@ -7,22 +7,22 @@ import { APIMentions } from './Channel'; | ||
export interface APIDoc { | ||
/** The ID of the doc. */ | ||
id: number; | ||
/** The ID of the server the doc belongs to. */ | ||
serverId: string; | ||
/** The ID of the channel the doc belongs to. */ | ||
channelId: string; | ||
/** The title of the doc. */ | ||
title: string; | ||
/** The content of the doc. */ | ||
content: string; | ||
/** The mentions of the doc. */ | ||
mentions?: APIMentions; | ||
/** The date the doc was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the doc. */ | ||
createdBy: string; | ||
/** The date the doc was edited. */ | ||
updatedAt?: string; | ||
/** The ID of the user that edited the doc. */ | ||
updatedBy?: string; | ||
/** The ID of the doc. */ | ||
id: number; | ||
/** The ID of the server the doc belongs to. */ | ||
serverId: string; | ||
/** The ID of the channel the doc belongs to. */ | ||
channelId: string; | ||
/** The title of the doc. */ | ||
title: string; | ||
/** The content of the doc. */ | ||
content: string; | ||
/** The mentions of the doc. */ | ||
mentions?: APIMentions; | ||
/** The date the doc was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the doc. */ | ||
createdBy: string; | ||
/** The date the doc was edited. */ | ||
updatedAt?: string; | ||
/** The ID of the user that edited the doc. */ | ||
updatedBy?: string; | ||
} | ||
@@ -35,6 +35,6 @@ /** | ||
export interface APIDocPayload { | ||
/** The title of the doc. */ | ||
title: string; | ||
/** The content of the doc. */ | ||
content: string; | ||
/** The title of the doc. */ | ||
title: string; | ||
/** The content of the doc. */ | ||
content: string; | ||
} | ||
@@ -46,7 +46,7 @@ /** | ||
export interface APIFetchDocsQuery { | ||
/** The date to fetch docs before. */ | ||
before?: string; | ||
/** The maximum number of docs to fetch. */ | ||
limit?: number; | ||
/** The date to fetch docs before. */ | ||
before?: string; | ||
/** The maximum number of docs to fetch. */ | ||
limit?: number; | ||
} | ||
//# sourceMappingURL=Doc.d.ts.map | ||
//# sourceMappingURL=Doc.d.ts.map |
@@ -6,22 +6,22 @@ /** | ||
export interface APIEmbed { | ||
/** The title of the embed. */ | ||
title?: string; | ||
/** The description of the embed. */ | ||
description?: string; | ||
/** The URL of the embed. */ | ||
url?: string; | ||
/** The color of the embed. */ | ||
color?: number; | ||
/** The footer of the embed. */ | ||
footer?: APIEmbedFooter; | ||
/** The timestamp of the embed. */ | ||
timestamp?: string; | ||
/** The thumbnail of the embed. */ | ||
thumbnail?: APIEmbedMedia; | ||
/** The image of the embed. */ | ||
image?: APIEmbedMedia; | ||
/** The author of the embed. */ | ||
author?: APIEmbedAuthor; | ||
/** The fields of the embed. */ | ||
fields?: APIEmbedField[]; | ||
/** The title of the embed. */ | ||
title?: string; | ||
/** The description of the embed. */ | ||
description?: string; | ||
/** The URL of the embed. */ | ||
url?: string; | ||
/** The color of the embed. */ | ||
color?: number; | ||
/** The footer of the embed. */ | ||
footer?: APIEmbedFooter; | ||
/** The timestamp of the embed. */ | ||
timestamp?: string; | ||
/** The thumbnail of the embed. */ | ||
thumbnail?: APIEmbedMedia; | ||
/** The image of the embed. */ | ||
image?: APIEmbedMedia; | ||
/** The author of the embed. */ | ||
author?: APIEmbedAuthor; | ||
/** The fields of the embed. */ | ||
fields?: APIEmbedField[]; | ||
} | ||
@@ -33,6 +33,6 @@ /** | ||
export interface APIEmbedFooter { | ||
/** The icon URL of the footer. */ | ||
icon_url?: string; | ||
/** The text of the footer. */ | ||
text: string; | ||
/** The icon URL of the footer. */ | ||
icon_url?: string; | ||
/** The text of the footer. */ | ||
text: string; | ||
} | ||
@@ -44,4 +44,4 @@ /** | ||
export interface APIEmbedMedia { | ||
/** The URL of the media. */ | ||
url?: string; | ||
/** The URL of the media. */ | ||
url?: string; | ||
} | ||
@@ -53,8 +53,8 @@ /** | ||
export interface APIEmbedAuthor { | ||
/** The name of the author. */ | ||
name?: string; | ||
/** The URL of the author. */ | ||
url?: string; | ||
/** The icon URL of the author. */ | ||
icon_url?: string; | ||
/** The name of the author. */ | ||
name?: string; | ||
/** The URL of the author. */ | ||
url?: string; | ||
/** The icon URL of the author. */ | ||
icon_url?: string; | ||
} | ||
@@ -66,9 +66,9 @@ /** | ||
export interface APIEmbedField { | ||
/** The name of the field. */ | ||
name: string; | ||
/** The value of the field. */ | ||
value: string; | ||
/** Whether the field is inline. */ | ||
inline?: boolean; | ||
/** The name of the field. */ | ||
name: string; | ||
/** The value of the field. */ | ||
value: string; | ||
/** Whether the field is inline. */ | ||
inline?: boolean; | ||
} | ||
//# sourceMappingURL=Embed.d.ts.map | ||
//# sourceMappingURL=Embed.d.ts.map |
@@ -7,4 +7,4 @@ import { APIMentions } from './Channel'; | ||
export interface APIListItem extends APIListItemSummary { | ||
/** The note of the list item. */ | ||
note?: APINote; | ||
/** The note of the list item. */ | ||
note?: APINote; | ||
} | ||
@@ -16,30 +16,30 @@ /** | ||
export interface APIListItemSummary { | ||
/** The ID of the list item. */ | ||
id: string; | ||
/** The ID of the server the list item belongs to. */ | ||
serverId: string; | ||
/** The ID of the channel the list item belongs to. */ | ||
channelId: string; | ||
/** The message of the list item. */ | ||
message: string; | ||
/** The mentions of the list item. */ | ||
mentions?: APIMentions; | ||
/** The date the list item was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the list item. */ | ||
createdBy: string; | ||
/** The ID of the webhook that created the list item. */ | ||
createdByWebhookId?: string; | ||
/** The date the list item was edited. */ | ||
updatedAt?: string; | ||
/** The ID of the user that edited the list item. */ | ||
updatedBy?: string; | ||
/** The ID of the parent list item that the list item belongs to. */ | ||
parentListItemId?: string; | ||
/** The date the list item was created. */ | ||
completedAt?: string; | ||
/** The ID of the user that completed the list item. */ | ||
completedBy?: string; | ||
/** The note of the list item. */ | ||
note?: APINoteSummary; | ||
/** The ID of the list item. */ | ||
id: string; | ||
/** The ID of the server the list item belongs to. */ | ||
serverId: string; | ||
/** The ID of the channel the list item belongs to. */ | ||
channelId: string; | ||
/** The message of the list item. */ | ||
message: string; | ||
/** The mentions of the list item. */ | ||
mentions?: APIMentions; | ||
/** The date the list item was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the list item. */ | ||
createdBy: string; | ||
/** The ID of the webhook that created the list item. */ | ||
createdByWebhookId?: string; | ||
/** The date the list item was edited. */ | ||
updatedAt?: string; | ||
/** The ID of the user that edited the list item. */ | ||
updatedBy?: string; | ||
/** The ID of the parent list item that the list item belongs to. */ | ||
parentListItemId?: string; | ||
/** The date the list item was created. */ | ||
completedAt?: string; | ||
/** The ID of the user that completed the list item. */ | ||
completedBy?: string; | ||
/** The note of the list item. */ | ||
note?: APINoteSummary; | ||
} | ||
@@ -51,4 +51,4 @@ /** | ||
export interface APINote extends APINoteSummary { | ||
/** The content of the note. */ | ||
content: string; | ||
/** The content of the note. */ | ||
content: string; | ||
} | ||
@@ -60,12 +60,12 @@ /** | ||
export interface APINoteSummary { | ||
/** The mentions of the note. */ | ||
mentions?: APIMentions; | ||
/** The date the note was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the note. */ | ||
createdBy: string; | ||
/** The date the note was edited. */ | ||
updatedAt?: string; | ||
/** The ID of the user that edited the note. */ | ||
updatedBy?: string; | ||
/** The mentions of the note. */ | ||
mentions?: APIMentions; | ||
/** The date the note was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the note. */ | ||
createdBy: string; | ||
/** The date the note was edited. */ | ||
updatedAt?: string; | ||
/** The ID of the user that edited the note. */ | ||
updatedBy?: string; | ||
} | ||
@@ -77,6 +77,6 @@ /** | ||
export interface APIListItemPayload { | ||
/** The message of the list item. */ | ||
message: string; | ||
/** The note of the list item. */ | ||
note?: APINotePayload; | ||
/** The message of the list item. */ | ||
message: string; | ||
/** The note of the list item. */ | ||
note?: APINotePayload; | ||
} | ||
@@ -88,5 +88,5 @@ /** | ||
export interface APINotePayload { | ||
/** The content of the note. */ | ||
content: string; | ||
/** The content of the note. */ | ||
content: string; | ||
} | ||
//# sourceMappingURL=ListItem.d.ts.map | ||
//# sourceMappingURL=ListItem.d.ts.map |
@@ -8,22 +8,22 @@ import { APIMentions } from './Channel'; | ||
export interface APIMessage extends Omit<APIMessageSummary, 'deletedAt'> { | ||
/** The type of the message. */ | ||
type: APIMessageTypeString; | ||
/** The content of the message. */ | ||
content?: string; | ||
/** The embeds of the message. */ | ||
embeds?: APIEmbed[]; | ||
/** The IDs of messages that were replied to. */ | ||
replyMessageIds?: string[]; | ||
/** Whether the message is silent. */ | ||
isSilent?: boolean; | ||
/** The mentions of the message. */ | ||
mentions?: APIMentions; | ||
/** The date the message was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the message. */ | ||
createdBy: string; | ||
/** The ID of the webhook that created the message. */ | ||
createdByWebhookId?: string; | ||
/** The date the message was edited. */ | ||
updatedAt?: string; | ||
/** The type of the message. */ | ||
type: APIMessageTypeString; | ||
/** The content of the message. */ | ||
content?: string; | ||
/** The embeds of the message. */ | ||
embeds?: APIEmbed[]; | ||
/** The IDs of messages that were replied to. */ | ||
replyMessageIds?: string[]; | ||
/** Whether the message is silent. */ | ||
isSilent?: boolean; | ||
/** The mentions of the message. */ | ||
mentions?: APIMentions; | ||
/** The date the message was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the message. */ | ||
createdBy: string; | ||
/** The ID of the webhook that created the message. */ | ||
createdByWebhookId?: string; | ||
/** The date the message was edited. */ | ||
updatedAt?: string; | ||
} | ||
@@ -35,12 +35,12 @@ /** | ||
export interface APIMessageSummary { | ||
/** The ID of the message. */ | ||
id: string; | ||
/** The ID of the server the message belongs to. */ | ||
serverId?: string; | ||
/** The ID of the channel the message belongs to. */ | ||
channelId: string; | ||
/** The date the message was deleted. */ | ||
deletedAt: string; | ||
/** Whether the message is private. */ | ||
isPrivate?: boolean; | ||
/** The ID of the message. */ | ||
id: string; | ||
/** The ID of the server the message belongs to. */ | ||
serverId?: string; | ||
/** The ID of the channel the message belongs to. */ | ||
channelId: string; | ||
/** The date the message was deleted. */ | ||
deletedAt: string; | ||
/** Whether the message is private. */ | ||
isPrivate?: boolean; | ||
} | ||
@@ -52,4 +52,4 @@ /** | ||
export declare enum APIMessageType { | ||
Default = 'default', | ||
System = 'system', | ||
Default = "default", | ||
System = "system" | ||
} | ||
@@ -66,8 +66,8 @@ /** | ||
export interface APIMessagePayload extends APIMessageEditPayload { | ||
/** Whether the message is private. */ | ||
isPrivate?: boolean; | ||
/** Whether the message is silent. */ | ||
isSilent?: boolean; | ||
/** The IDs of messages to reply to. */ | ||
replyMessageIds?: string[]; | ||
/** Whether the message is private. */ | ||
isPrivate?: boolean; | ||
/** Whether the message is silent. */ | ||
isSilent?: boolean; | ||
/** The IDs of messages to reply to. */ | ||
replyMessageIds?: string[]; | ||
} | ||
@@ -79,6 +79,6 @@ /** | ||
export interface APIMessageEditPayload { | ||
/** The content of the message. */ | ||
content?: string; | ||
/** The embeds of the message. */ | ||
embeds?: APIEmbed[]; | ||
/** The content of the message. */ | ||
content?: string; | ||
/** The embeds of the message. */ | ||
embeds?: APIEmbed[]; | ||
} | ||
@@ -94,11 +94,11 @@ /** The resolvable payload for creating a message. */ | ||
export interface APIFetchMessagesQuery { | ||
/** The date to fetch messages before. */ | ||
before?: string; | ||
/** The date to fetch messages after. */ | ||
after?: string; | ||
/** The limit of messages to fetch. */ | ||
limit?: number; | ||
/** Whether to include private messages. */ | ||
includePrivate?: boolean; | ||
/** The date to fetch messages before. */ | ||
before?: string; | ||
/** The date to fetch messages after. */ | ||
after?: string; | ||
/** The limit of messages to fetch. */ | ||
limit?: number; | ||
/** Whether to include private messages. */ | ||
includePrivate?: boolean; | ||
} | ||
//# sourceMappingURL=Message.d.ts.map | ||
//# sourceMappingURL=Message.d.ts.map |
@@ -7,26 +7,26 @@ import { APIUser, APIUserSummary } from './User'; | ||
export interface APIServer { | ||
/** The ID of the server. */ | ||
id: string; | ||
/** The ID of the user the server belongs to. */ | ||
ownerId: string; | ||
/** The type of the server. */ | ||
type?: APIServerTypeString; | ||
/** The name of the server. */ | ||
name: string; | ||
/** The vanity URL of the server. */ | ||
url?: string; | ||
/** The description of the server. */ | ||
about?: string; | ||
/** The URL of the server's avatar. */ | ||
avatar?: string; | ||
/** The URL of the server's banner. */ | ||
banner?: string; | ||
/** The timezone of the server. */ | ||
timezone?: string; | ||
/** Whether the server is verified. */ | ||
isVerified?: boolean; | ||
/** The ID of the server's default channel. */ | ||
defaultChannelId?: string; | ||
/** The date the server was created. */ | ||
createdAt: string; | ||
/** The ID of the server. */ | ||
id: string; | ||
/** The ID of the user the server belongs to. */ | ||
ownerId: string; | ||
/** The type of the server. */ | ||
type?: APIServerTypeString; | ||
/** The name of the server. */ | ||
name: string; | ||
/** The vanity URL of the server. */ | ||
url?: string; | ||
/** The description of the server. */ | ||
about?: string; | ||
/** The URL of the server's avatar. */ | ||
avatar?: string; | ||
/** The URL of the server's banner. */ | ||
banner?: string; | ||
/** The timezone of the server. */ | ||
timezone?: string; | ||
/** Whether the server is verified. */ | ||
isVerified?: boolean; | ||
/** The ID of the server's default channel. */ | ||
defaultChannelId?: string; | ||
/** The date the server was created. */ | ||
createdAt: string; | ||
} | ||
@@ -38,10 +38,10 @@ /** | ||
export declare enum APIServerType { | ||
Team = 'team', | ||
Organization = 'organization', | ||
Community = 'community', | ||
Clan = 'clan', | ||
Guild = 'guild', | ||
Friends = 'friends', | ||
Streaming = 'streaming', | ||
Other = 'other', | ||
Team = "team", | ||
Organization = "organization", | ||
Community = "community", | ||
Clan = "clan", | ||
Guild = "guild", | ||
Friends = "friends", | ||
Streaming = "streaming", | ||
Other = "other" | ||
} | ||
@@ -58,9 +58,9 @@ /** | ||
export interface APIServerMember extends APIServerMemberSummary { | ||
user: APIUser; | ||
/** The nickname of the server member. */ | ||
nickname?: string; | ||
/** The date the member joined the server. */ | ||
joinedAt: string; | ||
/** Whether the server member is the owner of the server. */ | ||
isOwner?: boolean; | ||
user: APIUser; | ||
/** The nickname of the server member. */ | ||
nickname?: string; | ||
/** The date the member joined the server. */ | ||
joinedAt: string; | ||
/** Whether the server member is the owner of the server. */ | ||
isOwner?: boolean; | ||
} | ||
@@ -72,6 +72,6 @@ /** | ||
export interface APIServerMemberSummary { | ||
/** The user the server member belongs to. */ | ||
user: APIUserSummary; | ||
/** The IDs of roles that belong to the server member. */ | ||
roleIds: number[]; | ||
/** The user the server member belongs to. */ | ||
user: APIUserSummary; | ||
/** The IDs of roles that belong to the server member. */ | ||
roleIds: number[]; | ||
} | ||
@@ -83,10 +83,10 @@ /** | ||
export interface APIServerBan { | ||
/** The user the server ban belongs to. */ | ||
user: APIUserSummary; | ||
/** The reason of the server ban. */ | ||
reason?: string; | ||
/** The ID of the user that created the server ban. */ | ||
createdBy: string; | ||
/** The date the server ban was created. */ | ||
createdAt: string; | ||
/** The user the server ban belongs to. */ | ||
user: APIUserSummary; | ||
/** The reason of the server ban. */ | ||
reason?: string; | ||
/** The ID of the user that created the server ban. */ | ||
createdBy: string; | ||
/** The date the server ban was created. */ | ||
createdAt: string; | ||
} | ||
@@ -98,4 +98,4 @@ /** | ||
export interface APIServerNicknamePayload { | ||
/** The nickname of the server member. */ | ||
nickname: string; | ||
/** The nickname of the server member. */ | ||
nickname: string; | ||
} | ||
@@ -107,4 +107,4 @@ /** | ||
export interface APIServerBanPayload { | ||
/** The reason of the server ban. */ | ||
reason?: string; | ||
/** The reason of the server ban. */ | ||
reason?: string; | ||
} | ||
@@ -117,4 +117,4 @@ /** | ||
export interface APIServerXpPayload { | ||
/** The amount of XP to award. */ | ||
amount: number; | ||
/** The amount of XP to award. */ | ||
amount: number; | ||
} | ||
@@ -126,9 +126,9 @@ /** | ||
export interface APISocialLink { | ||
/** The handle of the social link. */ | ||
handle?: string; | ||
/** The ID of the service the social link belongs to. */ | ||
serviceId?: string; | ||
/** The type of the social link. */ | ||
type: string; | ||
/** The handle of the social link. */ | ||
handle?: string; | ||
/** The ID of the service the social link belongs to. */ | ||
serviceId?: string; | ||
/** The type of the social link. */ | ||
type: string; | ||
} | ||
//# sourceMappingURL=Server.d.ts.map | ||
//# sourceMappingURL=Server.d.ts.map |
@@ -6,20 +6,20 @@ /** | ||
export interface APITopic { | ||
/** The ID of the forum topic. */ | ||
id: number; | ||
/** The ID of the server the forum topic belongs to. */ | ||
serverId: string; | ||
/** The ID of the channel the forum topic belongs to. */ | ||
channelId: string; | ||
/** The title of the forum topic. */ | ||
title?: string; | ||
/** The content of the forum topic. */ | ||
content?: string; | ||
/** The date the forum topic was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the forum topic. */ | ||
createdBy: string; | ||
/** The ID of the webhook that created the forum topic. */ | ||
createdByWebhookId?: string; | ||
/** The date the forum topic was edited. */ | ||
updatedAt?: string; | ||
/** The ID of the forum topic. */ | ||
id: number; | ||
/** The ID of the server the forum topic belongs to. */ | ||
serverId: string; | ||
/** The ID of the channel the forum topic belongs to. */ | ||
channelId: string; | ||
/** The title of the forum topic. */ | ||
title?: string; | ||
/** The content of the forum topic. */ | ||
content?: string; | ||
/** The date the forum topic was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the forum topic. */ | ||
createdBy: string; | ||
/** The ID of the webhook that created the forum topic. */ | ||
createdByWebhookId?: string; | ||
/** The date the forum topic was edited. */ | ||
updatedAt?: string; | ||
} | ||
@@ -31,7 +31,7 @@ /** | ||
export interface APITopicPayload { | ||
/** The title of the forum topic. */ | ||
title: string; | ||
/** The content of the forum topic. */ | ||
content: string; | ||
/** The title of the forum topic. */ | ||
title: string; | ||
/** The content of the forum topic. */ | ||
content: string; | ||
} | ||
//# sourceMappingURL=Topic.d.ts.map | ||
//# sourceMappingURL=Topic.d.ts.map |
@@ -6,6 +6,6 @@ /** | ||
export interface APIUser extends APIUserSummary { | ||
/** The URL of the user's banner. */ | ||
banner?: string; | ||
/** The date the user was created. */ | ||
createdAt: string; | ||
/** The URL of the user's banner. */ | ||
banner?: string; | ||
/** The date the user was created. */ | ||
createdAt: string; | ||
} | ||
@@ -17,10 +17,10 @@ /** | ||
export interface APIUserSummary { | ||
/** The ID of the user. */ | ||
id: string; | ||
/** The type of the user. */ | ||
type?: APIUserTypeString; | ||
/** The name of the user. */ | ||
name: string; | ||
/** The URL of the user's avatar. */ | ||
avatar?: string; | ||
/** The ID of the user. */ | ||
id: string; | ||
/** The type of the user. */ | ||
type?: APIUserTypeString; | ||
/** The name of the user. */ | ||
name: string; | ||
/** The URL of the user's avatar. */ | ||
avatar?: string; | ||
} | ||
@@ -33,4 +33,4 @@ /** | ||
export declare enum APIUserType { | ||
Bot = 'bot', | ||
User = 'user', | ||
Bot = "bot", | ||
User = "user" | ||
} | ||
@@ -43,2 +43,2 @@ /** | ||
export declare type APIUserTypeString = `${APIUserType}`; | ||
//# sourceMappingURL=User.d.ts.map | ||
//# sourceMappingURL=User.d.ts.map |
@@ -6,18 +6,18 @@ /** | ||
export interface APIWebhook { | ||
/** The ID of the webhook. */ | ||
id: string; | ||
/** The name of the webhook. */ | ||
name: string; | ||
/** The ID of the server the webhook belongs to. */ | ||
serverId: string; | ||
/** The ID of the channel the webhook belongs to. */ | ||
channelId: string; | ||
/** The date the webhook was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the webhook. */ | ||
createdBy: string; | ||
/** The date the webhook was deleted. */ | ||
deletedAt?: string; | ||
/** The token of the webhook. */ | ||
token?: string; | ||
/** The ID of the webhook. */ | ||
id: string; | ||
/** The name of the webhook. */ | ||
name: string; | ||
/** The ID of the server the webhook belongs to. */ | ||
serverId: string; | ||
/** The ID of the channel the webhook belongs to. */ | ||
channelId: string; | ||
/** The date the webhook was created. */ | ||
createdAt: string; | ||
/** The ID of the user that created the webhook. */ | ||
createdBy: string; | ||
/** The date the webhook was deleted. */ | ||
deletedAt?: string; | ||
/** The token of the webhook. */ | ||
token?: string; | ||
} | ||
@@ -29,4 +29,4 @@ /** | ||
export interface APIWebhookPayload extends APIWebhookEditPayload { | ||
/** The ID of the channel the webhook belongs to. */ | ||
channelId: string; | ||
/** The ID of the channel the webhook belongs to. */ | ||
channelId: string; | ||
} | ||
@@ -38,6 +38,6 @@ /** | ||
export interface APIWebhookEditPayload { | ||
/** The name of the webhook. */ | ||
name: string; | ||
/** The ID of the channel the webhook belongs to. */ | ||
channelId?: string; | ||
/** The name of the webhook. */ | ||
name: string; | ||
/** The ID of the channel the webhook belongs to. */ | ||
channelId?: string; | ||
} | ||
@@ -49,5 +49,5 @@ /** | ||
export interface APIFetchWebhooksQuery { | ||
/** The ID of the channel the webhooks belong to. */ | ||
channelId: string; | ||
/** The ID of the channel the webhooks belong to. */ | ||
channelId: string; | ||
} | ||
//# sourceMappingURL=Webhook.d.ts.map | ||
//# sourceMappingURL=Webhook.d.ts.map |
@@ -12,244 +12,244 @@ import { APIChannel } from './structures/Channel'; | ||
export interface WSEvents { | ||
/** | ||
* Emitted when a message is created. | ||
* @see https://www.guilded.gg/docs/api/websockets/ChatMessageCreated | ||
*/ | ||
ChatMessageCreated: { | ||
/** The ID of the server the message belongs to. */ | ||
serverId: string; | ||
/** The message that was created. */ | ||
message: APIMessage; | ||
}; | ||
/** | ||
* Emitted when a message is edited. | ||
* @see https://www.guilded.gg/docs/api/websockets/ChatMessageUpdated | ||
*/ | ||
ChatMessageUpdated: { | ||
/** The ID of the server the message belongs to. */ | ||
serverId: string; | ||
/** The message that was edited. */ | ||
message: APIMessage; | ||
}; | ||
/** | ||
* Emitted when a message is deleted. | ||
* @see https://www.guilded.gg/docs/api/websockets/ChatMessageDeleted | ||
*/ | ||
ChatMessageDeleted: { | ||
/** The ID of the server the message belongs to. */ | ||
serverId: string; | ||
/** The message that was deleted. */ | ||
message: APIMessageSummary; | ||
}; | ||
/** | ||
* Emitted whan a member joins a server. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamMemberJoined | ||
*/ | ||
TeamMemberJoined: { | ||
/** The ID of the server the member belongs to. */ | ||
serverId: string; | ||
/** The member that joined the server. */ | ||
member: APIServerMember; | ||
}; | ||
/** | ||
* Emitted when a member leaves a server. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamMemberRemoved | ||
*/ | ||
TeamMemberRemoved: { | ||
/** The ID of the server the member belongs to. */ | ||
serverId: string; | ||
/** The ID of the member that left the server. */ | ||
userId: string; | ||
/** Whether the member was kicked from the server. */ | ||
isKick?: boolean; | ||
/** Whether the member was banned from the server. */ | ||
isBan?: boolean; | ||
}; | ||
/** | ||
* Emitted when a member is banned from a server. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamMemberBanned | ||
*/ | ||
TeamMemberBanned: { | ||
/** The ID of the server the ban belongs to. */ | ||
serverId: string; | ||
/** The created server ban. */ | ||
serverMemberBan: APIServerBan; | ||
}; | ||
/** | ||
* Emitted when a member is unbanned from a server. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamMemberUnbanned | ||
*/ | ||
TeamMemberUnbanned: { | ||
/** The ID of the server the ban belongs to. */ | ||
serverId: string; | ||
/** The deleted server ban. */ | ||
serverMemberBan: APIServerBan; | ||
}; | ||
/** | ||
* Emitted when a server member is edited. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamMemberUpdated | ||
*/ | ||
TeamMemberUpdated: { | ||
/** The ID of the server the member belongs to. */ | ||
serverId: string; | ||
/** The updated information about the server member. */ | ||
userInfo: { | ||
/** The ID of the member that was edited. */ | ||
id: string; | ||
/** The nickname of the member. */ | ||
nickname?: string; | ||
}; | ||
}; | ||
/** | ||
* Emitted when roles in a server are edited. | ||
* @see https://www.guilded.gg/docs/api/websockets/teamRolesUpdated | ||
*/ | ||
teamRolesUpdated: { | ||
/** The ID of the server the roles belong to. */ | ||
serverId: string; | ||
/** The updated roles. */ | ||
memberRoleIds: { | ||
/** The ID of the member that own the roles. */ | ||
userId: string; | ||
/** The IDs of the roles the member now has. */ | ||
roleIds: number[]; | ||
}[]; | ||
}; | ||
/** | ||
* Emitted when a channel is created. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamChannelCreated | ||
*/ | ||
TeamChannelCreated: { | ||
/** The ID of the server the channel belongs to. */ | ||
serverId: string; | ||
/** The created channel. */ | ||
channel: APIChannel; | ||
}; | ||
/** | ||
* Emitted when a channel is edited. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamChannelUpdated | ||
*/ | ||
TeamChannelUpdated: { | ||
/** The ID of the server the channel belongs to. */ | ||
serverId: string; | ||
/** The edited channel. */ | ||
channel: APIChannel; | ||
}; | ||
/** | ||
* Emitted when a channel is deleted. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamChannelDeleted | ||
*/ | ||
TeamChannelDeleted: { | ||
/** The ID of the server the channel belongs to. */ | ||
serverId: string; | ||
/** The deleted channel. */ | ||
channel: APIChannel; | ||
}; | ||
/** | ||
* Emitted when a webhook is created. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamWebhookCreated | ||
*/ | ||
TeamWebhookCreated: { | ||
/** The ID of the server the webhook belongs to. */ | ||
serverId: string; | ||
/** The created webhook. */ | ||
webhook: APIWebhook; | ||
}; | ||
/** | ||
* Emitted when a webhook is edited. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamWebhookUpdated | ||
*/ | ||
TeamWebhookUpdated: { | ||
/** The ID of the server the webhook belongs to. */ | ||
serverId: string; | ||
/** The edited webhook. */ | ||
webhook: APIWebhook; | ||
}; | ||
/** | ||
* Emitted when a doc is created. | ||
* @see https://www.guilded.gg/docs/api/websockets/DocCreated | ||
*/ | ||
DocCreated: { | ||
/** The ID of the server the doc belongs to. */ | ||
serverId: string; | ||
/** The created doc. */ | ||
doc: APIDoc; | ||
}; | ||
/** | ||
* Emitted when a doc is edited. | ||
* @see https://www.guilded.gg/docs/api/websockets/DocUpdated | ||
*/ | ||
DocUpdated: { | ||
/** The ID of the server the doc belongs to. */ | ||
serverId: string; | ||
/** The edited doc. */ | ||
doc: APIDoc; | ||
}; | ||
/** | ||
* Emitted when a doc is deleted. | ||
* @see https://www.guilded.gg/docs/api/websockets/DocDeleted | ||
*/ | ||
DocDeleted: { | ||
/** The ID of the server the doc belongs to. */ | ||
serverId: string; | ||
/** The deleted doc. */ | ||
doc: APIDoc; | ||
}; | ||
/** | ||
* Emitted when a list item is created. | ||
* @see https://www.guilded.gg/docs/api/websockets/ListItemCreated | ||
*/ | ||
ListItemCreated: { | ||
/** The ID of the server the list item belongs to. */ | ||
serverId: string; | ||
/** The created list item. */ | ||
listItem: APIListItem; | ||
}; | ||
/** | ||
* Emitted when a list item is edited. | ||
* @see https://www.guilded.gg/docs/api/websockets/ListItemUpdated | ||
*/ | ||
ListItemUpdated: { | ||
/** The ID of the server the list item belongs to. */ | ||
serverId: string; | ||
/** The edited list item. */ | ||
listItem: APIListItem; | ||
}; | ||
/** | ||
* Emitted when a list item is deleted. | ||
* @see https://www.guilded.gg/docs/api/websockets/ListItemDeleted | ||
*/ | ||
ListItemDeleted: { | ||
/** The ID of the server the list item belongs to. */ | ||
serverId: string; | ||
/** The deleted list item. */ | ||
listItem: APIListItem; | ||
}; | ||
/** | ||
* Emitted when a list item is completed. | ||
* @see https://www.guilded.gg/docs/api/websockets/ListItemCompleted | ||
*/ | ||
ListItemCompleted: { | ||
/** The ID of the server the list item belongs to. */ | ||
serverId: string; | ||
/** The completed list item. */ | ||
listItem: APIListItem; | ||
}; | ||
/** | ||
* Emitted when a list item is uncompleted. | ||
* @see https://www.guilded.gg/docs/api/websockets/ListItemUncompleted | ||
*/ | ||
ListItemUncompleted: { | ||
/** The ID of the server thw list item belongs to. */ | ||
serverId: string; | ||
/** The uncompleted list item. */ | ||
listItem: APIListItem; | ||
}; | ||
/** | ||
* Emitted when a message is created. | ||
* @see https://www.guilded.gg/docs/api/websockets/ChatMessageCreated | ||
*/ | ||
ChatMessageCreated: { | ||
/** The ID of the server the message belongs to. */ | ||
serverId: string; | ||
/** The message that was created. */ | ||
message: APIMessage; | ||
}; | ||
/** | ||
* Emitted when a message is edited. | ||
* @see https://www.guilded.gg/docs/api/websockets/ChatMessageUpdated | ||
*/ | ||
ChatMessageUpdated: { | ||
/** The ID of the server the message belongs to. */ | ||
serverId: string; | ||
/** The message that was edited. */ | ||
message: APIMessage; | ||
}; | ||
/** | ||
* Emitted when a message is deleted. | ||
* @see https://www.guilded.gg/docs/api/websockets/ChatMessageDeleted | ||
*/ | ||
ChatMessageDeleted: { | ||
/** The ID of the server the message belongs to. */ | ||
serverId: string; | ||
/** The message that was deleted. */ | ||
message: APIMessageSummary; | ||
}; | ||
/** | ||
* Emitted whan a member joins a server. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamMemberJoined | ||
*/ | ||
TeamMemberJoined: { | ||
/** The ID of the server the member belongs to. */ | ||
serverId: string; | ||
/** The member that joined the server. */ | ||
member: APIServerMember; | ||
}; | ||
/** | ||
* Emitted when a member leaves a server. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamMemberRemoved | ||
*/ | ||
TeamMemberRemoved: { | ||
/** The ID of the server the member belongs to. */ | ||
serverId: string; | ||
/** The ID of the member that left the server. */ | ||
userId: string; | ||
/** Whether the member was kicked from the server. */ | ||
isKick?: boolean; | ||
/** Whether the member was banned from the server. */ | ||
isBan?: boolean; | ||
}; | ||
/** | ||
* Emitted when a member is banned from a server. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamMemberBanned | ||
*/ | ||
TeamMemberBanned: { | ||
/** The ID of the server the ban belongs to. */ | ||
serverId: string; | ||
/** The created server ban. */ | ||
serverMemberBan: APIServerBan; | ||
}; | ||
/** | ||
* Emitted when a member is unbanned from a server. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamMemberUnbanned | ||
*/ | ||
TeamMemberUnbanned: { | ||
/** The ID of the server the ban belongs to. */ | ||
serverId: string; | ||
/** The deleted server ban. */ | ||
serverMemberBan: APIServerBan; | ||
}; | ||
/** | ||
* Emitted when a server member is edited. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamMemberUpdated | ||
*/ | ||
TeamMemberUpdated: { | ||
/** The ID of the server the member belongs to. */ | ||
serverId: string; | ||
/** The updated information about the server member. */ | ||
userInfo: { | ||
/** The ID of the member that was edited. */ | ||
id: string; | ||
/** The nickname of the member. */ | ||
nickname?: string; | ||
}; | ||
}; | ||
/** | ||
* Emitted when roles in a server are edited. | ||
* @see https://www.guilded.gg/docs/api/websockets/teamRolesUpdated | ||
*/ | ||
teamRolesUpdated: { | ||
/** The ID of the server the roles belong to. */ | ||
serverId: string; | ||
/** The updated roles. */ | ||
memberRoleIds: { | ||
/** The ID of the member that own the roles. */ | ||
userId: string; | ||
/** The IDs of the roles the member now has. */ | ||
roleIds: number[]; | ||
}[]; | ||
}; | ||
/** | ||
* Emitted when a channel is created. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamChannelCreated | ||
*/ | ||
TeamChannelCreated: { | ||
/** The ID of the server the channel belongs to. */ | ||
serverId: string; | ||
/** The created channel. */ | ||
channel: APIChannel; | ||
}; | ||
/** | ||
* Emitted when a channel is edited. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamChannelUpdated | ||
*/ | ||
TeamChannelUpdated: { | ||
/** The ID of the server the channel belongs to. */ | ||
serverId: string; | ||
/** The edited channel. */ | ||
channel: APIChannel; | ||
}; | ||
/** | ||
* Emitted when a channel is deleted. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamChannelDeleted | ||
*/ | ||
TeamChannelDeleted: { | ||
/** The ID of the server the channel belongs to. */ | ||
serverId: string; | ||
/** The deleted channel. */ | ||
channel: APIChannel; | ||
}; | ||
/** | ||
* Emitted when a webhook is created. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamWebhookCreated | ||
*/ | ||
TeamWebhookCreated: { | ||
/** The ID of the server the webhook belongs to. */ | ||
serverId: string; | ||
/** The created webhook. */ | ||
webhook: APIWebhook; | ||
}; | ||
/** | ||
* Emitted when a webhook is edited. | ||
* @see https://www.guilded.gg/docs/api/websockets/TeamWebhookUpdated | ||
*/ | ||
TeamWebhookUpdated: { | ||
/** The ID of the server the webhook belongs to. */ | ||
serverId: string; | ||
/** The edited webhook. */ | ||
webhook: APIWebhook; | ||
}; | ||
/** | ||
* Emitted when a doc is created. | ||
* @see https://www.guilded.gg/docs/api/websockets/DocCreated | ||
*/ | ||
DocCreated: { | ||
/** The ID of the server the doc belongs to. */ | ||
serverId: string; | ||
/** The created doc. */ | ||
doc: APIDoc; | ||
}; | ||
/** | ||
* Emitted when a doc is edited. | ||
* @see https://www.guilded.gg/docs/api/websockets/DocUpdated | ||
*/ | ||
DocUpdated: { | ||
/** The ID of the server the doc belongs to. */ | ||
serverId: string; | ||
/** The edited doc. */ | ||
doc: APIDoc; | ||
}; | ||
/** | ||
* Emitted when a doc is deleted. | ||
* @see https://www.guilded.gg/docs/api/websockets/DocDeleted | ||
*/ | ||
DocDeleted: { | ||
/** The ID of the server the doc belongs to. */ | ||
serverId: string; | ||
/** The deleted doc. */ | ||
doc: APIDoc; | ||
}; | ||
/** | ||
* Emitted when a list item is created. | ||
* @see https://www.guilded.gg/docs/api/websockets/ListItemCreated | ||
*/ | ||
ListItemCreated: { | ||
/** The ID of the server the list item belongs to. */ | ||
serverId: string; | ||
/** The created list item. */ | ||
listItem: APIListItem; | ||
}; | ||
/** | ||
* Emitted when a list item is edited. | ||
* @see https://www.guilded.gg/docs/api/websockets/ListItemUpdated | ||
*/ | ||
ListItemUpdated: { | ||
/** The ID of the server the list item belongs to. */ | ||
serverId: string; | ||
/** The edited list item. */ | ||
listItem: APIListItem; | ||
}; | ||
/** | ||
* Emitted when a list item is deleted. | ||
* @see https://www.guilded.gg/docs/api/websockets/ListItemDeleted | ||
*/ | ||
ListItemDeleted: { | ||
/** The ID of the server the list item belongs to. */ | ||
serverId: string; | ||
/** The deleted list item. */ | ||
listItem: APIListItem; | ||
}; | ||
/** | ||
* Emitted when a list item is completed. | ||
* @see https://www.guilded.gg/docs/api/websockets/ListItemCompleted | ||
*/ | ||
ListItemCompleted: { | ||
/** The ID of the server the list item belongs to. */ | ||
serverId: string; | ||
/** The completed list item. */ | ||
listItem: APIListItem; | ||
}; | ||
/** | ||
* Emitted when a list item is uncompleted. | ||
* @see https://www.guilded.gg/docs/api/websockets/ListItemUncompleted | ||
*/ | ||
ListItemUncompleted: { | ||
/** The ID of the server thw list item belongs to. */ | ||
serverId: string; | ||
/** The uncompleted list item. */ | ||
listItem: APIListItem; | ||
}; | ||
} | ||
/** The Guilded WebSocket API operation codes. */ | ||
export declare enum WSOpCodes { | ||
/** The ready operation code. */ | ||
Ready = 0, | ||
/** The event operation code. */ | ||
Event = 1, | ||
/** The ready operation code. */ | ||
Ready = 0, | ||
/** The event operation code. */ | ||
Event = 1 | ||
} | ||
//# sourceMappingURL=WS.d.ts.map | ||
//# sourceMappingURL=WS.d.ts.map |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
84988
55
1491