rest

package

Go to main page

Versions in this module

v0

v0.7.0

Sep 26, 2023

Changes in this version

type Client

+ func (c *Client) ListStickerPacks() (*discord.NitroStickerPacks, error)

v0.6.0

Jun 23, 2023

Changes in this version

type Client

+ func New(token string) *Client

+ func (c *Client) CreateFollowupMessage(interactionToken string, message discord.CreateFollowupMessage) (*discord.Message, error)

+ func (c *Client) CreateInteractionResponse(interactionID discord.Snowflake, interactionToken string, ...) error

+ func (c *Client) DeleteFollowupMessage(interactionToken string, messageID discord.Snowflake) error

+ func (c *Client) DeleteOriginalInteractionResponse(interactionToken string) error

+ func (c *Client) EditFollowupMessage(interactionToken string, messageID, threadID discord.Snowflake, ...) (*discord.Webhook, error)

+ func (c *Client) EditOriginalInteractionResponse(interactionToken string, threadID discord.Snowflake, ...) (*discord.Webhook, error)

+ func (c *Client) GetFollowupMessage(interactionToken string, messageID discord.Snowflake) (*discord.Message, error)

+ func (c *Client) GetOriginalInteractionResponse(interactionToken string, threadID discord.Snowflake) (*discord.Message, error)

+ func (c *Client) ListGuildMembers(guildID, after discord.Snowflake, limit int) ([]discord.Member, error)

v0.5.0

Jun 16, 2023

Changes in this version

type Client

+ func (c *Client) DeleteWebhookMessage(webhookID, messageID discord.Snowflake, webhookToken string, ...) error

+ func (c *Client) EditWebhookMessage(webhookID, messageID discord.Snowflake, webhookToken string, ...) (*discord.Webhook, error)

+ func (c *Client) GetCurrentUserGuilds(before, after discord.Snowflake, limit int) ([]discord.PartialGuild, error)

v0.4.0

Jun 12, 2023

Changes in this version

+ func CreateMultipartBodyWithJSON(data T, files []discord.File) (string, []byte, error)

+ func DoEmptyRequest(client *Client, method, url string, requestBody any, ...) error

+ func DoEmptyRequestWithFiles(client *Client, method, url string, requestBody []byte, ...) error

+ func DoRequestAsStructure(client *Client, method, url string, requestBody any, ...) (*T, error)

+ func DoRequestWithFiles(client *Client, method, url string, requestBody []byte, ...) (*T, error)

type Client

+ func (c *Client) AddGuildMemberRole(guildID, userID, roleID, reason string) error

+ func (c *Client) AddThreadMember(threadID, userID string) error

+ func (c *Client) BeginGuildPrune(guildID string, prune discord.BeginGuildPrune) (*discord.GuildPrune, error)

+ func (c *Client) BulkDeleteMessages(channelID string, bulkDeleteMessages discord.BulkDeleteMessages) error

+ func (c *Client) BulkOverwriteGlobalApplicationCommand(applicationID string, applicationCommands []discord.ApplicationCommand) ([]discord.ApplicationCommand, error)

+ func (c *Client) BulkOverwriteGuildApplicationCommand(applicationID, guildID string, ...) ([]discord.ApplicationCommand, error)

+ func (c *Client) CreateAutoModerationRule(guildID string, autoModerationRule discord.CreateAutoModerationRule) (*discord.AutoModerationRule, error)

+ func (c *Client) CreateChannelInvite(channelID string, invite discord.CreateChannelInvite) (*discord.Invite, error)

+ func (c *Client) CreateDM(userID string) (*discord.Channel, error)

+ func (c *Client) CreateGlobalApplicationCommand(applicationID string, ...) (*discord.ApplicationCommand, error)

+ func (c *Client) CreateGuild(guild discord.CreateGuild) (*discord.Guild, error)

+ func (c *Client) CreateGuildApplicationCommand(applicationID, guildID string, ...) (*discord.ApplicationCommand, error)

+ func (c *Client) CreateGuildBan(guildID string, ban discord.CreateGuildBan) error

+ func (c *Client) CreateGuildChannel(guildID string, channel discord.CreateGuildChannel) (*discord.Channel, error)

+ func (c *Client) CreateGuildEmoji(guildID string, emoji discord.CreateGuildEmoji) (*discord.Emoji, error)

+ func (c *Client) CreateGuildFromTemplate(templateCode string, guild discord.CreateGuildFromTemplate) (*discord.Guild, error)

+ func (c *Client) CreateGuildRole(guildID string, role discord.CreateGuildRole) (*discord.Role, error)

+ func (c *Client) CreateGuildScheduledEvent(guildID string, scheduledEvent discord.CreateGuildScheduledEvent) (*discord.GuildScheduledEvent, error)

+ func (c *Client) CreateGuildSticker(guildID string, sticker discord.CreateGuildSticker) (*discord.Sticker, error)

+ func (c *Client) CreateGuildTemplate(guildID string, guildTemplate discord.CreateGuildTemplate) (*discord.GuildTemplate, error)

+ func (c *Client) CreateMessage(channelID string, message discord.CreateMessage) (*discord.Message, error)

+ func (c *Client) CreateReaction(channelID, messageID, emoji string) error

+ func (c *Client) CreateStageInstance(stageInstance discord.CreateStageInstance) (*discord.StageInstance, error)

+ func (c *Client) CreateWebhook(channelID string, webhook discord.CreateWebhook) (*discord.Webhook, error)

+ func (c *Client) CrosspostMessage(channelID, messageID string) (*discord.Message, error)

+ func (c *Client) DeleteAllReactions(channelID, messageID string) error

+ func (c *Client) DeleteAllReactionsForEmoji(channelID, messageID, emoji string) error

+ func (c *Client) DeleteAutoModerationRule(guildID, ruleID, reason string) error

+ func (c *Client) DeleteChannel(channelID, reason string) error

+ func (c *Client) DeleteChannelPermissions(channelID, overwriteID, reason string) error

+ func (c *Client) DeleteGlobalApplicationCommand(applicationID, commandID string) error

+ func (c *Client) DeleteGuild(guildID string) error

+ func (c *Client) DeleteGuildApplicationCommand(applicationID, guildID, commandID string) error

+ func (c *Client) DeleteGuildEmoji(guildID, emojiID, reason string) error

+ func (c *Client) DeleteGuildIntegration(guildID, integrationID, reason string) error

+ func (c *Client) DeleteGuildRole(guildID, roleID, reason string) error

+ func (c *Client) DeleteGuildScheduledEvent(guildID, scheduledEventID string) error

+ func (c *Client) DeleteGuildSticker(guildID, stickerID, reason string) error

+ func (c *Client) DeleteGuildTemplate(guildID, templateCode string) (*discord.GuildTemplate, error)

+ func (c *Client) DeleteInvite(inviteCode string) (*discord.Invite, error)

+ func (c *Client) DeleteMessage(channelID, messageID, reason string) error

+ func (c *Client) DeleteOwnReaction(channelID, messageID, emoji string) error

+ func (c *Client) DeleteStageInstance(channelID string) error

+ func (c *Client) DeleteUserReaction(channelID, messageID, userID, emoji string) error

+ func (c *Client) DeleteWebhook(webhookID string) error

+ func (c *Client) DeleteWebhookWithToken(webhookID, webhookToken string) error

+ func (c *Client) EditChannelPermissions(channelID, overwriteID string, ...) error

+ func (c *Client) EditGlobalApplicationCommand(applicationID, commandID string, ...) (*discord.ApplicationCommand, error)

+ func (c *Client) EditGuildApplicationCommand(applicationID, guildID, commandID string, ...) (*discord.ApplicationCommand, error)

+ func (c *Client) EditMessage(channelID, messageID string, message discord.EditMessage) (*discord.Message, error)

+ func (c *Client) ExecuteWebhook(webhookID, webhookToken, threadID string, message discord.ExecuteWebhook) error

+ func (c *Client) FollowAnnouncementChannel(channelID, targetID string) (*discord.FollowedChannel, error)

+ func (c *Client) GetApplicationRoleConnectionMetadataRecords(applicationID string) (*discord.ApplicationRoleConnectionMetadata, error)

+ func (c *Client) LeaveGuild(guildID string) error

+ func (c *Client) LeaveThread(threadID string) error

+ func (c *Client) ModifyAutoModerationRule(guildID, ruleID string, autoModerationRule discord.ModifyAutoModerationRule) (*discord.AutoModerationRule, error)

+ func (c *Client) ModifyChannel(channelID string, newChannel discord.ModifyChannel) (*discord.Channel, error)

+ func (c *Client) ModifyCurrentUser(user discord.ModifyCurrentUser) (*discord.User, error)

+ func (c *Client) ModifyCurrentUserVoiceState(guildID string, voiceState discord.ModifyCurrentUserVoiceState) error

+ func (c *Client) ModifyGuild(guildID string, guild discord.ModifyGuild) (*discord.Guild, error)

+ func (c *Client) ModifyGuildChannelPositions(guildID string, channelPositions []discord.ModifyGuildChannelPosition) error

+ func (c *Client) ModifyGuildEmoji(guildID, emojiID string, emoji discord.ModifyGuildEmoji) (*discord.Emoji, error)

+ func (c *Client) ModifyGuildMFALevel(guildID string, mfaLevel discord.ModifyGuildMFALevel) (*discord.MFALevel, error)

+ func (c *Client) ModifyGuildMember(guildID, userID string, member discord.ModifyGuildMember) (*discord.Member, error)

+ func (c *Client) ModifyGuildRole(guildID, roleID string, role discord.ModifyGuildRole) (*discord.Role, error)

+ func (c *Client) ModifyGuildRolePositions(guildID string, rolePositions []discord.GuildRolePosition) ([]discord.Role, error)

+ func (c *Client) ModifyGuildScheduledEvent(guildID, scheduledEventID string, ...) (*discord.GuildScheduledEvent, error)

+ func (c *Client) ModifyGuildSticker(guildID, stickerID string, sticker discord.ModifyGuildSticker) (*discord.Sticker, error)

+ func (c *Client) ModifyGuildTemplate(guildID string, guildTemplate discord.ModifyGuildTemplate) (*discord.GuildTemplate, error)

+ func (c *Client) ModifyGuildWelcomeScreen(guildID string, welcomeScreen discord.ModifyGuildWelcomeScreen) (*discord.WelcomeScreen, error)

+ func (c *Client) ModifyGuildWidget(guildID string, widget discord.ModifyGuildWidget) (*discord.WidgetSetting, error)

+ func (c *Client) ModifyStageInstance(channelID string, stageInstance discord.ModifyStageInstance) (*discord.StageInstance, error)

+ func (c *Client) ModifyUserVoiceState(guildID, userID string, voiceState discord.ModifyUserVoiceState) error

+ func (c *Client) ModifyWebhook(webhookID string, webhook discord.ModifyWebhook) (*discord.Webhook, error)

+ func (c *Client) ModifyWebhookWithToken(webhookID, webhookToken string, webhook discord.ModifyWebhookWithToken) (*discord.Webhook, error)

+ func (c *Client) PinMessage(channelID, messageID, reason string) error

+ func (c *Client) RemoveGuildBan(guildID, userID, reason string) error

+ func (c *Client) RemoveGuildMember(guildID, userID, reason string) error

+ func (c *Client) RemoveGuildMemberRole(guildID, userID, roleID, reason string) error

+ func (c *Client) RemoveThreadMember(threadID, userID string) error

+ func (c *Client) StartThreadFromMessage(channelID, messageID string, thread discord.StartThreadFromMessage) (*discord.Channel, error)

+ func (c *Client) StartThreadInForumChannel(channelID string, thread discord.StartThreadInForumChannel) (*discord.Channel, error)

+ func (c *Client) StartThreadWithoutMessage(channelID string, thread discord.StartThreadWithoutMessage) (*discord.Channel, error)

+ func (c *Client) SyncGuildTemplate(guildID, templateCode string) (*discord.GuildTemplate, error)

+ func (c *Client) TriggerTyping(channelID string) error

+ func (c *Client) UnpinMessage(channelID, messageID, reason string) error

+ func (c *Client) UpdateApplicationRoleConnectionMetadataRecords(applicationID string, records []discord.ApplicationRoleConnectionMetadata) ([]discord.ApplicationRoleConnectionMetadata, error)

+ type RequestOption func(r *http.Request)

+ func WithHeader(key, value string) RequestOption

+ func WithReason(reason string) RequestOption

v0.3.0

May 19, 2023

Changes in this version

+ const ApplicationsEndpoint

+ const ChannelsEndpoint

+ const GuildsEndpoint

+ const InvitesEndpoint

+ const StageInstancesEndpoint

+ const StickerPacksEndpoint

+ const StickersEndpoint

+ const VoiceEndpoint

+ const WebhooksEndpoint

+ func DoRequestAs(client *Client, method, url string, queryParams QueryParameters, attempt int) (*T, error)

+ func DoRequestAsList(client *Client, method, url string, queryParams QueryParameters, attempt int) ([]T, error)

type Client

+ func (c *Client) GetApplicationCommandPermissions(applicationID, guildID, commandID string) ([]discord.GuildApplicationCommandPermissions, error)

+ func (c *Client) GetApplicationRoleConnectionMetadata(applicationID string) (*discord.ApplicationRoleConnectionMetadata, error)

+ func (c *Client) GetAutoModerationRule(guildID, ruleID string) (*discord.AutoModerationRule, error)

+ func (c *Client) GetAutoModerationRules(guildID string) ([]discord.AutoModerationRule, error)

+ func (c *Client) GetChannel(channelID string) (*discord.Channel, error)

+ func (c *Client) GetChannelInvites(channelID string) ([]discord.InviteWithMetadata, error)

+ func (c *Client) GetChannelMessage(channelID, messageID string) (*discord.Message, error)

+ func (c *Client) GetChannelMessages(channelID string) ([]discord.Message, error)

+ func (c *Client) GetChannelWebhooks(channelID string) ([]discord.Webhook, error)

+ func (c *Client) GetGlobalApplicationCommand(applicationID, commandID string) (*discord.ApplicationCommand, error)

+ func (c *Client) GetGlobalApplicationCommands(applicationID string, withLocalizations bool) ([]discord.ApplicationCommand, error)

+ func (c *Client) GetGuild(guildID string, withCounts bool) (*discord.Guild, error)

+ func (c *Client) GetGuildApplicationCommand(applicationID, guildID, commandID string) (*discord.ApplicationCommand, error)

+ func (c *Client) GetGuildApplicationCommandPermissions(applicationID, guildID string) ([]discord.GuildApplicationCommandPermissions, error)

+ func (c *Client) GetGuildApplicationCommands(applicationID, guildID string, withLocalizations bool) ([]discord.ApplicationCommand, error)

+ func (c *Client) GetGuildAuditLog(guildID string) (*discord.AuditLog, error)

+ func (c *Client) GetGuildBan(guildID, banID string) (*discord.GuildBan, error)

+ func (c *Client) GetGuildBans(guildID, before, after string, limit int) ([]discord.GuildBan, error)

+ func (c *Client) GetGuildChannels(guildID string) ([]discord.Channel, error)

+ func (c *Client) GetGuildEmoji(guildID, emojiID string) (*discord.Emoji, error)

+ func (c *Client) GetGuildIntegrations(guildID string) ([]discord.Integration, error)

+ func (c *Client) GetGuildInvites(guildID string) ([]discord.InviteWithMetadata, error)

+ func (c *Client) GetGuildMember(guildID, userID string) (*discord.Member, error)

+ func (c *Client) GetGuildOnboarding(guildID string) (*discord.Onboarding, error)

+ func (c *Client) GetGuildPreview(guildID string) (*discord.GuildPreview, error)

+ func (c *Client) GetGuildPruneCount(guildID string, days int, includeRoles []string) (*discord.GuildPrune, error)

+ func (c *Client) GetGuildRoles(guildID string) ([]discord.Role, error)

+ func (c *Client) GetGuildScheduledEvent(guildID, scheduledEventID string, withUserCount bool) (*discord.GuildScheduledEvent, error)

+ func (c *Client) GetGuildScheduledEventUsers(guildID, scheduledEventID, before, after string, limit int, withMember bool) ([]discord.GuildScheduledEventUser, error)

+ func (c *Client) GetGuildSticker(guildID, stickerID string) (*discord.Sticker, error)

+ func (c *Client) GetGuildTemplate(templateCode string) (*discord.GuildTemplate, error)

+ func (c *Client) GetGuildTemplates(guildID string) ([]discord.GuildTemplate, error)

+ func (c *Client) GetGuildVanityURL(guildID string) (*discord.PartialInvite, error)

+ func (c *Client) GetGuildVoiceRegions(guildID string) ([]discord.VoiceRegion, error)

+ func (c *Client) GetGuildWebhooks(guildID string) ([]discord.Webhook, error)

+ func (c *Client) GetGuildWelcomeScreen(guildID string) (*discord.WelcomeScreen, error)

+ func (c *Client) GetGuildWidget(guildID string) (*discord.Widget, error)

+ func (c *Client) GetGuildWidgetSetting(guildID string) (*discord.WidgetSetting, error)

+ func (c *Client) GetInvite(inviteCode string, withCounts, withExpiration bool, ...) (*discord.Invite, error)

+ func (c *Client) GetPinnedMessages(channelID string) ([]discord.Message, error)

+ func (c *Client) GetReactions(channelID, messageID, emoji, after string, limit int) ([]discord.User, error)

+ func (c *Client) GetStageInstance(channelID string) (*discord.StageInstance, error)

+ func (c *Client) GetSticker(stickerID string) (*discord.Sticker, error)

+ func (c *Client) GetThreadMember(threadID, userID string) (*discord.ThreadMember, error)

+ func (c *Client) GetUser(userID string) (*discord.User, error)

+ func (c *Client) GetUserGuilds(before, after string, limit int) ([]discord.PartialGuild, error)

+ func (c *Client) GetWebhook(webhookID string) (*discord.Webhook, error)

+ func (c *Client) GetWebhookMessage(webhookID, webhookToken, messageID, threadID string) (*discord.Message, error)

+ func (c *Client) GetWebhookWithToken(webhookID, webhookToken string) (*discord.Webhook, error)

+ func (c *Client) ListActiveThreads(guildID string) (*discord.ActiveThreads, error)

+ func (c *Client) ListGuildEmojis(guildID string) ([]discord.Emoji, error)

+ func (c *Client) ListGuildScheduledEvents(guildID string, withUserCount bool) ([]discord.GuildScheduledEvent, error)

+ func (c *Client) ListGuildStickers(guildID string) ([]discord.Sticker, error)

+ func (c *Client) ListJoinedPrivateArchivedThreads(channelID, before string, limit int) (*discord.ArchivedThreads, error)

+ func (c *Client) ListNitroStickerPacks() (*discord.NitroStickerPacks, error)

+ func (c *Client) ListPrivateArchivedThreads(channelID string, before *time.Time, limit int) (*discord.ArchivedThreads, error)

+ func (c *Client) ListPublicArchivedThreads(channelID string, before *time.Time, limit int) (*discord.ArchivedThreads, error)

+ func (c *Client) ListThreadMembers(threadID, after string, withMember bool, limit int) ([]discord.ThreadMember, error)

+ func (c *Client) ListVoiceRegions() ([]discord.VoiceRegion, error)

+ func (c *Client) SearchGuildMember(guildID, query string, limit int) ([]discord.Member, error)

+ type QueryParameters map[string]string

v0.2.0

May 4, 2023

Changes in this version

type Client

+ TaskManager *tasks.TaskManager

+ type DefaultInterceptor struct

+ func (i *DefaultInterceptor) ModifyRequest(_ *http.Request)

+ func (i *DefaultInterceptor) ModifyResponse(_ *http.Response)

+ type HttpClient struct

+ Interceptor Interceptor

+ func (c *HttpClient) SetInterceptor(interceptor Interceptor)

+ type Interceptor interface

+ ModifyRequest func(r *http.Request)

+ ModifyResponse func(r *http.Response)

v0.1.0

Apr 27, 2023

Changes in this version

+ const BaseURL

+ const Endpoint

+ const UsersEndpoint

+ const Version

+ type Bucket struct

+ Key string

+ Limit int

+ Remaining int

+ ResetAt time.Time

+ func NewBucket(key string) *Bucket

+ type Client struct

+ Debug bool

+ Extras interface{}

+ HttpClient *http.Client

+ Logger *logger.Logger

+ RateLimiter *RateLimiter

+ func (c *Client) DoRequest(method, url string, attempt int) ([]byte, *http.Response, error)

+ func (c *Client) GetCurrentUser() (*discord.User, error)

+ func (c *Client) GetSelfUser() (*discord.User, error)

+ func (c *Client) SetAuthorizationHeader(authorizationHeader string)

+ type RateLimiter struct

+ Buckets map[string]*Bucket

+ GlobalResetAt time.Time

+ MaxRetries int

+ func NewRateLimiter() *RateLimiter

+ func (r *RateLimiter) GetBucket(key string) *Bucket

+ func (r *RateLimiter) LockBucket(key string) *Bucket

+ func (r *RateLimiter) UnlockBucket(bucket *Bucket, headers http.Header) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL