guildedapi-types.ts
Version:
Up to date Guilded API Typings. Contribution is welcome.
1,584 lines • 331 kB
text/typescript
export interface paths {
"/channels/{channelId}/messages": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get channel messages
* @description Results returned will be ordered ascending by the message's `createdAt`. `before` and `after` will filter based on the message's `createdAt`
*/
get: operations["ChannelMessageReadMany"];
put?: never;
/** Create a channel message */
post: operations["ChannelMessageCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/messages/{messageId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get a channel message
* @description Get details for a specific chat message from a chat channel.
*/
get: operations["ChannelMessageRead"];
/** Update a channel message */
put: operations["ChannelMessageUpdate"];
post?: never;
/** Delete a channel message */
delete: operations["ChannelMessageDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/groups/{groupId}/members/{userId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Add member to group */
put: operations["GroupMembershipCreate"];
post?: never;
/** Remove member from group */
delete: operations["GroupMembershipDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/members/{userId}/xp": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Set a member's XP */
put: operations["ServerXpForUserUpdate"];
/** Award XP to a member */
post: operations["ServerXpForUserCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/xp": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Bulk set members' XP
* @description Take note of the max number of `userIds` that can be submitted on each request. If you require more, please batch your requests
*/
put: operations["ServerXpForUserUpdateMany"];
/**
* Bulk award XP to members
* @description Take note of the max number of `userIds` that can be submitted on each request. If you require more, please batch your requests
*/
post: operations["ServerXpForUserCreateMany"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/roles/{roleId}/xp": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Award XP to role
* @description Award XP to all members with a particular role.
*/
post: operations["ServerXpForRoleCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/members/{userId}/roles/{roleId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Assign role to member */
put: operations["RoleMembershipCreate"];
post?: never;
/** Remove role from member */
delete: operations["RoleMembershipDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/members/{userId}/roles": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get member roles
* @description Get a list of the roles assigned to a member
*/
get: operations["RoleMembershipReadMany"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/topics": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get forum topics */
get: operations["ForumTopicReadMany"];
put?: never;
/** Create a topic in a forum */
post: operations["ForumTopicCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/topics/{forumTopicId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a forum topic */
get: operations["ForumTopicRead"];
put?: never;
post?: never;
/** Delete a forum topic */
delete: operations["ForumTopicDelete"];
options?: never;
head?: never;
/** Update a forum topic */
patch: operations["ForumTopicUpdate"];
trace?: never;
};
"/channels/{channelId}/topics/{forumTopicId}/pin": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Pin a forum topic */
put: operations["ForumTopicPin"];
post?: never;
/** Unpin a forum topic */
delete: operations["ForumTopicUnpin"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/topics/{forumTopicId}/emotes/{emoteId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Create forum topic reaction */
put: operations["ForumTopicReactionCreate"];
post?: never;
/** Delete forum topic reaction */
delete: operations["ForumTopicReactionDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/topics/{forumTopicId}/lock": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Lock a forum topic */
put: operations["ForumTopicLock"];
post?: never;
/** Unlock a forum topic */
delete: operations["ForumTopicUnlock"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/topics/{forumTopicId}/comments": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a forum topic's comments */
get: operations["ForumTopicCommentReadMany"];
put?: never;
/** Create a forum topic comment */
post: operations["ForumTopicCommentCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/topics/{forumTopicId}/comments/{forumTopicCommentId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a comment on a forum topic */
get: operations["ForumTopicCommentRead"];
put?: never;
post?: never;
/** Delete a forum topic comment */
delete: operations["ForumTopicCommentDelete"];
options?: never;
head?: never;
/** Update a forum topic comment */
patch: operations["ForumTopicCommentUpdate"];
trace?: never;
};
"/channels/{channelId}/items": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get list items within a channel */
get: operations["ListItemReadMany"];
put?: never;
/** Create a list item */
post: operations["ListItemCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/items/{listItemId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a list item */
get: operations["ListItemRead"];
put?: never;
post?: never;
/** Delete a list item */
delete: operations["ListItemDelete"];
options?: never;
head?: never;
/** Update a list item */
patch: operations["ListItemUpdate"];
trace?: never;
};
"/channels/{channelId}/items/{listItemId}/complete": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Complete a list item */
post: operations["ListItemCompleteCreate"];
/** Uncomplete a list item */
delete: operations["ListItemCompleteDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/members/{userId}/social-links/{socialLinkType}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Retrieves a member's public social links */
get: operations["MemberSocialLinkRead"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/members/{userId}/nickname": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Update a member's nickname */
put: operations["MemberNicknameUpdate"];
post?: never;
/** Delete a member's nickname */
delete: operations["MemberNicknameDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create a channel
* @description Only server channels are supported at this time (coming soon™: DM Channels!). By default, a channel will be created with a null value for priority on a server. You can update its priority using [the channel update route](/docs/api/channels/ChannelUpdate)
*/
post: operations["ChannelCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get a channel
* @description Must be a member of the server to get the channel. Only server channels are supported at this time (coming soon™: DM Channels!)
*/
get: operations["ChannelRead"];
put?: never;
post?: never;
/**
* Delete a channel
* @description Only server channels are supported at this time (coming soon™: DM Channels!)
*/
delete: operations["ChannelDelete"];
options?: never;
head?: never;
/**
* Update a channel
* @description Only server channels are supported at this time (coming soon™: DM Channels!)
*/
patch: operations["ChannelUpdate"];
trace?: never;
};
"/channels/{channelId}/docs": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get docs
* @description Results returned will be ordered descending by the doc's `updatedAt`. `before` will filter based on the doc's `updatedAt`
*/
get: operations["DocReadMany"];
put?: never;
/** Create a doc */
post: operations["DocCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/docs/{docId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a doc */
get: operations["DocRead"];
/** Update a doc */
put: operations["DocUpdate"];
post?: never;
/** Delete a doc */
delete: operations["DocDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/members/{userId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a server member */
get: operations["ServerMemberRead"];
put?: never;
post?: never;
/**
* Kick a server member
* @description This route can be used to leave servers by passing in your own user ID or `@me` for `userId`
*/
delete: operations["ServerMemberDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/members": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get members of a server
* @description Results returned will be ordered ascending by the member's `joinedAt`
*/
get: operations["ServerMemberReadMany"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/bans/{userId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a server ban */
get: operations["ServerMemberBanRead"];
put?: never;
/**
* Create a server ban
* @description Also known as banning a server member
*/
post: operations["ServerMemberBanCreate"];
/**
* Delete a server ban
* @description Also known as unbanning a server member
*/
delete: operations["ServerMemberBanDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/bans": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get server bans */
get: operations["ServerMemberBanReadMany"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/webhooks": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get a server's webhooks
* @description Get a list of webhooks from a server.
*/
get: operations["WebhookReadMany"];
put?: never;
/**
* Create a webhook
* @description Note that each server can only have 200 webhooks
*/
post: operations["WebhookCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/webhooks/{webhookId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a server's webhook */
get: operations["WebhookRead"];
/** Update a webhook */
put: operations["WebhookUpdate"];
post?: never;
/** Delete a server webhook */
delete: operations["WebhookDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get a server
* @description Fetch various information about a given server. Currently, the bot must be a member of the server in order to fetch its information.
*/
get: operations["ServerRead"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/events": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get calendar events
* @description Results returned will be ordered ascending by the event's `startsAt`. `before` and `after` will filter based on the event's `startsAt`
*/
get: operations["CalendarEventReadMany"];
put?: never;
/**
* Create a calendar event
* @description We currently do not have a way to surface the `repeatInfo` after event series are updated. Stay tuned!
*/
post: operations["CalendarEventCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/events/{calendarEventId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a calendar event */
get: operations["CalendarEventRead"];
put?: never;
post?: never;
/** Delete a calendar event */
delete: operations["CalendarEventDelete"];
options?: never;
head?: never;
/**
* Update a calendar event
* @description We currently do not have a way to surface the `repeatInfo` after event series are updated. Stay tuned!
*/
patch: operations["CalendarEventUpdate"];
trace?: never;
};
"/channels/{channelId}/events/{calendarEventId}/rsvps/{userId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a calendar event RSVP */
get: operations["CalendarEventRsvpRead"];
/** Create or update a calendar event RSVP */
put: operations["CalendarEventRsvpUpdate"];
post?: never;
/** Delete a calendar event RSVP */
delete: operations["CalendarEventRsvpDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/events/{calendarEventId}/rsvps": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get calendar event RSVPs */
get: operations["CalendarEventRsvpReadMany"];
/** Create or update a calendar event RSVP for multiple users */
put: operations["CalendarEventRsvpUpdateMany"];
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/users/{userId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get a user
* @description **Note** - at this time, you can only retrieve your own user
*/
get: operations["UserRead"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/topics/{forumTopicId}/comments/{forumTopicCommentId}/emotes/{emoteId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Create forum topic comment reaction */
put: operations["ForumTopicCommentReactionCreate"];
post?: never;
/** Delete forum topic comment reaction */
delete: operations["ForumTopicCommentReactionDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/events/{calendarEventId}/comments": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a calendar event's comments */
get: operations["CalendarEventCommentReadMany"];
put?: never;
/** Create a comment on a calendar event */
post: operations["CalendarEventCommentCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/events/{calendarEventId}/comments/{calendarEventCommentId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a comment on the calendar event */
get: operations["CalendarEventCommentRead"];
put?: never;
post?: never;
/** Delete a calendar event comment */
delete: operations["CalendarEventCommentDelete"];
options?: never;
head?: never;
/** Update a calendar event comment */
patch: operations["CalendarEventCommentUpdate"];
trace?: never;
};
"/channels/{channelId}/events/{calendarEventId}/emotes/{emoteId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Create calendar event reaction */
put: operations["CalendarEventReactionCreate"];
post?: never;
/** Delete calendar event reaction */
delete: operations["CalendarEventReactionDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/events/{calendarEventId}/comments/{calendarEventCommentId}/emotes/{emoteId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Create calendar event comment reaction */
put: operations["CalendarEventCommentReactionCreate"];
post?: never;
/** Delete calendar event comment reaction */
delete: operations["CalendarEventCommentReactionDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/docs/{docId}/comments": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a doc's comments */
get: operations["DocCommentReadMany"];
put?: never;
/** Create a comment on a doc */
post: operations["DocCommentCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/docs/{docId}/comments/{docCommentId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a comment on a doc */
get: operations["DocCommentRead"];
put?: never;
post?: never;
/** Delete a doc comment */
delete: operations["DocCommentDelete"];
options?: never;
head?: never;
/** Update a doc comment */
patch: operations["DocCommentUpdate"];
trace?: never;
};
"/channels/{channelId}/docs/{docId}/emotes/{emoteId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Create doc reaction */
put: operations["DocReactionCreate"];
post?: never;
/** Delete doc reaction */
delete: operations["DocReactionDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/docs/{docId}/comments/{docCommentId}/emotes/{emoteId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Create doc comment reaction */
put: operations["DocCommentReactionCreate"];
post?: never;
/** Delete doc comment reaction */
delete: operations["DocCommentReactionDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/event_series/{calendarEventSeriesId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Delete a calendar event series */
delete: operations["CalendarEventSeriesDelete"];
options?: never;
head?: never;
/** Update a calendar event series */
patch: operations["CalendarEventSeriesUpdate"];
trace?: never;
};
"/channels/{channelId}/announcements": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get announcements
* @description Results returned will be ordered ascending by the announcement's `createdAt`. `before` will filter based on the announcement's `createdAt`
*/
get: operations["AnnouncementReadMany"];
put?: never;
/** Create an announcement */
post: operations["AnnouncementCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/announcements/{announcementId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Read an announcement */
get: operations["AnnouncementRead"];
put?: never;
post?: never;
/** Delete an announcement */
delete: operations["AnnouncementDelete"];
options?: never;
head?: never;
/** Update an announcement */
patch: operations["AnnouncementUpdate"];
trace?: never;
};
"/users/{userId}/servers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Get a users servers
* @description **Note** - at this time, you can only retrieve your own servers
*/
get: operations["UserServerReadMany"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/announcements/{announcementId}/emotes/{emoteId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Create announcement reaction */
put: operations["AnnouncementReactionCreate"];
post?: never;
/** Delete announcement reaction */
delete: operations["AnnouncementReactionDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/announcements/{announcementId}/comments": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get an announcement's comments */
get: operations["AnnouncementCommentReadMany"];
put?: never;
/** Create a comment on an announcement */
post: operations["AnnouncementCommentCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/announcements/{announcementId}/comments/{announcementCommentId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a comment on the announcement */
get: operations["AnnouncementCommentRead"];
put?: never;
post?: never;
/** Delete an announcement comment */
delete: operations["AnnouncementCommentDelete"];
options?: never;
head?: never;
/** Update an announcement comment */
patch: operations["AnnouncementCommentUpdate"];
trace?: never;
};
"/channels/{channelId}/announcements/{announcementId}/comments/{announcementCommentId}/emotes/{emoteId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Create an announcement comment reaction */
put: operations["AnnouncementCommentReactionCreate"];
post?: never;
/** Delete an announcement comment reaction */
delete: operations["AnnouncementCommentReactionDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/users/{userId}/status": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/**
* Update your status
* @description This value can be a max of 24 hours into the future. If you are wanting a longer expiration, set this value to null so that it never expires. **Note** - at this time, you can only set a status on your own user
*/
put: operations["UserStatusCreate"];
post?: never;
/**
* Delete your status
* @description **Note** - at this time, you can only set a status on your own user
*/
delete: operations["UserStatusDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/messages/{messageId}/emotes/{emoteId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Create a message reaction */
put: operations["ChannelMessageReactionCreate"];
post?: never;
/** Delete a message reaction */
delete: operations["ChannelMessageReactionDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/messages/{messageId}/emotes": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
/** Bulk delete a message's reactions */
delete: operations["ChannelMessageReactionDeleteMany"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/groups": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get groups */
get: operations["GroupReadMany"];
put?: never;
/**
* Create a group
* @description Note: only 100 unarchived groups can exist on a server at any time
*/
post: operations["GroupCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/groups/{groupId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a group */
get: operations["GroupRead"];
put?: never;
post?: never;
/**
* Delete a group
* @description Note: you cannot delete the home group
*/
delete: operations["GroupDelete"];
options?: never;
head?: never;
/** Update a group */
patch: operations["GroupUpdate"];
trace?: never;
};
"/servers/{serverId}/roles": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get roles */
get: operations["RoleReadMany"];
put?: never;
/**
* Create a role
* @description By default, a role will be created with the lowest priority on a server. You can update its priority using [the role update route](/docs/api/roles/RoleUpdate)
*/
post: operations["RoleCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/roles/{roleId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a role */
get: operations["RoleRead"];
put?: never;
post?: never;
/** Delete a role */
delete: operations["RoleDelete"];
options?: never;
head?: never;
/**
* Update a role
* @description Note that when a `priority` is updated, there will still only be a socket event for the role that was touched directly and not for other roles that were shifted
*/
patch: operations["RoleUpdate"];
trace?: never;
};
"/servers/{serverId}/roles/{roleId}/permissions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
/** Update a role permission */
patch: operations["RolePermissionUpdate"];
trace?: never;
};
"/servers/{serverId}/subscriptions/tiers/{serverSubscriptionTierType}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a server subscription tier */
get: operations["ServerSubscriptionTierRead"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/subscriptions/tiers": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get server subscription tiers */
get: operations["ServerSubscriptionTierReadMany"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/members/{userId}/permissions": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/**
* Read a server member's permissions
* @description If the user has *all* of the permissions passed, the HTTP status code will be 200; if user is missing one or more permissions passed, the HTTP status code will be [418](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/418) with a `meta` property containing `missingPermissions` of the permissions the user does not have (this is a 418 to differentiate from a 403 if the _bot_ did not have permissions to perform the request, not the _user_). Tip: Use the `HEAD` HTTP method for this route if you only care about if the user has permissions and not the response body containing what's missing.
*/
get: operations["ServerMemberPermissionsRead"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/channels/{channelId}/archive": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
/** Archive a channel */
put: operations["ChannelArchiveCreate"];
post?: never;
/** Restore an archived channel */
delete: operations["ChannelArchiveDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/categories": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Create a category */
post: operations["CategoryCreate"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/categories/{categoryId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Read a category */
get: operations["CategoryRead"];
put?: never;
post?: never;
/** Delete a category */
delete: operations["CategoryDelete"];
options?: never;
head?: never;
/** Update a category */
patch: operations["CategoryUpdate"];
trace?: never;
};
"/channels/{channelId}/messages/{messageId}/pin": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/** Pin a message */
post: operations["ChannelMessagePinCreate"];
/** Unpin a message */
delete: operations["ChannelMessagePinDelete"];
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/channels/{channelId}/permissions/roles/{roleId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Read a channel role permission */
get: operations["ChannelRolePermissionRead"];
put?: never;
/** Create a channel role permission */
post: operations["ChannelRolePermissionCreate"];
/** Delete a channel role permission */
delete: operations["ChannelRolePermissionDelete"];
options?: never;
head?: never;
/** Update a channel role permission */
patch: operations["ChannelRolePermissionUpdate"];
trace?: never;
};
"/servers/{serverId}/channels/{channelId}/permissions/roles": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** ReadMany a channel role permission */
get: operations["ChannelRolePermissionReadMany"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/channels/{channelId}/permissions/users/{userId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Read a channel user permission */
get: operations["ChannelUserPermissionRead"];
put?: never;
/** Create a channel user permission */
post: operations["ChannelUserPermissionCreate"];
/** Delete a channel user permission */
delete: operations["ChannelUserPermissionDelete"];
options?: never;
head?: never;
/** Update a channel user permission */
patch: operations["ChannelUserPermissionUpdate"];
trace?: never;
};
"/servers/{serverId}/channels/{channelId}/permissions/users": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Read a channel user permission */
get: operations["ChannelUserPermissionReadMany"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/categories/{categoryId}/permissions/users/{userId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Read a channel category user permission */
get: operations["ChannelCategoryUserPermissionRead"];
put?: never;
/** Create a channel category user permission */
post: operations["ChannelCategoryUserPermissionCreate"];
/** Delete a channel category user permission */
delete: operations["ChannelCategoryUserPermissionDelete"];
options?: never;
head?: never;
/** Update a channel category user permission */
patch: operations["ChannelCategoryUserPermissionUpdate"];
trace?: never;
};
"/servers/{serverId}/categories/{categoryId}/permissions/users": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a list of the channel category user permissions */
get: operations["ChannelCategoryUserPermissionReadMany"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/servers/{serverId}/categories/{categoryId}/permissions/roles/{roleId}": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Read a channel category role permission */
get: operations["ChannelCategoryRolePermissionRead"];
put?: never;
/** Create a channel category role permission */
post: operations["ChannelCategoryRolePermissionCreate"];
/** Delete a channel category role permission */
delete: operations["ChannelCategoryRolePermissionDelete"];
options?: never;
head?: never;
/** Update a channel category role permission */
patch: operations["ChannelCategoryRolePermissionUpdate"];
trace?: never;
};
"/servers/{serverId}/categories/{categoryId}/permissions/roles": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
/** Get a list of the channel category role permissions */
get: operations["ChannelCategoryRolePermissionReadMany"];
put?: never;
post?: never;
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
"/url-signatures": {
parameters: {
query?: never;
header?: never;
path?: never;
cookie?: never;
};
get?: never;
put?: never;
/**
* Create URL signatures
* @description User-uploaded content hosted on our CDN will no longer be accessible directly after June 30th, 2024. To access the content, you will need to generate a valid signature via the `/url-signatures` endpoint, which is valid for 5 minutes, and download the content to store the data. Each asset comes with a daily request limit of one, so make sure to save the assets accordingly.
*/
post: operations["UrlSignatureCreateMany"];
delete?: never;
options?: never;
head?: never;
patch?: never;
trace?: never;
};
}
export type webhooks = Record<string, never>;
export interface components {
schemas: {
/** @example {
* "id": "00000000-0000-0000-0000-000000000000",
* "type": "default",
* "serverId": "wlVr3Ggl",
* "groupId": "ZVzBo83p",
* "channelId": "00000000-0000-0000-0000-000000000000",
* "content": "Hello **world**!",
* "embeds": [
* {
* "title": "embed title",
* "description": "embeds support a **different** __subset__ *of* markdown than other markdown fields. <@Ann6LewA>\n\n [links](https://www.guilded.gg) ```\ncheck this code out```\n\n:pizza: time!! ttyl",
* "url": "https://www.guilded.gg",
* "color": 6118369,
* "timestamp": "2022-04-12T22:14:36.737Z",
* "footer": {
* "icon_url": "https://www.guilded.gg/asset/Logos/logomark/Color/Guilded_Logomark_Color.png",
* "text": "footer text"
* },
* "thumbnail": {
* "url": "https://www.guilded.gg/asset/Logos/logomark/Color/Guilded_Logomark_Color.png"
* },
* "image": {
* "url": "https://www.guilded.gg/asset/Logos/logomark_wordmark/Color/Guilded_Logomark_Wordmark_Color.png"
* },
* "author": {
* "name": "Gil",
* "url": "https://www.guilded.gg",
* "icon_url": "https://www.guilded.gg/asset/Default/Gil-md.png"
* },
* "fields": [
* {
* "name": "hello",
* "value": "these are fields"
* },
* {
* "name": "~~help i have been crossed out~~",
* "value": "~~oh noes~~",
* "inline": true
* },
* {
* "name": "another inline",
* "value": "field",
* "inline": true
* }
* ]
* }
* ],
* "createdAt": "2021-06-15T20:15:00.706Z",
* "createdBy": "Ann6LewA"
* } */
ChatMessage: {
/**
* Message ID
* Format: uuid
* @description The ID of the message
*/
id: string;
/**
* Type
* @description The type of chat message. "system" messages are generated by Guilded, while "default" messages are user or bot-generated.
* @enum {string}
*/
type: ChatMessageType;
/**
* Server ID
* @description The ID of the server
*/
serverId?: string;
/**
* Group ID
* @description The ID of the group
*/
groupId?: string;
/**
* Channel ID
* Format: uuid
* @description The ID of the channel
*/
channelId: string;
/**
* Content
* Format: chat markdown
* @description The content of the message
*/
content?: string;
/**
* Hidden content link preview URLs
* @description Links in `content` to prevent unfurling as a link preview when displaying in Guilded
*/
hiddenLinkPreviewUrls?: string[];
embeds?: components["schemas"]["ChatEmbed"][];
/** @description Messa