hoshii / Exports / Endpoints

Endpoints

Table of contents

Type Aliases

• HTTPMethod

Variables

• HTTPMethods

Functions

• Channel
• ChannelDoc
• ChannelDocs
• ChannelEvent
• ChannelEventRSVP
• ChannelEventRSVPS
• ChannelEvents
• ChannelMessage
• ChannelMessageContentEmote
• ChannelMessages
• Channels
• ForumTopic
• ForumTopicComment
• ForumTopicCommentEmote
• ForumTopicComments
• ForumTopicEmote
• ForumTopicLock
• ForumTopicPin
• ForumTopics
• ListItem
• ListItemComplete
• ListItems
• Server
• ServerBan
• ServerBans
• ServerGroup
• ServerGroupMember
• ServerGroupMembers
• ServerMember
• ServerMemberNickname
• ServerMemberRole
• ServerMemberRoleXP
• ServerMemberRoles
• ServerMemberSocials
• ServerMemberXP
• ServerMembers
• ServerWebhook
• ServerWebhooks
• User

Type Aliases

HTTPMethod

Ƭ HTTPMethod: typeof HTTPMethods[number]

Defined in

lib/rest/Endpoints.ts:3

Variables

HTTPMethods

• Const HTTPMethods: readonly ["GET", "POST", "PUT", "PATCH", "DELETE"]

Defined in

lib/rest/Endpoints.ts:1

Functions

Channel

▸ Channel(channelID): string

Parameters

Name	Type
channelID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:6

---

ChannelDoc

▸ ChannelDoc(channelID, docID): string

Parameters

Name	Type
channelID	string
docID	number

Returns

string

Defined in

lib/rest/Endpoints.ts:8

---

ChannelDocs

▸ ChannelDocs(channelID): string

Parameters

Name	Type
channelID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:7

---

ChannelEvent

▸ ChannelEvent(channelID, eventID): string

Parameters

Name	Type
channelID	string
eventID	number

Returns

string

Defined in

lib/rest/Endpoints.ts:12

---

ChannelEventRSVP

▸ ChannelEventRSVP(channelID, eventID, memberID): string

Parameters

Name	Type
channelID	string
eventID	number
memberID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:14

---

ChannelEventRSVPS

▸ ChannelEventRSVPS(channelID, eventID): string

Parameters

Name	Type
channelID	string
eventID	number

Returns

string

Defined in

lib/rest/Endpoints.ts:19

---

ChannelEvents

▸ ChannelEvents(channelID): string

Parameters

Name	Type
channelID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:10

---

ChannelMessage

▸ ChannelMessage(channelID, messageID): string

Parameters

Name	Type
channelID	string
messageID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:23

---

ChannelMessageContentEmote

▸ ChannelMessageContentEmote(channelID, contentID, emoteID): string

Parameters

Name	Type
channelID	string
contentID	string
emoteID	number

Returns

string

Defined in

lib/rest/Endpoints.ts:25

---

ChannelMessages

▸ ChannelMessages(channelID): string

Parameters

Name	Type
channelID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:21

---

Channels

▸ Channels(): string

Returns

string

Defined in

lib/rest/Endpoints.ts:5

---

ForumTopic

▸ ForumTopic(channelID, topicID): string

Parameters

Name	Type
channelID	string
topicID	number

Returns

string

Defined in

lib/rest/Endpoints.ts:33

---

ForumTopicComment

▸ ForumTopicComment(channelID, topicID, commentID): string

Parameters

Name	Type
channelID	string
topicID	number
commentID	number

Returns

string

Defined in

lib/rest/Endpoints.ts:46

---

ForumTopicCommentEmote

▸ ForumTopicCommentEmote(channelID, topicID, commentID, emoteID): string

Parameters

Name	Type
channelID	string
topicID	number
commentID	number
emoteID	number

Returns

string

Defined in

lib/rest/Endpoints.ts:51

---

ForumTopicComments

▸ ForumTopicComments(channelID, topicID): string

Parameters

Name	Type
channelID	string
topicID	number

Returns

string

Defined in

lib/rest/Endpoints.ts:44

---

ForumTopicEmote

▸ ForumTopicEmote(channelID, topicID, emoteID): string

Parameters

Name	Type
channelID	string
topicID	number
emoteID	number

Returns

string

Defined in

lib/rest/Endpoints.ts:39

---

ForumTopicLock

▸ ForumTopicLock(channelID, topicID): string

Parameters

Name	Type
channelID	string
topicID	number

Returns

string

Defined in

lib/rest/Endpoints.ts:37

---

ForumTopicPin

▸ ForumTopicPin(channelID, topicID): string

Parameters

Name	Type
channelID	string
topicID	number

Returns

string

Defined in

lib/rest/Endpoints.ts:35

---

ForumTopics

▸ ForumTopics(channelID): string

Parameters

Name	Type
channelID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:31

---

ListItem

▸ ListItem(channelID, itemID): string

Parameters

Name	Type
channelID	string
itemID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:98

---

ListItemComplete

▸ ListItemComplete(channelID, itemID): string

Parameters

Name	Type
channelID	string
itemID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:100

---

ListItems

▸ ListItems(channelID): string

Parameters

Name	Type
channelID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:97

---

Server

▸ Server(serverID): string

Parameters

Name	Type
serverID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:59

---

ServerBan

▸ ServerBan(serverID, memberID): string

Parameters

Name	Type
serverID	string
memberID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:60

---

ServerBans

▸ ServerBans(serverID): string

Parameters

Name	Type
serverID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:62

---

ServerGroup

▸ ServerGroup(groupID): string

Parameters

Name	Type
groupID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:67

---

ServerGroupMember

▸ ServerGroupMember(groupID, memberID): string

Parameters

Name	Type
groupID	string
memberID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:63

---

ServerGroupMembers

▸ ServerGroupMembers(groupID): string

Parameters

Name	Type
groupID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:65

---

ServerMember

▸ ServerMember(serverID, memberID): string

Parameters

Name	Type
serverID	string
memberID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:68

---

ServerMemberNickname

▸ ServerMemberNickname(serverID, memberID): string

Parameters

Name	Type
serverID	string
memberID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:72

---

ServerMemberRole

▸ ServerMemberRole(serverID, memberID, roleID): string

Parameters

Name	Type
serverID	string
memberID	string
roleID	number

Returns

string

Defined in

lib/rest/Endpoints.ts:74

---

ServerMemberRoleXP

▸ ServerMemberRoleXP(serverID, roleID): string

Parameters

Name	Type
serverID	string
roleID	number

Returns

string

Defined in

lib/rest/Endpoints.ts:81

---

ServerMemberRoles

▸ ServerMemberRoles(serverID, memberID): string

Parameters

Name	Type
serverID	string
memberID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:79

---

ServerMemberSocials

▸ ServerMemberSocials(serverID, memberID, type): string

Parameters

Name	Type
serverID	string
memberID	string
type	string

Returns

string

Defined in

lib/rest/Endpoints.ts:83

---

ServerMemberXP

▸ ServerMemberXP(serverID, memberID): string

Parameters

Name	Type
serverID	string
memberID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:88

---

ServerMembers

▸ ServerMembers(serverID): string

Parameters

Name	Type
serverID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:70

---

ServerWebhook

▸ ServerWebhook(serverID, webhookID): string

Parameters

Name	Type
serverID	string
webhookID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:92

---

ServerWebhooks

▸ ServerWebhooks(serverID): string

Parameters

Name	Type
serverID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:90

---

User

▸ User(userID): string

Parameters

Name	Type
userID	string

Returns

string

Defined in

lib/rest/Endpoints.ts:95