Module @guildedjs/api

@guildedjs/api

GitHub npm CI workflows

Multi-use wrapper over the entire Guilded API. Covers rest requests and ws connections.

⚠️ If you intend to use guilded.js you won't need to install this, as it's already a dependency of that package.

Installation

You can install this package from NPM

  • npm install @guildedjs/api
  • yarn add @guildedjs/api
  • pnpm add @guildedjs/api
  • bun add @guildedjs/api

Contributing

Please see the main README.md for info on how to contribute to this package or the other @guildedjs packages.

LICENSE

Licensed under the MIT License

Index

Enumerations

WSOpCodes

Classes

AnnouncementCommentsService AnnouncementsService ApiError BaseHttpRequest CalendarEventCommentsService CalendarEventSeriesService CalendarEventsService CancelError CategoriesService ChannelsService ChatService DocCommentsService DocsService ForumCommentsService ForumsService GroupMembershipService GroupsService GuildedAPIError GuildedRouter ListItemsService MemberBansService MembersService PermissionOverrideService PermissionsError ReactionsService RestManager RoleMembershipService RolesService ServerSubscriptionService ServerXpService ServersService SocialLinksService UrlSignatureService UserStatusService UsersService WebSocketManager WebhookClient WebhookEmbed WebhookService

Interfaces

components

Type Aliases

APIContent APIEmbed APIEmbedAuthor APIEmbedFooter APIEmbedImage APIEmbedProvider APIEmbedThumbnail APIEmbedVideo APIWebhookEmbedMediaData AnnouncementCommentPayload AnnouncementCommentReactionPayload AnnouncementPayload AnnouncementReactionPayload CalendarEventCommentPayload CalendarEventCommentReactionPayload CalendarEventPayload CalendarEventReactionPayload CalendarEventRsvpPayload CalendarEventSeriesPayload CancelablePromise CategoryPayload ChannelCategoryRolePermissionPayload ChannelCategoryUserPermissionPayload ChannelRolePermissionPayload ChannelUserPermissionPayload ChatEmbedPayload ChatMessagePayload ChatMessageReactionPayload ClientUserData DocCommentPayload DocCommentReactionPayload DocPayload DocReactionPayload EmbedAuthor EmbedField EmbedFooter EmbedImage EmbedPayload EmbedStructure EmotePayload ForumTopicCommentPayload ForumTopicCommentReactionPayload ForumTopicPayload ForumTopicReactionPayload ForumTopicSummaryPayload GroupPayload HTTPMethods JSON JSONB JSONContent ListItemPayload ListItemSummaryPayload MakeOptions MentionsPayload MessageAttachment MessageDataNode OpenAPIConfig RESTPostWebhookBody RESTPostWebhookResult RequestBodyObject RequestOptions ResponseDetails RestManagerEvents RestOptions RolePayload ServerChannelPayload ServerMemberBanPayload ServerMemberPayload ServerMemberPermissionsPayload ServerMemberSummaryPayload ServerPayload ServerSubscriptionTierPayload SkeletonWSPayload SocialLinkPayload UrlSignaturePayload UserPayload UserStatusPayload UserSummaryPayload WSContent WSEvent WSEventNames WSPacket WSPayload WSSchema WebSocketOptions WebhookContentPayload WebhookExecuteResponse WebhookMessageContent WebhookPayload WebsocketManagerEvents enforcedMessageStructure external operations parsedMessage parsedTextResponse paths webhooks

Variables

COLORS DOMAINS GUILDED_STATUS_CODES OpenAPI ROUTES WebSocketEvents

Functions

parseMessage parseToMessage resolveColor transformEmbedToAPIEmbed

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc