/
emailsecuritytimeseriesgroup.go
2246 lines (1921 loc) · 112 KB
/
emailsecuritytimeseriesgroup.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"
)
// EmailSecurityTimeseriesGroupService 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
// [NewEmailSecurityTimeseriesGroupService] method instead.
type EmailSecurityTimeseriesGroupService struct {
Options []option.RequestOption
}
// NewEmailSecurityTimeseriesGroupService 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 NewEmailSecurityTimeseriesGroupService(opts ...option.RequestOption) (r *EmailSecurityTimeseriesGroupService) {
r = &EmailSecurityTimeseriesGroupService{}
r.Options = opts
return
}
// Percentage distribution of emails classified per Arc validation over time.
func (r *EmailSecurityTimeseriesGroupService) ARC(ctx context.Context, query EmailSecurityTimeseriesGroupARCParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupARCResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailSecurityTimeseriesGroupARCResponseEnvelope
path := "radar/email/security/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 *EmailSecurityTimeseriesGroupService) DKIM(ctx context.Context, query EmailSecurityTimeseriesGroupDKIMParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupDKIMResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailSecurityTimeseriesGroupDKIMResponseEnvelope
path := "radar/email/security/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 *EmailSecurityTimeseriesGroupService) DMARC(ctx context.Context, query EmailSecurityTimeseriesGroupDMARCParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupDMARCResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailSecurityTimeseriesGroupDMARCResponseEnvelope
path := "radar/email/security/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 classified as MALICIOUS over time.
func (r *EmailSecurityTimeseriesGroupService) Malicious(ctx context.Context, query EmailSecurityTimeseriesGroupMaliciousParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupMaliciousResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailSecurityTimeseriesGroupMaliciousResponseEnvelope
path := "radar/email/security/timeseries_groups/malicious"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Percentage distribution of emails classified as SPAM over time.
func (r *EmailSecurityTimeseriesGroupService) Spam(ctx context.Context, query EmailSecurityTimeseriesGroupSpamParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupSpamResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailSecurityTimeseriesGroupSpamResponseEnvelope
path := "radar/email/security/timeseries_groups/spam"
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 *EmailSecurityTimeseriesGroupService) SPF(ctx context.Context, query EmailSecurityTimeseriesGroupSPFParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupSPFResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailSecurityTimeseriesGroupSPFResponseEnvelope
path := "radar/email/security/timeseries_groups/spf"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Percentage distribution of emails classified as SPOOF over time.
func (r *EmailSecurityTimeseriesGroupService) Spoof(ctx context.Context, query EmailSecurityTimeseriesGroupSpoofParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupSpoofResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailSecurityTimeseriesGroupSpoofResponseEnvelope
path := "radar/email/security/timeseries_groups/spoof"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Percentage distribution of emails classified in Threat Categories over time.
func (r *EmailSecurityTimeseriesGroupService) ThreatCategory(ctx context.Context, query EmailSecurityTimeseriesGroupThreatCategoryParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupThreatCategoryResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailSecurityTimeseriesGroupThreatCategoryResponseEnvelope
path := "radar/email/security/timeseries_groups/threat_category"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Percentage distribution of emails classified per TLS Version over time.
func (r *EmailSecurityTimeseriesGroupService) TLSVersion(ctx context.Context, query EmailSecurityTimeseriesGroupTLSVersionParams, opts ...option.RequestOption) (res *EmailSecurityTimeseriesGroupTLSVersionResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailSecurityTimeseriesGroupTLSVersionResponseEnvelope
path := "radar/email/security/timeseries_groups/tls_version"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
type EmailSecurityTimeseriesGroupARCResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 RadarEmailSeries `json:"serie_0,required"`
JSON emailSecurityTimeseriesGroupARCResponseJSON `json:"-"`
}
// emailSecurityTimeseriesGroupARCResponseJSON contains the JSON metadata for the
// struct [EmailSecurityTimeseriesGroupARCResponse]
type emailSecurityTimeseriesGroupARCResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupARCResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupARCResponseJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupDKIMResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 RadarEmailSeries `json:"serie_0,required"`
JSON emailSecurityTimeseriesGroupDKIMResponseJSON `json:"-"`
}
// emailSecurityTimeseriesGroupDKIMResponseJSON contains the JSON metadata for the
// struct [EmailSecurityTimeseriesGroupDKIMResponse]
type emailSecurityTimeseriesGroupDKIMResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupDKIMResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupDKIMResponseJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupDMARCResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 RadarEmailSeries `json:"serie_0,required"`
JSON emailSecurityTimeseriesGroupDMARCResponseJSON `json:"-"`
}
// emailSecurityTimeseriesGroupDMARCResponseJSON contains the JSON metadata for the
// struct [EmailSecurityTimeseriesGroupDMARCResponse]
type emailSecurityTimeseriesGroupDMARCResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupDMARCResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupDMARCResponseJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupMaliciousResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 EmailSecurityTimeseriesGroupMaliciousResponseSerie0 `json:"serie_0,required"`
JSON emailSecurityTimeseriesGroupMaliciousResponseJSON `json:"-"`
}
// emailSecurityTimeseriesGroupMaliciousResponseJSON contains the JSON metadata for
// the struct [EmailSecurityTimeseriesGroupMaliciousResponse]
type emailSecurityTimeseriesGroupMaliciousResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupMaliciousResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupMaliciousResponseJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupMaliciousResponseSerie0 struct {
Malicious []string `json:"MALICIOUS,required"`
NotMalicious []string `json:"NOT_MALICIOUS,required"`
JSON emailSecurityTimeseriesGroupMaliciousResponseSerie0JSON `json:"-"`
}
// emailSecurityTimeseriesGroupMaliciousResponseSerie0JSON contains the JSON
// metadata for the struct [EmailSecurityTimeseriesGroupMaliciousResponseSerie0]
type emailSecurityTimeseriesGroupMaliciousResponseSerie0JSON struct {
Malicious apijson.Field
NotMalicious apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupMaliciousResponseSerie0) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupMaliciousResponseSerie0JSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupSpamResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 EmailSecurityTimeseriesGroupSpamResponseSerie0 `json:"serie_0,required"`
JSON emailSecurityTimeseriesGroupSpamResponseJSON `json:"-"`
}
// emailSecurityTimeseriesGroupSpamResponseJSON contains the JSON metadata for the
// struct [EmailSecurityTimeseriesGroupSpamResponse]
type emailSecurityTimeseriesGroupSpamResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupSpamResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupSpamResponseJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupSpamResponseSerie0 struct {
NotSpam []string `json:"NOT_SPAM,required"`
Spam []string `json:"SPAM,required"`
JSON emailSecurityTimeseriesGroupSpamResponseSerie0JSON `json:"-"`
}
// emailSecurityTimeseriesGroupSpamResponseSerie0JSON contains the JSON metadata
// for the struct [EmailSecurityTimeseriesGroupSpamResponseSerie0]
type emailSecurityTimeseriesGroupSpamResponseSerie0JSON struct {
NotSpam apijson.Field
Spam apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupSpamResponseSerie0) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupSpamResponseSerie0JSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupSPFResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 RadarEmailSeries `json:"serie_0,required"`
JSON emailSecurityTimeseriesGroupSPFResponseJSON `json:"-"`
}
// emailSecurityTimeseriesGroupSPFResponseJSON contains the JSON metadata for the
// struct [EmailSecurityTimeseriesGroupSPFResponse]
type emailSecurityTimeseriesGroupSPFResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupSPFResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupSPFResponseJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupSpoofResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 EmailSecurityTimeseriesGroupSpoofResponseSerie0 `json:"serie_0,required"`
JSON emailSecurityTimeseriesGroupSpoofResponseJSON `json:"-"`
}
// emailSecurityTimeseriesGroupSpoofResponseJSON contains the JSON metadata for the
// struct [EmailSecurityTimeseriesGroupSpoofResponse]
type emailSecurityTimeseriesGroupSpoofResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupSpoofResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupSpoofResponseJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupSpoofResponseSerie0 struct {
NotSpoof []string `json:"NOT_SPOOF,required"`
Spoof []string `json:"SPOOF,required"`
JSON emailSecurityTimeseriesGroupSpoofResponseSerie0JSON `json:"-"`
}
// emailSecurityTimeseriesGroupSpoofResponseSerie0JSON contains the JSON metadata
// for the struct [EmailSecurityTimeseriesGroupSpoofResponseSerie0]
type emailSecurityTimeseriesGroupSpoofResponseSerie0JSON struct {
NotSpoof apijson.Field
Spoof apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupSpoofResponseSerie0) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupSpoofResponseSerie0JSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupThreatCategoryResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 EmailSecurityTimeseriesGroupThreatCategoryResponseSerie0 `json:"serie_0,required"`
JSON emailSecurityTimeseriesGroupThreatCategoryResponseJSON `json:"-"`
}
// emailSecurityTimeseriesGroupThreatCategoryResponseJSON contains the JSON
// metadata for the struct [EmailSecurityTimeseriesGroupThreatCategoryResponse]
type emailSecurityTimeseriesGroupThreatCategoryResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupThreatCategoryResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupThreatCategoryResponseJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupThreatCategoryResponseSerie0 struct {
BrandImpersonation []string `json:"BrandImpersonation,required"`
CredentialHarvester []string `json:"CredentialHarvester,required"`
IdentityDeception []string `json:"IdentityDeception,required"`
Link []string `json:"Link,required"`
JSON emailSecurityTimeseriesGroupThreatCategoryResponseSerie0JSON `json:"-"`
}
// emailSecurityTimeseriesGroupThreatCategoryResponseSerie0JSON contains the JSON
// metadata for the struct
// [EmailSecurityTimeseriesGroupThreatCategoryResponseSerie0]
type emailSecurityTimeseriesGroupThreatCategoryResponseSerie0JSON struct {
BrandImpersonation apijson.Field
CredentialHarvester apijson.Field
IdentityDeception apijson.Field
Link apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupThreatCategoryResponseSerie0) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupThreatCategoryResponseSerie0JSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupTLSVersionResponse struct {
Meta interface{} `json:"meta,required"`
Serie0 EmailSecurityTimeseriesGroupTLSVersionResponseSerie0 `json:"serie_0,required"`
JSON emailSecurityTimeseriesGroupTLSVersionResponseJSON `json:"-"`
}
// emailSecurityTimeseriesGroupTLSVersionResponseJSON contains the JSON metadata
// for the struct [EmailSecurityTimeseriesGroupTLSVersionResponse]
type emailSecurityTimeseriesGroupTLSVersionResponseJSON struct {
Meta apijson.Field
Serie0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupTLSVersionResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupTLSVersionResponseJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupTLSVersionResponseSerie0 struct {
TLS1_0 []string `json:"TLS 1.0,required"`
TLS1_1 []string `json:"TLS 1.1,required"`
TLS1_2 []string `json:"TLS 1.2,required"`
TLS1_3 []string `json:"TLS 1.3,required"`
JSON emailSecurityTimeseriesGroupTLSVersionResponseSerie0JSON `json:"-"`
}
// emailSecurityTimeseriesGroupTLSVersionResponseSerie0JSON contains the JSON
// metadata for the struct [EmailSecurityTimeseriesGroupTLSVersionResponseSerie0]
type emailSecurityTimeseriesGroupTLSVersionResponseSerie0JSON struct {
TLS1_0 apijson.Field
TLS1_1 apijson.Field
TLS1_2 apijson.Field
TLS1_3 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupTLSVersionResponseSerie0) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupTLSVersionResponseSerie0JSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupARCParams 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[EmailSecurityTimeseriesGroupARCParamsAggInterval] `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[[]EmailSecurityTimeseriesGroupARCParamsDateRange] `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[[]EmailSecurityTimeseriesGroupARCParamsDKIM] `query:"dkim"`
// Filter for dmarc.
DMARC param.Field[[]EmailSecurityTimeseriesGroupARCParamsDMARC] `query:"dmarc"`
// Format results are returned in.
Format param.Field[EmailSecurityTimeseriesGroupARCParamsFormat] `query:"format"`
// 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[[]EmailSecurityTimeseriesGroupARCParamsSPF] `query:"spf"`
// Filter for tls version.
TLSVersion param.Field[[]EmailSecurityTimeseriesGroupARCParamsTLSVersion] `query:"tlsVersion"`
}
// URLQuery serializes [EmailSecurityTimeseriesGroupARCParams]'s query parameters
// as `url.Values`.
func (r EmailSecurityTimeseriesGroupARCParams) 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 EmailSecurityTimeseriesGroupARCParamsAggInterval string
const (
EmailSecurityTimeseriesGroupARCParamsAggInterval15m EmailSecurityTimeseriesGroupARCParamsAggInterval = "15m"
EmailSecurityTimeseriesGroupARCParamsAggInterval1h EmailSecurityTimeseriesGroupARCParamsAggInterval = "1h"
EmailSecurityTimeseriesGroupARCParamsAggInterval1d EmailSecurityTimeseriesGroupARCParamsAggInterval = "1d"
EmailSecurityTimeseriesGroupARCParamsAggInterval1w EmailSecurityTimeseriesGroupARCParamsAggInterval = "1w"
)
func (r EmailSecurityTimeseriesGroupARCParamsAggInterval) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupARCParamsAggInterval15m, EmailSecurityTimeseriesGroupARCParamsAggInterval1h, EmailSecurityTimeseriesGroupARCParamsAggInterval1d, EmailSecurityTimeseriesGroupARCParamsAggInterval1w:
return true
}
return false
}
type EmailSecurityTimeseriesGroupARCParamsDateRange string
const (
EmailSecurityTimeseriesGroupARCParamsDateRange1d EmailSecurityTimeseriesGroupARCParamsDateRange = "1d"
EmailSecurityTimeseriesGroupARCParamsDateRange2d EmailSecurityTimeseriesGroupARCParamsDateRange = "2d"
EmailSecurityTimeseriesGroupARCParamsDateRange7d EmailSecurityTimeseriesGroupARCParamsDateRange = "7d"
EmailSecurityTimeseriesGroupARCParamsDateRange14d EmailSecurityTimeseriesGroupARCParamsDateRange = "14d"
EmailSecurityTimeseriesGroupARCParamsDateRange28d EmailSecurityTimeseriesGroupARCParamsDateRange = "28d"
EmailSecurityTimeseriesGroupARCParamsDateRange12w EmailSecurityTimeseriesGroupARCParamsDateRange = "12w"
EmailSecurityTimeseriesGroupARCParamsDateRange24w EmailSecurityTimeseriesGroupARCParamsDateRange = "24w"
EmailSecurityTimeseriesGroupARCParamsDateRange52w EmailSecurityTimeseriesGroupARCParamsDateRange = "52w"
EmailSecurityTimeseriesGroupARCParamsDateRange1dControl EmailSecurityTimeseriesGroupARCParamsDateRange = "1dControl"
EmailSecurityTimeseriesGroupARCParamsDateRange2dControl EmailSecurityTimeseriesGroupARCParamsDateRange = "2dControl"
EmailSecurityTimeseriesGroupARCParamsDateRange7dControl EmailSecurityTimeseriesGroupARCParamsDateRange = "7dControl"
EmailSecurityTimeseriesGroupARCParamsDateRange14dControl EmailSecurityTimeseriesGroupARCParamsDateRange = "14dControl"
EmailSecurityTimeseriesGroupARCParamsDateRange28dControl EmailSecurityTimeseriesGroupARCParamsDateRange = "28dControl"
EmailSecurityTimeseriesGroupARCParamsDateRange12wControl EmailSecurityTimeseriesGroupARCParamsDateRange = "12wControl"
EmailSecurityTimeseriesGroupARCParamsDateRange24wControl EmailSecurityTimeseriesGroupARCParamsDateRange = "24wControl"
)
func (r EmailSecurityTimeseriesGroupARCParamsDateRange) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupARCParamsDateRange1d, EmailSecurityTimeseriesGroupARCParamsDateRange2d, EmailSecurityTimeseriesGroupARCParamsDateRange7d, EmailSecurityTimeseriesGroupARCParamsDateRange14d, EmailSecurityTimeseriesGroupARCParamsDateRange28d, EmailSecurityTimeseriesGroupARCParamsDateRange12w, EmailSecurityTimeseriesGroupARCParamsDateRange24w, EmailSecurityTimeseriesGroupARCParamsDateRange52w, EmailSecurityTimeseriesGroupARCParamsDateRange1dControl, EmailSecurityTimeseriesGroupARCParamsDateRange2dControl, EmailSecurityTimeseriesGroupARCParamsDateRange7dControl, EmailSecurityTimeseriesGroupARCParamsDateRange14dControl, EmailSecurityTimeseriesGroupARCParamsDateRange28dControl, EmailSecurityTimeseriesGroupARCParamsDateRange12wControl, EmailSecurityTimeseriesGroupARCParamsDateRange24wControl:
return true
}
return false
}
type EmailSecurityTimeseriesGroupARCParamsDKIM string
const (
EmailSecurityTimeseriesGroupARCParamsDKIMPass EmailSecurityTimeseriesGroupARCParamsDKIM = "PASS"
EmailSecurityTimeseriesGroupARCParamsDKIMNone EmailSecurityTimeseriesGroupARCParamsDKIM = "NONE"
EmailSecurityTimeseriesGroupARCParamsDKIMFail EmailSecurityTimeseriesGroupARCParamsDKIM = "FAIL"
)
func (r EmailSecurityTimeseriesGroupARCParamsDKIM) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupARCParamsDKIMPass, EmailSecurityTimeseriesGroupARCParamsDKIMNone, EmailSecurityTimeseriesGroupARCParamsDKIMFail:
return true
}
return false
}
type EmailSecurityTimeseriesGroupARCParamsDMARC string
const (
EmailSecurityTimeseriesGroupARCParamsDMARCPass EmailSecurityTimeseriesGroupARCParamsDMARC = "PASS"
EmailSecurityTimeseriesGroupARCParamsDMARCNone EmailSecurityTimeseriesGroupARCParamsDMARC = "NONE"
EmailSecurityTimeseriesGroupARCParamsDMARCFail EmailSecurityTimeseriesGroupARCParamsDMARC = "FAIL"
)
func (r EmailSecurityTimeseriesGroupARCParamsDMARC) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupARCParamsDMARCPass, EmailSecurityTimeseriesGroupARCParamsDMARCNone, EmailSecurityTimeseriesGroupARCParamsDMARCFail:
return true
}
return false
}
// Format results are returned in.
type EmailSecurityTimeseriesGroupARCParamsFormat string
const (
EmailSecurityTimeseriesGroupARCParamsFormatJson EmailSecurityTimeseriesGroupARCParamsFormat = "JSON"
EmailSecurityTimeseriesGroupARCParamsFormatCsv EmailSecurityTimeseriesGroupARCParamsFormat = "CSV"
)
func (r EmailSecurityTimeseriesGroupARCParamsFormat) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupARCParamsFormatJson, EmailSecurityTimeseriesGroupARCParamsFormatCsv:
return true
}
return false
}
type EmailSecurityTimeseriesGroupARCParamsSPF string
const (
EmailSecurityTimeseriesGroupARCParamsSPFPass EmailSecurityTimeseriesGroupARCParamsSPF = "PASS"
EmailSecurityTimeseriesGroupARCParamsSPFNone EmailSecurityTimeseriesGroupARCParamsSPF = "NONE"
EmailSecurityTimeseriesGroupARCParamsSPFFail EmailSecurityTimeseriesGroupARCParamsSPF = "FAIL"
)
func (r EmailSecurityTimeseriesGroupARCParamsSPF) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupARCParamsSPFPass, EmailSecurityTimeseriesGroupARCParamsSPFNone, EmailSecurityTimeseriesGroupARCParamsSPFFail:
return true
}
return false
}
type EmailSecurityTimeseriesGroupARCParamsTLSVersion string
const (
EmailSecurityTimeseriesGroupARCParamsTLSVersionTlSv1_0 EmailSecurityTimeseriesGroupARCParamsTLSVersion = "TLSv1_0"
EmailSecurityTimeseriesGroupARCParamsTLSVersionTlSv1_1 EmailSecurityTimeseriesGroupARCParamsTLSVersion = "TLSv1_1"
EmailSecurityTimeseriesGroupARCParamsTLSVersionTlSv1_2 EmailSecurityTimeseriesGroupARCParamsTLSVersion = "TLSv1_2"
EmailSecurityTimeseriesGroupARCParamsTLSVersionTlSv1_3 EmailSecurityTimeseriesGroupARCParamsTLSVersion = "TLSv1_3"
)
func (r EmailSecurityTimeseriesGroupARCParamsTLSVersion) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupARCParamsTLSVersionTlSv1_0, EmailSecurityTimeseriesGroupARCParamsTLSVersionTlSv1_1, EmailSecurityTimeseriesGroupARCParamsTLSVersionTlSv1_2, EmailSecurityTimeseriesGroupARCParamsTLSVersionTlSv1_3:
return true
}
return false
}
type EmailSecurityTimeseriesGroupARCResponseEnvelope struct {
Result EmailSecurityTimeseriesGroupARCResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON emailSecurityTimeseriesGroupARCResponseEnvelopeJSON `json:"-"`
}
// emailSecurityTimeseriesGroupARCResponseEnvelopeJSON contains the JSON metadata
// for the struct [EmailSecurityTimeseriesGroupARCResponseEnvelope]
type emailSecurityTimeseriesGroupARCResponseEnvelopeJSON struct {
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupARCResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupARCResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupDKIMParams 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[EmailSecurityTimeseriesGroupDKIMParamsAggInterval] `query:"aggInterval"`
// Filter for arc (Authenticated Received Chain).
ARC param.Field[[]EmailSecurityTimeseriesGroupDKIMParamsARC] `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[[]EmailSecurityTimeseriesGroupDKIMParamsDateRange] `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[[]EmailSecurityTimeseriesGroupDKIMParamsDMARC] `query:"dmarc"`
// Format results are returned in.
Format param.Field[EmailSecurityTimeseriesGroupDKIMParamsFormat] `query:"format"`
// 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[[]EmailSecurityTimeseriesGroupDKIMParamsSPF] `query:"spf"`
// Filter for tls version.
TLSVersion param.Field[[]EmailSecurityTimeseriesGroupDKIMParamsTLSVersion] `query:"tlsVersion"`
}
// URLQuery serializes [EmailSecurityTimeseriesGroupDKIMParams]'s query parameters
// as `url.Values`.
func (r EmailSecurityTimeseriesGroupDKIMParams) 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 EmailSecurityTimeseriesGroupDKIMParamsAggInterval string
const (
EmailSecurityTimeseriesGroupDKIMParamsAggInterval15m EmailSecurityTimeseriesGroupDKIMParamsAggInterval = "15m"
EmailSecurityTimeseriesGroupDKIMParamsAggInterval1h EmailSecurityTimeseriesGroupDKIMParamsAggInterval = "1h"
EmailSecurityTimeseriesGroupDKIMParamsAggInterval1d EmailSecurityTimeseriesGroupDKIMParamsAggInterval = "1d"
EmailSecurityTimeseriesGroupDKIMParamsAggInterval1w EmailSecurityTimeseriesGroupDKIMParamsAggInterval = "1w"
)
func (r EmailSecurityTimeseriesGroupDKIMParamsAggInterval) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupDKIMParamsAggInterval15m, EmailSecurityTimeseriesGroupDKIMParamsAggInterval1h, EmailSecurityTimeseriesGroupDKIMParamsAggInterval1d, EmailSecurityTimeseriesGroupDKIMParamsAggInterval1w:
return true
}
return false
}
type EmailSecurityTimeseriesGroupDKIMParamsARC string
const (
EmailSecurityTimeseriesGroupDKIMParamsARCPass EmailSecurityTimeseriesGroupDKIMParamsARC = "PASS"
EmailSecurityTimeseriesGroupDKIMParamsARCNone EmailSecurityTimeseriesGroupDKIMParamsARC = "NONE"
EmailSecurityTimeseriesGroupDKIMParamsARCFail EmailSecurityTimeseriesGroupDKIMParamsARC = "FAIL"
)
func (r EmailSecurityTimeseriesGroupDKIMParamsARC) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupDKIMParamsARCPass, EmailSecurityTimeseriesGroupDKIMParamsARCNone, EmailSecurityTimeseriesGroupDKIMParamsARCFail:
return true
}
return false
}
type EmailSecurityTimeseriesGroupDKIMParamsDateRange string
const (
EmailSecurityTimeseriesGroupDKIMParamsDateRange1d EmailSecurityTimeseriesGroupDKIMParamsDateRange = "1d"
EmailSecurityTimeseriesGroupDKIMParamsDateRange2d EmailSecurityTimeseriesGroupDKIMParamsDateRange = "2d"
EmailSecurityTimeseriesGroupDKIMParamsDateRange7d EmailSecurityTimeseriesGroupDKIMParamsDateRange = "7d"
EmailSecurityTimeseriesGroupDKIMParamsDateRange14d EmailSecurityTimeseriesGroupDKIMParamsDateRange = "14d"
EmailSecurityTimeseriesGroupDKIMParamsDateRange28d EmailSecurityTimeseriesGroupDKIMParamsDateRange = "28d"
EmailSecurityTimeseriesGroupDKIMParamsDateRange12w EmailSecurityTimeseriesGroupDKIMParamsDateRange = "12w"
EmailSecurityTimeseriesGroupDKIMParamsDateRange24w EmailSecurityTimeseriesGroupDKIMParamsDateRange = "24w"
EmailSecurityTimeseriesGroupDKIMParamsDateRange52w EmailSecurityTimeseriesGroupDKIMParamsDateRange = "52w"
EmailSecurityTimeseriesGroupDKIMParamsDateRange1dControl EmailSecurityTimeseriesGroupDKIMParamsDateRange = "1dControl"
EmailSecurityTimeseriesGroupDKIMParamsDateRange2dControl EmailSecurityTimeseriesGroupDKIMParamsDateRange = "2dControl"
EmailSecurityTimeseriesGroupDKIMParamsDateRange7dControl EmailSecurityTimeseriesGroupDKIMParamsDateRange = "7dControl"
EmailSecurityTimeseriesGroupDKIMParamsDateRange14dControl EmailSecurityTimeseriesGroupDKIMParamsDateRange = "14dControl"
EmailSecurityTimeseriesGroupDKIMParamsDateRange28dControl EmailSecurityTimeseriesGroupDKIMParamsDateRange = "28dControl"
EmailSecurityTimeseriesGroupDKIMParamsDateRange12wControl EmailSecurityTimeseriesGroupDKIMParamsDateRange = "12wControl"
EmailSecurityTimeseriesGroupDKIMParamsDateRange24wControl EmailSecurityTimeseriesGroupDKIMParamsDateRange = "24wControl"
)
func (r EmailSecurityTimeseriesGroupDKIMParamsDateRange) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupDKIMParamsDateRange1d, EmailSecurityTimeseriesGroupDKIMParamsDateRange2d, EmailSecurityTimeseriesGroupDKIMParamsDateRange7d, EmailSecurityTimeseriesGroupDKIMParamsDateRange14d, EmailSecurityTimeseriesGroupDKIMParamsDateRange28d, EmailSecurityTimeseriesGroupDKIMParamsDateRange12w, EmailSecurityTimeseriesGroupDKIMParamsDateRange24w, EmailSecurityTimeseriesGroupDKIMParamsDateRange52w, EmailSecurityTimeseriesGroupDKIMParamsDateRange1dControl, EmailSecurityTimeseriesGroupDKIMParamsDateRange2dControl, EmailSecurityTimeseriesGroupDKIMParamsDateRange7dControl, EmailSecurityTimeseriesGroupDKIMParamsDateRange14dControl, EmailSecurityTimeseriesGroupDKIMParamsDateRange28dControl, EmailSecurityTimeseriesGroupDKIMParamsDateRange12wControl, EmailSecurityTimeseriesGroupDKIMParamsDateRange24wControl:
return true
}
return false
}
type EmailSecurityTimeseriesGroupDKIMParamsDMARC string
const (
EmailSecurityTimeseriesGroupDKIMParamsDMARCPass EmailSecurityTimeseriesGroupDKIMParamsDMARC = "PASS"
EmailSecurityTimeseriesGroupDKIMParamsDMARCNone EmailSecurityTimeseriesGroupDKIMParamsDMARC = "NONE"
EmailSecurityTimeseriesGroupDKIMParamsDMARCFail EmailSecurityTimeseriesGroupDKIMParamsDMARC = "FAIL"
)
func (r EmailSecurityTimeseriesGroupDKIMParamsDMARC) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupDKIMParamsDMARCPass, EmailSecurityTimeseriesGroupDKIMParamsDMARCNone, EmailSecurityTimeseriesGroupDKIMParamsDMARCFail:
return true
}
return false
}
// Format results are returned in.
type EmailSecurityTimeseriesGroupDKIMParamsFormat string
const (
EmailSecurityTimeseriesGroupDKIMParamsFormatJson EmailSecurityTimeseriesGroupDKIMParamsFormat = "JSON"
EmailSecurityTimeseriesGroupDKIMParamsFormatCsv EmailSecurityTimeseriesGroupDKIMParamsFormat = "CSV"
)
func (r EmailSecurityTimeseriesGroupDKIMParamsFormat) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupDKIMParamsFormatJson, EmailSecurityTimeseriesGroupDKIMParamsFormatCsv:
return true
}
return false
}
type EmailSecurityTimeseriesGroupDKIMParamsSPF string
const (
EmailSecurityTimeseriesGroupDKIMParamsSPFPass EmailSecurityTimeseriesGroupDKIMParamsSPF = "PASS"
EmailSecurityTimeseriesGroupDKIMParamsSPFNone EmailSecurityTimeseriesGroupDKIMParamsSPF = "NONE"
EmailSecurityTimeseriesGroupDKIMParamsSPFFail EmailSecurityTimeseriesGroupDKIMParamsSPF = "FAIL"
)
func (r EmailSecurityTimeseriesGroupDKIMParamsSPF) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupDKIMParamsSPFPass, EmailSecurityTimeseriesGroupDKIMParamsSPFNone, EmailSecurityTimeseriesGroupDKIMParamsSPFFail:
return true
}
return false
}
type EmailSecurityTimeseriesGroupDKIMParamsTLSVersion string
const (
EmailSecurityTimeseriesGroupDKIMParamsTLSVersionTlSv1_0 EmailSecurityTimeseriesGroupDKIMParamsTLSVersion = "TLSv1_0"
EmailSecurityTimeseriesGroupDKIMParamsTLSVersionTlSv1_1 EmailSecurityTimeseriesGroupDKIMParamsTLSVersion = "TLSv1_1"
EmailSecurityTimeseriesGroupDKIMParamsTLSVersionTlSv1_2 EmailSecurityTimeseriesGroupDKIMParamsTLSVersion = "TLSv1_2"
EmailSecurityTimeseriesGroupDKIMParamsTLSVersionTlSv1_3 EmailSecurityTimeseriesGroupDKIMParamsTLSVersion = "TLSv1_3"
)
func (r EmailSecurityTimeseriesGroupDKIMParamsTLSVersion) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupDKIMParamsTLSVersionTlSv1_0, EmailSecurityTimeseriesGroupDKIMParamsTLSVersionTlSv1_1, EmailSecurityTimeseriesGroupDKIMParamsTLSVersionTlSv1_2, EmailSecurityTimeseriesGroupDKIMParamsTLSVersionTlSv1_3:
return true
}
return false
}
type EmailSecurityTimeseriesGroupDKIMResponseEnvelope struct {
Result EmailSecurityTimeseriesGroupDKIMResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON emailSecurityTimeseriesGroupDKIMResponseEnvelopeJSON `json:"-"`
}
// emailSecurityTimeseriesGroupDKIMResponseEnvelopeJSON contains the JSON metadata
// for the struct [EmailSecurityTimeseriesGroupDKIMResponseEnvelope]
type emailSecurityTimeseriesGroupDKIMResponseEnvelopeJSON struct {
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTimeseriesGroupDKIMResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTimeseriesGroupDKIMResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTimeseriesGroupDMARCParams 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[EmailSecurityTimeseriesGroupDMARCParamsAggInterval] `query:"aggInterval"`
// Filter for arc (Authenticated Received Chain).
ARC param.Field[[]EmailSecurityTimeseriesGroupDMARCParamsARC] `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[[]EmailSecurityTimeseriesGroupDMARCParamsDateRange] `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[[]EmailSecurityTimeseriesGroupDMARCParamsDKIM] `query:"dkim"`
// Format results are returned in.
Format param.Field[EmailSecurityTimeseriesGroupDMARCParamsFormat] `query:"format"`
// 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[[]EmailSecurityTimeseriesGroupDMARCParamsSPF] `query:"spf"`
// Filter for tls version.
TLSVersion param.Field[[]EmailSecurityTimeseriesGroupDMARCParamsTLSVersion] `query:"tlsVersion"`
}
// URLQuery serializes [EmailSecurityTimeseriesGroupDMARCParams]'s query parameters
// as `url.Values`.
func (r EmailSecurityTimeseriesGroupDMARCParams) 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 EmailSecurityTimeseriesGroupDMARCParamsAggInterval string
const (
EmailSecurityTimeseriesGroupDMARCParamsAggInterval15m EmailSecurityTimeseriesGroupDMARCParamsAggInterval = "15m"
EmailSecurityTimeseriesGroupDMARCParamsAggInterval1h EmailSecurityTimeseriesGroupDMARCParamsAggInterval = "1h"
EmailSecurityTimeseriesGroupDMARCParamsAggInterval1d EmailSecurityTimeseriesGroupDMARCParamsAggInterval = "1d"
EmailSecurityTimeseriesGroupDMARCParamsAggInterval1w EmailSecurityTimeseriesGroupDMARCParamsAggInterval = "1w"
)
func (r EmailSecurityTimeseriesGroupDMARCParamsAggInterval) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupDMARCParamsAggInterval15m, EmailSecurityTimeseriesGroupDMARCParamsAggInterval1h, EmailSecurityTimeseriesGroupDMARCParamsAggInterval1d, EmailSecurityTimeseriesGroupDMARCParamsAggInterval1w:
return true
}
return false
}
type EmailSecurityTimeseriesGroupDMARCParamsARC string
const (
EmailSecurityTimeseriesGroupDMARCParamsARCPass EmailSecurityTimeseriesGroupDMARCParamsARC = "PASS"
EmailSecurityTimeseriesGroupDMARCParamsARCNone EmailSecurityTimeseriesGroupDMARCParamsARC = "NONE"
EmailSecurityTimeseriesGroupDMARCParamsARCFail EmailSecurityTimeseriesGroupDMARCParamsARC = "FAIL"
)
func (r EmailSecurityTimeseriesGroupDMARCParamsARC) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupDMARCParamsARCPass, EmailSecurityTimeseriesGroupDMARCParamsARCNone, EmailSecurityTimeseriesGroupDMARCParamsARCFail:
return true
}
return false
}
type EmailSecurityTimeseriesGroupDMARCParamsDateRange string
const (
EmailSecurityTimeseriesGroupDMARCParamsDateRange1d EmailSecurityTimeseriesGroupDMARCParamsDateRange = "1d"
EmailSecurityTimeseriesGroupDMARCParamsDateRange2d EmailSecurityTimeseriesGroupDMARCParamsDateRange = "2d"
EmailSecurityTimeseriesGroupDMARCParamsDateRange7d EmailSecurityTimeseriesGroupDMARCParamsDateRange = "7d"
EmailSecurityTimeseriesGroupDMARCParamsDateRange14d EmailSecurityTimeseriesGroupDMARCParamsDateRange = "14d"
EmailSecurityTimeseriesGroupDMARCParamsDateRange28d EmailSecurityTimeseriesGroupDMARCParamsDateRange = "28d"
EmailSecurityTimeseriesGroupDMARCParamsDateRange12w EmailSecurityTimeseriesGroupDMARCParamsDateRange = "12w"
EmailSecurityTimeseriesGroupDMARCParamsDateRange24w EmailSecurityTimeseriesGroupDMARCParamsDateRange = "24w"
EmailSecurityTimeseriesGroupDMARCParamsDateRange52w EmailSecurityTimeseriesGroupDMARCParamsDateRange = "52w"
EmailSecurityTimeseriesGroupDMARCParamsDateRange1dControl EmailSecurityTimeseriesGroupDMARCParamsDateRange = "1dControl"
EmailSecurityTimeseriesGroupDMARCParamsDateRange2dControl EmailSecurityTimeseriesGroupDMARCParamsDateRange = "2dControl"
EmailSecurityTimeseriesGroupDMARCParamsDateRange7dControl EmailSecurityTimeseriesGroupDMARCParamsDateRange = "7dControl"
EmailSecurityTimeseriesGroupDMARCParamsDateRange14dControl EmailSecurityTimeseriesGroupDMARCParamsDateRange = "14dControl"
EmailSecurityTimeseriesGroupDMARCParamsDateRange28dControl EmailSecurityTimeseriesGroupDMARCParamsDateRange = "28dControl"
EmailSecurityTimeseriesGroupDMARCParamsDateRange12wControl EmailSecurityTimeseriesGroupDMARCParamsDateRange = "12wControl"
EmailSecurityTimeseriesGroupDMARCParamsDateRange24wControl EmailSecurityTimeseriesGroupDMARCParamsDateRange = "24wControl"
)
func (r EmailSecurityTimeseriesGroupDMARCParamsDateRange) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupDMARCParamsDateRange1d, EmailSecurityTimeseriesGroupDMARCParamsDateRange2d, EmailSecurityTimeseriesGroupDMARCParamsDateRange7d, EmailSecurityTimeseriesGroupDMARCParamsDateRange14d, EmailSecurityTimeseriesGroupDMARCParamsDateRange28d, EmailSecurityTimeseriesGroupDMARCParamsDateRange12w, EmailSecurityTimeseriesGroupDMARCParamsDateRange24w, EmailSecurityTimeseriesGroupDMARCParamsDateRange52w, EmailSecurityTimeseriesGroupDMARCParamsDateRange1dControl, EmailSecurityTimeseriesGroupDMARCParamsDateRange2dControl, EmailSecurityTimeseriesGroupDMARCParamsDateRange7dControl, EmailSecurityTimeseriesGroupDMARCParamsDateRange14dControl, EmailSecurityTimeseriesGroupDMARCParamsDateRange28dControl, EmailSecurityTimeseriesGroupDMARCParamsDateRange12wControl, EmailSecurityTimeseriesGroupDMARCParamsDateRange24wControl:
return true
}
return false
}
type EmailSecurityTimeseriesGroupDMARCParamsDKIM string
const (
EmailSecurityTimeseriesGroupDMARCParamsDKIMPass EmailSecurityTimeseriesGroupDMARCParamsDKIM = "PASS"
EmailSecurityTimeseriesGroupDMARCParamsDKIMNone EmailSecurityTimeseriesGroupDMARCParamsDKIM = "NONE"
EmailSecurityTimeseriesGroupDMARCParamsDKIMFail EmailSecurityTimeseriesGroupDMARCParamsDKIM = "FAIL"
)
func (r EmailSecurityTimeseriesGroupDMARCParamsDKIM) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupDMARCParamsDKIMPass, EmailSecurityTimeseriesGroupDMARCParamsDKIMNone, EmailSecurityTimeseriesGroupDMARCParamsDKIMFail:
return true
}
return false
}
// Format results are returned in.
type EmailSecurityTimeseriesGroupDMARCParamsFormat string
const (
EmailSecurityTimeseriesGroupDMARCParamsFormatJson EmailSecurityTimeseriesGroupDMARCParamsFormat = "JSON"
EmailSecurityTimeseriesGroupDMARCParamsFormatCsv EmailSecurityTimeseriesGroupDMARCParamsFormat = "CSV"
)
func (r EmailSecurityTimeseriesGroupDMARCParamsFormat) IsKnown() bool {
switch r {
case EmailSecurityTimeseriesGroupDMARCParamsFormatJson, EmailSecurityTimeseriesGroupDMARCParamsFormatCsv:
return true
}
return false
}
type EmailSecurityTimeseriesGroupDMARCParamsSPF string
const (
EmailSecurityTimeseriesGroupDMARCParamsSPFPass EmailSecurityTimeseriesGroupDMARCParamsSPF = "PASS"
EmailSecurityTimeseriesGroupDMARCParamsSPFNone EmailSecurityTimeseriesGroupDMARCParamsSPF = "NONE"
EmailSecurityTimeseriesGroupDMARCParamsSPFFail EmailSecurityTimeseriesGroupDMARCParamsSPF = "FAIL"
)
func (r EmailSecurityTimeseriesGroupDMARCParamsSPF) IsKnown() bool {