restapi.go 56 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948
  1. // Discordgo - Discord bindings for Go
  2. // Available at https://github.com/bwmarrin/discordgo
  3. // Copyright 2015-2016 Bruce Marriner <bruce@sqls.net>. All rights reserved.
  4. // Use of this source code is governed by a BSD-style
  5. // license that can be found in the LICENSE file.
  6. // This file contains functions for interacting with the Discord REST/JSON API
  7. // at the lowest level.
  8. package discordgo
  9. import (
  10. "bytes"
  11. "encoding/json"
  12. "errors"
  13. "fmt"
  14. "image"
  15. _ "image/jpeg" // For JPEG decoding
  16. _ "image/png" // For PNG decoding
  17. "io"
  18. "io/ioutil"
  19. "log"
  20. "mime/multipart"
  21. "net/http"
  22. "net/url"
  23. "strconv"
  24. "strings"
  25. "time"
  26. )
  27. // ErrJSONUnmarshal is returned for JSON Unmarshall errors.
  28. var ErrJSONUnmarshal = errors.New("json unmarshal")
  29. // Request is the same as RequestWithBucketID but the bucket id is the same as the urlStr
  30. func (s *Session) Request(method, urlStr string, data interface{}) (response []byte, err error) {
  31. return s.RequestWithBucketID(method, urlStr, data, strings.SplitN(urlStr, "?", 2)[0])
  32. }
  33. // RequestWithBucketID makes a (GET/POST/...) Requests to Discord REST API with JSON data.
  34. func (s *Session) RequestWithBucketID(method, urlStr string, data interface{}, bucketID string) (response []byte, err error) {
  35. var body []byte
  36. if data != nil {
  37. body, err = json.Marshal(data)
  38. if err != nil {
  39. return
  40. }
  41. }
  42. return s.request(method, urlStr, "application/json", body, bucketID, 0)
  43. }
  44. // request makes a (GET/POST/...) Requests to Discord REST API.
  45. // Sequence is the sequence number, if it fails with a 502 it will
  46. // retry with sequence+1 until it either succeeds or sequence >= session.MaxRestRetries
  47. func (s *Session) request(method, urlStr, contentType string, b []byte, bucketID string, sequence int) (response []byte, err error) {
  48. if bucketID == "" {
  49. bucketID = strings.SplitN(urlStr, "?", 2)[0]
  50. }
  51. bucket := s.ratelimiter.LockBucket(bucketID)
  52. if s.Debug {
  53. log.Printf("API REQUEST %8s :: %s\n", method, urlStr)
  54. log.Printf("API REQUEST PAYLOAD :: [%s]\n", string(b))
  55. }
  56. req, err := http.NewRequest(method, urlStr, bytes.NewBuffer(b))
  57. if err != nil {
  58. bucket.Release(nil)
  59. return
  60. }
  61. // Not used on initial login..
  62. // TODO: Verify if a login, otherwise complain about no-token
  63. if s.Token != "" {
  64. req.Header.Set("authorization", s.Token)
  65. }
  66. req.Header.Set("Content-Type", contentType)
  67. // TODO: Make a configurable static variable.
  68. req.Header.Set("User-Agent", fmt.Sprintf("DiscordBot (https://github.com/bwmarrin/discordgo, v%s)", VERSION))
  69. if s.Debug {
  70. for k, v := range req.Header {
  71. log.Printf("API REQUEST HEADER :: [%s] = %+v\n", k, v)
  72. }
  73. }
  74. resp, err := s.Client.Do(req)
  75. if err != nil {
  76. bucket.Release(nil)
  77. return
  78. }
  79. defer func() {
  80. err2 := resp.Body.Close()
  81. if err2 != nil {
  82. log.Println("error closing resp body")
  83. }
  84. }()
  85. err = bucket.Release(resp.Header)
  86. if err != nil {
  87. return
  88. }
  89. response, err = ioutil.ReadAll(resp.Body)
  90. if err != nil {
  91. return
  92. }
  93. if s.Debug {
  94. log.Printf("API RESPONSE STATUS :: %s\n", resp.Status)
  95. for k, v := range resp.Header {
  96. log.Printf("API RESPONSE HEADER :: [%s] = %+v\n", k, v)
  97. }
  98. log.Printf("API RESPONSE BODY :: [%s]\n\n\n", response)
  99. }
  100. switch resp.StatusCode {
  101. case http.StatusOK:
  102. case http.StatusCreated:
  103. case http.StatusNoContent:
  104. // TODO check for 401 response, invalidate token if we get one.
  105. case http.StatusBadGateway:
  106. // Retry sending request if possible
  107. if sequence < s.MaxRestRetries {
  108. s.log(LogInformational, "%s Failed (%s), Retrying...", urlStr, resp.Status)
  109. response, err = s.request(method, urlStr, contentType, b, bucketID, sequence+1)
  110. } else {
  111. err = fmt.Errorf("Exceeded Max retries HTTP %s, %s", resp.Status, response)
  112. }
  113. case 429: // TOO MANY REQUESTS - Rate limiting
  114. rl := TooManyRequests{}
  115. err = json.Unmarshal(response, &rl)
  116. if err != nil {
  117. s.log(LogError, "rate limit unmarshal error, %s", err)
  118. return
  119. }
  120. s.log(LogInformational, "Rate Limiting %s, retry in %d", urlStr, rl.RetryAfter)
  121. s.handleEvent(rateLimitEventType, RateLimit{TooManyRequests: &rl, URL: urlStr})
  122. time.Sleep(rl.RetryAfter * time.Millisecond)
  123. // we can make the above smarter
  124. // this method can cause longer delays than required
  125. response, err = s.request(method, urlStr, contentType, b, bucketID, sequence)
  126. default: // Error condition
  127. err = newRestError(req, resp, response)
  128. }
  129. return
  130. }
  131. func unmarshal(data []byte, v interface{}) error {
  132. err := json.Unmarshal(data, v)
  133. if err != nil {
  134. return ErrJSONUnmarshal
  135. }
  136. return nil
  137. }
  138. // ------------------------------------------------------------------------------------------------
  139. // Functions specific to Discord Sessions
  140. // ------------------------------------------------------------------------------------------------
  141. // Login asks the Discord server for an authentication token.
  142. func (s *Session) Login(email, password string) (err error) {
  143. data := struct {
  144. Email string `json:"email"`
  145. Password string `json:"password"`
  146. }{email, password}
  147. response, err := s.RequestWithBucketID("POST", EndpointLogin, data, EndpointLogin)
  148. if err != nil {
  149. return
  150. }
  151. temp := struct {
  152. Token string `json:"token"`
  153. }{}
  154. err = unmarshal(response, &temp)
  155. if err != nil {
  156. return
  157. }
  158. s.Token = temp.Token
  159. return
  160. }
  161. // Register sends a Register request to Discord, and returns the authentication token
  162. // Note that this account is temporary and should be verified for future use.
  163. // Another option is to save the authentication token external, but this isn't recommended.
  164. func (s *Session) Register(username string) (token string, err error) {
  165. data := struct {
  166. Username string `json:"username"`
  167. }{username}
  168. response, err := s.RequestWithBucketID("POST", EndpointRegister, data, EndpointRegister)
  169. if err != nil {
  170. return
  171. }
  172. temp := struct {
  173. Token string `json:"token"`
  174. }{}
  175. err = unmarshal(response, &temp)
  176. if err != nil {
  177. return
  178. }
  179. token = temp.Token
  180. return
  181. }
  182. // Logout sends a logout request to Discord.
  183. // This does not seem to actually invalidate the token. So you can still
  184. // make API calls even after a Logout. So, it seems almost pointless to
  185. // even use.
  186. func (s *Session) Logout() (err error) {
  187. // _, err = s.Request("POST", LOGOUT, fmt.Sprintf(`{"token": "%s"}`, s.Token))
  188. if s.Token == "" {
  189. return
  190. }
  191. data := struct {
  192. Token string `json:"token"`
  193. }{s.Token}
  194. _, err = s.RequestWithBucketID("POST", EndpointLogout, data, EndpointLogout)
  195. return
  196. }
  197. // ------------------------------------------------------------------------------------------------
  198. // Functions specific to Discord Users
  199. // ------------------------------------------------------------------------------------------------
  200. // User returns the user details of the given userID
  201. // userID : A user ID or "@me" which is a shortcut of current user ID
  202. func (s *Session) User(userID string) (st *User, err error) {
  203. body, err := s.RequestWithBucketID("GET", EndpointUser(userID), nil, EndpointUsers)
  204. if err != nil {
  205. return
  206. }
  207. err = unmarshal(body, &st)
  208. return
  209. }
  210. // UserAvatar returns an image.Image of a users Avatar.
  211. // userID : A user ID or "@me" which is a shortcut of current user ID
  212. func (s *Session) UserAvatar(userID string) (img image.Image, err error) {
  213. u, err := s.User(userID)
  214. if err != nil {
  215. return
  216. }
  217. body, err := s.RequestWithBucketID("GET", EndpointUserAvatar(userID, u.Avatar), nil, EndpointUserAvatar("", ""))
  218. if err != nil {
  219. return
  220. }
  221. img, _, err = image.Decode(bytes.NewReader(body))
  222. return
  223. }
  224. // UserUpdate updates a users settings.
  225. func (s *Session) UserUpdate(email, password, username, avatar, newPassword string) (st *User, err error) {
  226. // NOTE: Avatar must be either the hash/id of existing Avatar or
  227. // data:image/png;base64,BASE64_STRING_OF_NEW_AVATAR_PNG
  228. // to set a new avatar.
  229. // If left blank, avatar will be set to null/blank
  230. data := struct {
  231. Email string `json:"email"`
  232. Password string `json:"password"`
  233. Username string `json:"username"`
  234. Avatar string `json:"avatar,omitempty"`
  235. NewPassword string `json:"new_password,omitempty"`
  236. }{email, password, username, avatar, newPassword}
  237. body, err := s.RequestWithBucketID("PATCH", EndpointUser("@me"), data, EndpointUsers)
  238. if err != nil {
  239. return
  240. }
  241. err = unmarshal(body, &st)
  242. return
  243. }
  244. // UserSettings returns the settings for a given user
  245. func (s *Session) UserSettings() (st *Settings, err error) {
  246. body, err := s.RequestWithBucketID("GET", EndpointUserSettings("@me"), nil, EndpointUserSettings(""))
  247. if err != nil {
  248. return
  249. }
  250. err = unmarshal(body, &st)
  251. return
  252. }
  253. // UserUpdateStatus update the user status
  254. // status : The new status (Actual valid status are 'online','idle','dnd','invisible')
  255. func (s *Session) UserUpdateStatus(status Status) (st *Settings, err error) {
  256. if status == StatusOffline {
  257. err = errors.New("You can't set your Status to offline")
  258. return
  259. }
  260. data := struct {
  261. Status Status `json:"status"`
  262. }{status}
  263. body, err := s.RequestWithBucketID("PATCH", EndpointUserSettings("@me"), data, EndpointUserSettings(""))
  264. if err != nil {
  265. return
  266. }
  267. err = unmarshal(body, &st)
  268. return
  269. }
  270. // UserChannels returns an array of Channel structures for all private
  271. // channels.
  272. func (s *Session) UserChannels() (st []*Channel, err error) {
  273. body, err := s.RequestWithBucketID("GET", EndpointUserChannels("@me"), nil, EndpointUserChannels(""))
  274. if err != nil {
  275. return
  276. }
  277. err = unmarshal(body, &st)
  278. return
  279. }
  280. // UserChannelCreate creates a new User (Private) Channel with another User
  281. // recipientID : A user ID for the user to which this channel is opened with.
  282. func (s *Session) UserChannelCreate(recipientID string) (st *Channel, err error) {
  283. data := struct {
  284. RecipientID string `json:"recipient_id"`
  285. }{recipientID}
  286. body, err := s.RequestWithBucketID("POST", EndpointUserChannels("@me"), data, EndpointUserChannels(""))
  287. if err != nil {
  288. return
  289. }
  290. err = unmarshal(body, &st)
  291. return
  292. }
  293. // UserGuilds returns an array of UserGuild structures for all guilds.
  294. // limit : The number guilds that can be returned. (max 100)
  295. // beforeID : If provided all guilds returned will be before given ID.
  296. // afterID : If provided all guilds returned will be after given ID.
  297. func (s *Session) UserGuilds(limit int, beforeID, afterID string) (st []*UserGuild, err error) {
  298. v := url.Values{}
  299. if limit > 0 {
  300. v.Set("limit", strconv.Itoa(limit))
  301. }
  302. if afterID != "" {
  303. v.Set("after", afterID)
  304. }
  305. if beforeID != "" {
  306. v.Set("before", beforeID)
  307. }
  308. uri := EndpointUserGuilds("@me")
  309. if len(v) > 0 {
  310. uri = fmt.Sprintf("%s?%s", uri, v.Encode())
  311. }
  312. body, err := s.RequestWithBucketID("GET", uri, nil, EndpointUserGuilds(""))
  313. if err != nil {
  314. return
  315. }
  316. err = unmarshal(body, &st)
  317. return
  318. }
  319. // UserGuildSettingsEdit Edits the users notification settings for a guild
  320. // guildID : The ID of the guild to edit the settings on
  321. // settings : The settings to update
  322. func (s *Session) UserGuildSettingsEdit(guildID string, settings *UserGuildSettingsEdit) (st *UserGuildSettings, err error) {
  323. body, err := s.RequestWithBucketID("PATCH", EndpointUserGuildSettings("@me", guildID), settings, EndpointUserGuildSettings("", guildID))
  324. if err != nil {
  325. return
  326. }
  327. err = unmarshal(body, &st)
  328. return
  329. }
  330. // UserChannelPermissions returns the permission of a user in a channel.
  331. // userID : The ID of the user to calculate permissions for.
  332. // channelID : The ID of the channel to calculate permission for.
  333. //
  334. // NOTE: This function is now deprecated and will be removed in the future.
  335. // Please see the same function inside state.go
  336. func (s *Session) UserChannelPermissions(userID, channelID string) (apermissions int, err error) {
  337. // Try to just get permissions from state.
  338. apermissions, err = s.State.UserChannelPermissions(userID, channelID)
  339. if err == nil {
  340. return
  341. }
  342. // Otherwise try get as much data from state as possible, falling back to the network.
  343. channel, err := s.State.Channel(channelID)
  344. if err != nil || channel == nil {
  345. channel, err = s.Channel(channelID)
  346. if err != nil {
  347. return
  348. }
  349. }
  350. guild, err := s.State.Guild(channel.GuildID)
  351. if err != nil || guild == nil {
  352. guild, err = s.Guild(channel.GuildID)
  353. if err != nil {
  354. return
  355. }
  356. }
  357. if userID == guild.OwnerID {
  358. apermissions = PermissionAll
  359. return
  360. }
  361. member, err := s.State.Member(guild.ID, userID)
  362. if err != nil || member == nil {
  363. member, err = s.GuildMember(guild.ID, userID)
  364. if err != nil {
  365. return
  366. }
  367. }
  368. return memberPermissions(guild, channel, member), nil
  369. }
  370. // Calculates the permissions for a member.
  371. // https://support.discordapp.com/hc/en-us/articles/206141927-How-is-the-permission-hierarchy-structured-
  372. func memberPermissions(guild *Guild, channel *Channel, member *Member) (apermissions int) {
  373. userID := member.User.ID
  374. if userID == guild.OwnerID {
  375. apermissions = PermissionAll
  376. return
  377. }
  378. for _, role := range guild.Roles {
  379. if role.ID == guild.ID {
  380. apermissions |= role.Permissions
  381. break
  382. }
  383. }
  384. for _, role := range guild.Roles {
  385. for _, roleID := range member.Roles {
  386. if role.ID == roleID {
  387. apermissions |= role.Permissions
  388. break
  389. }
  390. }
  391. }
  392. if apermissions&PermissionAdministrator == PermissionAdministrator {
  393. apermissions |= PermissionAll
  394. }
  395. // Apply @everyone overrides from the channel.
  396. for _, overwrite := range channel.PermissionOverwrites {
  397. if guild.ID == overwrite.ID {
  398. apermissions &= ^overwrite.Deny
  399. apermissions |= overwrite.Allow
  400. break
  401. }
  402. }
  403. denies := 0
  404. allows := 0
  405. // Member overwrites can override role overrides, so do two passes
  406. for _, overwrite := range channel.PermissionOverwrites {
  407. for _, roleID := range member.Roles {
  408. if overwrite.Type == "role" && roleID == overwrite.ID {
  409. denies |= overwrite.Deny
  410. allows |= overwrite.Allow
  411. break
  412. }
  413. }
  414. }
  415. apermissions &= ^denies
  416. apermissions |= allows
  417. for _, overwrite := range channel.PermissionOverwrites {
  418. if overwrite.Type == "member" && overwrite.ID == userID {
  419. apermissions &= ^overwrite.Deny
  420. apermissions |= overwrite.Allow
  421. break
  422. }
  423. }
  424. if apermissions&PermissionAdministrator == PermissionAdministrator {
  425. apermissions |= PermissionAllChannel
  426. }
  427. return apermissions
  428. }
  429. // ------------------------------------------------------------------------------------------------
  430. // Functions specific to Discord Guilds
  431. // ------------------------------------------------------------------------------------------------
  432. // Guild returns a Guild structure of a specific Guild.
  433. // guildID : The ID of a Guild
  434. func (s *Session) Guild(guildID string) (st *Guild, err error) {
  435. if s.StateEnabled {
  436. // Attempt to grab the guild from State first.
  437. st, err = s.State.Guild(guildID)
  438. if err == nil {
  439. return
  440. }
  441. }
  442. body, err := s.RequestWithBucketID("GET", EndpointGuild(guildID), nil, EndpointGuild(guildID))
  443. if err != nil {
  444. return
  445. }
  446. err = unmarshal(body, &st)
  447. return
  448. }
  449. // GuildCreate creates a new Guild
  450. // name : A name for the Guild (2-100 characters)
  451. func (s *Session) GuildCreate(name string) (st *Guild, err error) {
  452. data := struct {
  453. Name string `json:"name"`
  454. }{name}
  455. body, err := s.RequestWithBucketID("POST", EndpointGuilds, data, EndpointGuilds)
  456. if err != nil {
  457. return
  458. }
  459. err = unmarshal(body, &st)
  460. return
  461. }
  462. // GuildEdit edits a new Guild
  463. // guildID : The ID of a Guild
  464. // g : A GuildParams struct with the values Name, Region and VerificationLevel defined.
  465. func (s *Session) GuildEdit(guildID string, g GuildParams) (st *Guild, err error) {
  466. // Bounds checking for VerificationLevel, interval: [0, 3]
  467. if g.VerificationLevel != nil {
  468. val := *g.VerificationLevel
  469. if val < 0 || val > 3 {
  470. err = errors.New("VerificationLevel out of bounds, should be between 0 and 3")
  471. return
  472. }
  473. }
  474. //Bounds checking for regions
  475. if g.Region != "" {
  476. isValid := false
  477. regions, _ := s.VoiceRegions()
  478. for _, r := range regions {
  479. if g.Region == r.ID {
  480. isValid = true
  481. }
  482. }
  483. if !isValid {
  484. var valid []string
  485. for _, r := range regions {
  486. valid = append(valid, r.ID)
  487. }
  488. err = fmt.Errorf("Region not a valid region (%q)", valid)
  489. return
  490. }
  491. }
  492. data := struct {
  493. Name string `json:"name,omitempty"`
  494. Region string `json:"region,omitempty"`
  495. VerificationLevel *VerificationLevel `json:"verification_level,omitempty"`
  496. }{g.Name, g.Region, g.VerificationLevel}
  497. body, err := s.RequestWithBucketID("PATCH", EndpointGuild(guildID), data, EndpointGuild(guildID))
  498. if err != nil {
  499. return
  500. }
  501. err = unmarshal(body, &st)
  502. return
  503. }
  504. // GuildDelete deletes a Guild.
  505. // guildID : The ID of a Guild
  506. func (s *Session) GuildDelete(guildID string) (st *Guild, err error) {
  507. body, err := s.RequestWithBucketID("DELETE", EndpointGuild(guildID), nil, EndpointGuild(guildID))
  508. if err != nil {
  509. return
  510. }
  511. err = unmarshal(body, &st)
  512. return
  513. }
  514. // GuildLeave leaves a Guild.
  515. // guildID : The ID of a Guild
  516. func (s *Session) GuildLeave(guildID string) (err error) {
  517. _, err = s.RequestWithBucketID("DELETE", EndpointUserGuild("@me", guildID), nil, EndpointUserGuild("", guildID))
  518. return
  519. }
  520. // GuildBans returns an array of User structures for all bans of a
  521. // given guild.
  522. // guildID : The ID of a Guild.
  523. func (s *Session) GuildBans(guildID string) (st []*GuildBan, err error) {
  524. body, err := s.RequestWithBucketID("GET", EndpointGuildBans(guildID), nil, EndpointGuildBans(guildID))
  525. if err != nil {
  526. return
  527. }
  528. err = unmarshal(body, &st)
  529. return
  530. }
  531. // GuildBanCreate bans the given user from the given guild.
  532. // guildID : The ID of a Guild.
  533. // userID : The ID of a User
  534. // days : The number of days of previous comments to delete.
  535. func (s *Session) GuildBanCreate(guildID, userID string, days int) (err error) {
  536. uri := EndpointGuildBan(guildID, userID)
  537. if days > 0 {
  538. uri = fmt.Sprintf("%s?delete-message-days=%d", uri, days)
  539. }
  540. _, err = s.RequestWithBucketID("PUT", uri, nil, EndpointGuildBan(guildID, ""))
  541. return
  542. }
  543. // GuildBanDelete removes the given user from the guild bans
  544. // guildID : The ID of a Guild.
  545. // userID : The ID of a User
  546. func (s *Session) GuildBanDelete(guildID, userID string) (err error) {
  547. _, err = s.RequestWithBucketID("DELETE", EndpointGuildBan(guildID, userID), nil, EndpointGuildBan(guildID, ""))
  548. return
  549. }
  550. // GuildMembers returns a list of members for a guild.
  551. // guildID : The ID of a Guild.
  552. // after : The id of the member to return members after
  553. // limit : max number of members to return (max 1000)
  554. func (s *Session) GuildMembers(guildID string, after string, limit int) (st []*Member, err error) {
  555. uri := EndpointGuildMembers(guildID)
  556. v := url.Values{}
  557. if after != "" {
  558. v.Set("after", after)
  559. }
  560. if limit > 0 {
  561. v.Set("limit", strconv.Itoa(limit))
  562. }
  563. if len(v) > 0 {
  564. uri = fmt.Sprintf("%s?%s", uri, v.Encode())
  565. }
  566. body, err := s.RequestWithBucketID("GET", uri, nil, EndpointGuildMembers(guildID))
  567. if err != nil {
  568. return
  569. }
  570. err = unmarshal(body, &st)
  571. return
  572. }
  573. // GuildMember returns a member of a guild.
  574. // guildID : The ID of a Guild.
  575. // userID : The ID of a User
  576. func (s *Session) GuildMember(guildID, userID string) (st *Member, err error) {
  577. body, err := s.RequestWithBucketID("GET", EndpointGuildMember(guildID, userID), nil, EndpointGuildMember(guildID, ""))
  578. if err != nil {
  579. return
  580. }
  581. err = unmarshal(body, &st)
  582. return
  583. }
  584. // GuildMemberDelete removes the given user from the given guild.
  585. // guildID : The ID of a Guild.
  586. // userID : The ID of a User
  587. func (s *Session) GuildMemberDelete(guildID, userID string) (err error) {
  588. _, err = s.RequestWithBucketID("DELETE", EndpointGuildMember(guildID, userID), nil, EndpointGuildMember(guildID, ""))
  589. return
  590. }
  591. // GuildMemberEdit edits the roles of a member.
  592. // guildID : The ID of a Guild.
  593. // userID : The ID of a User.
  594. // roles : A list of role ID's to set on the member.
  595. func (s *Session) GuildMemberEdit(guildID, userID string, roles []string) (err error) {
  596. data := struct {
  597. Roles []string `json:"roles"`
  598. }{roles}
  599. _, err = s.RequestWithBucketID("PATCH", EndpointGuildMember(guildID, userID), data, EndpointGuildMember(guildID, ""))
  600. if err != nil {
  601. return
  602. }
  603. return
  604. }
  605. // GuildMemberMove moves a guild member from one voice channel to another/none
  606. // guildID : The ID of a Guild.
  607. // userID : The ID of a User.
  608. // channelID : The ID of a channel to move user to, or null?
  609. // NOTE : I am not entirely set on the name of this function and it may change
  610. // prior to the final 1.0.0 release of Discordgo
  611. func (s *Session) GuildMemberMove(guildID, userID, channelID string) (err error) {
  612. data := struct {
  613. ChannelID string `json:"channel_id"`
  614. }{channelID}
  615. _, err = s.RequestWithBucketID("PATCH", EndpointGuildMember(guildID, userID), data, EndpointGuildMember(guildID, ""))
  616. if err != nil {
  617. return
  618. }
  619. return
  620. }
  621. // GuildMemberNickname updates the nickname of a guild member
  622. // guildID : The ID of a guild
  623. // userID : The ID of a user
  624. // userID : The ID of a user or "@me" which is a shortcut of the current user ID
  625. func (s *Session) GuildMemberNickname(guildID, userID, nickname string) (err error) {
  626. data := struct {
  627. Nick string `json:"nick"`
  628. }{nickname}
  629. if userID == "@me" {
  630. userID += "/nick"
  631. }
  632. _, err = s.RequestWithBucketID("PATCH", EndpointGuildMember(guildID, userID), data, EndpointGuildMember(guildID, ""))
  633. return
  634. }
  635. // GuildMemberRoleAdd adds the specified role to a given member
  636. // guildID : The ID of a Guild.
  637. // userID : The ID of a User.
  638. // roleID : The ID of a Role to be assigned to the user.
  639. func (s *Session) GuildMemberRoleAdd(guildID, userID, roleID string) (err error) {
  640. _, err = s.RequestWithBucketID("PUT", EndpointGuildMemberRole(guildID, userID, roleID), nil, EndpointGuildMemberRole(guildID, "", ""))
  641. return
  642. }
  643. // GuildMemberRoleRemove removes the specified role to a given member
  644. // guildID : The ID of a Guild.
  645. // userID : The ID of a User.
  646. // roleID : The ID of a Role to be removed from the user.
  647. func (s *Session) GuildMemberRoleRemove(guildID, userID, roleID string) (err error) {
  648. _, err = s.RequestWithBucketID("DELETE", EndpointGuildMemberRole(guildID, userID, roleID), nil, EndpointGuildMemberRole(guildID, "", ""))
  649. return
  650. }
  651. // GuildChannels returns an array of Channel structures for all channels of a
  652. // given guild.
  653. // guildID : The ID of a Guild.
  654. func (s *Session) GuildChannels(guildID string) (st []*Channel, err error) {
  655. body, err := s.request("GET", EndpointGuildChannels(guildID), "", nil, EndpointGuildChannels(guildID), 0)
  656. if err != nil {
  657. return
  658. }
  659. err = unmarshal(body, &st)
  660. return
  661. }
  662. // GuildChannelCreate creates a new channel in the given guild
  663. // guildID : The ID of a Guild.
  664. // name : Name of the channel (2-100 chars length)
  665. // ctype : Tpye of the channel (voice or text)
  666. func (s *Session) GuildChannelCreate(guildID, name, ctype string) (st *Channel, err error) {
  667. data := struct {
  668. Name string `json:"name"`
  669. Type string `json:"type"`
  670. }{name, ctype}
  671. body, err := s.RequestWithBucketID("POST", EndpointGuildChannels(guildID), data, EndpointGuildChannels(guildID))
  672. if err != nil {
  673. return
  674. }
  675. err = unmarshal(body, &st)
  676. return
  677. }
  678. // GuildChannelsReorder updates the order of channels in a guild
  679. // guildID : The ID of a Guild.
  680. // channels : Updated channels.
  681. func (s *Session) GuildChannelsReorder(guildID string, channels []*Channel) (err error) {
  682. _, err = s.RequestWithBucketID("PATCH", EndpointGuildChannels(guildID), channels, EndpointGuildChannels(guildID))
  683. return
  684. }
  685. // GuildInvites returns an array of Invite structures for the given guild
  686. // guildID : The ID of a Guild.
  687. func (s *Session) GuildInvites(guildID string) (st []*Invite, err error) {
  688. body, err := s.RequestWithBucketID("GET", EndpointGuildInvites(guildID), nil, EndpointGuildInivtes(guildID))
  689. if err != nil {
  690. return
  691. }
  692. err = unmarshal(body, &st)
  693. return
  694. }
  695. // GuildRoles returns all roles for a given guild.
  696. // guildID : The ID of a Guild.
  697. func (s *Session) GuildRoles(guildID string) (st []*Role, err error) {
  698. body, err := s.RequestWithBucketID("GET", EndpointGuildRoles(guildID), nil, EndpointGuildRoles(guildID))
  699. if err != nil {
  700. return
  701. }
  702. err = unmarshal(body, &st)
  703. return // TODO return pointer
  704. }
  705. // GuildRoleCreate returns a new Guild Role.
  706. // guildID: The ID of a Guild.
  707. func (s *Session) GuildRoleCreate(guildID string) (st *Role, err error) {
  708. body, err := s.RequestWithBucketID("POST", EndpointGuildRoles(guildID), nil, EndpointGuildRoles(guildID))
  709. if err != nil {
  710. return
  711. }
  712. err = unmarshal(body, &st)
  713. return
  714. }
  715. // GuildRoleEdit updates an existing Guild Role with new values
  716. // guildID : The ID of a Guild.
  717. // roleID : The ID of a Role.
  718. // name : The name of the Role.
  719. // color : The color of the role (decimal, not hex).
  720. // hoist : Whether to display the role's users separately.
  721. // perm : The permissions for the role.
  722. // mention : Whether this role is mentionable
  723. func (s *Session) GuildRoleEdit(guildID, roleID, name string, color int, hoist bool, perm int, mention bool) (st *Role, err error) {
  724. // Prevent sending a color int that is too big.
  725. if color > 0xFFFFFF {
  726. err = fmt.Errorf("color value cannot be larger than 0xFFFFFF")
  727. }
  728. data := struct {
  729. Name string `json:"name"` // The role's name (overwrites existing)
  730. Color int `json:"color"` // The color the role should have (as a decimal, not hex)
  731. Hoist bool `json:"hoist"` // Whether to display the role's users separately
  732. Permissions int `json:"permissions"` // The overall permissions number of the role (overwrites existing)
  733. Mentionable bool `json:"mentionable"` // Whether this role is mentionable
  734. }{name, color, hoist, perm, mention}
  735. body, err := s.RequestWithBucketID("PATCH", EndpointGuildRole(guildID, roleID), data, EndpointGuildRole(guildID, ""))
  736. if err != nil {
  737. return
  738. }
  739. err = unmarshal(body, &st)
  740. return
  741. }
  742. // GuildRoleReorder reoders guild roles
  743. // guildID : The ID of a Guild.
  744. // roles : A list of ordered roles.
  745. func (s *Session) GuildRoleReorder(guildID string, roles []*Role) (st []*Role, err error) {
  746. body, err := s.RequestWithBucketID("PATCH", EndpointGuildRoles(guildID), roles, EndpointGuildRoles(guildID))
  747. if err != nil {
  748. return
  749. }
  750. err = unmarshal(body, &st)
  751. return
  752. }
  753. // GuildRoleDelete deletes an existing role.
  754. // guildID : The ID of a Guild.
  755. // roleID : The ID of a Role.
  756. func (s *Session) GuildRoleDelete(guildID, roleID string) (err error) {
  757. _, err = s.RequestWithBucketID("DELETE", EndpointGuildRole(guildID, roleID), nil, EndpointGuildRole(guildID, ""))
  758. return
  759. }
  760. // GuildPruneCount Returns the number of members that would be removed in a prune operation.
  761. // Requires 'KICK_MEMBER' permission.
  762. // guildID : The ID of a Guild.
  763. // days : The number of days to count prune for (1 or more).
  764. func (s *Session) GuildPruneCount(guildID string, days uint32) (count uint32, err error) {
  765. count = 0
  766. if days <= 0 {
  767. err = errors.New("the number of days should be more than or equal to 1")
  768. return
  769. }
  770. p := struct {
  771. Pruned uint32 `json:"pruned"`
  772. }{}
  773. uri := EndpointGuildPrune(guildID) + fmt.Sprintf("?days=%d", days)
  774. body, err := s.RequestWithBucketID("GET", uri, nil, EndpointGuildPrune(guildID))
  775. err = unmarshal(body, &p)
  776. if err != nil {
  777. return
  778. }
  779. count = p.Pruned
  780. return
  781. }
  782. // GuildPrune Begin as prune operation. Requires the 'KICK_MEMBERS' permission.
  783. // Returns an object with one 'pruned' key indicating the number of members that were removed in the prune operation.
  784. // guildID : The ID of a Guild.
  785. // days : The number of days to count prune for (1 or more).
  786. func (s *Session) GuildPrune(guildID string, days uint32) (count uint32, err error) {
  787. count = 0
  788. if days <= 0 {
  789. err = errors.New("the number of days should be more than or equal to 1")
  790. return
  791. }
  792. data := struct {
  793. days uint32
  794. }{days}
  795. p := struct {
  796. Pruned uint32 `json:"pruned"`
  797. }{}
  798. body, err := s.RequestWithBucketID("POST", EndpointGuildPrune(guildID), data, EndpointGuildPrune(guildID))
  799. if err != nil {
  800. return
  801. }
  802. err = unmarshal(body, &p)
  803. if err != nil {
  804. return
  805. }
  806. count = p.Pruned
  807. return
  808. }
  809. // GuildIntegrations returns an array of Integrations for a guild.
  810. // guildID : The ID of a Guild.
  811. func (s *Session) GuildIntegrations(guildID string) (st []*GuildIntegration, err error) {
  812. body, err := s.RequestWithBucketID("GET", EndpointGuildIntegrations(guildID), nil, EndpointGuildIntegrations(guildID))
  813. if err != nil {
  814. return
  815. }
  816. err = unmarshal(body, &st)
  817. return
  818. }
  819. // GuildIntegrationCreate creates a Guild Integration.
  820. // guildID : The ID of a Guild.
  821. // integrationType : The Integration type.
  822. // integrationID : The ID of an integration.
  823. func (s *Session) GuildIntegrationCreate(guildID, integrationType, integrationID string) (err error) {
  824. data := struct {
  825. Type string `json:"type"`
  826. ID string `json:"id"`
  827. }{integrationType, integrationID}
  828. _, err = s.RequestWithBucketID("POST", EndpointGuildIntegrations(guildID), data, EndpointGuildIntegrations(guildID))
  829. return
  830. }
  831. // GuildIntegrationEdit edits a Guild Integration.
  832. // guildID : The ID of a Guild.
  833. // integrationType : The Integration type.
  834. // integrationID : The ID of an integration.
  835. // expireBehavior : The behavior when an integration subscription lapses (see the integration object documentation).
  836. // expireGracePeriod : Period (in seconds) where the integration will ignore lapsed subscriptions.
  837. // enableEmoticons : Whether emoticons should be synced for this integration (twitch only currently).
  838. func (s *Session) GuildIntegrationEdit(guildID, integrationID string, expireBehavior, expireGracePeriod int, enableEmoticons bool) (err error) {
  839. data := struct {
  840. ExpireBehavior int `json:"expire_behavior"`
  841. ExpireGracePeriod int `json:"expire_grace_period"`
  842. EnableEmoticons bool `json:"enable_emoticons"`
  843. }{expireBehavior, expireGracePeriod, enableEmoticons}
  844. _, err = s.RequestWithBucketID("PATCH", EndpointGuildIntegration(guildID, integrationID), data, EndpointGuildIntegration(guildID, ""))
  845. return
  846. }
  847. // GuildIntegrationDelete removes the given integration from the Guild.
  848. // guildID : The ID of a Guild.
  849. // integrationID : The ID of an integration.
  850. func (s *Session) GuildIntegrationDelete(guildID, integrationID string) (err error) {
  851. _, err = s.RequestWithBucketID("DELETE", EndpointGuildIntegration(guildID, integrationID), nil, EndpointGuildIntegration(guildID, ""))
  852. return
  853. }
  854. // GuildIntegrationSync syncs an integration.
  855. // guildID : The ID of a Guild.
  856. // integrationID : The ID of an integration.
  857. func (s *Session) GuildIntegrationSync(guildID, integrationID string) (err error) {
  858. _, err = s.RequestWithBucketID("POST", EndpointGuildIntegrationSync(guildID, integrationID), nil, EndpointGuildIntegration(guildID, ""))
  859. return
  860. }
  861. // GuildIcon returns an image.Image of a guild icon.
  862. // guildID : The ID of a Guild.
  863. func (s *Session) GuildIcon(guildID string) (img image.Image, err error) {
  864. g, err := s.Guild(guildID)
  865. if err != nil {
  866. return
  867. }
  868. if g.Icon == "" {
  869. err = errors.New("guild does not have an icon set")
  870. return
  871. }
  872. body, err := s.RequestWithBucketID("GET", EndpointGuildIcon(guildID, g.Icon), nil, EndpointGuildIcon(guildID, ""))
  873. if err != nil {
  874. return
  875. }
  876. img, _, err = image.Decode(bytes.NewReader(body))
  877. return
  878. }
  879. // GuildSplash returns an image.Image of a guild splash image.
  880. // guildID : The ID of a Guild.
  881. func (s *Session) GuildSplash(guildID string) (img image.Image, err error) {
  882. g, err := s.Guild(guildID)
  883. if err != nil {
  884. return
  885. }
  886. if g.Splash == "" {
  887. err = errors.New("guild does not have a splash set")
  888. return
  889. }
  890. body, err := s.RequestWithBucketID("GET", EndpointGuildSplash(guildID, g.Splash), nil, EndpointGuildSplash(guildID, ""))
  891. if err != nil {
  892. return
  893. }
  894. img, _, err = image.Decode(bytes.NewReader(body))
  895. return
  896. }
  897. // GuildEmbed returns the embed for a Guild.
  898. // guildID : The ID of a Guild.
  899. func (s *Session) GuildEmbed(guildID string) (st *GuildEmbed, err error) {
  900. body, err := s.RequestWithBucketID("GET", EndpointGuildEmbed(guildID), nil, EndpointGuildEmbed(guildID))
  901. if err != nil {
  902. return
  903. }
  904. err = unmarshal(body, &st)
  905. return
  906. }
  907. // GuildEmbedEdit returns the embed for a Guild.
  908. // guildID : The ID of a Guild.
  909. func (s *Session) GuildEmbedEdit(guildID string, enabled bool, channelID string) (err error) {
  910. data := GuildEmbed{enabled, channelID}
  911. _, err = s.RequestWithBucketID("PATCH", EndpointGuildEmbed(guildID), data, EndpointGuildEmbed(guildID))
  912. return
  913. }
  914. // ------------------------------------------------------------------------------------------------
  915. // Functions specific to Discord Channels
  916. // ------------------------------------------------------------------------------------------------
  917. // Channel returns a Channel strucutre of a specific Channel.
  918. // channelID : The ID of the Channel you want returned.
  919. func (s *Session) Channel(channelID string) (st *Channel, err error) {
  920. body, err := s.RequestWithBucketID("GET", EndpointChannel(channelID), nil, EndpointChannel(channelID))
  921. if err != nil {
  922. return
  923. }
  924. err = unmarshal(body, &st)
  925. return
  926. }
  927. // ChannelEdit edits the given channel
  928. // channelID : The ID of a Channel
  929. // name : The new name to assign the channel.
  930. func (s *Session) ChannelEdit(channelID, name string) (st *Channel, err error) {
  931. data := struct {
  932. Name string `json:"name"`
  933. }{name}
  934. body, err := s.RequestWithBucketID("PATCH", EndpointChannel(channelID), data, EndpointChannel(channelID))
  935. if err != nil {
  936. return
  937. }
  938. err = unmarshal(body, &st)
  939. return
  940. }
  941. // ChannelDelete deletes the given channel
  942. // channelID : The ID of a Channel
  943. func (s *Session) ChannelDelete(channelID string) (st *Channel, err error) {
  944. body, err := s.RequestWithBucketID("DELETE", EndpointChannel(channelID), nil, EndpointChannel(channelID))
  945. if err != nil {
  946. return
  947. }
  948. err = unmarshal(body, &st)
  949. return
  950. }
  951. // ChannelTyping broadcasts to all members that authenticated user is typing in
  952. // the given channel.
  953. // channelID : The ID of a Channel
  954. func (s *Session) ChannelTyping(channelID string) (err error) {
  955. _, err = s.RequestWithBucketID("POST", EndpointChannelTyping(channelID), nil, EndpointChannelTyping(channelID))
  956. return
  957. }
  958. // ChannelMessages returns an array of Message structures for messages within
  959. // a given channel.
  960. // channelID : The ID of a Channel.
  961. // limit : The number messages that can be returned. (max 100)
  962. // beforeID : If provided all messages returned will be before given ID.
  963. // afterID : If provided all messages returned will be after given ID.
  964. // aroundID : If provided all messages returned will be around given ID.
  965. func (s *Session) ChannelMessages(channelID string, limit int, beforeID, afterID, aroundID string) (st []*Message, err error) {
  966. uri := EndpointChannelMessages(channelID)
  967. v := url.Values{}
  968. if limit > 0 {
  969. v.Set("limit", strconv.Itoa(limit))
  970. }
  971. if afterID != "" {
  972. v.Set("after", afterID)
  973. }
  974. if beforeID != "" {
  975. v.Set("before", beforeID)
  976. }
  977. if aroundID != "" {
  978. v.Set("around", aroundID)
  979. }
  980. if len(v) > 0 {
  981. uri = fmt.Sprintf("%s?%s", uri, v.Encode())
  982. }
  983. body, err := s.RequestWithBucketID("GET", uri, nil, EndpointChannelMessages(channelID))
  984. if err != nil {
  985. return
  986. }
  987. err = unmarshal(body, &st)
  988. return
  989. }
  990. // ChannelMessage gets a single message by ID from a given channel.
  991. // channeld : The ID of a Channel
  992. // messageID : the ID of a Message
  993. func (s *Session) ChannelMessage(channelID, messageID string) (st *Message, err error) {
  994. response, err := s.RequestWithBucketID("GET", EndpointChannelMessage(channelID, messageID), nil, EndpointChannelMessage(channelID, ""))
  995. if err != nil {
  996. return
  997. }
  998. err = unmarshal(response, &st)
  999. return
  1000. }
  1001. // ChannelMessageAck acknowledges and marks the given message as read
  1002. // channeld : The ID of a Channel
  1003. // messageID : the ID of a Message
  1004. // lastToken : token returned by last ack
  1005. func (s *Session) ChannelMessageAck(channelID, messageID, lastToken string) (st *Ack, err error) {
  1006. body, err := s.RequestWithBucketID("POST", EndpointChannelMessageAck(channelID, messageID), &Ack{Token: lastToken}, EndpointChannelMessageAck(channelID, ""))
  1007. if err != nil {
  1008. return
  1009. }
  1010. err = unmarshal(body, &st)
  1011. return
  1012. }
  1013. // channelMessageSend sends a message to the given channel.
  1014. // channelID : The ID of a Channel.
  1015. // content : The message to send.
  1016. // tts : Whether to send the message with TTS.
  1017. func (s *Session) channelMessageSend(channelID, content string, tts bool) (st *Message, err error) {
  1018. // TODO: nonce string ?
  1019. data := struct {
  1020. Content string `json:"content"`
  1021. TTS bool `json:"tts"`
  1022. }{content, tts}
  1023. // Send the message to the given channel
  1024. response, err := s.RequestWithBucketID("POST", EndpointChannelMessages(channelID), data, EndpointChannelMessages(channelID))
  1025. if err != nil {
  1026. return
  1027. }
  1028. err = unmarshal(response, &st)
  1029. return
  1030. }
  1031. // ChannelMessageSend sends a message to the given channel.
  1032. // channelID : The ID of a Channel.
  1033. // content : The message to send.
  1034. func (s *Session) ChannelMessageSend(channelID string, content string) (st *Message, err error) {
  1035. return s.channelMessageSend(channelID, content, false)
  1036. }
  1037. // ChannelMessageSendTTS sends a message to the given channel with Text to Speech.
  1038. // channelID : The ID of a Channel.
  1039. // content : The message to send.
  1040. func (s *Session) ChannelMessageSendTTS(channelID string, content string) (st *Message, err error) {
  1041. return s.channelMessageSend(channelID, content, true)
  1042. }
  1043. // ChannelMessageSendEmbed sends a message to the given channel with embedded data (bot only).
  1044. // channelID : The ID of a Channel.
  1045. // embed : The embed data to send.
  1046. func (s *Session) ChannelMessageSendEmbed(channelID string, embed *MessageEmbed) (st *Message, err error) {
  1047. return s.ChannelMessageSendEmbedWithMessage(channelID, "", embed)
  1048. }
  1049. // ChannelMessageSendEmbedWithMessage sends a message to the given channel with embedded data (bot only) and a message.
  1050. // channelID : The ID of a Channel.
  1051. // content : The message to send.
  1052. // embed : The embed data to send.
  1053. func (s *Session) ChannelMessageSendEmbedWithMessage(channelID string, content string, embed *MessageEmbed) (st *Message, err error) {
  1054. if embed != nil && embed.Type == "" {
  1055. embed.Type = "rich"
  1056. }
  1057. data := struct {
  1058. Embed *MessageEmbed `json:"embed"`
  1059. Content string `json:"content"`
  1060. }{embed, content}
  1061. // Send the message to the given channel
  1062. response, err := s.RequestWithBucketID("POST", EndpointChannelMessages(channelID), data, EndpointChannelMessages(channelID))
  1063. if err != nil {
  1064. return
  1065. }
  1066. err = unmarshal(response, &st)
  1067. return
  1068. }
  1069. // ChannelMessageEdit edits an existing message, replacing it entirely with
  1070. // the given content.
  1071. // channeld : The ID of a Channel
  1072. // messageID : the ID of a Message
  1073. func (s *Session) ChannelMessageEdit(channelID, messageID, content string) (st *Message, err error) {
  1074. data := struct {
  1075. Content string `json:"content"`
  1076. }{content}
  1077. response, err := s.RequestWithBucketID("PATCH", EndpointChannelMessage(channelID, messageID), data, EndpointChannelMessage(channelID, ""))
  1078. if err != nil {
  1079. return
  1080. }
  1081. err = unmarshal(response, &st)
  1082. return
  1083. }
  1084. // ChannelMessageEditEmbed edits an existing message with embedded data (bot only).
  1085. // channelID : The ID of a Channel
  1086. // messageID : The ID of a Message
  1087. // embed : The embed data to send
  1088. func (s *Session) ChannelMessageEditEmbed(channelID, messageID string, embed *MessageEmbed) (st *Message, err error) {
  1089. if embed != nil && embed.Type == "" {
  1090. embed.Type = "rich"
  1091. }
  1092. data := struct {
  1093. Embed *MessageEmbed `json:"embed"`
  1094. }{embed}
  1095. response, err := s.RequestWithBucketID("PATCH", EndpointChannelMessage(channelID, messageID), data, EndpointChannelMessage(channelID, ""))
  1096. if err != nil {
  1097. return
  1098. }
  1099. err = unmarshal(response, &st)
  1100. return
  1101. }
  1102. // ChannelMessageDelete deletes a message from the Channel.
  1103. func (s *Session) ChannelMessageDelete(channelID, messageID string) (err error) {
  1104. _, err = s.RequestWithBucketID("DELETE", EndpointChannelMessage(channelID, messageID), nil, EndpointChannelMessage(channelID, ""))
  1105. return
  1106. }
  1107. // ChannelMessagesBulkDelete bulk deletes the messages from the channel for the provided messageIDs.
  1108. // If only one messageID is in the slice call channelMessageDelete funciton.
  1109. // If the slice is empty do nothing.
  1110. // channelID : The ID of the channel for the messages to delete.
  1111. // messages : The IDs of the messages to be deleted. A slice of string IDs. A maximum of 100 messages.
  1112. func (s *Session) ChannelMessagesBulkDelete(channelID string, messages []string) (err error) {
  1113. if len(messages) == 0 {
  1114. return
  1115. }
  1116. if len(messages) == 1 {
  1117. err = s.ChannelMessageDelete(channelID, messages[0])
  1118. return
  1119. }
  1120. if len(messages) > 100 {
  1121. messages = messages[:100]
  1122. }
  1123. data := struct {
  1124. Messages []string `json:"messages"`
  1125. }{messages}
  1126. _, err = s.RequestWithBucketID("POST", EndpointChannelMessagesBulkDelete(channelID), data, EndpointChannelMessagesBulkDelete(channelID))
  1127. return
  1128. }
  1129. // ChannelMessagePin pins a message within a given channel.
  1130. // channelID: The ID of a channel.
  1131. // messageID: The ID of a message.
  1132. func (s *Session) ChannelMessagePin(channelID, messageID string) (err error) {
  1133. _, err = s.RequestWithBucketID("PUT", EndpointChannelMessagePin(channelID, messageID), nil, EndpointChannelMessagePin(channelID, ""))
  1134. return
  1135. }
  1136. // ChannelMessageUnpin unpins a message within a given channel.
  1137. // channelID: The ID of a channel.
  1138. // messageID: The ID of a message.
  1139. func (s *Session) ChannelMessageUnpin(channelID, messageID string) (err error) {
  1140. _, err = s.RequestWithBucketID("DELETE", EndpointChannelMessagePin(channelID, messageID), nil, EndpointChannelMessagePin(channelID, ""))
  1141. return
  1142. }
  1143. // ChannelMessagesPinned returns an array of Message structures for pinned messages
  1144. // within a given channel
  1145. // channelID : The ID of a Channel.
  1146. func (s *Session) ChannelMessagesPinned(channelID string) (st []*Message, err error) {
  1147. body, err := s.RequestWithBucketID("GET", EndpointChannelMessagesPins(channelID), nil, EndpointChannelMessagesPins(channelID))
  1148. if err != nil {
  1149. return
  1150. }
  1151. err = unmarshal(body, &st)
  1152. return
  1153. }
  1154. // ChannelFileSend sends a file to the given channel.
  1155. // channelID : The ID of a Channel.
  1156. // name: The name of the file.
  1157. // io.Reader : A reader for the file contents.
  1158. func (s *Session) ChannelFileSend(channelID, name string, r io.Reader) (st *Message, err error) {
  1159. return s.ChannelFileSendWithMessage(channelID, "", name, r)
  1160. }
  1161. // ChannelFileSendWithMessage sends a file to the given channel with an message.
  1162. // channelID : The ID of a Channel.
  1163. // content: Optional Message content.
  1164. // name: The name of the file.
  1165. // io.Reader : A reader for the file contents.
  1166. func (s *Session) ChannelFileSendWithMessage(channelID, content string, name string, r io.Reader) (st *Message, err error) {
  1167. body := &bytes.Buffer{}
  1168. bodywriter := multipart.NewWriter(body)
  1169. if len(content) != 0 {
  1170. if err := bodywriter.WriteField("content", content); err != nil {
  1171. return nil, err
  1172. }
  1173. }
  1174. writer, err := bodywriter.CreateFormFile("file", name)
  1175. if err != nil {
  1176. return nil, err
  1177. }
  1178. _, err = io.Copy(writer, r)
  1179. if err != nil {
  1180. return
  1181. }
  1182. err = bodywriter.Close()
  1183. if err != nil {
  1184. return
  1185. }
  1186. response, err := s.request("POST", EndpointChannelMessages(channelID), bodywriter.FormDataContentType(), body.Bytes(), EndpointChannelMessages(channelID), 0)
  1187. if err != nil {
  1188. return
  1189. }
  1190. err = unmarshal(response, &st)
  1191. return
  1192. }
  1193. // ChannelInvites returns an array of Invite structures for the given channel
  1194. // channelID : The ID of a Channel
  1195. func (s *Session) ChannelInvites(channelID string) (st []*Invite, err error) {
  1196. body, err := s.RequestWithBucketID("GET", EndpointChannelInvites(channelID), nil, EndpointChannelInvites(channelID))
  1197. if err != nil {
  1198. return
  1199. }
  1200. err = unmarshal(body, &st)
  1201. return
  1202. }
  1203. // ChannelInviteCreate creates a new invite for the given channel.
  1204. // channelID : The ID of a Channel
  1205. // i : An Invite struct with the values MaxAge, MaxUses, Temporary,
  1206. // and XkcdPass defined.
  1207. func (s *Session) ChannelInviteCreate(channelID string, i Invite) (st *Invite, err error) {
  1208. data := struct {
  1209. MaxAge int `json:"max_age"`
  1210. MaxUses int `json:"max_uses"`
  1211. Temporary bool `json:"temporary"`
  1212. XKCDPass string `json:"xkcdpass"`
  1213. }{i.MaxAge, i.MaxUses, i.Temporary, i.XkcdPass}
  1214. body, err := s.RequestWithBucketID("POST", EndpointChannelInvites(channelID), data, EndpointChannelInvites(channelID))
  1215. if err != nil {
  1216. return
  1217. }
  1218. err = unmarshal(body, &st)
  1219. return
  1220. }
  1221. // ChannelPermissionSet creates a Permission Override for the given channel.
  1222. // NOTE: This func name may changed. Using Set instead of Create because
  1223. // you can both create a new override or update an override with this function.
  1224. func (s *Session) ChannelPermissionSet(channelID, targetID, targetType string, allow, deny int) (err error) {
  1225. data := struct {
  1226. ID string `json:"id"`
  1227. Type string `json:"type"`
  1228. Allow int `json:"allow"`
  1229. Deny int `json:"deny"`
  1230. }{targetID, targetType, allow, deny}
  1231. _, err = s.RequestWithBucketID("PUT", EndpointChannelPermission(channelID, targetID), data, EndpointChannelPermission(channelID, ""))
  1232. return
  1233. }
  1234. // ChannelPermissionDelete deletes a specific permission override for the given channel.
  1235. // NOTE: Name of this func may change.
  1236. func (s *Session) ChannelPermissionDelete(channelID, targetID string) (err error) {
  1237. _, err = s.RequestWithBucketID("DELETE", EndpointChannelPermission(channelID, targetID), nil, EndpointChannelPermission(channelID, ""))
  1238. return
  1239. }
  1240. // ------------------------------------------------------------------------------------------------
  1241. // Functions specific to Discord Invites
  1242. // ------------------------------------------------------------------------------------------------
  1243. // Invite returns an Invite structure of the given invite
  1244. // inviteID : The invite code (or maybe xkcdpass?)
  1245. func (s *Session) Invite(inviteID string) (st *Invite, err error) {
  1246. body, err := s.RequestWithBucketID("GET", EndpointInvite(inviteID), nil, EndpointInvite(""))
  1247. if err != nil {
  1248. return
  1249. }
  1250. err = unmarshal(body, &st)
  1251. return
  1252. }
  1253. // InviteDelete deletes an existing invite
  1254. // inviteID : the code (or maybe xkcdpass?) of an invite
  1255. func (s *Session) InviteDelete(inviteID string) (st *Invite, err error) {
  1256. body, err := s.RequestWithBucketID("DELETE", EndpointInvite(inviteID), nil, EndpointInvite(""))
  1257. if err != nil {
  1258. return
  1259. }
  1260. err = unmarshal(body, &st)
  1261. return
  1262. }
  1263. // InviteAccept accepts an Invite to a Guild or Channel
  1264. // inviteID : The invite code (or maybe xkcdpass?)
  1265. func (s *Session) InviteAccept(inviteID string) (st *Invite, err error) {
  1266. body, err := s.RequestWithBucketID("POST", EndpointInvite(inviteID), nil, EndpointInvite(""))
  1267. if err != nil {
  1268. return
  1269. }
  1270. err = unmarshal(body, &st)
  1271. return
  1272. }
  1273. // ------------------------------------------------------------------------------------------------
  1274. // Functions specific to Discord Voice
  1275. // ------------------------------------------------------------------------------------------------
  1276. // VoiceRegions returns the voice server regions
  1277. func (s *Session) VoiceRegions() (st []*VoiceRegion, err error) {
  1278. body, err := s.RequestWithBucketID("GET", EndpointVoiceRegions, nil, EndpointVoiceRegions)
  1279. if err != nil {
  1280. return
  1281. }
  1282. err = unmarshal(body, &st)
  1283. return
  1284. }
  1285. // VoiceICE returns the voice server ICE information
  1286. func (s *Session) VoiceICE() (st *VoiceICE, err error) {
  1287. body, err := s.RequestWithBucketID("GET", EndpointVoiceIce, nil, EndpointVoiceIce)
  1288. if err != nil {
  1289. return
  1290. }
  1291. err = unmarshal(body, &st)
  1292. return
  1293. }
  1294. // ------------------------------------------------------------------------------------------------
  1295. // Functions specific to Discord Websockets
  1296. // ------------------------------------------------------------------------------------------------
  1297. // Gateway returns the a websocket Gateway address
  1298. func (s *Session) Gateway() (gateway string, err error) {
  1299. response, err := s.RequestWithBucketID("GET", EndpointGateway, nil, EndpointGateway)
  1300. if err != nil {
  1301. return
  1302. }
  1303. temp := struct {
  1304. URL string `json:"url"`
  1305. }{}
  1306. err = unmarshal(response, &temp)
  1307. if err != nil {
  1308. return
  1309. }
  1310. gateway = temp.URL
  1311. // Ensure the gateway always has a trailing slash.
  1312. // MacOS will fail to connect if we add query params without a trailing slash on the base domain.
  1313. if !strings.HasSuffix(gateway, "/") {
  1314. gateway += "/"
  1315. }
  1316. return
  1317. }
  1318. // Functions specific to Webhooks
  1319. // WebhookCreate returns a new Webhook.
  1320. // channelID: The ID of a Channel.
  1321. // name : The name of the webhook.
  1322. // avatar : The avatar of the webhook.
  1323. func (s *Session) WebhookCreate(channelID, name, avatar string) (st *Webhook, err error) {
  1324. data := struct {
  1325. Name string `json:"name"`
  1326. Avatar string `json:"avatar,omitempty"`
  1327. }{name, avatar}
  1328. body, err := s.RequestWithBucketID("POST", EndpointChannelWebhooks(channelID), data, EndpointChannelWebhooks(channelID))
  1329. if err != nil {
  1330. return
  1331. }
  1332. err = unmarshal(body, &st)
  1333. return
  1334. }
  1335. // ChannelWebhooks returns all webhooks for a given channel.
  1336. // channelID: The ID of a channel.
  1337. func (s *Session) ChannelWebhooks(channelID string) (st []*Webhook, err error) {
  1338. body, err := s.RequestWithBucketID("GET", EndpointChannelWebhooks(channelID), nil, EndpointChannelWebhooks(channelID))
  1339. if err != nil {
  1340. return
  1341. }
  1342. err = unmarshal(body, &st)
  1343. return
  1344. }
  1345. // GuildWebhooks returns all webhooks for a given guild.
  1346. // guildID: The ID of a Guild.
  1347. func (s *Session) GuildWebhooks(guildID string) (st []*Webhook, err error) {
  1348. body, err := s.RequestWithBucketID("GET", EndpointGuildWebhooks(guildID), nil, EndpointGuildWebhooks(guildID))
  1349. if err != nil {
  1350. return
  1351. }
  1352. err = unmarshal(body, &st)
  1353. return
  1354. }
  1355. // Webhook returns a webhook for a given ID
  1356. // webhookID: The ID of a webhook.
  1357. func (s *Session) Webhook(webhookID string) (st *Webhook, err error) {
  1358. body, err := s.RequestWithBucketID("GET", EndpointWebhook(webhookID), nil, EndpointWebhooks)
  1359. if err != nil {
  1360. return
  1361. }
  1362. err = unmarshal(body, &st)
  1363. return
  1364. }
  1365. // WebhookWithToken returns a webhook for a given ID
  1366. // webhookID: The ID of a webhook.
  1367. // token : The auth token for the webhook.
  1368. func (s *Session) WebhookWithToken(webhookID, token string) (st *Webhook, err error) {
  1369. body, err := s.RequestWithBucketID("GET", EndpointWebhookToken(webhookID, token), nil, EndpointWebhookToken("", ""))
  1370. if err != nil {
  1371. return
  1372. }
  1373. err = unmarshal(body, &st)
  1374. return
  1375. }
  1376. // WebhookEdit updates an existing Webhook.
  1377. // webhookID: The ID of a webhook.
  1378. // name : The name of the webhook.
  1379. // avatar : The avatar of the webhook.
  1380. func (s *Session) WebhookEdit(webhookID, name, avatar string) (st *Role, err error) {
  1381. data := struct {
  1382. Name string `json:"name,omitempty"`
  1383. Avatar string `json:"avatar,omitempty"`
  1384. }{name, avatar}
  1385. body, err := s.RequestWithBucketID("PATCH", EndpointWebhook(webhookID), data, EndpointWebhooks)
  1386. if err != nil {
  1387. return
  1388. }
  1389. err = unmarshal(body, &st)
  1390. return
  1391. }
  1392. // WebhookEditWithToken updates an existing Webhook with an auth token.
  1393. // webhookID: The ID of a webhook.
  1394. // token : The auth token for the webhook.
  1395. // name : The name of the webhook.
  1396. // avatar : The avatar of the webhook.
  1397. func (s *Session) WebhookEditWithToken(webhookID, token, name, avatar string) (st *Role, err error) {
  1398. data := struct {
  1399. Name string `json:"name,omitempty"`
  1400. Avatar string `json:"avatar,omitempty"`
  1401. }{name, avatar}
  1402. body, err := s.RequestWithBucketID("PATCH", EndpointWebhookToken(webhookID, token), data, EndpointWebhookToken("", ""))
  1403. if err != nil {
  1404. return
  1405. }
  1406. err = unmarshal(body, &st)
  1407. return
  1408. }
  1409. // WebhookDelete deletes a webhook for a given ID
  1410. // webhookID: The ID of a webhook.
  1411. func (s *Session) WebhookDelete(webhookID string) (st *Webhook, err error) {
  1412. body, err := s.RequestWithBucketID("DELETE", EndpointWebhook(webhookID), nil, EndpointWebhooks)
  1413. if err != nil {
  1414. return
  1415. }
  1416. err = unmarshal(body, &st)
  1417. return
  1418. }
  1419. // WebhookDeleteWithToken deletes a webhook for a given ID with an auth token.
  1420. // webhookID: The ID of a webhook.
  1421. // token : The auth token for the webhook.
  1422. func (s *Session) WebhookDeleteWithToken(webhookID, token string) (st *Webhook, err error) {
  1423. body, err := s.RequestWithBucketID("DELETE", EndpointWebhookToken(webhookID, token), nil, EndpointWebhookToken("", ""))
  1424. if err != nil {
  1425. return
  1426. }
  1427. err = unmarshal(body, &st)
  1428. return
  1429. }
  1430. // WebhookExecute executes a webhook.
  1431. // webhookID: The ID of a webhook.
  1432. // token : The auth token for the webhook
  1433. func (s *Session) WebhookExecute(webhookID, token string, wait bool, data *WebhookParams) (err error) {
  1434. uri := EndpointWebhookToken(webhookID, token)
  1435. if wait {
  1436. uri += "?wait=true"
  1437. }
  1438. _, err = s.RequestWithBucketID("POST", uri, data, EndpointWebhookToken("", ""))
  1439. return
  1440. }
  1441. // MessageReactionAdd creates an emoji reaction to a message.
  1442. // channelID : The channel ID.
  1443. // messageID : The message ID.
  1444. // emojiID : Either the unicode emoji for the reaction, or a guild emoji identifier.
  1445. func (s *Session) MessageReactionAdd(channelID, messageID, emojiID string) error {
  1446. _, err := s.RequestWithBucketID("PUT", EndpointMessageReaction(channelID, messageID, emojiID, "@me"), nil, EndpointMessageReaction(channelID, "", "", ""))
  1447. return err
  1448. }
  1449. // MessageReactionRemove deletes an emoji reaction to a message.
  1450. // channelID : The channel ID.
  1451. // messageID : The message ID.
  1452. // emojiID : Either the unicode emoji for the reaction, or a guild emoji identifier.
  1453. // userID : @me or ID of the user to delete the reaction for.
  1454. func (s *Session) MessageReactionRemove(channelID, messageID, emojiID, userID string) error {
  1455. _, err := s.RequestWithBucketID("DELETE", EndpointMessageReaction(channelID, messageID, emojiID, userID), nil, EndpointMessageReaction(channelID, "", "", ""))
  1456. return err
  1457. }
  1458. // MessageReactions gets all the users reactions for a specific emoji.
  1459. // channelID : The channel ID.
  1460. // messageID : The message ID.
  1461. // emojiID : Either the unicode emoji for the reaction, or a guild emoji identifier.
  1462. // limit : max number of users to return (max 100)
  1463. func (s *Session) MessageReactions(channelID, messageID, emojiID string, limit int) (st []*User, err error) {
  1464. uri := EndpointMessageReactions(channelID, messageID, emojiID)
  1465. v := url.Values{}
  1466. if limit > 0 {
  1467. v.Set("limit", strconv.Itoa(limit))
  1468. }
  1469. if len(v) > 0 {
  1470. uri = fmt.Sprintf("%s?%s", uri, v.Encode())
  1471. }
  1472. body, err := s.RequestWithBucketID("GET", uri, nil, EndpointMessageReaction(channelID, "", "", ""))
  1473. if err != nil {
  1474. return
  1475. }
  1476. err = unmarshal(body, &st)
  1477. return
  1478. }
  1479. // ------------------------------------------------------------------------------------------------
  1480. // Functions specific to Discord Relationships (Friends list)
  1481. // ------------------------------------------------------------------------------------------------
  1482. // RelationshipsGet returns an array of all the relationships of the user.
  1483. func (s *Session) RelationshipsGet() (r []*Relationship, err error) {
  1484. body, err := s.RequestWithBucketID("GET", EndpointRelationships(), nil, EndpointRelationships())
  1485. if err != nil {
  1486. return
  1487. }
  1488. err = unmarshal(body, &r)
  1489. return
  1490. }
  1491. // relationshipCreate creates a new relationship. (I.e. send or accept a friend request, block a user.)
  1492. // relationshipType : 1 = friend, 2 = blocked, 3 = incoming friend req, 4 = sent friend req
  1493. func (s *Session) relationshipCreate(userID string, relationshipType int) (err error) {
  1494. data := struct {
  1495. Type int `json:"type"`
  1496. }{relationshipType}
  1497. _, err = s.RequestWithBucketID("PUT", EndpointRelationship(userID), data, EndpointRelationships())
  1498. return
  1499. }
  1500. // RelationshipFriendRequestSend sends a friend request to a user.
  1501. // userID: ID of the user.
  1502. func (s *Session) RelationshipFriendRequestSend(userID string) (err error) {
  1503. err = s.relationshipCreate(userID, 4)
  1504. return
  1505. }
  1506. // RelationshipFriendRequestAccept accepts a friend request from a user.
  1507. // userID: ID of the user.
  1508. func (s *Session) RelationshipFriendRequestAccept(userID string) (err error) {
  1509. err = s.relationshipCreate(userID, 1)
  1510. return
  1511. }
  1512. // RelationshipUserBlock blocks a user.
  1513. // userID: ID of the user.
  1514. func (s *Session) RelationshipUserBlock(userID string) (err error) {
  1515. err = s.relationshipCreate(userID, 2)
  1516. return
  1517. }
  1518. // RelationshipDelete removes the relationship with a user.
  1519. // userID: ID of the user.
  1520. func (s *Session) RelationshipDelete(userID string) (err error) {
  1521. _, err = s.RequestWithBucketID("DELETE", EndpointRelationship(userID), nil, EndpointRelationships())
  1522. return
  1523. }
  1524. // RelationshipsMutualGet returns an array of all the users both @me and the given user is friends with.
  1525. // userID: ID of the user.
  1526. func (s *Session) RelationshipsMutualGet(userID string) (mf []*User, err error) {
  1527. body, err := s.RequestWithBucketID("GET", EndpointRelationshipsMutual(userID), nil, EndpointRelationshipsMutual(userID))
  1528. if err != nil {
  1529. return
  1530. }
  1531. err = unmarshal(body, &mf)
  1532. return
  1533. }