restclient

package module

Go to main page

Versions in this module

v1

v1.2.8

Sep 24, 2021

v1.2.7

Aug 3, 2021

v1.2.6

Jul 30, 2021

v1.2.5

Jul 29, 2021

Changes in this version

+ var ApplicationCover = NewCDNRoute("/app-assets/{application.id}/{cover.image.hash}", []FileExtension{ ... })

+ var CustomEmoji = NewCDNRoute("/emojis/{emote.id}", []FileExtension{ ... })

+ var UserBanner = NewCDNRoute("/banners/{user.id}/{user.banner.hash}", []FileExtension{ ... })

v1.2.4

Jul 26, 2021

Changes in this version

+ var CreateIntegration = NewAPIRoute(POST, "/guilds/{guild.id}/integrations")

+ var DeleteIntegration = NewAPIRoute(DELETE, "/guilds/{guild.id}/integrations/{integration.id}")

+ var GetAllWebhooks = NewAPIRoute(GET, "/guilds/{guild.id}/webhooks")

+ var GetAuditLogs = NewAPIRoute(GET, "/guilds/{guild.id}/audit-logs", "user_id", "action_type", "before", ...)

+ var GetIntegrations = NewAPIRoute(GET, "/guilds/{guild.id}/integrations")

+ var SyncIntegration = NewAPIRoute(POST, "/guilds/{guild.id}/integrations/{integration.id}/sync")

+ var UpdateIntegration = NewAPIRoute(PATCH, "/guilds/{guild.id}/integrations/{integration.id}")

v1.2.3

Jul 22, 2021

Changes in this version

+ var AddBan = NewAPIRoute(PUT, "/guilds/{guild.id}/bans/{user.id}")

v1.2.2

Jun 21, 2021

Changes in this version

+ var CreateGuildFromTemplate = NewAPIRoute(POST, "/guilds/templates/{template.code}")

v1.2.1

Jun 21, 2021

Changes in this version

+ var CreateGuildTemplate = NewAPIRoute(POST, "/guilds/{guild.id}/templates")

+ var DeleteGuildTemplate = NewAPIRoute(DELETE, "/guilds/{guild.id}/templates/{template.code}")

+ var GetGuildTemplate = NewAPIRoute(GET, "/guilds/templates/{template.code}")

+ var GetGuildTemplates = NewAPIRoute(GET, "/guilds/{guild.id}/templates")

+ var SyncGuildTemplate = NewAPIRoute(PUT, "/guilds/{guild.id}/templates/{template.code}")

+ var UpdateGuildTemplate = NewAPIRoute(PATCH, "/guilds/{guild.id}/templates/{template.code}")

v1.2.0

Jun 15, 2021

Changes in this version

+ var DeleteRole = NewAPIRoute(DELETE, "/guilds/{guild.id}/roles/{role.id}")

+ var GetEmote = NewAPIRoute(GET, "/guilds/{guild.id}/emojis/{emoji.id}")

+ var GetGuildPreview = NewAPIRoute(GET, "/guilds/{guild.id}/preview")

+ var GetJoinedAchievedPrivateThreads = NewAPIRoute(GET, "/channels/{channel.id}/users/@me/threads/archived/private")

+ var SearchMembers = NewAPIRoute(GET, "/guilds/{guild.id}/members/search", "query", "limit")

+ var UpdateWebhookWithToken = NewAPIRoute(PATCH, "/webhooks/{webhook.id}/{webhook.token}")

+ type QueryValues map[string]interface

type RestError

+ func NewError(response *http.Response, err error) RestError

v1.1.5

Jun 11, 2021

Changes in this version

+ const Github

+ var Version = getVersion()

+ type File struct

+ Flags FileFlags

+ Name string

+ Reader io.Reader

+ func NewFile(name string, reader io.Reader, flags ...FileFlags) File

+ type FileFlags int

+ const FileFlagNone

+ const FileFlagSpoiler

+ func (f FileFlags) Add(flags ...FileFlags) FileFlags

+ func (f FileFlags) Has(flag FileFlags) bool

+ func (f FileFlags) HasAll(flags ...FileFlags) bool

+ func (f FileFlags) Missing(flag FileFlags) bool

+ func (f FileFlags) MissingAny(flags ...FileFlags) bool

+ func (f FileFlags) Remove(flags ...FileFlags) FileFlags

+ type MultipartBuffer struct

+ Buffer *bytes.Buffer

+ ContentType string

+ func PayloadWithFiles(v interface{}, files ...File) (buffer *MultipartBuffer, err error)

type RestClient

+ HTTPClient func() *http.Client

v1.1.4

May 28, 2021

v1.1.3

May 28, 2021

v1.1.2

May 28, 2021

Changes in this version

+ var GatewayURL = NewRoute(API + "/gateway", "v", "encoding", "compress")

type RestClient

+ Close func()

type RestClientImpl

+ func (r *RestClientImpl) Close()

v1.1.1

May 28, 2021

Changes in this version

+ var UpdateWebhook = NewAPIRoute(PATCH, "/webhooks/{webhook.id}")

v1.1.0

May 28, 2021

Changes in this version

type RestClient

+ Do func(route *CompiledAPIRoute, rqBody interface{}, rsBody interface{}) RestError

+ DoWithHeaders func(route *CompiledAPIRoute, rqBody interface{}, rsBody interface{}, ...) RestError

type RestClientImpl

+ func (r *RestClientImpl) Do(route *CompiledAPIRoute, rqBody interface{}, rsBody interface{}) RestError

+ func (r *RestClientImpl) DoWithHeaders(route *CompiledAPIRoute, rqBody interface{}, rsBody interface{}, ...) RestError

v1.0.3

May 28, 2021

Changes in this version

+ type RestClientImpl struct

+ func (r *RestClientImpl) HttpClient() *http.Client

+ func (r *RestClientImpl) Logger() log.Logger

+ func (r *RestClientImpl) Request(route *CompiledAPIRoute, rqBody interface{}, rsBody interface{}, ...) RestError

+ func (r *RestClientImpl) UserAgent() string

v1.0.2

May 27, 2021

v1.0.0

May 27, 2021

Changes in this version

+ const API

+ const APIVersion

+ const Base

+ const CDN

+ var AchievementIcon = NewCDNRoute(...)

+ var AddMember = NewAPIRoute(PUT, "/guilds/{guild.id}/members/{user.id}")

+ var AddMemberRole = NewAPIRoute(PUT, "/guilds/{guild.id}/members/{user.id}/roles/{role.id}")

+ var AddPinnedMessage = NewAPIRoute(PUT, "/channels/{channel.id}/pins/{message.id}")

+ var AddReaction = NewAPIRoute(PUT, "/channels/{channel.id}/messages/{message.id}/reactions/{emoji}/@me")

+ var AddThreadMember = NewAPIRoute(PUT, "/channels/{channel.id}/thread-members/{user.id}")

+ var ApplicationAsset = NewCDNRoute("/app-assets/{application.id}/{asset.id}.", []FileExtension{ ... })

+ var ApplicationIcon = NewCDNRoute("/app-icons/{application.id}/icon.", []FileExtension{ ... })

+ var Attachments = NewCDNRoute("/attachments/{channel.id}/{attachment.id}/{file.name}", ...)

+ var BaseRoute = ""

+ var BulkDeleteMessage = NewAPIRoute(POST, "/channels/{channel.id}/messages/bulk-delete")

+ var CreateBan = NewAPIRoute(POST, "/guilds/{guild.id}/bans/{user.id}", "delete_message_days", "reason")

+ var CreateDMChannel = NewAPIRoute(POST, "/users/@me/channels")

+ var CreateEmote = NewAPIRoute(POST, "/guilds/{guild.id}/emojis")

+ var CreateFollowupMessage = NewAPIRoute(POST, "/webhooks/{application.id}/{interaction.token}")

+ var CreateGlobalCommand = NewAPIRoute(POST, "/applications/{application.id}/commands")

+ var CreateGuild = NewAPIRoute(POST, "/guilds")

+ var CreateGuildChannel = NewAPIRoute(POST, "/guilds/{guild.id}/channels")

+ var CreateGuildCommand = NewAPIRoute(POST, "/applications/{application.id}/guilds/{guild.id}/commands")

+ var CreateGuildIntegration = NewAPIRoute(POST, "/guilds/{guild.id}/integrations")

+ var CreateInteractionResponse = NewAPIRoute(POST, "/interactions/{interaction.id}/{interaction.token}/callback")

+ var CreateInvite = NewAPIRoute(POST, "/channels/{channel.id}/invites")

+ var CreateMessage = NewAPIRoute(POST, "/channels/{channel.id}/messages")

+ var CreatePermissionOverride = NewAPIRoute(PUT, "/channels/{channel.id}/permissions/{overwrite.id}")

+ var CreateRole = NewAPIRoute(POST, "/guilds/{guild.id}/roles")

+ var CreateThread = NewAPIRoute(POST, "/channels/{channel.id}/threads")

+ var CreateThreadWithMessage = NewAPIRoute(POST, "/channels/{channel.id}/messages/{message.id}/threads")

+ var CreateWebhook = NewAPIRoute(POST, "/channels/{channel.id}/webhooks")

+ var CreateWebhookMessage = NewAPIRoute(POST, "/webhooks/{webhook.id}", "wait", "thread_id")

+ var CreateWebhookMessageGithub = NewAPIRoute(POST, "/webhooks/{webhook.id}/github", "wait")

+ var CreateWebhookMessageSlack = NewAPIRoute(POST, "/webhooks/{webhook.id}/slack", "wait")

+ var CrosspostMessage = NewAPIRoute(POST, "/channels/{channel.id}/messages/{message.id}/crosspost")

+ var DefaultUserAvatar = NewCDNRoute("/embed/avatars/{user.discriminator%5}.", []FileExtension{ ... })

+ var DeleteBan = NewAPIRoute(DELETE, "/guilds/{guild.id}/bans/{user.id}")

+ var DeleteChannel = NewAPIRoute(DELETE, "/channels/{channel.id}")

+ var DeleteEmote = NewAPIRoute(DELETE, "/guilds/{guild.id}/emojis/{emote.id}")

+ var DeleteFollowupMessage = NewAPIRoute(DELETE, "/webhooks/{application.id}/{interaction.token}/messages/{message.id}")

+ var DeleteGlobalCommand = NewAPIRoute(DELETE, "/applications/{application.id}/commands")

+ var DeleteGuild = NewAPIRoute(DELETE, "/guilds/{guild.id}")

+ var DeleteGuildCommand = NewAPIRoute(DELETE, "/applications/{application.id}/guilds/{guild.id}/commands")

+ var DeleteGuildIntegration = NewAPIRoute(DELETE, "/guilds/{guild.id}/integrations/{integration.id}")

+ var DeleteInteractionResponse = NewAPIRoute(DELETE, "/webhooks/{application.id}/{interaction.token}/messages/@original")

+ var DeleteInvite = NewAPIRoute(DELETE, "/invites/{code}")

+ var DeleteMessage = NewAPIRoute(DELETE, "/channels/{channel.id}/messages/{message.id}")

+ var DeletePermissionOverride = NewAPIRoute(DELETE, "/channels/{channel.id}/permissions/{overwrite.id}")

+ var DeleteWebhook = NewAPIRoute(DELETE, "/webhooks/{webhook.id}")

+ var DeleteWebhookMessage = NewAPIRoute(POST, "/webhooks/{webhook.id}/{token}/messages/{message.id}")

+ var DeleteWebhookWithToken = NewAPIRoute(DELETE, "/webhooks/{webhook.id}/{token}")

+ var DelteRole = NewAPIRoute(DELETE, "/guilds/{guild.id}/roles/{role.id}")

+ var Emote = NewCDNRoute("/emojis/{emote.id}.", []FileExtension{ ... })

+ var ErrBadGateway = errors.New("bad gateway could not reach destination")

+ var ErrBadRequest = errors.New("bad request please check your request")

+ var ErrRatelimited = errors.New("too many requests")

+ var ErrUnauthorized = errors.New("not authorized for this endpoint")

+ var GetActiveThreads = NewAPIRoute(GET, "/channels/{channel.id}/threads/active")

+ var GetArchivedPrivateThreads = NewAPIRoute(GET, "/channels/{channel.id}/threads/archived/private")

+ var GetArchivedPublicThreads = NewAPIRoute(GET, "/channels/{channel.id}/threads/archived/public")

+ var GetBan = NewAPIRoute(GET, "/guilds/{guild.id}/bans/{user.id}")

+ var GetBans = NewAPIRoute(GET, "/guilds/{guild.id}/bans")

+ var GetBotApplication = NewAPIRoute(GET, "/oauth2/applications/@me")

+ var GetChannel = NewAPIRoute(GET, "/channels/{channel.id}")

+ var GetChannelInvites = NewAPIRoute(GET, "/channels/{channel.id}/invites")

+ var GetDMChannels = NewAPIRoute(GET, "/users/@me/channels")

+ var GetEmotes = NewAPIRoute(GET, "/guilds/{guild.id}/emojis")

+ var GetGateway = NewAPIRoute(GET, "/gateway")

+ var GetGatewayBot = NewAPIRoute(GET, "/gateway/bot")

+ var GetGlobalCommand = NewAPIRoute(GET, "/applications/{application.id}/command/{command.id}")

+ var GetGlobalCommands = NewAPIRoute(GET, "/applications/{application.id}/commands")

+ var GetGuild = NewAPIRoute(GET, "/guilds/{guild.id}")

+ var GetGuildAuditLogs = NewAPIRoute(GET, "/guilds/{guild.id}/audit-logs")

+ var GetGuildChannels = NewAPIRoute(GET, "/guilds/{guild.id}/channels")

+ var GetGuildCommand = NewAPIRoute(GET, "/applications/{application.id}/guilds/{guild.id}/command/{command.id}")

+ var GetGuildCommandPermission = NewAPIRoute(GET, ...)

+ var GetGuildCommandPermissions = NewAPIRoute(GET, "/applications/{application.id}/guilds/{guild.id}/commands/permissions")

+ var GetGuildCommands = NewAPIRoute(GET, "/applications/{application.id}/guilds/{guild.id}/commands")

+ var GetGuildIntegrations = NewAPIRoute(GET, "/guilds/{guild.id}/integrations")

+ var GetGuildInvite = NewAPIRoute(GET, "/guilds/{guild.id}/invites")

+ var GetGuildVanityURL = NewAPIRoute(GET, "/guilds/{guild.id}/vanity-url")

+ var GetGuildVoiceRegions = NewAPIRoute(GET, "/guilds/{guild.id}/regions")

+ var GetGuildWebhooks = NewAPIRoute(GET, "/guilds/{guild.id}/webhooks")

+ var GetGuilds = NewAPIRoute(GET, "/users/@me/guilds")

+ var GetInvite = NewAPIRoute(GET, "/invites/{code}")

+ var GetJoinedArchievedPrivateThreads = NewAPIRoute(GET, "/channels/{channel.id}/users/@me/threads/archived/private")

+ var GetMember = NewAPIRoute(GET, "/guilds/{guild.id}/members/{user.id}")

+ var GetMembers = NewAPIRoute(GET, "/guilds/{guild.id}/members")

+ var GetMessage = NewAPIRoute(GET, "/channels/{channel.id}/messages/{message.id}")

+ var GetMessages = NewAPIRoute(GET, "/channels/{channel.id}/messages")

+ var GetPermissionOverride = NewAPIRoute(GET, "/channels/{channel.id}/permissions/{overwrite.id}")

+ var GetPermissionOverrides = NewAPIRoute(GET, "/channels/{channel.id}/permissions")

+ var GetPinnedMessages = NewAPIRoute(GET, "/channels/{channel.id}/pins")

+ var GetPruneMembersCount = NewAPIRoute(GET, "/guilds/{guild.id}/prune")

+ var GetReactions = NewAPIRoute(GET, "/channels/{channel.id}/messages/{message.id}/reactions/{emoji}")

+ var GetRole = NewAPIRoute(GET, "/guilds/{guild.id}/roles/{role.id}")

+ var GetRoles = NewAPIRoute(GET, "/guilds/{guild.id}/roles")

+ var GetSelfUser = NewAPIRoute(GET, "/users/@me")

+ var GetThreadMembers = NewAPIRoute(GET, "/channels/{channel.id}/thread-members")

+ var GetUser = NewAPIRoute(GET, "/users/{user.id}")

+ var GetVoiceRegions = NewAPIRoute(GET, "/voice/regions")

+ var GetWebhook = NewAPIRoute(GET, "/webhooks/{webhook.id}")

+ var GetWebhookWithToken = NewAPIRoute(GET, "/webhooks/{webhook.id}/{token}")

+ var GetWebhooks = NewAPIRoute(GET, "/channels/{channel.id}/webhooks")

+ var Getemote = NewAPIRoute(GET, "/guilds/{guild.id}/emojis/{emoji.id}")

+ var GuildBanner = NewCDNRoute("/banners/{guild.id}/guild.banner.", []FileExtension{ ... })

+ var GuildDiscoverySplash = NewCDNRoute("/discovery-splashes/{guild.id}/guild.discovery.splash.", ...)

+ var GuildIcon = NewCDNRoute("/icons/{guild.id}/{icon.hash}.", []FileExtension{ ... })

+ var GuildSplash = NewCDNRoute("/splashes/{guild.id}/guild.splash.", []FileExtension{ ... })

+ var InviteURL = NewRoute("https://discord.gg/{code}")

+ var JoinThread = NewAPIRoute(PUT, "/channels/{channel.id}/thread-members/@me")

+ var LeaveGuild = NewAPIRoute(DELETE, "/users/@me/guilds/{guild.id}")

+ var LeaveThread = NewAPIRoute(DELETE, "/channels/{channel.id}/thread-members/@me")

+ var PruneMembers = NewAPIRoute(POST, "/guilds/{guild.id}/prune")

+ var RemoveAllReactions = NewAPIRoute(DELETE, "/channels/{channel.id}/messages/{message.id}/reactions")

+ var RemoveAllReactionsEmoji = NewAPIRoute(DELETE, "/channels/{channel.id}/messages/{message.id}/reactions/{emoji}")

+ var RemoveMember = NewAPIRoute(DELETE, "/guilds/{guild.id}/members/{user.id}", "reason")

+ var RemoveMemberRole = NewAPIRoute(DELETE, "/guilds/{guild.id}/members/{user.id}/roles/{role.id}")

+ var RemoveOwnReaction = NewAPIRoute(DELETE, "/channels/{channel.id}/messages/{message.id}/reactions/{emoji}/@me")

+ var RemovePinnedMessage = NewAPIRoute(DELETE, "/channels/{channel.id}/pins/{message.id}")

+ var RemoveThreadMember = NewAPIRoute(DELETE, "/channels/{channel.id}/thread-members/{user.id}")

+ var RemoveUserReaction = NewAPIRoute(DELETE, ...)

+ var SendTyping = NewAPIRoute(POST, "/channels/{channel.id}/typing")

+ var SetGlobalCommands = NewAPIRoute(PUT, "/applications/{application.id}/commands")

+ var SetGuildCommandPermissions = NewAPIRoute(PUT, ...)

+ var SetGuildCommands = NewAPIRoute(PUT, "/applications/{application.id}/guilds/{guild.id}/commands")

+ var SetGuildCommandsPermissions = NewAPIRoute(PUT, "/applications/{application.id}/guilds/{guild.id}/commands/permissions")

+ var SyncGuildIntegration = NewAPIRoute(POST, "/guilds/{guild.id}/integrations/{integration.id}/sync")

+ var TeamIcon = NewCDNRoute("/team-icons/{team.id}/team.icon.", []FileExtension{ ... })

+ var UpdateChannel = NewAPIRoute(PATCH, "/channels/{channel.id}")

+ var UpdateChannelPositions = NewAPIRoute(PATCH, "/guilds/{guild.id}/channels")

+ var UpdateEmote = NewAPIRoute(PATCH, "/guilds/{guild.id}/emojis/{emote.id}")

+ var UpdateFollowupMessage = NewAPIRoute(PATCH, "/webhooks/{application.id}/{interaction.token}/messages/{message.id}")

+ var UpdateGlobalCommand = NewAPIRoute(PATCH, "/applications/{application.id}/commands/{command.id}")

+ var UpdateGuild = NewAPIRoute(PATCH, "/guilds/{guild.id}")

+ var UpdateGuildCommand = NewAPIRoute(PATCH, ...)

+ var UpdateGuildIntegration = NewAPIRoute(PATCH, "/guilds/{guild.id}/integrations/{integration.id}")

+ var UpdateInteractionResponse = NewAPIRoute(PATCH, "/webhooks/{application.id}/{interaction.token}/messages/@original")

+ var UpdateMember = NewAPIRoute(PATCH, "/guilds/{guild.id}/members/{user.id}")

+ var UpdateMessage = NewAPIRoute(PATCH, "/channels/{channel.id}/messages/{message.id}")

+ var UpdatePermissionOverride = NewAPIRoute(PUT, "/channels/{channel.id}/permissions/{overwrite.id}")

+ var UpdateRole = NewAPIRoute(PATCH, "/guilds/{guild.id}/roles/{role.id}")

+ var UpdateRolePositions = NewAPIRoute(PATCH, "/guilds/{guild.id}/roles")

+ var UpdateRoles = NewAPIRoute(PATCH, "/guilds/{guild.id}/roles")

+ var UpdateSelfNick = NewAPIRoute(PATCH, "/guilds/{guild.id}/members/@me/nick")

+ var UpdateSelfUser = NewAPIRoute(PATCH, "/users/@me")

+ var UpdateWebhok = NewAPIRoute(PATCH, "/webhooks/{webhook.id}")

+ var UpdateWebhokWithToken = NewAPIRoute(PATCH, "/webhooks/{webhook.id}/{token}")

+ var UpdateWebhookMessage = NewAPIRoute(POST, "/webhooks/{webhook.id}/{token}/messages/{message.id}")

+ var UserAvatar = NewCDNRoute("/avatars/{user.id}/user.avatar.", []FileExtension{ ... })

+ func NewRestError(response *http.Response, err error) *restErrorImpl

+ type APIRoute struct

+ func NewAPIRoute(method Method, url string, queryParams ...string) *APIRoute

+ func NewCustomRoute(method Method, url string, queryParams ...string) *APIRoute

+ func (r *APIRoute) Compile(queryParams map[string]interface{}, args ...interface{}) (*CompiledAPIRoute, error)

+ func (r *APIRoute) Method() Method

+ type CDNRoute struct

+ func NewCDNRoute(url string, supportedFileExtensions []FileExtension, queryParams ...string) *CDNRoute

+ func (r *CDNRoute) Compile(queryParams map[string]interface{}, fileExtension FileExtension, size int, ...) (*CompiledCDNRoute, error)

+ type CompiledAPIRoute struct

+ func (r *CompiledAPIRoute) Method() Method

+ type CompiledCDNRoute struct

+ type CompiledRoute struct

+ func (r *CompiledRoute) QueryParams() string

+ func (r *CompiledRoute) Route() string

+ func (r *CompiledRoute) URL() string

+ type CustomRoute struct

+ func (r CustomRoute) Compile(queryParams map[string]interface{}, args ...interface{}) (*CompiledAPIRoute, error)

+ type FileExtension string

+ const BLANK

+ const GIF

+ const JPEG

+ const PNG

+ const WEBP

+ func (f FileExtension) String() string

+ type Method string

+ const DELETE

+ const GET

+ const PATCH

+ const POST

+ const PUT

+ func (m Method) String() string

+ type RestClient struct

+ func NewRestClient(httpClient *http.Client, logger log.Logger, userAgent string) *RestClient

+ func (r *RestClient) HttpClient() *http.Client

+ func (r *RestClient) Logger() log.Logger

+ func (r *RestClient) Request(route *CompiledAPIRoute, rqBody interface{}, rsBody interface{}, ...) RestError

+ func (r *RestClient) UserAgent() string

+ type RestError interface

+ Response func() *http.Response

+ type Route struct

+ func NewRoute(url string, queryParams ...string) *Route

+ func (r *Route) Compile(queryParams map[string]interface{}, args ...interface{}) (*CompiledRoute, error)

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