Class Routes

The REST API endpoints for Guilded.

Hierarchy

Routes

Constructors

constructor

new Routes(): Routes
Returns Routes

Properties

`Static` channels

channels: "/channels" = ...

The enpoint for channels on Guilded.

See

https://www.guilded.gg/docs/api/channels/ChannelCreate

Methods

`Static` calendarEvent

calendarEvent<C, CE>(channelId: C, calendarEventId: CE): `/channels/${C}/events/${CE}`
The endpoint for a calendar event on Guilded.

See
Example
```
Routes.calendarEvent('abc', 123); // '/channels/abc/events/123'
```
Type Parameters
- C extends string
- CE extends number
Parameters
- channelId: C
  
  The ID of the channel the calendar event belongs to.
- calendarEventId: CE
  
  The ID of the calendar event.
Returns `/channels/${C}/events/${CE}`
- Defined in guilded-api-typings/src/v1/REST.ts:250

`Static` calendarEventRsvp

calendarEventRsvp<C, CE, U>(channelId: C, calendarEventId: CE, userId: U): `/channels/${C}/events/${CE}/rsvps/${U}`
The endpoint for a calendar event RSVP on Guilded.

See
Type Parameters
- C extends string
- CE extends number
- U extends string
Parameters
- channelId: C
  
  The ID of the channel the calendar event belongs to.
- calendarEventId: CE
  
  The ID of the calendar event the RSVP belongs to.
- userId: U
  
  The ID of the user the RSVP belongs to.
Returns `/channels/${C}/events/${CE}/rsvps/${U}`
- Defined in guilded-api-typings/src/v1/REST.ts:263

`Static` calendarEventRsvps

calendarEventRsvps<C, CE>(channelId: C, calendarEventId: CE): string
The endpoint for calendar event RSVPs on Guilded.

See
https://www.guilded.gg/docs/api/calendarEvents/CalendarEventRsvpReadMany
Type Parameters
- C extends string
- CE extends number
Parameters
- channelId: C
  
  The ID of the channel the calendar event belongs to.
- calendarEventId: CE
  
  The ID of the calendar event the RSVPs belong to.
Returns string
- Defined in guilded-api-typings/src/v1/REST.ts:277

`Static` calendarEvents

calendarEvents<C>(channelId: C): `/channels/${C}/events`
The endpoint for calendar events on Guilded.

See
- https://www.guilded.gg/docs/api/calendarEvents/CalendarEventCreate
- https://www.guilded.gg/docs/api/calendarEvents/CalendarEventReadMany
Example
```
Routes.calendarEvents('abc'); // '/channels/abc/events'
```
Type Parameters
- C extends string
Parameters
- channelId: C
  
  The ID of the channel the calendar events belongs to.
Returns `/channels/${C}/events`
- Defined in guilded-api-typings/src/v1/REST.ts:237

`Static` channel

channel<C>(channelId: C): `/channels/${C}`
The endpoint for a channel on Guilded.

See
Example
```
Routes.channel('abc'); // '/channels/abc'
```
Type Parameters
- C extends string
Parameters
- channelId: C
  
  The ID of the channel.
Returns `/channels/${C}`
- Defined in guilded-api-typings/src/v1/REST.ts:27

`Static` doc

doc<C, D>(channelId: C, docId: D): `/channels/${C}/docs/${D}`
The endpoint for a doc on Guilded.

See
Example
```
Routes.doc('abc', 123); // '/channels/abc/docs/123'
```
Type Parameters
- C extends string
- D extends number
Parameters
- channelId: C
  
  The ID of the channel the doc belongs to.
- docId: D
  
  The ID of the doc.
Returns `/channels/${C}/docs/${D}`
- Defined in guilded-api-typings/src/v1/REST.ts:226

`Static` docs

docs<C>(channelId: C): `/channels/${C}/docs`
The endpoint for docs on Guilded.

See
- https://www.guilded.gg/docs/api/docs/DocCreate
- https://www.guilded.gg/docs/api/docs/DocReadMany
Example
```
Routes.docs('abc'); // '/channels/abc/docs'
```
Type Parameters
- C extends string
Parameters
- channelId: C
  
  The ID of the channel the docs belongs to.
Returns `/channels/${C}/docs`
- Defined in guilded-api-typings/src/v1/REST.ts:213

`Static` forumTopic

forumTopic<C, F>(channelId: C, forumTopicId: F): `/channels/${C}/topics/${F}`
The endpoint for a forum topic.

See
Example
```
Routes.forumTopic('abc', 123); // '/channels/abc/topics/123'
```
Type Parameters
- C extends string
- F extends number
Parameters
- channelId: C
  
  The ID of the channel the forum topic belongs to.
- forumTopicId: F
  
  The ID of the forum topic.
Returns `/channels/${C}/topics/${F}`
- Defined in guilded-api-typings/src/v1/REST.ts:142

`Static` forumTopicLock

forumTopicLock<C, F>(channelId: C, forumTopicId: F): `/channels/${C}/topics/${F}/lock`
The endpoint for a forum topic lock.

See
- https://www.guilded.gg/docs/api/forums/ForumTopicLock
- https://www.guilded.gg/docs/api/forums/ForumTopicUnlock
Example
```
Routes.forumTopicLock('abc', 123); // '/channels/abc/topics/123/lock'
```
Type Parameters
- C extends string
- F extends number
Parameters
- channelId: C
  
  The ID of the channel the forum topic belongs to.
- forumTopicId: F
  
  The ID of the forum topic.
Returns `/channels/${C}/topics/${F}/lock`
- Defined in guilded-api-typings/src/v1/REST.ts:166

`Static` forumTopicPin

forumTopicPin<C, F>(channelId: C, forumTopicId: F): `/channels/${C}/topics/${F}/pin`
The endpoint for a forum topic pin.

See
- https://www.guilded.gg/docs/api/forums/ForumTopicPin
- https://www.guilded.gg/docs/api/forums/ForumTopicUnpin
Example
```
Routes.forumTopicPin('abc', 123); // '/channels/abc/topics/123/pin'
```
Type Parameters
- C extends string
- F extends number
Parameters
- channelId: C
  
  The ID of the channel the forum topic belongs to.
- forumTopicId: F
  
  The ID of the forum topic.
Returns `/channels/${C}/topics/${F}/pin`
- Defined in guilded-api-typings/src/v1/REST.ts:154

`Static` forumTopics

forumTopics<C>(channelId: C): `/channels/${C}/topics`
The endpoint for forum topics.

See
- https://www.guilded.gg/docs/api/forums/ForumTopicReadMany
- https://www.guilded.gg/docs/api/forums/ForumTopicCreate
Example
```
Routes.forumTopics('abc'); // '/channels/abc/topics'
```
Type Parameters
- C extends string
Parameters
- channelId: C
  
  The ID of the channel the forum topics belongs to.
Returns `/channels/${C}/topics`
- Defined in guilded-api-typings/src/v1/REST.ts:129

`Static` groupMember

groupMember<G, M>(groupId: G, memberId: M): `/groups/${G}/members/${M}`
The endpoint for a group member on Guilded.

See
- https://www.guilded.gg/docs/api/groupMembership/GroupMembershipCreate
- https://www.guilded.gg/docs/api/groupMembership/GroupMembershipDelete
Example
```
Routes.groupMember('abc', 'abc'); // '/groups/abc/members/abc'
```
Type Parameters
- G extends string
- M extends string
Parameters
- groupId: G
  
  The ID of the group the member belongs to.
- memberId: M
  
  The ID of the member.
Returns `/groups/${G}/members/${M}`
- Defined in guilded-api-typings/src/v1/REST.ts:346

`Static` listItem

listItem<C, L>(channelId: C, listItemId: L): `/channels/${C}/items/${L}`
The endpoint for a list item on Guilded.

See
Example
```
Routes.listItem('abc', 'abc'); // '/channels/abc/items/abc'
```
Type Parameters
- C extends string
- L extends string
Parameters
- channelId: C
  
  The ID of the channel the list item belongs to.
- listItemId: L
  
  The ID of the list item.
Returns `/channels/${C}/items/${L}`
- Defined in guilded-api-typings/src/v1/REST.ts:190

`Static` listItemComplete

listItemComplete<C, L>(channelId: C, listItemId: L): `/channels/${C}/items/${L}/complete`
The endpoint for list item completions on Guilded.

See
- https://www.guilded.gg/docs/api/listItems/ListItemCompleteCreate
- https://www.guilded.gg/docs/api/listItems/ListItemCompleteDelete
Example
```
Routes.listItemComplete('abc', 'abc'); // '/channels/abc/items/abc/complete'
```
Type Parameters
- C extends string
- L extends string
Parameters
- channelId: C
  
  The ID of the channel the list item belongs to.
- listItemId: L
  
  The ID of the list item.
Returns `/channels/${C}/items/${L}/complete`
- Defined in guilded-api-typings/src/v1/REST.ts:202

`Static` listItems

listItems<C>(channelId: C): `/channels/${C}/items`
The endpoint for list items on Guilded.

See
- https://www.guilded.gg/docs/api/listItems/ListItemCreate
- https://www.guilded.gg/docs/api/listItems/ListItemReadMany
Example
```
Routes.listItems('abc'); // '/channels/abc/items'
```
Type Parameters
- C extends string
Parameters
- channelId: C
  
  The ID of the channel the list items belongs to.
Returns `/channels/${C}/items`
- Defined in guilded-api-typings/src/v1/REST.ts:177

`Static` message

message<C, M>(channelId: C, messageId: M): `/channels/${C}/messages/${M}`
The endpoint for a message on Guilded.

See
Example
```
Routes.message('abc', 'abc'); // '/channels/abc/messages/abc'
```
Type Parameters
- C extends string
- M extends string
Parameters
- channelId: C
  
  The ID of the channel the message belongs to.
- messageId: M
  
  The ID of the message.
Returns `/channels/${C}/messages/${M}`
- Defined in guilded-api-typings/src/v1/REST.ts:61

`Static` messages

messages<C>(channelId: C): `/channels/${C}/messages`
The endpoint for messages on Guilded.

See
- https://www.guilded.gg/docs/api/chat/ChannelMessageCreate
- https://www.guilded.gg/docs/api/chat/ChannelMessageReadMany
Example
```
Routes.messages('abc'); // '/channels/abc/messages'
```
Type Parameters
- C extends string
Parameters
- channelId: C
  
  The ID of the channel the messages belongs to.
Returns `/channels/${C}/messages`
- Defined in guilded-api-typings/src/v1/REST.ts:48

`Static` reaction

reaction<C, Co, E>(channelId: C, contentId: Co, emoteId: E): `/channels/${C}/content/${Co}/emotes/${E}`
The endpoint for a content reaction on Guilded.

See
https://www.guilded.gg/docs/api/reactions/ContentReactionCreate

Example
```
Routes.reaction('abc', 'abc', 123); // '/channels/abc/content/abc/emotes/123'
```
Type Parameters
- C extends string
- Co extends string
- E extends number
Parameters
- channelId: C
  
  The ID of the channel the content belongs to.
- contentId: Co
  
  The ID of the content.
- emoteId: E
  
  The ID of the emote.
Returns `/channels/${C}/content/${Co}/emotes/${E}`
- Defined in guilded-api-typings/src/v1/REST.ts:292

`Static` server

server<S>(serverId: S): `/servers/${S}`
The endpoint for a server on Guilded.

See
https://www.guilded.gg/docs/api/servers/ServerRead

Example
```
Routes.server('abc'); // '/servers/abc'
```
Type Parameters
- S extends string
Parameters
- serverId: S
  
  The ID of the server.
Returns `/servers/${S}`
- Defined in guilded-api-typings/src/v1/REST.ts:37

`Static` serverBan

serverBan<S, B>(serverId: S, banId: B): `/servers/${S}/bans/${B}`
The endpoint for a server ban on Guilded.

See
Example
```
Routes.serverBan('abc', 'abc'); // '/servers/abc/bans/abc'
```
Type Parameters
- S extends string
- B extends string
Parameters
- serverId: S
  
  The ID of the server the ban belongs to.
- banId: B
  
  The ID of the ban.
Returns `/servers/${S}/bans/${B}`
- Defined in guilded-api-typings/src/v1/REST.ts:108

`Static` serverBans

serverBans<S>(serverId: S): `/servers/${S}/bans`
The endpoint for server bans on Guilded.

See
https://www.guilded.gg/docs/api/member-bans/ServerMemberBanReadMany

Example
```
Routes.serverBans('abc'); // '/servers/abc/bans'
```
Type Parameters
- S extends string
Parameters
- serverId: S
  
  The ID of the server the bans belong to.
Returns `/servers/${S}/bans`
- Defined in guilded-api-typings/src/v1/REST.ts:118

`Static` serverMember

serverMember<S, M>(serverId: S, memberId: M): `/servers/${S}/members/${M}`
The endpoint for a server member on Guilded.

See
- https://www.guilded.gg/docs/api/members/ServerMemberRead
- https://www.guilded.gg/docs/api/members/ServerMemberDelete
Example
```
Routes.serverMember('abc', 'abc'); // '/servers/abc/members/abc'
```
Type Parameters
- S extends string
- M extends string
Parameters
- serverId: S
  
  The ID of the server the member belongs to.
- memberId: M
  
  The ID of the member.
Returns `/servers/${S}/members/${M}`
- Defined in guilded-api-typings/src/v1/REST.ts:85

`Static` serverMemberRole

serverMemberRole<S, M, R>(serverId: S, memberId: M, roleId: R): `/servers/${S}/members/${M}/roles/${R}`
The endpoint for a server member role on Guilded.

See
- https://www.guilded.gg/docs/api/roleMembership/RoleMembershipCreate
- https://www.guilded.gg/docs/api/roleMembership/RoleMembershipDelete
Example
```
Routes.serverMemberRole('abc', 'abc', 123); // '/servers/abc/members/abc/roles/123'
```
Type Parameters
- S extends string
- M extends string
- R extends number
Parameters
- serverId: S
  
  The ID of the server the member belongs to.
- memberId: M
  
  The ID of the member.
- roleId: R
  
  The ID of the role.
Returns `/servers/${S}/members/${M}/roles/${R}`
- Defined in guilded-api-typings/src/v1/REST.ts:359

`Static` serverMemberRoles

serverMemberRoles<S, M>(serverId: S, memberId: M): `/servers/${S}/members/${M}/roles`
The endpoint for server member roles on Guilded.

See
https://www.guilded.gg/docs/api/roleMembership/RoleMembershipReadMany

Example
```
Routes.serverMemberRoles('abc', 'abc'); // '/servers/abc/members/abc/roles'
```
Type Parameters
- S extends string
- M extends string
Parameters
- serverId: S
  
  The ID of the server the member belongs to.
- memberId: M
  
  The ID of the member.
Returns `/servers/${S}/members/${M}/roles`
- Defined in guilded-api-typings/src/v1/REST.ts:374

`Static` serverMemberXp

serverMemberXp<S, M>(serverId: S, memberId: M): `/servers/${S}/members/${M}/xp`
The endpoint for server member XP on Guilded.

See
https://www.guilded.gg/docs/api/server-xp/ServerXpForUserCreate

Example
```
Routes.serverMemberXp('abc', 'abc'); // '/servers/abc/members/abc/xp'
```
Type Parameters
- S extends string
- M extends string
Parameters
- serverId: S
  
  The ID of the server the member belongs to.
- memberId: M
  
  The ID of the member.
Returns `/servers/${S}/members/${M}/xp`
- Defined in guilded-api-typings/src/v1/REST.ts:307

`Static` serverMembers

serverMembers<S>(serverId: S): `/servers/${S}/members`
The endpoint for server members on Guilded.

See
https://www.guilded.gg/docs/api/members/ServerMemberReadMany

Example
```
Routes.serverMembers('abc'); // '/servers/abc/members'
```
Type Parameters
- S extends string
Parameters
- serverId: S
  
  The ID of the server the members belong to.
Returns `/servers/${S}/members`
- Defined in guilded-api-typings/src/v1/REST.ts:95

`Static` serverNickname

serverNickname<S, M>(serverId: S, memberId: M): `/servers/${S}/members/${M}/nickname`
The endpoint for a server nickname on Guilded.

See
- https://www.guilded.gg/docs/api/members/MemberNicknameUpdate
- https://www.guilded.gg/docs/api/members/MemberNicknameDelete
Example
```
Routes.serverNickname('abc', 'abc'); // '/servers/abc/members/abc/nickname'
```
Type Parameters
- S extends string
- M extends string
Parameters
- serverId: S
  
  The ID of the server the member belongs to.
- memberId: M
  
  The ID of the member.
Returns `/servers/${S}/members/${M}/nickname`
- Defined in guilded-api-typings/src/v1/REST.ts:73

`Static` serverRoleXp

serverRoleXp<S, R>(serverId: S, roleId: R): `/servers/${S}/roles/${R}/xp`
The endpoint for server role XP on Guilded.

See
https://www.guilded.gg/docs/api/server-xp/ServerXpForRoleCreate

Example
```
Routes.serverRoleXp('abc', 123); // '/servers/abc/roles/123/xp'
```
Type Parameters
- S extends string
- R extends number
Parameters
- serverId: S
  
  The ID of the server the role belongs to.
- roleId: R
  
  The ID of the role.
Returns `/servers/${S}/roles/${R}/xp`
- Defined in guilded-api-typings/src/v1/REST.ts:318

`Static` socialLink

socialLink<S, M, T>(serverId: S, memberId: M, type: T): `/servers/${S}/members/${M}/social-links/${T}`
The endpoint for a server member social link on Guilded.

See
https://www.guilded.gg/docs/api/socialLinks/MemberSocialLinkRead

Example
```
Routes.socialLink('abc', 'abc', 'youtube'); // '/servers/abc/members/abc/social-links/youtube'
```
Type Parameters
- S extends string
- M extends string
- T extends string
Parameters
- serverId: S
  
  The ID of the server the member belongs to.
- memberId: M
  
  The ID of the member.
- type: T
  
  The type of social link.
Returns `/servers/${S}/members/${M}/social-links/${T}`
- Defined in guilded-api-typings/src/v1/REST.ts:330

`Static` webhook

webhook<S, W>(serverId: S, webhookId: W): `/servers/${S}/webhooks/${W}`
The endpoint for a webhook on Guilded.

See
Example
```
Routes.webhook('abc', 'abc'); // '/servers/abc/webhooks/abc'
```
Type Parameters
- S extends string
- W extends string
Parameters
- serverId: S
  
  The ID of the server the webhook belongs to.
- webhookId: W
  
  The ID of the webhook.
Returns `/servers/${S}/webhooks/${W}`
- Defined in guilded-api-typings/src/v1/REST.ts:398

`Static` webhookExecute

webhookExecute<W, WT>(webhookId: W, webhookToken: WT): `/webhooks/${W}/${WT}`
The endpoint for a webhook execution on Guilded.

Example
```
Routes.webhookExecute('abc', 'abc'); // '/webhooks/abc/abc'
```
Type Parameters
- W extends string
- WT extends string
Parameters
- webhookId: W
  
  The ID of the webhook.
- webhookToken: WT
  
  The ID of the webhook.
Returns `/webhooks/${W}/${WT}`
- Defined in guilded-api-typings/src/v1/REST.ts:408

`Static` webhooks

webhooks<S>(serverId: S): `/servers/${S}/webhooks`
The endpoint for webhooks on Guilded.

See
- https://www.guilded.gg/docs/api/webhook/WebhookCreate
- https://www.guilded.gg/docs/api/webhook/WebhookReadMany
Example
```
Routes.webhooks('abc'); // '/servers/abc/webhooks'
```
Type Parameters
- S extends string
Parameters
- serverId: S
  
  The ID of the server the webhooks belongs to.
Returns `/servers/${S}/webhooks`
- Defined in guilded-api-typings/src/v1/REST.ts:385

Class Routes

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Routes

Properties

Static channels

See

Methods

Static calendarEvent

See

Example

Type Parameters

C extends string

CE extends number

Parameters

channelId: C

calendarEventId: CE

Returns `/channels/${C}/events/${CE}`

Static calendarEventRsvp

See

Type Parameters

C extends string

CE extends number

U extends string

Parameters

channelId: C

calendarEventId: CE

userId: U

Returns `/channels/${C}/events/${CE}/rsvps/${U}`

Static calendarEventRsvps

See

Type Parameters

C extends string

CE extends number

Parameters

channelId: C

calendarEventId: CE

Returns string

Static calendarEvents

See

Example

Type Parameters

C extends string

Parameters

channelId: C

Returns `/channels/${C}/events`

Static channel

See

Example

Type Parameters

C extends string

Parameters

channelId: C

Returns `/channels/${C}`

Static doc

See

Example

Type Parameters

C extends string

D extends number

Parameters

channelId: C

docId: D

Returns `/channels/${C}/docs/${D}`

Static docs

See

Example

Type Parameters

C extends string

Parameters

channelId: C

Returns `/channels/${C}/docs`

Static forumTopic

See

Example

`Static` channels

`Static` calendarEvent

`Static` calendarEventRsvp

`Static` calendarEventRsvps

`Static` calendarEvents

`Static` channel

`Static` doc

`Static` docs

`Static` forumTopic

`Static` forumTopicLock

`Static` forumTopicPin

`Static` forumTopics

`Static` groupMember

`Static` listItem

`Static` listItemComplete

`Static` listItems