forked from cloudflare/cloudflare-go
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathwaiting_room.go
637 lines (567 loc) · 23.7 KB
/
waiting_room.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
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
package cloudflare
import (
"context"
"errors"
"fmt"
"net/http"
"time"
"github.com/goccy/go-json"
)
var (
ErrMissingWaitingRoomID = errors.New("missing required waiting room ID")
ErrMissingWaitingRoomRuleID = errors.New("missing required waiting room rule ID")
)
// WaitingRoom describes a WaitingRoom object.
type WaitingRoom struct {
CreatedOn time.Time `json:"created_on,omitempty"`
ModifiedOn time.Time `json:"modified_on,omitempty"`
Path string `json:"path"`
Name string `json:"name"`
Description string `json:"description,omitempty"`
QueueingMethod string `json:"queueing_method,omitempty"`
CustomPageHTML string `json:"custom_page_html,omitempty"`
DefaultTemplateLanguage string `json:"default_template_language,omitempty"`
Host string `json:"host"`
ID string `json:"id,omitempty"`
NewUsersPerMinute int `json:"new_users_per_minute"`
TotalActiveUsers int `json:"total_active_users"`
SessionDuration int `json:"session_duration"`
QueueAll bool `json:"queue_all"`
DisableSessionRenewal bool `json:"disable_session_renewal"`
Suspended bool `json:"suspended"`
JsonResponseEnabled bool `json:"json_response_enabled"`
NextEventPrequeueStartTime *time.Time `json:"next_event_prequeue_start_time,omitempty"`
NextEventStartTime *time.Time `json:"next_event_start_time,omitempty"`
CookieSuffix string `json:"cookie_suffix"`
AdditionalRoutes []*WaitingRoomRoute `json:"additional_routes,omitempty"`
QueueingStatusCode int `json:"queueing_status_code"`
EnabledOriginCommands []string `json:"enabled_origin_commands,omitempty"`
CookieAttributes *WaitingRoomCookieAttributes `json:"cookie_attributes,omitempty"`
}
// WaitingRoomStatus describes the status of a waiting room.
type WaitingRoomStatus struct {
Status string `json:"status"`
EventID string `json:"event_id"`
EstimatedQueuedUsers int `json:"estimated_queued_users"`
EstimatedTotalActiveUsers int `json:"estimated_total_active_users"`
MaxEstimatedTimeMinutes int `json:"max_estimated_time_minutes"`
}
// WaitingRoomEvent describes a WaitingRoomEvent object.
type WaitingRoomEvent struct {
EventEndTime time.Time `json:"event_end_time"`
CreatedOn time.Time `json:"created_on,omitempty"`
ModifiedOn time.Time `json:"modified_on,omitempty"`
PrequeueStartTime *time.Time `json:"prequeue_start_time,omitempty"`
EventStartTime time.Time `json:"event_start_time"`
Name string `json:"name"`
Description string `json:"description,omitempty"`
QueueingMethod string `json:"queueing_method,omitempty"`
ID string `json:"id,omitempty"`
CustomPageHTML string `json:"custom_page_html,omitempty"`
NewUsersPerMinute int `json:"new_users_per_minute,omitempty"`
TotalActiveUsers int `json:"total_active_users,omitempty"`
SessionDuration int `json:"session_duration,omitempty"`
DisableSessionRenewal *bool `json:"disable_session_renewal,omitempty"`
Suspended bool `json:"suspended"`
ShuffleAtEventStart bool `json:"shuffle_at_event_start"`
}
type WaitingRoomRule struct {
ID string `json:"id,omitempty"`
Version string `json:"version,omitempty"`
Action string `json:"action"`
Expression string `json:"expression"`
Description string `json:"description"`
LastUpdated *time.Time `json:"last_updated,omitempty"`
Enabled *bool `json:"enabled"`
}
// WaitingRoomSettings describes zone-level waiting room settings.
type WaitingRoomSettings struct {
// Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone
SearchEngineCrawlerBypass bool `json:"search_engine_crawler_bypass"`
}
// WaitingRoomPagePreviewURL describes a WaitingRoomPagePreviewURL object.
type WaitingRoomPagePreviewURL struct {
PreviewURL string `json:"preview_url"`
}
// WaitingRoomPagePreviewCustomHTML describes a WaitingRoomPagePreviewCustomHTML object.
type WaitingRoomPagePreviewCustomHTML struct {
CustomHTML string `json:"custom_html"`
}
// WaitingRoomRoute describes a WaitingRoomRoute object.
type WaitingRoomRoute struct {
Host string `json:"host"`
Path string `json:"path"`
}
// WaitingRoomCookieAttributes describes a WaitingRoomCookieAttributes object.
type WaitingRoomCookieAttributes struct {
Samesite string `json:"samesite"`
Secure string `json:"secure"`
}
// WaitingRoomDetailResponse is the API response, containing a single WaitingRoom.
type WaitingRoomDetailResponse struct {
Response
Result WaitingRoom `json:"result"`
}
// WaitingRoomsResponse is the API response, containing an array of WaitingRooms.
type WaitingRoomsResponse struct {
Response
Result []WaitingRoom `json:"result"`
}
// WaitingRoomSettingsResponse is the API response, containing zone-level Waiting Room settings.
type WaitingRoomSettingsResponse struct {
Response
Result WaitingRoomSettings `json:"result"`
}
// WaitingRoomStatusResponse is the API response, containing the status of a waiting room.
type WaitingRoomStatusResponse struct {
Response
Result WaitingRoomStatus `json:"result"`
}
// WaitingRoomPagePreviewResponse is the API response, containing the URL to a custom waiting room preview.
type WaitingRoomPagePreviewResponse struct {
Response
Result WaitingRoomPagePreviewURL `json:"result"`
}
// WaitingRoomEventDetailResponse is the API response, containing a single WaitingRoomEvent.
type WaitingRoomEventDetailResponse struct {
Response
Result WaitingRoomEvent `json:"result"`
}
// WaitingRoomEventsResponse is the API response, containing an array of WaitingRoomEvents.
type WaitingRoomEventsResponse struct {
Response
Result []WaitingRoomEvent `json:"result"`
}
// WaitingRoomRulesResponse is the API response, containing an array of WaitingRoomRule.
type WaitingRoomRulesResponse struct {
Response
Result []WaitingRoomRule `json:"result"`
}
// CreateWaitingRoom creates a new Waiting Room for a zone.
//
// API reference: https://api.cloudflare.com/#waiting-room-create-waiting-room
func (api *API) CreateWaitingRoom(ctx context.Context, zoneID string, waitingRoom WaitingRoom) (*WaitingRoom, error) {
uri := fmt.Sprintf("/zones/%s/waiting_rooms", zoneID)
res, err := api.makeRequestContext(ctx, http.MethodPost, uri, waitingRoom)
if err != nil {
return nil, err
}
var r WaitingRoomDetailResponse
err = json.Unmarshal(res, &r)
if err != nil {
return nil, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return &r.Result, nil
}
// ListWaitingRooms returns all Waiting Room for a zone.
//
// API reference: https://api.cloudflare.com/#waiting-room-list-waiting-rooms
func (api *API) ListWaitingRooms(ctx context.Context, zoneID string) ([]WaitingRoom, error) {
uri := fmt.Sprintf("/zones/%s/waiting_rooms", zoneID)
res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return []WaitingRoom{}, err
}
var r WaitingRoomsResponse
err = json.Unmarshal(res, &r)
if err != nil {
return []WaitingRoom{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// WaitingRoom fetches detail about one Waiting room for a zone.
//
// API reference: https://api.cloudflare.com/#waiting-room-waiting-room-details
func (api *API) WaitingRoom(ctx context.Context, zoneID, waitingRoomID string) (WaitingRoom, error) {
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s", zoneID, waitingRoomID)
res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return WaitingRoom{}, err
}
var r WaitingRoomDetailResponse
err = json.Unmarshal(res, &r)
if err != nil {
return WaitingRoom{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// ChangeWaitingRoom lets you change individual settings for a Waiting room. This is
// in contrast to UpdateWaitingRoom which replaces the entire Waiting room.
//
// API reference: https://api.cloudflare.com/#waiting-room-update-waiting-room
func (api *API) ChangeWaitingRoom(ctx context.Context, zoneID, waitingRoomID string, waitingRoom WaitingRoom) (WaitingRoom, error) {
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s", zoneID, waitingRoomID)
res, err := api.makeRequestContext(ctx, http.MethodPatch, uri, waitingRoom)
if err != nil {
return WaitingRoom{}, err
}
var r WaitingRoomDetailResponse
err = json.Unmarshal(res, &r)
if err != nil {
return WaitingRoom{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// UpdateWaitingRoom lets you replace a Waiting Room. This is in contrast to
// ChangeWaitingRoom which lets you change individual settings.
//
// API reference: https://api.cloudflare.com/#waiting-room-update-waiting-room
func (api *API) UpdateWaitingRoom(ctx context.Context, zoneID string, waitingRoom WaitingRoom) (WaitingRoom, error) {
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s", zoneID, waitingRoom.ID)
res, err := api.makeRequestContext(ctx, http.MethodPut, uri, waitingRoom)
if err != nil {
return WaitingRoom{}, err
}
var r WaitingRoomDetailResponse
err = json.Unmarshal(res, &r)
if err != nil {
return WaitingRoom{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// DeleteWaitingRoom deletes a Waiting Room for a zone.
//
// API reference: https://api.cloudflare.com/#waiting-room-delete-waiting-room
func (api *API) DeleteWaitingRoom(ctx context.Context, zoneID, waitingRoomID string) error {
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s", zoneID, waitingRoomID)
res, err := api.makeRequestContext(ctx, http.MethodDelete, uri, nil)
if err != nil {
return err
}
var r WaitingRoomDetailResponse
err = json.Unmarshal(res, &r)
if err != nil {
return fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return nil
}
// WaitingRoomStatus returns the status of one Waiting Room for a zone.
//
// API reference: https://api.cloudflare.com/#waiting-room-get-waiting-room-status
func (api *API) WaitingRoomStatus(ctx context.Context, zoneID, waitingRoomID string) (WaitingRoomStatus, error) {
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s/status", zoneID, waitingRoomID)
res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return WaitingRoomStatus{}, err
}
var r WaitingRoomStatusResponse
err = json.Unmarshal(res, &r)
if err != nil {
return WaitingRoomStatus{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// WaitingRoomPagePreview uploads a custom waiting room page for preview and
// returns a preview URL.
//
// API reference: https://api.cloudflare.com/#waiting-room-create-a-custom-waiting-room-page-preview
func (api *API) WaitingRoomPagePreview(ctx context.Context, zoneID, customHTML string) (WaitingRoomPagePreviewURL, error) {
uri := fmt.Sprintf("/zones/%s/waiting_rooms/preview", zoneID)
res, err := api.makeRequestContext(ctx, http.MethodPost, uri, WaitingRoomPagePreviewCustomHTML{CustomHTML: customHTML})
if err != nil {
return WaitingRoomPagePreviewURL{}, err
}
var r WaitingRoomPagePreviewResponse
err = json.Unmarshal(res, &r)
if err != nil {
return WaitingRoomPagePreviewURL{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// CreateWaitingRoomEvent creates a new event for a Waiting Room.
//
// API reference: https://api.cloudflare.com/#waiting-room-create-event
func (api *API) CreateWaitingRoomEvent(ctx context.Context, zoneID string, waitingRoomID string, waitingRoomEvent WaitingRoomEvent) (*WaitingRoomEvent, error) {
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s/events", zoneID, waitingRoomID)
res, err := api.makeRequestContext(ctx, http.MethodPost, uri, waitingRoomEvent)
if err != nil {
return nil, err
}
var r WaitingRoomEventDetailResponse
err = json.Unmarshal(res, &r)
if err != nil {
return nil, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return &r.Result, nil
}
// ListWaitingRoomEvents returns all Waiting Room Events for a zone.
//
// API reference: https://api.cloudflare.com/#waiting-room-list-events
func (api *API) ListWaitingRoomEvents(ctx context.Context, zoneID string, waitingRoomID string) ([]WaitingRoomEvent, error) {
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s/events", zoneID, waitingRoomID)
res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return []WaitingRoomEvent{}, err
}
var r WaitingRoomEventsResponse
err = json.Unmarshal(res, &r)
if err != nil {
return []WaitingRoomEvent{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// WaitingRoomEvent fetches detail about one Waiting Room Event for a zone.
//
// API reference: https://api.cloudflare.com/#waiting-room-event-details
func (api *API) WaitingRoomEvent(ctx context.Context, zoneID string, waitingRoomID string, eventID string) (WaitingRoomEvent, error) {
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s/events/%s", zoneID, waitingRoomID, eventID)
res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return WaitingRoomEvent{}, err
}
var r WaitingRoomEventDetailResponse
err = json.Unmarshal(res, &r)
if err != nil {
return WaitingRoomEvent{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// WaitingRoomEventPreview returns an event's configuration as if it was active.
// Inherited fields from the waiting room will be displayed with their current values.
//
// API reference: https://api.cloudflare.com/#waiting-room-preview-active-event-details
func (api *API) WaitingRoomEventPreview(ctx context.Context, zoneID string, waitingRoomID string, eventID string) (WaitingRoomEvent, error) {
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s/events/%s/details", zoneID, waitingRoomID, eventID)
res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return WaitingRoomEvent{}, err
}
var r WaitingRoomEventDetailResponse
err = json.Unmarshal(res, &r)
if err != nil {
return WaitingRoomEvent{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// ChangeWaitingRoomEvent lets you change individual settings for a Waiting Room Event. This is
// in contrast to UpdateWaitingRoomEvent which replaces the entire Waiting Room Event.
//
// API reference: https://api.cloudflare.com/#waiting-room-patch-event
func (api *API) ChangeWaitingRoomEvent(ctx context.Context, zoneID, waitingRoomID string, waitingRoomEvent WaitingRoomEvent) (WaitingRoomEvent, error) {
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s/events/%s", zoneID, waitingRoomID, waitingRoomEvent.ID)
res, err := api.makeRequestContext(ctx, http.MethodPatch, uri, waitingRoomEvent)
if err != nil {
return WaitingRoomEvent{}, err
}
var r WaitingRoomEventDetailResponse
err = json.Unmarshal(res, &r)
if err != nil {
return WaitingRoomEvent{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// UpdateWaitingRoomEvent lets you replace a Waiting Room Event. This is in contrast to
// ChangeWaitingRoomEvent which lets you change individual settings.
//
// API reference: https://api.cloudflare.com/#waiting-room-update-event
func (api *API) UpdateWaitingRoomEvent(ctx context.Context, zoneID string, waitingRoomID string, waitingRoomEvent WaitingRoomEvent) (WaitingRoomEvent, error) {
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s/events/%s", zoneID, waitingRoomID, waitingRoomEvent.ID)
res, err := api.makeRequestContext(ctx, http.MethodPut, uri, waitingRoomEvent)
if err != nil {
return WaitingRoomEvent{}, err
}
var r WaitingRoomEventDetailResponse
err = json.Unmarshal(res, &r)
if err != nil {
return WaitingRoomEvent{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// DeleteWaitingRoomEvent deletes an event for a Waiting Room.
//
// API reference: https://api.cloudflare.com/#waiting-room-delete-event
func (api *API) DeleteWaitingRoomEvent(ctx context.Context, zoneID string, waitingRoomID string, eventID string) error {
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s/events/%s", zoneID, waitingRoomID, eventID)
res, err := api.makeRequestContext(ctx, http.MethodDelete, uri, nil)
if err != nil {
return err
}
var r WaitingRoomEventDetailResponse
err = json.Unmarshal(res, &r)
if err != nil {
return fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return nil
}
type ListWaitingRoomRuleParams struct {
WaitingRoomID string
}
type CreateWaitingRoomRuleParams struct {
WaitingRoomID string
Rule WaitingRoomRule
}
type ReplaceWaitingRoomRuleParams struct {
WaitingRoomID string
Rules []WaitingRoomRule
}
type UpdateWaitingRoomRuleParams struct {
WaitingRoomID string
Rule WaitingRoomRule
}
type DeleteWaitingRoomRuleParams struct {
WaitingRoomID string
RuleID string
}
// ListWaitingRoomRules lists all rules for a Waiting Room.
//
// API reference: https://api.cloudflare.com/#waiting-room-list-waiting-room-rules
func (api *API) ListWaitingRoomRules(ctx context.Context, rc *ResourceContainer, params ListWaitingRoomRuleParams) ([]WaitingRoomRule, error) {
if params.WaitingRoomID == "" {
return nil, ErrMissingWaitingRoomID
}
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s/rules", rc.Identifier, params.WaitingRoomID)
res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return nil, err
}
var r WaitingRoomRulesResponse
err = json.Unmarshal(res, &r)
if err != nil {
return nil, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// CreateWaitingRoomRule creates a new rule for a Waiting Room.
//
// API reference: https://api.cloudflare.com/#waiting-room-create-waiting-room-rule
func (api *API) CreateWaitingRoomRule(ctx context.Context, rc *ResourceContainer, params CreateWaitingRoomRuleParams) ([]WaitingRoomRule, error) {
if params.WaitingRoomID == "" {
return nil, ErrMissingWaitingRoomID
}
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s/rules", rc.Identifier, params.WaitingRoomID)
res, err := api.makeRequestContext(ctx, http.MethodPost, uri, params.Rule)
if err != nil {
return nil, err
}
var r WaitingRoomRulesResponse
err = json.Unmarshal(res, &r)
if err != nil {
return nil, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// ReplaceWaitingRoomRules replaces all rules for a Waiting Room.
//
// API reference: https://api.cloudflare.com/#waiting-room-replace-waiting-room-rules
func (api *API) ReplaceWaitingRoomRules(ctx context.Context, rc *ResourceContainer, params ReplaceWaitingRoomRuleParams) ([]WaitingRoomRule, error) {
if params.WaitingRoomID == "" {
return nil, ErrMissingWaitingRoomID
}
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s/rules", rc.Identifier, params.WaitingRoomID)
res, err := api.makeRequestContext(ctx, http.MethodPut, uri, params.Rules)
if err != nil {
return nil, err
}
var r WaitingRoomRulesResponse
err = json.Unmarshal(res, &r)
if err != nil {
return nil, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// UpdateWaitingRoomRule updates a rule for a Waiting Room.
//
// API reference: https://api.cloudflare.com/#waiting-room-patch-waiting-room-rule
func (api *API) UpdateWaitingRoomRule(ctx context.Context, rc *ResourceContainer, params UpdateWaitingRoomRuleParams) ([]WaitingRoomRule, error) {
if params.WaitingRoomID == "" {
return nil, ErrMissingWaitingRoomID
}
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s/rules/%s", rc.Identifier, params.WaitingRoomID, params.Rule.ID)
res, err := api.makeRequestContext(ctx, http.MethodPatch, uri, params.Rule)
if err != nil {
return nil, err
}
var r WaitingRoomRulesResponse
err = json.Unmarshal(res, &r)
if err != nil {
return nil, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// DeleteWaitingRoomRule deletes a rule for a Waiting Room.
//
// API reference: https://api.cloudflare.com/#waiting-room-delete-waiting-room-rule
func (api *API) DeleteWaitingRoomRule(ctx context.Context, rc *ResourceContainer, params DeleteWaitingRoomRuleParams) ([]WaitingRoomRule, error) {
if params.WaitingRoomID == "" {
return nil, ErrMissingWaitingRoomID
}
if params.RuleID == "" {
return nil, ErrMissingWaitingRoomRuleID
}
uri := fmt.Sprintf("/zones/%s/waiting_rooms/%s/rules/%s", rc.Identifier, params.WaitingRoomID, params.RuleID)
res, err := api.makeRequestContext(ctx, http.MethodDelete, uri, nil)
if err != nil {
return nil, err
}
var r WaitingRoomRulesResponse
err = json.Unmarshal(res, &r)
if err != nil {
return nil, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
// GetWaitingRoomSettings fetches the Waiting Room zone-level settings for a zone.
//
// API reference: https://api.cloudflare.com/#waiting-room-get-zone-settings
func (api *API) GetWaitingRoomSettings(ctx context.Context, rc *ResourceContainer) (WaitingRoomSettings, error) {
if rc.Level != ZoneRouteLevel {
return WaitingRoomSettings{}, fmt.Errorf(errInvalidResourceContainerAccess, rc.Level)
}
uri := fmt.Sprintf("/zones/%s/waiting_rooms/settings", rc.Identifier)
res, err := api.makeRequestContext(ctx, http.MethodGet, uri, nil)
if err != nil {
return WaitingRoomSettings{}, err
}
var r WaitingRoomSettingsResponse
err = json.Unmarshal(res, &r)
if err != nil {
return WaitingRoomSettings{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
type PatchWaitingRoomSettingsParams struct {
SearchEngineCrawlerBypass *bool `json:"search_engine_crawler_bypass,omitempty"`
}
// PatchWaitingRoomSettings lets you change individual zone-level Waiting Room settings. This is
// in contrast to UpdateWaitingRoomSettings which replaces all settings.
//
// API reference: https://api.cloudflare.com/#waiting-room-patch-zone-settings
func (api *API) PatchWaitingRoomSettings(ctx context.Context, rc *ResourceContainer, params PatchWaitingRoomSettingsParams) (WaitingRoomSettings, error) {
if rc.Level != ZoneRouteLevel {
return WaitingRoomSettings{}, fmt.Errorf(errInvalidResourceContainerAccess, rc.Level)
}
uri := fmt.Sprintf("/zones/%s/waiting_rooms/settings", rc.Identifier)
res, err := api.makeRequestContext(ctx, http.MethodPatch, uri, params)
if err != nil {
return WaitingRoomSettings{}, err
}
var r WaitingRoomSettingsResponse
err = json.Unmarshal(res, &r)
if err != nil {
return WaitingRoomSettings{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}
type UpdateWaitingRoomSettingsParams struct {
SearchEngineCrawlerBypass *bool `json:"search_engine_crawler_bypass,omitempty"`
}
// UpdateWaitingRoomSettings lets you replace all zone-level Waiting Room settings. This is in contrast to
// PatchWaitingRoomSettings which lets you change individual settings.
//
// API reference: https://api.cloudflare.com/#waiting-room-update-zone-settings
func (api *API) UpdateWaitingRoomSettings(ctx context.Context, rc *ResourceContainer, params UpdateWaitingRoomSettingsParams) (WaitingRoomSettings, error) {
if rc.Level != ZoneRouteLevel {
return WaitingRoomSettings{}, fmt.Errorf(errInvalidResourceContainerAccess, rc.Level)
}
uri := fmt.Sprintf("/zones/%s/waiting_rooms/settings", rc.Identifier)
res, err := api.makeRequestContext(ctx, http.MethodPut, uri, params)
if err != nil {
return WaitingRoomSettings{}, err
}
var r WaitingRoomSettingsResponse
err = json.Unmarshal(res, &r)
if err != nil {
return WaitingRoomSettings{}, fmt.Errorf("%s: %w", errUnmarshalError, err)
}
return r.Result, nil
}