/
emailroutingtimeseriesgroup.go
1516 lines (1293 loc) · 72.3 KB
/
emailroutingtimeseriesgroup.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
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package radar
import (
"context"
"net/http"
"net/url"
"time"
"github.com/cloudflare/cloudflare-go/v2/internal/apijson"
"github.com/cloudflare/cloudflare-go/v2/internal/apiquery"
"github.com/cloudflare/cloudflare-go/v2/internal/param"
"github.com/cloudflare/cloudflare-go/v2/internal/requestconfig"
"github.com/cloudflare/cloudflare-go/v2/option"
)
// EmailRoutingTimeseriesGroupService contains methods and other services that help
// with interacting with the cloudflare API. Note, unlike clients, this service
// does not read variables from the environment automatically. You should not
// instantiate this service directly, and instead use the
// [NewEmailRoutingTimeseriesGroupService] method instead.
type EmailRoutingTimeseriesGroupService struct {
Options []option.RequestOption
}
// NewEmailRoutingTimeseriesGroupService generates a new service that applies the
// given options to each request. These options are applied after the parent
// client's options (if there is one), and before any request-specific options.
func NewEmailRoutingTimeseriesGroupService(opts ...option.RequestOption) (r *EmailRoutingTimeseriesGroupService) {
r = &EmailRoutingTimeseriesGroupService{}
r.Options = opts
return
}
// Percentage distribution of emails classified per Arc validation over time.
func (r *EmailRoutingTimeseriesGroupService) ARC(ctx context.Context, query EmailRoutingTimeseriesGroupARCParams, opts ...option.RequestOption) (res *EmailRoutingTimeseriesGroupARCResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailRoutingTimeseriesGroupARCResponseEnvelope
path := "radar/email/routing/timeseries_groups/arc"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Percentage distribution of emails classified per DKIM validation over time.
func (r *EmailRoutingTimeseriesGroupService) DKIM(ctx context.Context, query EmailRoutingTimeseriesGroupDKIMParams, opts ...option.RequestOption) (res *EmailRoutingTimeseriesGroupDKIMResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailRoutingTimeseriesGroupDKIMResponseEnvelope
path := "radar/email/routing/timeseries_groups/dkim"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Percentage distribution of emails classified per DMARC validation over time.
func (r *EmailRoutingTimeseriesGroupService) DMARC(ctx context.Context, query EmailRoutingTimeseriesGroupDMARCParams, opts ...option.RequestOption) (res *EmailRoutingTimeseriesGroupDMARCResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailRoutingTimeseriesGroupDMARCResponseEnvelope
path := "radar/email/routing/timeseries_groups/dmarc"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Percentage distribution of emails by Encrypted over time.
func (r *EmailRoutingTimeseriesGroupService) Encrypted(ctx context.Context, query EmailRoutingTimeseriesGroupEncryptedParams, opts ...option.RequestOption) (res *EmailRoutingTimeseriesGroupEncryptedResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailRoutingTimeseriesGroupEncryptedResponseEnvelope
path := "radar/email/routing/timeseries_groups/encrypted"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Percentage distribution of emails by Ip Version over time.
func (r *EmailRoutingTimeseriesGroupService) IPVersion(ctx context.Context, query EmailRoutingTimeseriesGroupIPVersionParams, opts ...option.RequestOption) (res *EmailRoutingTimeseriesGroupIPVersionResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailRoutingTimeseriesGroupIPVersionResponseEnvelope
path := "radar/email/routing/timeseries_groups/ip_version"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Percentage distribution of emails classified per SPF validation over time.
func (r *EmailRoutingTimeseriesGroupService) SPF(ctx context.Context, query EmailRoutingTimeseriesGroupSPFParams, opts ...option.RequestOption) (res *EmailRoutingTimeseriesGroupSPFResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailRoutingTimeseriesGroupSPFResponseEnvelope
path := "radar/email/routing/timeseries_groups/spf"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
type EmailRoutingTimeseriesGroupARCResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 RadarEmailSeries `json:"serie_0,required"`
JSON emailRoutingTimeseriesGroupARCResponseJSON `json:"-"`
}
// emailRoutingTimeseriesGroupARCResponseJSON contains the JSON metadata for the
// struct [EmailRoutingTimeseriesGroupARCResponse]
type emailRoutingTimeseriesGroupARCResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailRoutingTimeseriesGroupARCResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailRoutingTimeseriesGroupARCResponseJSON) RawJSON() string {
return r.raw
}
type EmailRoutingTimeseriesGroupDKIMResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 RadarEmailSeries `json:"serie_0,required"`
JSON emailRoutingTimeseriesGroupDKIMResponseJSON `json:"-"`
}
// emailRoutingTimeseriesGroupDKIMResponseJSON contains the JSON metadata for the
// struct [EmailRoutingTimeseriesGroupDKIMResponse]
type emailRoutingTimeseriesGroupDKIMResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailRoutingTimeseriesGroupDKIMResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailRoutingTimeseriesGroupDKIMResponseJSON) RawJSON() string {
return r.raw
}
type EmailRoutingTimeseriesGroupDMARCResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 RadarEmailSeries `json:"serie_0,required"`
JSON emailRoutingTimeseriesGroupDMARCResponseJSON `json:"-"`
}
// emailRoutingTimeseriesGroupDMARCResponseJSON contains the JSON metadata for the
// struct [EmailRoutingTimeseriesGroupDMARCResponse]
type emailRoutingTimeseriesGroupDMARCResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailRoutingTimeseriesGroupDMARCResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailRoutingTimeseriesGroupDMARCResponseJSON) RawJSON() string {
return r.raw
}
type EmailRoutingTimeseriesGroupEncryptedResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 EmailRoutingTimeseriesGroupEncryptedResponseSerie0 `json:"serie_0,required"`
JSON emailRoutingTimeseriesGroupEncryptedResponseJSON `json:"-"`
}
// emailRoutingTimeseriesGroupEncryptedResponseJSON contains the JSON metadata for
// the struct [EmailRoutingTimeseriesGroupEncryptedResponse]
type emailRoutingTimeseriesGroupEncryptedResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailRoutingTimeseriesGroupEncryptedResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailRoutingTimeseriesGroupEncryptedResponseJSON) RawJSON() string {
return r.raw
}
type EmailRoutingTimeseriesGroupEncryptedResponseSerie0 struct {
Encrypted []string `json:"ENCRYPTED,required"`
NotEncrypted []string `json:"NOT_ENCRYPTED,required"`
JSON emailRoutingTimeseriesGroupEncryptedResponseSerie0JSON `json:"-"`
}
// emailRoutingTimeseriesGroupEncryptedResponseSerie0JSON contains the JSON
// metadata for the struct [EmailRoutingTimeseriesGroupEncryptedResponseSerie0]
type emailRoutingTimeseriesGroupEncryptedResponseSerie0JSON struct {
Encrypted apijson.Field
NotEncrypted apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailRoutingTimeseriesGroupEncryptedResponseSerie0) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailRoutingTimeseriesGroupEncryptedResponseSerie0JSON) RawJSON() string {
return r.raw
}
type EmailRoutingTimeseriesGroupIPVersionResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 EmailRoutingTimeseriesGroupIPVersionResponseSerie0 `json:"serie_0,required"`
JSON emailRoutingTimeseriesGroupIPVersionResponseJSON `json:"-"`
}
// emailRoutingTimeseriesGroupIPVersionResponseJSON contains the JSON metadata for
// the struct [EmailRoutingTimeseriesGroupIPVersionResponse]
type emailRoutingTimeseriesGroupIPVersionResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailRoutingTimeseriesGroupIPVersionResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailRoutingTimeseriesGroupIPVersionResponseJSON) RawJSON() string {
return r.raw
}
type EmailRoutingTimeseriesGroupIPVersionResponseSerie0 struct {
IPv4 []string `json:"IPv4,required"`
IPv6 []string `json:"IPv6,required"`
JSON emailRoutingTimeseriesGroupIPVersionResponseSerie0JSON `json:"-"`
}
// emailRoutingTimeseriesGroupIPVersionResponseSerie0JSON contains the JSON
// metadata for the struct [EmailRoutingTimeseriesGroupIPVersionResponseSerie0]
type emailRoutingTimeseriesGroupIPVersionResponseSerie0JSON struct {
IPv4 apijson.Field
IPv6 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailRoutingTimeseriesGroupIPVersionResponseSerie0) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailRoutingTimeseriesGroupIPVersionResponseSerie0JSON) RawJSON() string {
return r.raw
}
type EmailRoutingTimeseriesGroupSPFResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 RadarEmailSeries `json:"serie_0,required"`
JSON emailRoutingTimeseriesGroupSPFResponseJSON `json:"-"`
}
// emailRoutingTimeseriesGroupSPFResponseJSON contains the JSON metadata for the
// struct [EmailRoutingTimeseriesGroupSPFResponse]
type emailRoutingTimeseriesGroupSPFResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailRoutingTimeseriesGroupSPFResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailRoutingTimeseriesGroupSPFResponseJSON) RawJSON() string {
return r.raw
}
type EmailRoutingTimeseriesGroupARCParams struct {
// Aggregation interval results should be returned in (for example, in 15 minutes
// or 1 hour intervals). Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[EmailRoutingTimeseriesGroupARCParamsAggInterval] `query:"aggInterval"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// For example, use `7d` and `7dControl` to compare this week with the previous
// week. Use this parameter or set specific start and end dates (`dateStart` and
// `dateEnd` parameters).
DateRange param.Field[[]EmailRoutingTimeseriesGroupARCParamsDateRange] `query:"dateRange"`
// Array of datetimes to filter the start of a series.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filter for dkim.
DKIM param.Field[[]EmailRoutingTimeseriesGroupARCParamsDKIM] `query:"dkim"`
// Filter for dmarc.
DMARC param.Field[[]EmailRoutingTimeseriesGroupARCParamsDMARC] `query:"dmarc"`
// Filter for encrypted emails.
Encrypted param.Field[[]EmailRoutingTimeseriesGroupARCParamsEncrypted] `query:"encrypted"`
// Format results are returned in.
Format param.Field[EmailRoutingTimeseriesGroupARCParamsFormat] `query:"format"`
// Filter for ip version.
IPVersion param.Field[[]EmailRoutingTimeseriesGroupARCParamsIPVersion] `query:"ipVersion"`
// Array of names that will be used to name the series in responses.
Name param.Field[[]string] `query:"name"`
// Filter for spf.
SPF param.Field[[]EmailRoutingTimeseriesGroupARCParamsSPF] `query:"spf"`
}
// URLQuery serializes [EmailRoutingTimeseriesGroupARCParams]'s query parameters as
// `url.Values`.
func (r EmailRoutingTimeseriesGroupARCParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// Aggregation interval results should be returned in (for example, in 15 minutes
// or 1 hour intervals). Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
type EmailRoutingTimeseriesGroupARCParamsAggInterval string
const (
EmailRoutingTimeseriesGroupARCParamsAggInterval15m EmailRoutingTimeseriesGroupARCParamsAggInterval = "15m"
EmailRoutingTimeseriesGroupARCParamsAggInterval1h EmailRoutingTimeseriesGroupARCParamsAggInterval = "1h"
EmailRoutingTimeseriesGroupARCParamsAggInterval1d EmailRoutingTimeseriesGroupARCParamsAggInterval = "1d"
EmailRoutingTimeseriesGroupARCParamsAggInterval1w EmailRoutingTimeseriesGroupARCParamsAggInterval = "1w"
)
func (r EmailRoutingTimeseriesGroupARCParamsAggInterval) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupARCParamsAggInterval15m, EmailRoutingTimeseriesGroupARCParamsAggInterval1h, EmailRoutingTimeseriesGroupARCParamsAggInterval1d, EmailRoutingTimeseriesGroupARCParamsAggInterval1w:
return true
}
return false
}
type EmailRoutingTimeseriesGroupARCParamsDateRange string
const (
EmailRoutingTimeseriesGroupARCParamsDateRange1d EmailRoutingTimeseriesGroupARCParamsDateRange = "1d"
EmailRoutingTimeseriesGroupARCParamsDateRange2d EmailRoutingTimeseriesGroupARCParamsDateRange = "2d"
EmailRoutingTimeseriesGroupARCParamsDateRange7d EmailRoutingTimeseriesGroupARCParamsDateRange = "7d"
EmailRoutingTimeseriesGroupARCParamsDateRange14d EmailRoutingTimeseriesGroupARCParamsDateRange = "14d"
EmailRoutingTimeseriesGroupARCParamsDateRange28d EmailRoutingTimeseriesGroupARCParamsDateRange = "28d"
EmailRoutingTimeseriesGroupARCParamsDateRange12w EmailRoutingTimeseriesGroupARCParamsDateRange = "12w"
EmailRoutingTimeseriesGroupARCParamsDateRange24w EmailRoutingTimeseriesGroupARCParamsDateRange = "24w"
EmailRoutingTimeseriesGroupARCParamsDateRange52w EmailRoutingTimeseriesGroupARCParamsDateRange = "52w"
EmailRoutingTimeseriesGroupARCParamsDateRange1dControl EmailRoutingTimeseriesGroupARCParamsDateRange = "1dControl"
EmailRoutingTimeseriesGroupARCParamsDateRange2dControl EmailRoutingTimeseriesGroupARCParamsDateRange = "2dControl"
EmailRoutingTimeseriesGroupARCParamsDateRange7dControl EmailRoutingTimeseriesGroupARCParamsDateRange = "7dControl"
EmailRoutingTimeseriesGroupARCParamsDateRange14dControl EmailRoutingTimeseriesGroupARCParamsDateRange = "14dControl"
EmailRoutingTimeseriesGroupARCParamsDateRange28dControl EmailRoutingTimeseriesGroupARCParamsDateRange = "28dControl"
EmailRoutingTimeseriesGroupARCParamsDateRange12wControl EmailRoutingTimeseriesGroupARCParamsDateRange = "12wControl"
EmailRoutingTimeseriesGroupARCParamsDateRange24wControl EmailRoutingTimeseriesGroupARCParamsDateRange = "24wControl"
)
func (r EmailRoutingTimeseriesGroupARCParamsDateRange) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupARCParamsDateRange1d, EmailRoutingTimeseriesGroupARCParamsDateRange2d, EmailRoutingTimeseriesGroupARCParamsDateRange7d, EmailRoutingTimeseriesGroupARCParamsDateRange14d, EmailRoutingTimeseriesGroupARCParamsDateRange28d, EmailRoutingTimeseriesGroupARCParamsDateRange12w, EmailRoutingTimeseriesGroupARCParamsDateRange24w, EmailRoutingTimeseriesGroupARCParamsDateRange52w, EmailRoutingTimeseriesGroupARCParamsDateRange1dControl, EmailRoutingTimeseriesGroupARCParamsDateRange2dControl, EmailRoutingTimeseriesGroupARCParamsDateRange7dControl, EmailRoutingTimeseriesGroupARCParamsDateRange14dControl, EmailRoutingTimeseriesGroupARCParamsDateRange28dControl, EmailRoutingTimeseriesGroupARCParamsDateRange12wControl, EmailRoutingTimeseriesGroupARCParamsDateRange24wControl:
return true
}
return false
}
type EmailRoutingTimeseriesGroupARCParamsDKIM string
const (
EmailRoutingTimeseriesGroupARCParamsDKIMPass EmailRoutingTimeseriesGroupARCParamsDKIM = "PASS"
EmailRoutingTimeseriesGroupARCParamsDKIMNone EmailRoutingTimeseriesGroupARCParamsDKIM = "NONE"
EmailRoutingTimeseriesGroupARCParamsDKIMFail EmailRoutingTimeseriesGroupARCParamsDKIM = "FAIL"
)
func (r EmailRoutingTimeseriesGroupARCParamsDKIM) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupARCParamsDKIMPass, EmailRoutingTimeseriesGroupARCParamsDKIMNone, EmailRoutingTimeseriesGroupARCParamsDKIMFail:
return true
}
return false
}
type EmailRoutingTimeseriesGroupARCParamsDMARC string
const (
EmailRoutingTimeseriesGroupARCParamsDMARCPass EmailRoutingTimeseriesGroupARCParamsDMARC = "PASS"
EmailRoutingTimeseriesGroupARCParamsDMARCNone EmailRoutingTimeseriesGroupARCParamsDMARC = "NONE"
EmailRoutingTimeseriesGroupARCParamsDMARCFail EmailRoutingTimeseriesGroupARCParamsDMARC = "FAIL"
)
func (r EmailRoutingTimeseriesGroupARCParamsDMARC) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupARCParamsDMARCPass, EmailRoutingTimeseriesGroupARCParamsDMARCNone, EmailRoutingTimeseriesGroupARCParamsDMARCFail:
return true
}
return false
}
type EmailRoutingTimeseriesGroupARCParamsEncrypted string
const (
EmailRoutingTimeseriesGroupARCParamsEncryptedEncrypted EmailRoutingTimeseriesGroupARCParamsEncrypted = "ENCRYPTED"
EmailRoutingTimeseriesGroupARCParamsEncryptedNotEncrypted EmailRoutingTimeseriesGroupARCParamsEncrypted = "NOT_ENCRYPTED"
)
func (r EmailRoutingTimeseriesGroupARCParamsEncrypted) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupARCParamsEncryptedEncrypted, EmailRoutingTimeseriesGroupARCParamsEncryptedNotEncrypted:
return true
}
return false
}
// Format results are returned in.
type EmailRoutingTimeseriesGroupARCParamsFormat string
const (
EmailRoutingTimeseriesGroupARCParamsFormatJson EmailRoutingTimeseriesGroupARCParamsFormat = "JSON"
EmailRoutingTimeseriesGroupARCParamsFormatCsv EmailRoutingTimeseriesGroupARCParamsFormat = "CSV"
)
func (r EmailRoutingTimeseriesGroupARCParamsFormat) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupARCParamsFormatJson, EmailRoutingTimeseriesGroupARCParamsFormatCsv:
return true
}
return false
}
type EmailRoutingTimeseriesGroupARCParamsIPVersion string
const (
EmailRoutingTimeseriesGroupARCParamsIPVersionIPv4 EmailRoutingTimeseriesGroupARCParamsIPVersion = "IPv4"
EmailRoutingTimeseriesGroupARCParamsIPVersionIPv6 EmailRoutingTimeseriesGroupARCParamsIPVersion = "IPv6"
)
func (r EmailRoutingTimeseriesGroupARCParamsIPVersion) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupARCParamsIPVersionIPv4, EmailRoutingTimeseriesGroupARCParamsIPVersionIPv6:
return true
}
return false
}
type EmailRoutingTimeseriesGroupARCParamsSPF string
const (
EmailRoutingTimeseriesGroupARCParamsSPFPass EmailRoutingTimeseriesGroupARCParamsSPF = "PASS"
EmailRoutingTimeseriesGroupARCParamsSPFNone EmailRoutingTimeseriesGroupARCParamsSPF = "NONE"
EmailRoutingTimeseriesGroupARCParamsSPFFail EmailRoutingTimeseriesGroupARCParamsSPF = "FAIL"
)
func (r EmailRoutingTimeseriesGroupARCParamsSPF) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupARCParamsSPFPass, EmailRoutingTimeseriesGroupARCParamsSPFNone, EmailRoutingTimeseriesGroupARCParamsSPFFail:
return true
}
return false
}
type EmailRoutingTimeseriesGroupARCResponseEnvelope struct {
Result EmailRoutingTimeseriesGroupARCResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON emailRoutingTimeseriesGroupARCResponseEnvelopeJSON `json:"-"`
}
// emailRoutingTimeseriesGroupARCResponseEnvelopeJSON contains the JSON metadata
// for the struct [EmailRoutingTimeseriesGroupARCResponseEnvelope]
type emailRoutingTimeseriesGroupARCResponseEnvelopeJSON struct {
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailRoutingTimeseriesGroupARCResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailRoutingTimeseriesGroupARCResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
type EmailRoutingTimeseriesGroupDKIMParams struct {
// Aggregation interval results should be returned in (for example, in 15 minutes
// or 1 hour intervals). Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[EmailRoutingTimeseriesGroupDKIMParamsAggInterval] `query:"aggInterval"`
// Filter for arc (Authenticated Received Chain).
ARC param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// For example, use `7d` and `7dControl` to compare this week with the previous
// week. Use this parameter or set specific start and end dates (`dateStart` and
// `dateEnd` parameters).
DateRange param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsDateRange] `query:"dateRange"`
// Array of datetimes to filter the start of a series.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filter for dmarc.
DMARC param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsDMARC] `query:"dmarc"`
// Filter for encrypted emails.
Encrypted param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsEncrypted] `query:"encrypted"`
// Format results are returned in.
Format param.Field[EmailRoutingTimeseriesGroupDKIMParamsFormat] `query:"format"`
// Filter for ip version.
IPVersion param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsIPVersion] `query:"ipVersion"`
// Array of names that will be used to name the series in responses.
Name param.Field[[]string] `query:"name"`
// Filter for spf.
SPF param.Field[[]EmailRoutingTimeseriesGroupDKIMParamsSPF] `query:"spf"`
}
// URLQuery serializes [EmailRoutingTimeseriesGroupDKIMParams]'s query parameters
// as `url.Values`.
func (r EmailRoutingTimeseriesGroupDKIMParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// Aggregation interval results should be returned in (for example, in 15 minutes
// or 1 hour intervals). Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
type EmailRoutingTimeseriesGroupDKIMParamsAggInterval string
const (
EmailRoutingTimeseriesGroupDKIMParamsAggInterval15m EmailRoutingTimeseriesGroupDKIMParamsAggInterval = "15m"
EmailRoutingTimeseriesGroupDKIMParamsAggInterval1h EmailRoutingTimeseriesGroupDKIMParamsAggInterval = "1h"
EmailRoutingTimeseriesGroupDKIMParamsAggInterval1d EmailRoutingTimeseriesGroupDKIMParamsAggInterval = "1d"
EmailRoutingTimeseriesGroupDKIMParamsAggInterval1w EmailRoutingTimeseriesGroupDKIMParamsAggInterval = "1w"
)
func (r EmailRoutingTimeseriesGroupDKIMParamsAggInterval) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDKIMParamsAggInterval15m, EmailRoutingTimeseriesGroupDKIMParamsAggInterval1h, EmailRoutingTimeseriesGroupDKIMParamsAggInterval1d, EmailRoutingTimeseriesGroupDKIMParamsAggInterval1w:
return true
}
return false
}
type EmailRoutingTimeseriesGroupDKIMParamsARC string
const (
EmailRoutingTimeseriesGroupDKIMParamsARCPass EmailRoutingTimeseriesGroupDKIMParamsARC = "PASS"
EmailRoutingTimeseriesGroupDKIMParamsARCNone EmailRoutingTimeseriesGroupDKIMParamsARC = "NONE"
EmailRoutingTimeseriesGroupDKIMParamsARCFail EmailRoutingTimeseriesGroupDKIMParamsARC = "FAIL"
)
func (r EmailRoutingTimeseriesGroupDKIMParamsARC) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDKIMParamsARCPass, EmailRoutingTimeseriesGroupDKIMParamsARCNone, EmailRoutingTimeseriesGroupDKIMParamsARCFail:
return true
}
return false
}
type EmailRoutingTimeseriesGroupDKIMParamsDateRange string
const (
EmailRoutingTimeseriesGroupDKIMParamsDateRange1d EmailRoutingTimeseriesGroupDKIMParamsDateRange = "1d"
EmailRoutingTimeseriesGroupDKIMParamsDateRange2d EmailRoutingTimeseriesGroupDKIMParamsDateRange = "2d"
EmailRoutingTimeseriesGroupDKIMParamsDateRange7d EmailRoutingTimeseriesGroupDKIMParamsDateRange = "7d"
EmailRoutingTimeseriesGroupDKIMParamsDateRange14d EmailRoutingTimeseriesGroupDKIMParamsDateRange = "14d"
EmailRoutingTimeseriesGroupDKIMParamsDateRange28d EmailRoutingTimeseriesGroupDKIMParamsDateRange = "28d"
EmailRoutingTimeseriesGroupDKIMParamsDateRange12w EmailRoutingTimeseriesGroupDKIMParamsDateRange = "12w"
EmailRoutingTimeseriesGroupDKIMParamsDateRange24w EmailRoutingTimeseriesGroupDKIMParamsDateRange = "24w"
EmailRoutingTimeseriesGroupDKIMParamsDateRange52w EmailRoutingTimeseriesGroupDKIMParamsDateRange = "52w"
EmailRoutingTimeseriesGroupDKIMParamsDateRange1dControl EmailRoutingTimeseriesGroupDKIMParamsDateRange = "1dControl"
EmailRoutingTimeseriesGroupDKIMParamsDateRange2dControl EmailRoutingTimeseriesGroupDKIMParamsDateRange = "2dControl"
EmailRoutingTimeseriesGroupDKIMParamsDateRange7dControl EmailRoutingTimeseriesGroupDKIMParamsDateRange = "7dControl"
EmailRoutingTimeseriesGroupDKIMParamsDateRange14dControl EmailRoutingTimeseriesGroupDKIMParamsDateRange = "14dControl"
EmailRoutingTimeseriesGroupDKIMParamsDateRange28dControl EmailRoutingTimeseriesGroupDKIMParamsDateRange = "28dControl"
EmailRoutingTimeseriesGroupDKIMParamsDateRange12wControl EmailRoutingTimeseriesGroupDKIMParamsDateRange = "12wControl"
EmailRoutingTimeseriesGroupDKIMParamsDateRange24wControl EmailRoutingTimeseriesGroupDKIMParamsDateRange = "24wControl"
)
func (r EmailRoutingTimeseriesGroupDKIMParamsDateRange) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDKIMParamsDateRange1d, EmailRoutingTimeseriesGroupDKIMParamsDateRange2d, EmailRoutingTimeseriesGroupDKIMParamsDateRange7d, EmailRoutingTimeseriesGroupDKIMParamsDateRange14d, EmailRoutingTimeseriesGroupDKIMParamsDateRange28d, EmailRoutingTimeseriesGroupDKIMParamsDateRange12w, EmailRoutingTimeseriesGroupDKIMParamsDateRange24w, EmailRoutingTimeseriesGroupDKIMParamsDateRange52w, EmailRoutingTimeseriesGroupDKIMParamsDateRange1dControl, EmailRoutingTimeseriesGroupDKIMParamsDateRange2dControl, EmailRoutingTimeseriesGroupDKIMParamsDateRange7dControl, EmailRoutingTimeseriesGroupDKIMParamsDateRange14dControl, EmailRoutingTimeseriesGroupDKIMParamsDateRange28dControl, EmailRoutingTimeseriesGroupDKIMParamsDateRange12wControl, EmailRoutingTimeseriesGroupDKIMParamsDateRange24wControl:
return true
}
return false
}
type EmailRoutingTimeseriesGroupDKIMParamsDMARC string
const (
EmailRoutingTimeseriesGroupDKIMParamsDMARCPass EmailRoutingTimeseriesGroupDKIMParamsDMARC = "PASS"
EmailRoutingTimeseriesGroupDKIMParamsDMARCNone EmailRoutingTimeseriesGroupDKIMParamsDMARC = "NONE"
EmailRoutingTimeseriesGroupDKIMParamsDMARCFail EmailRoutingTimeseriesGroupDKIMParamsDMARC = "FAIL"
)
func (r EmailRoutingTimeseriesGroupDKIMParamsDMARC) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDKIMParamsDMARCPass, EmailRoutingTimeseriesGroupDKIMParamsDMARCNone, EmailRoutingTimeseriesGroupDKIMParamsDMARCFail:
return true
}
return false
}
type EmailRoutingTimeseriesGroupDKIMParamsEncrypted string
const (
EmailRoutingTimeseriesGroupDKIMParamsEncryptedEncrypted EmailRoutingTimeseriesGroupDKIMParamsEncrypted = "ENCRYPTED"
EmailRoutingTimeseriesGroupDKIMParamsEncryptedNotEncrypted EmailRoutingTimeseriesGroupDKIMParamsEncrypted = "NOT_ENCRYPTED"
)
func (r EmailRoutingTimeseriesGroupDKIMParamsEncrypted) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDKIMParamsEncryptedEncrypted, EmailRoutingTimeseriesGroupDKIMParamsEncryptedNotEncrypted:
return true
}
return false
}
// Format results are returned in.
type EmailRoutingTimeseriesGroupDKIMParamsFormat string
const (
EmailRoutingTimeseriesGroupDKIMParamsFormatJson EmailRoutingTimeseriesGroupDKIMParamsFormat = "JSON"
EmailRoutingTimeseriesGroupDKIMParamsFormatCsv EmailRoutingTimeseriesGroupDKIMParamsFormat = "CSV"
)
func (r EmailRoutingTimeseriesGroupDKIMParamsFormat) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDKIMParamsFormatJson, EmailRoutingTimeseriesGroupDKIMParamsFormatCsv:
return true
}
return false
}
type EmailRoutingTimeseriesGroupDKIMParamsIPVersion string
const (
EmailRoutingTimeseriesGroupDKIMParamsIPVersionIPv4 EmailRoutingTimeseriesGroupDKIMParamsIPVersion = "IPv4"
EmailRoutingTimeseriesGroupDKIMParamsIPVersionIPv6 EmailRoutingTimeseriesGroupDKIMParamsIPVersion = "IPv6"
)
func (r EmailRoutingTimeseriesGroupDKIMParamsIPVersion) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDKIMParamsIPVersionIPv4, EmailRoutingTimeseriesGroupDKIMParamsIPVersionIPv6:
return true
}
return false
}
type EmailRoutingTimeseriesGroupDKIMParamsSPF string
const (
EmailRoutingTimeseriesGroupDKIMParamsSPFPass EmailRoutingTimeseriesGroupDKIMParamsSPF = "PASS"
EmailRoutingTimeseriesGroupDKIMParamsSPFNone EmailRoutingTimeseriesGroupDKIMParamsSPF = "NONE"
EmailRoutingTimeseriesGroupDKIMParamsSPFFail EmailRoutingTimeseriesGroupDKIMParamsSPF = "FAIL"
)
func (r EmailRoutingTimeseriesGroupDKIMParamsSPF) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDKIMParamsSPFPass, EmailRoutingTimeseriesGroupDKIMParamsSPFNone, EmailRoutingTimeseriesGroupDKIMParamsSPFFail:
return true
}
return false
}
type EmailRoutingTimeseriesGroupDKIMResponseEnvelope struct {
Result EmailRoutingTimeseriesGroupDKIMResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON emailRoutingTimeseriesGroupDKIMResponseEnvelopeJSON `json:"-"`
}
// emailRoutingTimeseriesGroupDKIMResponseEnvelopeJSON contains the JSON metadata
// for the struct [EmailRoutingTimeseriesGroupDKIMResponseEnvelope]
type emailRoutingTimeseriesGroupDKIMResponseEnvelopeJSON struct {
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailRoutingTimeseriesGroupDKIMResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailRoutingTimeseriesGroupDKIMResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
type EmailRoutingTimeseriesGroupDMARCParams struct {
// Aggregation interval results should be returned in (for example, in 15 minutes
// or 1 hour intervals). Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[EmailRoutingTimeseriesGroupDMARCParamsAggInterval] `query:"aggInterval"`
// Filter for arc (Authenticated Received Chain).
ARC param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// For example, use `7d` and `7dControl` to compare this week with the previous
// week. Use this parameter or set specific start and end dates (`dateStart` and
// `dateEnd` parameters).
DateRange param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsDateRange] `query:"dateRange"`
// Array of datetimes to filter the start of a series.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filter for dkim.
DKIM param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsDKIM] `query:"dkim"`
// Filter for encrypted emails.
Encrypted param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsEncrypted] `query:"encrypted"`
// Format results are returned in.
Format param.Field[EmailRoutingTimeseriesGroupDMARCParamsFormat] `query:"format"`
// Filter for ip version.
IPVersion param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsIPVersion] `query:"ipVersion"`
// Array of names that will be used to name the series in responses.
Name param.Field[[]string] `query:"name"`
// Filter for spf.
SPF param.Field[[]EmailRoutingTimeseriesGroupDMARCParamsSPF] `query:"spf"`
}
// URLQuery serializes [EmailRoutingTimeseriesGroupDMARCParams]'s query parameters
// as `url.Values`.
func (r EmailRoutingTimeseriesGroupDMARCParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// Aggregation interval results should be returned in (for example, in 15 minutes
// or 1 hour intervals). Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
type EmailRoutingTimeseriesGroupDMARCParamsAggInterval string
const (
EmailRoutingTimeseriesGroupDMARCParamsAggInterval15m EmailRoutingTimeseriesGroupDMARCParamsAggInterval = "15m"
EmailRoutingTimeseriesGroupDMARCParamsAggInterval1h EmailRoutingTimeseriesGroupDMARCParamsAggInterval = "1h"
EmailRoutingTimeseriesGroupDMARCParamsAggInterval1d EmailRoutingTimeseriesGroupDMARCParamsAggInterval = "1d"
EmailRoutingTimeseriesGroupDMARCParamsAggInterval1w EmailRoutingTimeseriesGroupDMARCParamsAggInterval = "1w"
)
func (r EmailRoutingTimeseriesGroupDMARCParamsAggInterval) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDMARCParamsAggInterval15m, EmailRoutingTimeseriesGroupDMARCParamsAggInterval1h, EmailRoutingTimeseriesGroupDMARCParamsAggInterval1d, EmailRoutingTimeseriesGroupDMARCParamsAggInterval1w:
return true
}
return false
}
type EmailRoutingTimeseriesGroupDMARCParamsARC string
const (
EmailRoutingTimeseriesGroupDMARCParamsARCPass EmailRoutingTimeseriesGroupDMARCParamsARC = "PASS"
EmailRoutingTimeseriesGroupDMARCParamsARCNone EmailRoutingTimeseriesGroupDMARCParamsARC = "NONE"
EmailRoutingTimeseriesGroupDMARCParamsARCFail EmailRoutingTimeseriesGroupDMARCParamsARC = "FAIL"
)
func (r EmailRoutingTimeseriesGroupDMARCParamsARC) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDMARCParamsARCPass, EmailRoutingTimeseriesGroupDMARCParamsARCNone, EmailRoutingTimeseriesGroupDMARCParamsARCFail:
return true
}
return false
}
type EmailRoutingTimeseriesGroupDMARCParamsDateRange string
const (
EmailRoutingTimeseriesGroupDMARCParamsDateRange1d EmailRoutingTimeseriesGroupDMARCParamsDateRange = "1d"
EmailRoutingTimeseriesGroupDMARCParamsDateRange2d EmailRoutingTimeseriesGroupDMARCParamsDateRange = "2d"
EmailRoutingTimeseriesGroupDMARCParamsDateRange7d EmailRoutingTimeseriesGroupDMARCParamsDateRange = "7d"
EmailRoutingTimeseriesGroupDMARCParamsDateRange14d EmailRoutingTimeseriesGroupDMARCParamsDateRange = "14d"
EmailRoutingTimeseriesGroupDMARCParamsDateRange28d EmailRoutingTimeseriesGroupDMARCParamsDateRange = "28d"
EmailRoutingTimeseriesGroupDMARCParamsDateRange12w EmailRoutingTimeseriesGroupDMARCParamsDateRange = "12w"
EmailRoutingTimeseriesGroupDMARCParamsDateRange24w EmailRoutingTimeseriesGroupDMARCParamsDateRange = "24w"
EmailRoutingTimeseriesGroupDMARCParamsDateRange52w EmailRoutingTimeseriesGroupDMARCParamsDateRange = "52w"
EmailRoutingTimeseriesGroupDMARCParamsDateRange1dControl EmailRoutingTimeseriesGroupDMARCParamsDateRange = "1dControl"
EmailRoutingTimeseriesGroupDMARCParamsDateRange2dControl EmailRoutingTimeseriesGroupDMARCParamsDateRange = "2dControl"
EmailRoutingTimeseriesGroupDMARCParamsDateRange7dControl EmailRoutingTimeseriesGroupDMARCParamsDateRange = "7dControl"
EmailRoutingTimeseriesGroupDMARCParamsDateRange14dControl EmailRoutingTimeseriesGroupDMARCParamsDateRange = "14dControl"
EmailRoutingTimeseriesGroupDMARCParamsDateRange28dControl EmailRoutingTimeseriesGroupDMARCParamsDateRange = "28dControl"
EmailRoutingTimeseriesGroupDMARCParamsDateRange12wControl EmailRoutingTimeseriesGroupDMARCParamsDateRange = "12wControl"
EmailRoutingTimeseriesGroupDMARCParamsDateRange24wControl EmailRoutingTimeseriesGroupDMARCParamsDateRange = "24wControl"
)
func (r EmailRoutingTimeseriesGroupDMARCParamsDateRange) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDMARCParamsDateRange1d, EmailRoutingTimeseriesGroupDMARCParamsDateRange2d, EmailRoutingTimeseriesGroupDMARCParamsDateRange7d, EmailRoutingTimeseriesGroupDMARCParamsDateRange14d, EmailRoutingTimeseriesGroupDMARCParamsDateRange28d, EmailRoutingTimeseriesGroupDMARCParamsDateRange12w, EmailRoutingTimeseriesGroupDMARCParamsDateRange24w, EmailRoutingTimeseriesGroupDMARCParamsDateRange52w, EmailRoutingTimeseriesGroupDMARCParamsDateRange1dControl, EmailRoutingTimeseriesGroupDMARCParamsDateRange2dControl, EmailRoutingTimeseriesGroupDMARCParamsDateRange7dControl, EmailRoutingTimeseriesGroupDMARCParamsDateRange14dControl, EmailRoutingTimeseriesGroupDMARCParamsDateRange28dControl, EmailRoutingTimeseriesGroupDMARCParamsDateRange12wControl, EmailRoutingTimeseriesGroupDMARCParamsDateRange24wControl:
return true
}
return false
}
type EmailRoutingTimeseriesGroupDMARCParamsDKIM string
const (
EmailRoutingTimeseriesGroupDMARCParamsDKIMPass EmailRoutingTimeseriesGroupDMARCParamsDKIM = "PASS"
EmailRoutingTimeseriesGroupDMARCParamsDKIMNone EmailRoutingTimeseriesGroupDMARCParamsDKIM = "NONE"
EmailRoutingTimeseriesGroupDMARCParamsDKIMFail EmailRoutingTimeseriesGroupDMARCParamsDKIM = "FAIL"
)
func (r EmailRoutingTimeseriesGroupDMARCParamsDKIM) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDMARCParamsDKIMPass, EmailRoutingTimeseriesGroupDMARCParamsDKIMNone, EmailRoutingTimeseriesGroupDMARCParamsDKIMFail:
return true
}
return false
}
type EmailRoutingTimeseriesGroupDMARCParamsEncrypted string
const (
EmailRoutingTimeseriesGroupDMARCParamsEncryptedEncrypted EmailRoutingTimeseriesGroupDMARCParamsEncrypted = "ENCRYPTED"
EmailRoutingTimeseriesGroupDMARCParamsEncryptedNotEncrypted EmailRoutingTimeseriesGroupDMARCParamsEncrypted = "NOT_ENCRYPTED"
)
func (r EmailRoutingTimeseriesGroupDMARCParamsEncrypted) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDMARCParamsEncryptedEncrypted, EmailRoutingTimeseriesGroupDMARCParamsEncryptedNotEncrypted:
return true
}
return false
}
// Format results are returned in.
type EmailRoutingTimeseriesGroupDMARCParamsFormat string
const (
EmailRoutingTimeseriesGroupDMARCParamsFormatJson EmailRoutingTimeseriesGroupDMARCParamsFormat = "JSON"
EmailRoutingTimeseriesGroupDMARCParamsFormatCsv EmailRoutingTimeseriesGroupDMARCParamsFormat = "CSV"
)
func (r EmailRoutingTimeseriesGroupDMARCParamsFormat) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDMARCParamsFormatJson, EmailRoutingTimeseriesGroupDMARCParamsFormatCsv:
return true
}
return false
}
type EmailRoutingTimeseriesGroupDMARCParamsIPVersion string
const (
EmailRoutingTimeseriesGroupDMARCParamsIPVersionIPv4 EmailRoutingTimeseriesGroupDMARCParamsIPVersion = "IPv4"
EmailRoutingTimeseriesGroupDMARCParamsIPVersionIPv6 EmailRoutingTimeseriesGroupDMARCParamsIPVersion = "IPv6"
)
func (r EmailRoutingTimeseriesGroupDMARCParamsIPVersion) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDMARCParamsIPVersionIPv4, EmailRoutingTimeseriesGroupDMARCParamsIPVersionIPv6:
return true
}
return false
}
type EmailRoutingTimeseriesGroupDMARCParamsSPF string
const (
EmailRoutingTimeseriesGroupDMARCParamsSPFPass EmailRoutingTimeseriesGroupDMARCParamsSPF = "PASS"
EmailRoutingTimeseriesGroupDMARCParamsSPFNone EmailRoutingTimeseriesGroupDMARCParamsSPF = "NONE"
EmailRoutingTimeseriesGroupDMARCParamsSPFFail EmailRoutingTimeseriesGroupDMARCParamsSPF = "FAIL"
)
func (r EmailRoutingTimeseriesGroupDMARCParamsSPF) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupDMARCParamsSPFPass, EmailRoutingTimeseriesGroupDMARCParamsSPFNone, EmailRoutingTimeseriesGroupDMARCParamsSPFFail:
return true
}
return false
}
type EmailRoutingTimeseriesGroupDMARCResponseEnvelope struct {
Result EmailRoutingTimeseriesGroupDMARCResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON emailRoutingTimeseriesGroupDMARCResponseEnvelopeJSON `json:"-"`
}
// emailRoutingTimeseriesGroupDMARCResponseEnvelopeJSON contains the JSON metadata
// for the struct [EmailRoutingTimeseriesGroupDMARCResponseEnvelope]
type emailRoutingTimeseriesGroupDMARCResponseEnvelopeJSON struct {
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailRoutingTimeseriesGroupDMARCResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailRoutingTimeseriesGroupDMARCResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
type EmailRoutingTimeseriesGroupEncryptedParams struct {
// Aggregation interval results should be returned in (for example, in 15 minutes
// or 1 hour intervals). Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
AggInterval param.Field[EmailRoutingTimeseriesGroupEncryptedParamsAggInterval] `query:"aggInterval"`
// Filter for arc (Authenticated Received Chain).
ARC param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsARC] `query:"arc"`
// End of the date range (inclusive).
DateEnd param.Field[[]time.Time] `query:"dateEnd" format:"date-time"`
// For example, use `7d` and `7dControl` to compare this week with the previous
// week. Use this parameter or set specific start and end dates (`dateStart` and
// `dateEnd` parameters).
DateRange param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsDateRange] `query:"dateRange"`
// Array of datetimes to filter the start of a series.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filter for dkim.
DKIM param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsDKIM] `query:"dkim"`
// Filter for dmarc.
DMARC param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsDMARC] `query:"dmarc"`
// Format results are returned in.
Format param.Field[EmailRoutingTimeseriesGroupEncryptedParamsFormat] `query:"format"`
// Filter for ip version.
IPVersion param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsIPVersion] `query:"ipVersion"`
// Array of names that will be used to name the series in responses.
Name param.Field[[]string] `query:"name"`
// Filter for spf.
SPF param.Field[[]EmailRoutingTimeseriesGroupEncryptedParamsSPF] `query:"spf"`
}
// URLQuery serializes [EmailRoutingTimeseriesGroupEncryptedParams]'s query
// parameters as `url.Values`.
func (r EmailRoutingTimeseriesGroupEncryptedParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// Aggregation interval results should be returned in (for example, in 15 minutes
// or 1 hour intervals). Refer to
// [Aggregation intervals](https://developers.cloudflare.com/radar/concepts/aggregation-intervals/).
type EmailRoutingTimeseriesGroupEncryptedParamsAggInterval string
const (
EmailRoutingTimeseriesGroupEncryptedParamsAggInterval15m EmailRoutingTimeseriesGroupEncryptedParamsAggInterval = "15m"
EmailRoutingTimeseriesGroupEncryptedParamsAggInterval1h EmailRoutingTimeseriesGroupEncryptedParamsAggInterval = "1h"
EmailRoutingTimeseriesGroupEncryptedParamsAggInterval1d EmailRoutingTimeseriesGroupEncryptedParamsAggInterval = "1d"
EmailRoutingTimeseriesGroupEncryptedParamsAggInterval1w EmailRoutingTimeseriesGroupEncryptedParamsAggInterval = "1w"
)
func (r EmailRoutingTimeseriesGroupEncryptedParamsAggInterval) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupEncryptedParamsAggInterval15m, EmailRoutingTimeseriesGroupEncryptedParamsAggInterval1h, EmailRoutingTimeseriesGroupEncryptedParamsAggInterval1d, EmailRoutingTimeseriesGroupEncryptedParamsAggInterval1w:
return true
}
return false
}
type EmailRoutingTimeseriesGroupEncryptedParamsARC string
const (
EmailRoutingTimeseriesGroupEncryptedParamsARCPass EmailRoutingTimeseriesGroupEncryptedParamsARC = "PASS"
EmailRoutingTimeseriesGroupEncryptedParamsARCNone EmailRoutingTimeseriesGroupEncryptedParamsARC = "NONE"
EmailRoutingTimeseriesGroupEncryptedParamsARCFail EmailRoutingTimeseriesGroupEncryptedParamsARC = "FAIL"
)
func (r EmailRoutingTimeseriesGroupEncryptedParamsARC) IsKnown() bool {
switch r {
case EmailRoutingTimeseriesGroupEncryptedParamsARCPass, EmailRoutingTimeseriesGroupEncryptedParamsARCNone, EmailRoutingTimeseriesGroupEncryptedParamsARCFail:
return true
}
return false
}
type EmailRoutingTimeseriesGroupEncryptedParamsDateRange string
const (
EmailRoutingTimeseriesGroupEncryptedParamsDateRange1d EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "1d"
EmailRoutingTimeseriesGroupEncryptedParamsDateRange2d EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "2d"
EmailRoutingTimeseriesGroupEncryptedParamsDateRange7d EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "7d"
EmailRoutingTimeseriesGroupEncryptedParamsDateRange14d EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "14d"
EmailRoutingTimeseriesGroupEncryptedParamsDateRange28d EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "28d"
EmailRoutingTimeseriesGroupEncryptedParamsDateRange12w EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "12w"
EmailRoutingTimeseriesGroupEncryptedParamsDateRange24w EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "24w"
EmailRoutingTimeseriesGroupEncryptedParamsDateRange52w EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "52w"
EmailRoutingTimeseriesGroupEncryptedParamsDateRange1dControl EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "1dControl"
EmailRoutingTimeseriesGroupEncryptedParamsDateRange2dControl EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "2dControl"
EmailRoutingTimeseriesGroupEncryptedParamsDateRange7dControl EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "7dControl"
EmailRoutingTimeseriesGroupEncryptedParamsDateRange14dControl EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "14dControl"
EmailRoutingTimeseriesGroupEncryptedParamsDateRange28dControl EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "28dControl"
EmailRoutingTimeseriesGroupEncryptedParamsDateRange12wControl EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "12wControl"
EmailRoutingTimeseriesGroupEncryptedParamsDateRange24wControl EmailRoutingTimeseriesGroupEncryptedParamsDateRange = "24wControl"
)