From e4d82f33e6b03641c5d371a4e99144be74a62660 Mon Sep 17 00:00:00 2001 From: nitroflap Date: Mon, 25 Jul 2022 22:19:20 +0300 Subject: [PATCH 01/15] refactor(GuildRoleEdit)!: use struct params Refactor GuildRoleEdit to accept parameters using a Params struct. Therefore also allow partial edits. --- restapi.go | 23 +++++------------------ structs.go | 14 ++++++++++++++ 2 files changed, 19 insertions(+), 18 deletions(-) diff --git a/restapi.go b/restapi.go index 7dc8d1196..f57fe1cb1 100644 --- a/restapi.go +++ b/restapi.go @@ -1045,30 +1045,17 @@ func (s *Session) GuildRoleCreate(guildID string) (st *Role, err error) { return } -// GuildRoleEdit updates an existing Guild Role with new values +// GuildRoleEdit updates an existing Guild Role and updated Role data. // guildID : The ID of a Guild. // roleID : The ID of a Role. -// name : The name of the Role. -// color : The color of the role (decimal, not hex). -// hoist : Whether to display the role's users separately. -// perm : The permissions for the role. -// mention : Whether this role is mentionable -func (s *Session) GuildRoleEdit(guildID, roleID, name string, color int, hoist bool, perm int64, mention bool) (st *Role, err error) { +// data : Updated Role data. +func (s *Session) GuildRoleEdit(guildID, roleID string, data *RoleParams) (st *Role, err error) { // Prevent sending a color int that is too big. - if color > 0xFFFFFF { - err = fmt.Errorf("color value cannot be larger than 0xFFFFFF") - return nil, err + if data.Color != nil && *data.Color > 0xFFFFFF { + return nil, fmt.Errorf("color value cannot be larger than 0xFFFFFF") } - data := struct { - Name string `json:"name"` // The role's name (overwrites existing) - Color int `json:"color"` // The color the role should have (as a decimal, not hex) - Hoist bool `json:"hoist"` // Whether to display the role's users separately - Permissions int64 `json:"permissions,string"` // The overall permissions number of the role (overwrites existing) - Mentionable bool `json:"mentionable"` // Whether this role is mentionable - }{name, color, hoist, perm, mention} - body, err := s.RequestWithBucketID("PATCH", EndpointGuildRole(guildID, roleID), data, EndpointGuildRole(guildID, "")) if err != nil { return diff --git a/structs.go b/structs.go index f6b0b50e8..e45c3e9b6 100644 --- a/structs.go +++ b/structs.go @@ -1083,6 +1083,20 @@ func (r *Role) Mention() string { return fmt.Sprintf("<@&%s>", r.ID) } +// RoleParams represents the parameters needed to create or update a Role +type RoleParams struct { + // The role's name + Name string `json:"name,omitempty"` + // The color the role should have (as a decimal, not hex) + Color *int `json:"color,omitempty"` + // Whether to display the role's users separately + Hoist *bool `json:"hoist,omitempty"` + // The overall permissions number of the role + Permissions *int64 `json:"permissions,omitempty,string"` + // Whether this role is mentionable + Mentionable *bool `json:"mentionable,omitempty"` +} + // Roles are a collection of Role type Roles []*Role From eb02a61123b9cf3c1c40720006229608933c8866 Mon Sep 17 00:00:00 2001 From: nitroflap Date: Mon, 25 Jul 2022 22:34:04 +0300 Subject: [PATCH 02/15] feat(GuildRoleCreate): initial parameters Make GuildRoleCreate accept a struct with initial parameters for a role --- restapi.go | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/restapi.go b/restapi.go index f57fe1cb1..7c29688d0 100644 --- a/restapi.go +++ b/restapi.go @@ -1031,11 +1031,11 @@ func (s *Session) GuildRoles(guildID string) (st []*Role, err error) { return // TODO return pointer } -// GuildRoleCreate returns a new Guild Role. -// guildID: The ID of a Guild. -func (s *Session) GuildRoleCreate(guildID string) (st *Role, err error) { - - body, err := s.RequestWithBucketID("POST", EndpointGuildRoles(guildID), nil, EndpointGuildRoles(guildID)) +// GuildRoleCreate creates a new Guild Role and returns it. +// guildID : The ID of a Guild. +// data : New role parameters. +func (s *Session) GuildRoleCreate(guildID string, data *RoleParams) (st *Role, err error) { + body, err := s.RequestWithBucketID("POST", EndpointGuildRoles(guildID), data, EndpointGuildRoles(guildID)) if err != nil { return } From 9de66a0edd469b3e586e58b494352b15029e5ebe Mon Sep 17 00:00:00 2001 From: nitroflap Date: Mon, 25 Jul 2022 22:49:11 +0300 Subject: [PATCH 03/15] refactor(ChannelEdit)!: replace ChannelEditComplex Move funcitonality of ChannelEditComplex to ChannelEdit --- restapi.go | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/restapi.go b/restapi.go index 7c29688d0..c4abdbd50 100644 --- a/restapi.go +++ b/restapi.go @@ -1519,19 +1519,10 @@ func (s *Session) Channel(channelID string) (st *Channel, err error) { return } -// ChannelEdit edits the given channel -// channelID : The ID of a Channel -// name : The new name to assign the channel. -func (s *Session) ChannelEdit(channelID, name string) (*Channel, error) { - return s.ChannelEditComplex(channelID, &ChannelEdit{ - Name: name, - }) -} - -// ChannelEditComplex edits an existing channel, replacing the parameters entirely with ChannelEdit struct -// channelID : The ID of a Channel -// data : The channel struct to send -func (s *Session) ChannelEditComplex(channelID string, data *ChannelEdit) (st *Channel, err error) { +// ChannelEdit edits the given channel and returns the updated Channel data. +// channelID : The ID of a Channel. +// data : New Channel data. +func (s *Session) ChannelEdit(channelID string, data *ChannelEdit) (st *Channel, err error) { body, err := s.RequestWithBucketID("PATCH", EndpointChannel(channelID), data, EndpointChannel(channelID)) if err != nil { return @@ -1539,6 +1530,14 @@ func (s *Session) ChannelEditComplex(channelID string, data *ChannelEdit) (st *C err = unmarshal(body, &st) return + +} + +// ChannelEditComplex edits an existing channel, replacing the parameters entirely with ChannelEdit struct +// channelID : The ID of a Channel +// data : The channel struct to send +func (s *Session) ChannelEditComplex(channelID string, data *ChannelEdit) (st *Channel, err error) { + return s.ChannelEdit(channelID, data) } // ChannelDelete deletes the given channel From bc1a3a80163c036e43274b587158cc64b7ce3dc4 Mon Sep 17 00:00:00 2001 From: nitroflap Date: Mon, 25 Jul 2022 22:50:25 +0300 Subject: [PATCH 04/15] chore: deprecate ChannelEditComplex --- restapi.go | 1 + 1 file changed, 1 insertion(+) diff --git a/restapi.go b/restapi.go index c4abdbd50..75126e876 100644 --- a/restapi.go +++ b/restapi.go @@ -1534,6 +1534,7 @@ func (s *Session) ChannelEdit(channelID string, data *ChannelEdit) (st *Channel, } // ChannelEditComplex edits an existing channel, replacing the parameters entirely with ChannelEdit struct +// NOTE: deprecated, use ChannelEdit instead // channelID : The ID of a Channel // data : The channel struct to send func (s *Session) ChannelEditComplex(channelID string, data *ChannelEdit) (st *Channel, err error) { From 54f1caf5e83b97078f059ca8d6930a1e321dda5c Mon Sep 17 00:00:00 2001 From: nitroflap Date: Mon, 25 Jul 2022 22:57:31 +0300 Subject: [PATCH 05/15] feat(GuildEmbed)!: allow partial edits * Make fields omitempty * Make `Enabled` field a pointer --- structs.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/structs.go b/structs.go index e45c3e9b6..236577f53 100644 --- a/structs.go +++ b/structs.go @@ -1407,8 +1407,8 @@ type AutoModerationAction struct { // A GuildEmbed stores data for a guild embed. type GuildEmbed struct { - Enabled bool `json:"enabled"` - ChannelID string `json:"channel_id"` + Enabled *bool `json:"enabled,omitempty"` + ChannelID string `json:"channel_id,omitempty"` } // A GuildAuditLog stores data for a guild audit log. From f86fc860c1735f79f4b394e7cbb14dccb454362c Mon Sep 17 00:00:00 2001 From: nitroflap Date: Mon, 25 Jul 2022 23:01:55 +0300 Subject: [PATCH 06/15] refactor(GuildEmbedEdit)!: use params struct Refactor GuildEmbedEdit to accept parameters through GuildEmbed struct --- restapi.go | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/restapi.go b/restapi.go index 75126e876..943b72c19 100644 --- a/restapi.go +++ b/restapi.go @@ -1273,12 +1273,10 @@ func (s *Session) GuildEmbed(guildID string) (st *GuildEmbed, err error) { return } -// GuildEmbedEdit returns the embed for a Guild. +// GuildEmbedEdit edits the embed of a Guild. // guildID : The ID of a Guild. -func (s *Session) GuildEmbedEdit(guildID string, enabled bool, channelID string) (err error) { - - data := GuildEmbed{enabled, channelID} - +// data : New embed data. +func (s *Session) GuildEmbedEdit(guildID string, data *GuildEmbed) (err error) { _, err = s.RequestWithBucketID("PATCH", EndpointGuildEmbed(guildID), data, EndpointGuildEmbed(guildID)) return } From d232ee7d53b253a1b9a09cbcbcb07b88c17bf0ab Mon Sep 17 00:00:00 2001 From: nitroflap Date: Fri, 29 Jul 2022 19:27:42 +0300 Subject: [PATCH 07/15] refactor(GuildMemberEdit)!: replace GuildMemberEditComplex Move functionality fo GuildMemberEditComplex to GuildMemberEdit --- restapi.go | 26 ++++++++++---------------- 1 file changed, 10 insertions(+), 16 deletions(-) diff --git a/restapi.go b/restapi.go index 943b72c19..e34578716 100644 --- a/restapi.go +++ b/restapi.go @@ -808,17 +808,18 @@ func (s *Session) GuildMemberDeleteWithReason(guildID, userID, reason string) (e return } -// GuildMemberEdit edits the roles of a member. +// GuildMemberEdit edits and returns updated member. // guildID : The ID of a Guild. // userID : The ID of a User. -// roles : A list of role ID's to set on the member. -func (s *Session) GuildMemberEdit(guildID, userID string, roles []string) (err error) { - - data := struct { - Roles []string `json:"roles"` - }{roles} +// data : Updated GuildMember data. +func (s *Session) GuildMemberEdit(guildID, userID string, data GuildMemberParams) (st *Member, err error) { + var body []byte + body, err = s.RequestWithBucketID("PATCH", EndpointGuildMember(guildID, userID), data, EndpointGuildMember(guildID, "")) + if err != nil { + return nil, err + } - _, err = s.RequestWithBucketID("PATCH", EndpointGuildMember(guildID, userID), data, EndpointGuildMember(guildID, "")) + err = unmarshal(body, &st) return } @@ -827,14 +828,7 @@ func (s *Session) GuildMemberEdit(guildID, userID string, roles []string) (err e // userID : The ID of a User. // data : A GuildMemberEditData struct with the new nickname and roles func (s *Session) GuildMemberEditComplex(guildID, userID string, data GuildMemberParams) (st *Member, err error) { - var body []byte - body, err = s.RequestWithBucketID("PATCH", EndpointGuildMember(guildID, userID), data, EndpointGuildMember(guildID, "")) - if err != nil { - return nil, err - } - - err = unmarshal(body, &st) - return + return s.GuildMemberEdit(guildID, userID, data) } // GuildMemberMove moves a guild member from one voice channel to another/none From 42c8c83d9d965a4edb99106b8999deaefa137b18 Mon Sep 17 00:00:00 2001 From: nitroflap Date: Fri, 29 Jul 2022 19:28:28 +0300 Subject: [PATCH 08/15] chore: deprecate GuildMemberEditComplex --- restapi.go | 1 + 1 file changed, 1 insertion(+) diff --git a/restapi.go b/restapi.go index e34578716..2878decca 100644 --- a/restapi.go +++ b/restapi.go @@ -824,6 +824,7 @@ func (s *Session) GuildMemberEdit(guildID, userID string, data GuildMemberParams } // GuildMemberEditComplex edits the nickname and roles of a member. +// NOTE: deprecated, use GuildMemberEdit instead. // guildID : The ID of a Guild. // userID : The ID of a User. // data : A GuildMemberEditData struct with the new nickname and roles From a0df6c3519a75abf995b26883815d0ac657d3610 Mon Sep 17 00:00:00 2001 From: nitroflap Date: Sun, 31 Jul 2022 01:10:24 +0300 Subject: [PATCH 09/15] refactor(GuildEmojiCreate)!: use struct params Refactor GuildEmojiCreate to take parameters using EmojiParams struct. --- restapi.go | 15 +++------------ structs.go | 11 +++++++++++ 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/restapi.go b/restapi.go index 2878decca..4bf77b2dc 100644 --- a/restapi.go +++ b/restapi.go @@ -1339,19 +1339,10 @@ func (s *Session) GuildEmoji(guildID, emojiID string) (emoji *Emoji, err error) return } -// GuildEmojiCreate creates a new emoji +// GuildEmojiCreate creates a new Emoji. // guildID : The ID of a Guild. -// name : The Name of the Emoji. -// image : The base64 encoded emoji image, has to be smaller than 256KB. -// roles : The roles for which this emoji will be whitelisted, can be nil. -func (s *Session) GuildEmojiCreate(guildID, name, image string, roles []string) (emoji *Emoji, err error) { - - data := struct { - Name string `json:"name"` - Image string `json:"image"` - Roles []string `json:"roles,omitempty"` - }{name, image, roles} - +// data : New Emoji data. +func (s *Session) GuildEmojiCreate(guildID string, data EmojiParams) (emoji *Emoji, err error) { body, err := s.RequestWithBucketID("POST", EndpointGuildEmojis(guildID), data, EndpointGuildEmojis(guildID)) if err != nil { return diff --git a/structs.go b/structs.go index 236577f53..bd94d5bf3 100644 --- a/structs.go +++ b/structs.go @@ -491,6 +491,17 @@ func (e *Emoji) APIName() string { return e.ID } +// EmojiParams represents parameters needed to create or update an Emoji. +type EmojiParams struct { + // Name of the emoji + Name string `json:"name,omitempty"` + // A base64 encoded emoji image, has to be smaller than 256KB. + // NOTE: can be only set on creation. + Image string `json:"image,omitempty"` + // Roles for which this emoji will be available. + Roles []string `json:"roles,omitempty"` +} + // StickerFormat is the file format of the Sticker. type StickerFormat int From de772a9606dd926971cd49e49025774b27df079c Mon Sep 17 00:00:00 2001 From: nitroflap Date: Sun, 31 Jul 2022 01:33:57 +0300 Subject: [PATCH 10/15] refactor(GuildEmojiEdit)!: use struct params Refactor GuildEmojiEdit to take parameters using EmojiParams struct. --- restapi.go | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/restapi.go b/restapi.go index 4bf77b2dc..912562179 100644 --- a/restapi.go +++ b/restapi.go @@ -1352,18 +1352,11 @@ func (s *Session) GuildEmojiCreate(guildID string, data EmojiParams) (emoji *Emo return } -// GuildEmojiEdit modifies an emoji +// GuildEmojiEdit modifies and returns updated emoji. // guildID : The ID of a Guild. // emojiID : The ID of an Emoji. -// name : The Name of the Emoji. -// roles : The roles for which this emoji will be whitelisted, if nil or empty the roles will be reset. -func (s *Session) GuildEmojiEdit(guildID, emojiID, name string, roles []string) (emoji *Emoji, err error) { - - data := struct { - Name string `json:"name"` - Roles []string `json:"roles"` - }{name, roles} - +// data : Updated emoji data. +func (s *Session) GuildEmojiEdit(guildID, emojiID string, data EmojiParams) (emoji *Emoji, err error) { body, err := s.RequestWithBucketID("PATCH", EndpointGuildEmoji(guildID, emojiID), data, EndpointGuildEmojis(guildID)) if err != nil { return From 1dacbbb7c271189c5b3a900ddd202db3ca6a65f2 Mon Sep 17 00:00:00 2001 From: nitroflap Date: Sun, 7 Aug 2022 22:24:35 +0300 Subject: [PATCH 11/15] refactor(GuildMemberAdd)!: use struct params Refactor GuildMemberAdd to take parameters using GuildMemberAddParams struct. --- restapi.go | 16 ++-------------- structs.go | 15 +++++++++++++++ 2 files changed, 17 insertions(+), 14 deletions(-) diff --git a/restapi.go b/restapi.go index 912562179..b711c8db1 100644 --- a/restapi.go +++ b/restapi.go @@ -760,22 +760,10 @@ func (s *Session) GuildMember(guildID, userID string) (st *Member, err error) { } // GuildMemberAdd force joins a user to the guild. -// accessToken : Valid access_token for the user. // guildID : The ID of a Guild. // userID : The ID of a User. -// nick : Value to set users nickname to -// roles : A list of role ID's to set on the member. -// mute : If the user is muted. -// deaf : If the user is deafened. -func (s *Session) GuildMemberAdd(accessToken, guildID, userID, nick string, roles []string, mute, deaf bool) (err error) { - - data := struct { - AccessToken string `json:"access_token"` - Nick string `json:"nick,omitempty"` - Roles []string `json:"roles,omitempty"` - Mute bool `json:"mute,omitempty"` - Deaf bool `json:"deaf,omitempty"` - }{accessToken, nick, roles, mute, deaf} +// data : Parameters of the user to add. +func (s *Session) GuildMemberAdd(guildID, userID string, data GuildMemberAddParams) (err error) { _, err = s.RequestWithBucketID("PUT", EndpointGuildMember(guildID, userID), data, EndpointGuildMember(guildID, "")) if err != nil { diff --git a/structs.go b/structs.go index bd94d5bf3..bd3ee813d 100644 --- a/structs.go +++ b/structs.go @@ -1726,6 +1726,21 @@ type GuildMemberParams struct { Roles *[]string `json:"roles,omitempty"` } +// GuildMemberAddParams stores data needed to add a user to a guild. +// NOTE: All fields are optional, except AccessToken. +type GuildMemberAddParams struct { + // Valid access_token for the user. + AccessToken string `json:"access_token"` + // Value to set users nickname to. + Nick string `json:"nick,omitempty"` + // A list of role ID's to set on the member. + Roles []string `json:"roles,omitempty"` + // Whether the user is muted. + Mute bool `json:"mute,omitempty"` + // Whether the user is deafened. + Deaf bool `json:"deaf,omitempty"` +} + // An APIErrorMessage is an api error message returned from discord type APIErrorMessage struct { Code int `json:"code"` From fa79cf49cc9fee0dd6e77f8cb3d362bad9f58fd1 Mon Sep 17 00:00:00 2001 From: nitroflap Date: Fri, 12 Aug 2022 16:12:16 +0300 Subject: [PATCH 12/15] refactor(GuildTemplateEdit)!: use struct params Refactor GuildTemplateEdit to take parameters using GuildTemplateParams struct. --- restapi.go | 14 ++++---------- structs.go | 8 ++++++++ 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/restapi.go b/restapi.go index b711c8db1..a340b9a59 100644 --- a/restapi.go +++ b/restapi.go @@ -1439,16 +1439,10 @@ func (s *Session) GuildTemplateSync(guildID, templateCode string) (err error) { } // GuildTemplateEdit modifies the template's metadata -// guildID: The ID of the guild -// templateCode: The code of the template -// name: The name of the template (1-100 characters) -// description: The description for the template (0-120 characters) -func (s *Session) GuildTemplateEdit(guildID, templateCode, name, description string) (st *GuildTemplate, err error) { - - data := struct { - Name string `json:"name,omitempty"` - Description string `json:"description,omitempty"` - }{name, description} +// guildID : The ID of the guild +// templateCode : The code of the template +// data : New template metadata +func (s *Session) GuildTemplateEdit(guildID, templateCode string, data GuildTemplateParams) (st *GuildTemplate, err error) { body, err := s.RequestWithBucketID("PATCH", EndpointGuildTemplateSync(guildID, templateCode), data, EndpointGuildTemplateSync(guildID, "")) if err != nil { diff --git a/structs.go b/structs.go index bd3ee813d..d362a28ae 100644 --- a/structs.go +++ b/structs.go @@ -995,6 +995,14 @@ type GuildTemplate struct { IsDirty bool `json:"is_dirty"` } +// GuildTemplateParams stores the data needed to create or update a GuildTemplate. +type GuildTemplateParams struct { + // The name of the template (1-100 characters) + Name string `json:"name,omitempty"` + // The description of the template (0-120 characters) + Description string `json:"description,omitempty"` +} + // MessageNotifications is the notification level for a guild // https://discord.com/developers/docs/resources/guild#guild-object-default-message-notification-level type MessageNotifications int From 61933502fb68cdbcc05623aac705519b6d04bb6a Mon Sep 17 00:00:00 2001 From: nitroflap Date: Fri, 12 Aug 2022 16:13:44 +0300 Subject: [PATCH 13/15] refactor(GuildTemplateCreate)!: use struct params Refactor GuildTemplateCreate to take parameters using GuildTemplateParams struct. --- restapi.go | 13 +++---------- 1 file changed, 3 insertions(+), 10 deletions(-) diff --git a/restapi.go b/restapi.go index a340b9a59..3bf83477e 100644 --- a/restapi.go +++ b/restapi.go @@ -1410,16 +1410,9 @@ func (s *Session) GuildTemplates(guildID string) (st []*GuildTemplate, err error } // GuildTemplateCreate creates a template for the guild -// guildID: The ID of the guild -// name: The name of the template (1-100 characters) -// description: The description for the template (0-120 characters) -func (s *Session) GuildTemplateCreate(guildID, name, description string) (st *GuildTemplate) { - - data := struct { - Name string `json:"name"` - Description string `json:"description"` - }{name, description} - +// guildID : The ID of the guild +// data : Template metadata +func (s *Session) GuildTemplateCreate(guildID string, data GuildTemplateParams) (st *GuildTemplate) { body, err := s.RequestWithBucketID("POST", EndpointGuildTemplates(guildID), data, EndpointGuildTemplates(guildID)) if err != nil { return From cd25316809d626686e4a0aefb7ea779f5c0c02be Mon Sep 17 00:00:00 2001 From: nitroflap Date: Wed, 17 Aug 2022 17:42:01 +0300 Subject: [PATCH 14/15] chore(rest)!: use pointers for Params structs Refactor methods with Params struct to use pointers --- restapi.go | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/restapi.go b/restapi.go index 3bf83477e..0740efd1e 100644 --- a/restapi.go +++ b/restapi.go @@ -763,7 +763,7 @@ func (s *Session) GuildMember(guildID, userID string) (st *Member, err error) { // guildID : The ID of a Guild. // userID : The ID of a User. // data : Parameters of the user to add. -func (s *Session) GuildMemberAdd(guildID, userID string, data GuildMemberAddParams) (err error) { +func (s *Session) GuildMemberAdd(guildID, userID string, data *GuildMemberAddParams) (err error) { _, err = s.RequestWithBucketID("PUT", EndpointGuildMember(guildID, userID), data, EndpointGuildMember(guildID, "")) if err != nil { @@ -800,7 +800,7 @@ func (s *Session) GuildMemberDeleteWithReason(guildID, userID, reason string) (e // guildID : The ID of a Guild. // userID : The ID of a User. // data : Updated GuildMember data. -func (s *Session) GuildMemberEdit(guildID, userID string, data GuildMemberParams) (st *Member, err error) { +func (s *Session) GuildMemberEdit(guildID, userID string, data *GuildMemberParams) (st *Member, err error) { var body []byte body, err = s.RequestWithBucketID("PATCH", EndpointGuildMember(guildID, userID), data, EndpointGuildMember(guildID, "")) if err != nil { @@ -816,7 +816,7 @@ func (s *Session) GuildMemberEdit(guildID, userID string, data GuildMemberParams // guildID : The ID of a Guild. // userID : The ID of a User. // data : A GuildMemberEditData struct with the new nickname and roles -func (s *Session) GuildMemberEditComplex(guildID, userID string, data GuildMemberParams) (st *Member, err error) { +func (s *Session) GuildMemberEditComplex(guildID, userID string, data *GuildMemberParams) (st *Member, err error) { return s.GuildMemberEdit(guildID, userID, data) } @@ -1330,7 +1330,7 @@ func (s *Session) GuildEmoji(guildID, emojiID string) (emoji *Emoji, err error) // GuildEmojiCreate creates a new Emoji. // guildID : The ID of a Guild. // data : New Emoji data. -func (s *Session) GuildEmojiCreate(guildID string, data EmojiParams) (emoji *Emoji, err error) { +func (s *Session) GuildEmojiCreate(guildID string, data *EmojiParams) (emoji *Emoji, err error) { body, err := s.RequestWithBucketID("POST", EndpointGuildEmojis(guildID), data, EndpointGuildEmojis(guildID)) if err != nil { return @@ -1344,7 +1344,7 @@ func (s *Session) GuildEmojiCreate(guildID string, data EmojiParams) (emoji *Emo // guildID : The ID of a Guild. // emojiID : The ID of an Emoji. // data : Updated emoji data. -func (s *Session) GuildEmojiEdit(guildID, emojiID string, data EmojiParams) (emoji *Emoji, err error) { +func (s *Session) GuildEmojiEdit(guildID, emojiID string, data *EmojiParams) (emoji *Emoji, err error) { body, err := s.RequestWithBucketID("PATCH", EndpointGuildEmoji(guildID, emojiID), data, EndpointGuildEmojis(guildID)) if err != nil { return @@ -1412,7 +1412,7 @@ func (s *Session) GuildTemplates(guildID string) (st []*GuildTemplate, err error // GuildTemplateCreate creates a template for the guild // guildID : The ID of the guild // data : Template metadata -func (s *Session) GuildTemplateCreate(guildID string, data GuildTemplateParams) (st *GuildTemplate) { +func (s *Session) GuildTemplateCreate(guildID string, data *GuildTemplateParams) (st *GuildTemplate) { body, err := s.RequestWithBucketID("POST", EndpointGuildTemplates(guildID), data, EndpointGuildTemplates(guildID)) if err != nil { return @@ -1435,7 +1435,7 @@ func (s *Session) GuildTemplateSync(guildID, templateCode string) (err error) { // guildID : The ID of the guild // templateCode : The code of the template // data : New template metadata -func (s *Session) GuildTemplateEdit(guildID, templateCode string, data GuildTemplateParams) (st *GuildTemplate, err error) { +func (s *Session) GuildTemplateEdit(guildID, templateCode string, data *GuildTemplateParams) (st *GuildTemplate, err error) { body, err := s.RequestWithBucketID("PATCH", EndpointGuildTemplateSync(guildID, templateCode), data, EndpointGuildTemplateSync(guildID, "")) if err != nil { From 8fb23f21485af3811f2c61e2446dd464b6d313af Mon Sep 17 00:00:00 2001 From: Fedor Lapshin Date: Wed, 17 Aug 2022 18:04:00 +0300 Subject: [PATCH 15/15] chore: grammar and style fixes in comments --- restapi.go | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/restapi.go b/restapi.go index 0740efd1e..d4cc635c9 100644 --- a/restapi.go +++ b/restapi.go @@ -1016,7 +1016,7 @@ func (s *Session) GuildRoles(guildID string) (st []*Role, err error) { // GuildRoleCreate creates a new Guild Role and returns it. // guildID : The ID of a Guild. -// data : New role parameters. +// data : New Role parameters. func (s *Session) GuildRoleCreate(guildID string, data *RoleParams) (st *Role, err error) { body, err := s.RequestWithBucketID("POST", EndpointGuildRoles(guildID), data, EndpointGuildRoles(guildID)) if err != nil { @@ -1028,7 +1028,7 @@ func (s *Session) GuildRoleCreate(guildID string, data *RoleParams) (st *Role, e return } -// GuildRoleEdit updates an existing Guild Role and updated Role data. +// GuildRoleEdit updates an existing Guild Role and returns updated Role data. // guildID : The ID of a Guild. // roleID : The ID of a Role. // data : Updated Role data. @@ -1258,7 +1258,7 @@ func (s *Session) GuildEmbed(guildID string) (st *GuildEmbed, err error) { // GuildEmbedEdit edits the embed of a Guild. // guildID : The ID of a Guild. -// data : New embed data. +// data : New GuildEmbed data. func (s *Session) GuildEmbedEdit(guildID string, data *GuildEmbed) (err error) { _, err = s.RequestWithBucketID("PATCH", EndpointGuildEmbed(guildID), data, EndpointGuildEmbed(guildID)) return @@ -1340,10 +1340,10 @@ func (s *Session) GuildEmojiCreate(guildID string, data *EmojiParams) (emoji *Em return } -// GuildEmojiEdit modifies and returns updated emoji. +// GuildEmojiEdit modifies and returns updated Emoji. // guildID : The ID of a Guild. // emojiID : The ID of an Emoji. -// data : Updated emoji data. +// data : Updated Emoji data. func (s *Session) GuildEmojiEdit(guildID, emojiID string, data *EmojiParams) (emoji *Emoji, err error) { body, err := s.RequestWithBucketID("PATCH", EndpointGuildEmoji(guildID, emojiID), data, EndpointGuildEmojis(guildID)) if err != nil {