forked from andersfylling/disgord
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rest_webhook.go
290 lines (259 loc) · 11.7 KB
/
rest_webhook.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
package disgord
import (
"errors"
"net/http"
"github.com/andersfylling/disgord/endpoint"
"github.com/andersfylling/disgord/httd"
)
func ratelimitWebhook(id Snowflake) string {
return "wh:" + id.String()
}
// CreateWebhookParams json params for the create webhook rest request
// avatar string: https://discordapp.com/developers/docs/resources/user#avatar-data
type CreateWebhookParams struct {
Name string `json:"name"` // name of the webhook (2-32 characters)
Avatar string `json:"avatar"` // avatar data uri scheme, image for the default webhook avatar
}
// CreateWebhook [POST] Create a new webhook. Requires the 'MANAGE_WEBHOOKS' permission.
// Returns a webhook object on success.
// Endpoint /channels/{channel.id}/webhooks
// Rate limiter /channels/{channel.id}/webhooks
// Discord documentation https://discordapp.com/developers/docs/resources/webhook#create-webhook
// Reviewed 2018-08-14
// Comment -
func CreateWebhook(client httd.Poster, channelID Snowflake, params *CreateWebhookParams) (ret *Webhook, err error) {
_, body, err := client.Post(&httd.Request{
Ratelimiter: ratelimitChannelWebhooks(channelID),
Endpoint: endpoint.ChannelWebhooks(channelID),
JSONParams: params,
ContentType: httd.ContentTypeJSON,
})
if err != nil {
return
}
err = unmarshal(body, &ret)
return
}
// GetChannelWebhooks [GET] Returns a list of channel webhook objects. Requires the 'MANAGE_WEBHOOKS' permission.
// Endpoint /channels/{channel.id}/webhooks
// Rate limiter /channels/{channel.id}/webhooks
// Discord documentation https://discordapp.com/developers/docs/resources/webhook#get-channel-webhooks
// Reviewed 2018-08-14
// Comment -
func GetChannelWebhooks(client httd.Getter, channelID Snowflake) (ret []*Webhook, err error) {
_, body, err := client.Get(&httd.Request{
Ratelimiter: ratelimitChannelWebhooks(channelID),
Endpoint: endpoint.ChannelWebhooks(channelID),
})
if err != nil {
return
}
err = unmarshal(body, &ret)
return
}
// GetGuildWebhooks [GET] Returns a list of guild webhook objects. Requires the 'MANAGE_WEBHOOKS' permission.
// Endpoint /guilds/{guild.id}/webhooks
// Rate limiter /guilds/{guild.id}/webhooks
// Discord documentation https://discordapp.com/developers/docs/resources/webhook#get-guild-webhooks
// Reviewed 2018-08-14
// Comment -
func GetGuildWebhooks(client httd.Getter, guildID Snowflake) (ret []*Webhook, err error) {
_, body, err := client.Get(&httd.Request{
Ratelimiter: ratelimitGuildWebhooks(guildID),
Endpoint: endpoint.GuildWebhooks(guildID),
})
if err != nil {
return
}
err = unmarshal(body, &ret)
return
}
// GetWebhook [GET] Returns the new webhook object for the given id.
// Endpoint /webhooks/{webhook.id}
// Rate limiter /webhooks/{webhook.id}
// Discord documentation https://discordapp.com/developers/docs/resources/webhook#get-webhook
// Reviewed 2018-08-14
// Comment -
func GetWebhook(client httd.Getter, id Snowflake) (ret *Webhook, err error) {
details := &httd.Request{
Ratelimiter: ratelimitWebhook(id),
Endpoint: endpoint.Webhook(id),
}
_, body, err := client.Get(details)
if err != nil {
return
}
err = unmarshal(body, &ret)
return
}
// GetWebhookWithToken [GET] Same as GetWebhook, except this call does not require authentication and returns
// no user in the webhook object.
// Endpoint /webhooks/{webhook.id}/{webhook.token}
// Rate limiter /webhooks/{webhook.id}
// Discord documentation https://discordapp.com/developers/docs/resources/webhook#get-webhook-with-token
// Reviewed 2018-08-14
// Comment -
func GetWebhookWithToken(client httd.Getter, id Snowflake, token string) (ret *Webhook, err error) {
_, body, err := client.Get(&httd.Request{
Ratelimiter: ratelimitWebhook(id),
Endpoint: endpoint.WebhookToken(id, token),
})
if err != nil {
return
}
err = unmarshal(body, &ret)
return
}
// ModifyWebhook [PATCH] Modify a webhook. Requires the 'MANAGE_WEBHOOKS' permission.
// Returns the updated webhook object on success.
// Endpoint /webhooks/{webhook.id}
// Rate limiter /webhooks/{webhook.id}
// Discord documentation https://discordapp.com/developers/docs/resources/webhook#modify-webhook
// Reviewed 2018-08-14
// Comment All parameters to this endpoint. are optional. Not tested:extra json fields might
// cause an issue. Consider writing a json params object.
func ModifyWebhook(client httd.Patcher, newWebhook *Webhook) (ret *Webhook, err error) {
id := newWebhook.ID
if id.Empty() {
err = errors.New("not a valid snowflake")
return
}
_, body, err := client.Patch(&httd.Request{
Ratelimiter: ratelimitWebhook(id),
Endpoint: endpoint.Webhook(id),
ContentType: httd.ContentTypeJSON,
})
if err != nil {
return
}
err = unmarshal(body, &ret)
return
}
// ModifyWebhookWithToken [PATCH] Same as ModifyWebhook, except this call does not require authentication,
// does not accept a channel_id parameter in the body, and does not return
// a user in the webhook object.
// Endpoint /webhooks/{webhook.id}/{webhook.token}
// Rate limiter /webhooks/{webhook.id}
// Discord documentation https://discordapp.com/developers/docs/resources/webhook#modify-webhook-with-token
// Reviewed 2018-08-14
// Comment All parameters to this endpoint. are optional. Not tested:extra json fields might
// cause an issue. Consider writing a json params object.
func ModifyWebhookWithToken(client httd.Patcher, newWebhook *Webhook) (ret *Webhook, err error) {
id := newWebhook.ID
if id.Empty() {
err = errors.New("not a valid snowflake")
return
}
_, body, err := client.Patch(&httd.Request{
Ratelimiter: ratelimitWebhook(id),
Endpoint: endpoint.WebhookToken(id, newWebhook.Token),
ContentType: httd.ContentTypeJSON,
})
if err != nil {
return
}
err = unmarshal(body, &ret)
return
}
// DeleteWebhook [DELETE] Delete a webhook permanently. User must be owner. Returns a 204 NO CONTENT response
// on success.
// Endpoint /webhooks/{webhook.id}
// Rate limiter /webhooks/{webhook.id}
// Discord documentation https://discordapp.com/developers/docs/resources/webhook#delete-webhook
// Reviewed 2018-08-14
// Comment -
func DeleteWebhook(client httd.Deleter, webhookID Snowflake) (err error) {
return DeleteWebhookWithToken(client, webhookID, "")
}
// DeleteWebhookWithToken [DELETE] Same as DeleteWebhook, except this call does not require authentication.
// Endpoint /webhooks/{webhook.id}/{webhook.token}
// Rate limiter /webhooks/{webhook.id}
// Discord documentation https://discordapp.com/developers/docs/resources/webhook#delete-webhook-with-token
// Reviewed 2018-08-14
// Comment -
func DeleteWebhookWithToken(client httd.Deleter, id Snowflake, token string) (err error) {
var e string
if token != "" {
e = endpoint.WebhookToken(id, token)
} else {
e = endpoint.Webhook(id)
}
resp, _, err := client.Delete(&httd.Request{
Ratelimiter: ratelimitWebhook(id),
Endpoint: e,
})
if err != nil {
return
}
if resp.StatusCode != http.StatusNoContent {
msg := "unexpected http response code. Got " + resp.Status + ", wants " + http.StatusText(http.StatusNoContent)
err = errors.New(msg)
}
return
}
// NewExecuteWebhookParams creates params for func ExecuteWebhook
func NewExecuteWebhookParams(id Snowflake, token string) (ret *ExecuteWebhookParams, err error) {
return &ExecuteWebhookParams{
WebhookID: id,
Token: token,
}, nil
}
// ExecuteWebhookParams JSON params for func ExecuteWebhook
type ExecuteWebhookParams struct {
WebhookID Snowflake `json:"-"`
Token string `json:"-"`
Content string `json:"content"`
Username string `json:"username"`
AvatarURL string `json:"avatar_url"`
TTS bool `json:"tts"`
File interface{} `json:"file"`
Embeds []*ChannelEmbed `json:"embeds"`
}
// ExecuteWebhook [POST] Trigger a webhook in Discord.
// Endpoint /webhooks/{webhook.id}/{webhook.token}
// Rate limiter /webhooks/{webhook.id}
// Discord documentation https://discordapp.com/developers/docs/resources/webhook#execute-webhook
// Reviewed 2018-08-14
// Comment This endpoint. supports both JSON and form data bodies. It does require
// multipart/form-data requests instead of the normal JSON request type when
// uploading files. Make sure you set your Content-Type to multipart/form-data if
// you're doing that. Note that in that case, the embeds field cannot be used, but
// you can pass an url-encoded JSON body as a form value for payload_json.
// Comment#2 For the webhook embed objects, you can set every field except type (it will be
// rich regardless of if you try to set it), provider, video, and any height, width,
// or proxy_url values for images.
// TODO
func ExecuteWebhook(client httd.Poster, params *ExecuteWebhookParams, wait bool, URLSuffix string) (err error) {
_, _, err = client.Post(&httd.Request{
Ratelimiter: ratelimitWebhook(params.WebhookID),
Endpoint: endpoint.WebhookToken(params.WebhookID, params.Token) + URLSuffix,
ContentType: httd.ContentTypeJSON,
})
if err != nil {
return
}
//err = unmarshal(body, ret) // TODO: how to verify success?
return
}
// ExecuteSlackWebhook [POST] Trigger a webhook in Discord from the Slack app.
// Endpoint /webhooks/{webhook.id}/{webhook.token}
// Rate limiter /webhooks
// Discord documentation https://discordapp.com/developers/docs/resources/webhook#execute-slackcompatible-webhook
// Reviewed 2018-08-14
// Comment Refer to Slack's documentation for more information. We do not support Slack's channel,
// icon_emoji, mrkdwn, or mrkdwn_in properties.
func ExecuteSlackWebhook(client httd.Poster, params *ExecuteWebhookParams, wait bool) (err error) {
return ExecuteWebhook(client, params, wait, endpoint.Slack())
}
// ExecuteGitHubWebhook [POST] Trigger a webhook in Discord from the GitHub app.
// Endpoint /webhooks/{webhook.id}/{webhook.token}
// Rate limiter /webhooks
// Discord documentation https://discordapp.com/developers/docs/resources/webhook#execute-githubcompatible-webhook
// Reviewed 2018-08-14
// Comment Add a new webhook to your GitHub repo (in the repo's settings), and use this endpoint.
// as the "Payload URL." You can choose what events your Discord channel receives by
// choosing the "Let me select individual events" option and selecting individual
// events for the new webhook you're configuring.
func ExecuteGitHubWebhook(client httd.Poster, params *ExecuteWebhookParams, wait bool) (err error) {
return ExecuteWebhook(client, params, wait, endpoint.GitHub())
}