-
Notifications
You must be signed in to change notification settings - Fork 541
/
emailsecuritytoptldmalicious.go
397 lines (338 loc) · 17.8 KB
/
emailsecuritytoptldmalicious.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
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package radar
import (
"context"
"fmt"
"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"
)
// EmailSecurityTopTldMaliciousService 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
// [NewEmailSecurityTopTldMaliciousService] method instead.
type EmailSecurityTopTldMaliciousService struct {
Options []option.RequestOption
}
// NewEmailSecurityTopTldMaliciousService 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 NewEmailSecurityTopTldMaliciousService(opts ...option.RequestOption) (r *EmailSecurityTopTldMaliciousService) {
r = &EmailSecurityTopTldMaliciousService{}
r.Options = opts
return
}
// Get the TLDs by emails classified as malicious or not.
func (r *EmailSecurityTopTldMaliciousService) Get(ctx context.Context, malicious EmailSecurityTopTldMaliciousGetParamsMalicious, query EmailSecurityTopTldMaliciousGetParams, opts ...option.RequestOption) (res *EmailSecurityTopTldMaliciousGetResponse, err error) {
opts = append(r.Options[:], opts...)
var env EmailSecurityTopTldMaliciousGetResponseEnvelope
path := fmt.Sprintf("radar/email/security/top/tlds/malicious/%v", malicious)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
type EmailSecurityTopTldMaliciousGetResponse struct {
Meta EmailSecurityTopTldMaliciousGetResponseMeta `json:"meta,required"`
Top0 []Browser `json:"top_0,required"`
JSON emailSecurityTopTldMaliciousGetResponseJSON `json:"-"`
}
// emailSecurityTopTldMaliciousGetResponseJSON contains the JSON metadata for the
// struct [EmailSecurityTopTldMaliciousGetResponse]
type emailSecurityTopTldMaliciousGetResponseJSON struct {
Meta apijson.Field
Top0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTopTldMaliciousGetResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTopTldMaliciousGetResponseJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTopTldMaliciousGetResponseMeta struct {
DateRange []EmailSecurityTopTldMaliciousGetResponseMetaDateRange `json:"dateRange,required"`
LastUpdated string `json:"lastUpdated,required"`
ConfidenceInfo EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
JSON emailSecurityTopTldMaliciousGetResponseMetaJSON `json:"-"`
}
// emailSecurityTopTldMaliciousGetResponseMetaJSON contains the JSON metadata for
// the struct [EmailSecurityTopTldMaliciousGetResponseMeta]
type emailSecurityTopTldMaliciousGetResponseMetaJSON struct {
DateRange apijson.Field
LastUpdated apijson.Field
ConfidenceInfo apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTopTldMaliciousGetResponseMeta) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTopTldMaliciousGetResponseMetaJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTopTldMaliciousGetResponseMetaDateRange struct {
// Adjusted end of date range.
EndTime time.Time `json:"endTime,required" format:"date-time"`
// Adjusted start of date range.
StartTime time.Time `json:"startTime,required" format:"date-time"`
JSON emailSecurityTopTldMaliciousGetResponseMetaDateRangeJSON `json:"-"`
}
// emailSecurityTopTldMaliciousGetResponseMetaDateRangeJSON contains the JSON
// metadata for the struct [EmailSecurityTopTldMaliciousGetResponseMetaDateRange]
type emailSecurityTopTldMaliciousGetResponseMetaDateRangeJSON struct {
EndTime apijson.Field
StartTime apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTopTldMaliciousGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTopTldMaliciousGetResponseMetaDateRangeJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfo struct {
Annotations []EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
Level int64 `json:"level"`
JSON emailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoJSON `json:"-"`
}
// emailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoJSON contains the JSON
// metadata for the struct
// [EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfo]
type emailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoJSON struct {
Annotations apijson.Field
Level apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotation struct {
DataSource string `json:"dataSource,required"`
Description string `json:"description,required"`
EventType string `json:"eventType,required"`
IsInstantaneous interface{} `json:"isInstantaneous,required"`
EndTime time.Time `json:"endTime" format:"date-time"`
LinkedURL string `json:"linkedUrl"`
StartTime time.Time `json:"startTime" format:"date-time"`
JSON emailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
// emailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotationJSON contains
// the JSON metadata for the struct
// [EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotation]
type emailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotationJSON struct {
DataSource apijson.Field
Description apijson.Field
EventType apijson.Field
IsInstantaneous apijson.Field
EndTime apijson.Field
LinkedURL apijson.Field
StartTime apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTopTldMaliciousGetResponseMetaConfidenceInfoAnnotationJSON) RawJSON() string {
return r.raw
}
type EmailSecurityTopTldMaliciousGetParams struct {
// Filter for arc (Authenticated Received Chain).
ARC param.Field[[]EmailSecurityTopTldMaliciousGetParamsARC] `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[[]EmailSecurityTopTldMaliciousGetParamsDateRange] `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[[]EmailSecurityTopTldMaliciousGetParamsDKIM] `query:"dkim"`
// Filter for dmarc.
DMARC param.Field[[]EmailSecurityTopTldMaliciousGetParamsDMARC] `query:"dmarc"`
// Format results are returned in.
Format param.Field[EmailSecurityTopTldMaliciousGetParamsFormat] `query:"format"`
// Limit the number of objects in the response.
Limit param.Field[int64] `query:"limit"`
// 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[[]EmailSecurityTopTldMaliciousGetParamsSPF] `query:"spf"`
// Filter for TLDs by category.
TldCategory param.Field[EmailSecurityTopTldMaliciousGetParamsTldCategory] `query:"tldCategory"`
// Filter for tls version.
TLSVersion param.Field[[]EmailSecurityTopTldMaliciousGetParamsTLSVersion] `query:"tlsVersion"`
}
// URLQuery serializes [EmailSecurityTopTldMaliciousGetParams]'s query parameters
// as `url.Values`.
func (r EmailSecurityTopTldMaliciousGetParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// Malicious.
type EmailSecurityTopTldMaliciousGetParamsMalicious string
const (
EmailSecurityTopTldMaliciousGetParamsMaliciousMalicious EmailSecurityTopTldMaliciousGetParamsMalicious = "MALICIOUS"
EmailSecurityTopTldMaliciousGetParamsMaliciousNotMalicious EmailSecurityTopTldMaliciousGetParamsMalicious = "NOT_MALICIOUS"
)
func (r EmailSecurityTopTldMaliciousGetParamsMalicious) IsKnown() bool {
switch r {
case EmailSecurityTopTldMaliciousGetParamsMaliciousMalicious, EmailSecurityTopTldMaliciousGetParamsMaliciousNotMalicious:
return true
}
return false
}
type EmailSecurityTopTldMaliciousGetParamsARC string
const (
EmailSecurityTopTldMaliciousGetParamsARCPass EmailSecurityTopTldMaliciousGetParamsARC = "PASS"
EmailSecurityTopTldMaliciousGetParamsARCNone EmailSecurityTopTldMaliciousGetParamsARC = "NONE"
EmailSecurityTopTldMaliciousGetParamsARCFail EmailSecurityTopTldMaliciousGetParamsARC = "FAIL"
)
func (r EmailSecurityTopTldMaliciousGetParamsARC) IsKnown() bool {
switch r {
case EmailSecurityTopTldMaliciousGetParamsARCPass, EmailSecurityTopTldMaliciousGetParamsARCNone, EmailSecurityTopTldMaliciousGetParamsARCFail:
return true
}
return false
}
type EmailSecurityTopTldMaliciousGetParamsDateRange string
const (
EmailSecurityTopTldMaliciousGetParamsDateRange1d EmailSecurityTopTldMaliciousGetParamsDateRange = "1d"
EmailSecurityTopTldMaliciousGetParamsDateRange2d EmailSecurityTopTldMaliciousGetParamsDateRange = "2d"
EmailSecurityTopTldMaliciousGetParamsDateRange7d EmailSecurityTopTldMaliciousGetParamsDateRange = "7d"
EmailSecurityTopTldMaliciousGetParamsDateRange14d EmailSecurityTopTldMaliciousGetParamsDateRange = "14d"
EmailSecurityTopTldMaliciousGetParamsDateRange28d EmailSecurityTopTldMaliciousGetParamsDateRange = "28d"
EmailSecurityTopTldMaliciousGetParamsDateRange12w EmailSecurityTopTldMaliciousGetParamsDateRange = "12w"
EmailSecurityTopTldMaliciousGetParamsDateRange24w EmailSecurityTopTldMaliciousGetParamsDateRange = "24w"
EmailSecurityTopTldMaliciousGetParamsDateRange52w EmailSecurityTopTldMaliciousGetParamsDateRange = "52w"
EmailSecurityTopTldMaliciousGetParamsDateRange1dControl EmailSecurityTopTldMaliciousGetParamsDateRange = "1dControl"
EmailSecurityTopTldMaliciousGetParamsDateRange2dControl EmailSecurityTopTldMaliciousGetParamsDateRange = "2dControl"
EmailSecurityTopTldMaliciousGetParamsDateRange7dControl EmailSecurityTopTldMaliciousGetParamsDateRange = "7dControl"
EmailSecurityTopTldMaliciousGetParamsDateRange14dControl EmailSecurityTopTldMaliciousGetParamsDateRange = "14dControl"
EmailSecurityTopTldMaliciousGetParamsDateRange28dControl EmailSecurityTopTldMaliciousGetParamsDateRange = "28dControl"
EmailSecurityTopTldMaliciousGetParamsDateRange12wControl EmailSecurityTopTldMaliciousGetParamsDateRange = "12wControl"
EmailSecurityTopTldMaliciousGetParamsDateRange24wControl EmailSecurityTopTldMaliciousGetParamsDateRange = "24wControl"
)
func (r EmailSecurityTopTldMaliciousGetParamsDateRange) IsKnown() bool {
switch r {
case EmailSecurityTopTldMaliciousGetParamsDateRange1d, EmailSecurityTopTldMaliciousGetParamsDateRange2d, EmailSecurityTopTldMaliciousGetParamsDateRange7d, EmailSecurityTopTldMaliciousGetParamsDateRange14d, EmailSecurityTopTldMaliciousGetParamsDateRange28d, EmailSecurityTopTldMaliciousGetParamsDateRange12w, EmailSecurityTopTldMaliciousGetParamsDateRange24w, EmailSecurityTopTldMaliciousGetParamsDateRange52w, EmailSecurityTopTldMaliciousGetParamsDateRange1dControl, EmailSecurityTopTldMaliciousGetParamsDateRange2dControl, EmailSecurityTopTldMaliciousGetParamsDateRange7dControl, EmailSecurityTopTldMaliciousGetParamsDateRange14dControl, EmailSecurityTopTldMaliciousGetParamsDateRange28dControl, EmailSecurityTopTldMaliciousGetParamsDateRange12wControl, EmailSecurityTopTldMaliciousGetParamsDateRange24wControl:
return true
}
return false
}
type EmailSecurityTopTldMaliciousGetParamsDKIM string
const (
EmailSecurityTopTldMaliciousGetParamsDKIMPass EmailSecurityTopTldMaliciousGetParamsDKIM = "PASS"
EmailSecurityTopTldMaliciousGetParamsDKIMNone EmailSecurityTopTldMaliciousGetParamsDKIM = "NONE"
EmailSecurityTopTldMaliciousGetParamsDKIMFail EmailSecurityTopTldMaliciousGetParamsDKIM = "FAIL"
)
func (r EmailSecurityTopTldMaliciousGetParamsDKIM) IsKnown() bool {
switch r {
case EmailSecurityTopTldMaliciousGetParamsDKIMPass, EmailSecurityTopTldMaliciousGetParamsDKIMNone, EmailSecurityTopTldMaliciousGetParamsDKIMFail:
return true
}
return false
}
type EmailSecurityTopTldMaliciousGetParamsDMARC string
const (
EmailSecurityTopTldMaliciousGetParamsDMARCPass EmailSecurityTopTldMaliciousGetParamsDMARC = "PASS"
EmailSecurityTopTldMaliciousGetParamsDMARCNone EmailSecurityTopTldMaliciousGetParamsDMARC = "NONE"
EmailSecurityTopTldMaliciousGetParamsDMARCFail EmailSecurityTopTldMaliciousGetParamsDMARC = "FAIL"
)
func (r EmailSecurityTopTldMaliciousGetParamsDMARC) IsKnown() bool {
switch r {
case EmailSecurityTopTldMaliciousGetParamsDMARCPass, EmailSecurityTopTldMaliciousGetParamsDMARCNone, EmailSecurityTopTldMaliciousGetParamsDMARCFail:
return true
}
return false
}
// Format results are returned in.
type EmailSecurityTopTldMaliciousGetParamsFormat string
const (
EmailSecurityTopTldMaliciousGetParamsFormatJson EmailSecurityTopTldMaliciousGetParamsFormat = "JSON"
EmailSecurityTopTldMaliciousGetParamsFormatCsv EmailSecurityTopTldMaliciousGetParamsFormat = "CSV"
)
func (r EmailSecurityTopTldMaliciousGetParamsFormat) IsKnown() bool {
switch r {
case EmailSecurityTopTldMaliciousGetParamsFormatJson, EmailSecurityTopTldMaliciousGetParamsFormatCsv:
return true
}
return false
}
type EmailSecurityTopTldMaliciousGetParamsSPF string
const (
EmailSecurityTopTldMaliciousGetParamsSPFPass EmailSecurityTopTldMaliciousGetParamsSPF = "PASS"
EmailSecurityTopTldMaliciousGetParamsSPFNone EmailSecurityTopTldMaliciousGetParamsSPF = "NONE"
EmailSecurityTopTldMaliciousGetParamsSPFFail EmailSecurityTopTldMaliciousGetParamsSPF = "FAIL"
)
func (r EmailSecurityTopTldMaliciousGetParamsSPF) IsKnown() bool {
switch r {
case EmailSecurityTopTldMaliciousGetParamsSPFPass, EmailSecurityTopTldMaliciousGetParamsSPFNone, EmailSecurityTopTldMaliciousGetParamsSPFFail:
return true
}
return false
}
// Filter for TLDs by category.
type EmailSecurityTopTldMaliciousGetParamsTldCategory string
const (
EmailSecurityTopTldMaliciousGetParamsTldCategoryClassic EmailSecurityTopTldMaliciousGetParamsTldCategory = "CLASSIC"
EmailSecurityTopTldMaliciousGetParamsTldCategoryCountry EmailSecurityTopTldMaliciousGetParamsTldCategory = "COUNTRY"
)
func (r EmailSecurityTopTldMaliciousGetParamsTldCategory) IsKnown() bool {
switch r {
case EmailSecurityTopTldMaliciousGetParamsTldCategoryClassic, EmailSecurityTopTldMaliciousGetParamsTldCategoryCountry:
return true
}
return false
}
type EmailSecurityTopTldMaliciousGetParamsTLSVersion string
const (
EmailSecurityTopTldMaliciousGetParamsTLSVersionTlSv1_0 EmailSecurityTopTldMaliciousGetParamsTLSVersion = "TLSv1_0"
EmailSecurityTopTldMaliciousGetParamsTLSVersionTlSv1_1 EmailSecurityTopTldMaliciousGetParamsTLSVersion = "TLSv1_1"
EmailSecurityTopTldMaliciousGetParamsTLSVersionTlSv1_2 EmailSecurityTopTldMaliciousGetParamsTLSVersion = "TLSv1_2"
EmailSecurityTopTldMaliciousGetParamsTLSVersionTlSv1_3 EmailSecurityTopTldMaliciousGetParamsTLSVersion = "TLSv1_3"
)
func (r EmailSecurityTopTldMaliciousGetParamsTLSVersion) IsKnown() bool {
switch r {
case EmailSecurityTopTldMaliciousGetParamsTLSVersionTlSv1_0, EmailSecurityTopTldMaliciousGetParamsTLSVersionTlSv1_1, EmailSecurityTopTldMaliciousGetParamsTLSVersionTlSv1_2, EmailSecurityTopTldMaliciousGetParamsTLSVersionTlSv1_3:
return true
}
return false
}
type EmailSecurityTopTldMaliciousGetResponseEnvelope struct {
Result EmailSecurityTopTldMaliciousGetResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON emailSecurityTopTldMaliciousGetResponseEnvelopeJSON `json:"-"`
}
// emailSecurityTopTldMaliciousGetResponseEnvelopeJSON contains the JSON metadata
// for the struct [EmailSecurityTopTldMaliciousGetResponseEnvelope]
type emailSecurityTopTldMaliciousGetResponseEnvelopeJSON struct {
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EmailSecurityTopTldMaliciousGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r emailSecurityTopTldMaliciousGetResponseEnvelopeJSON) RawJSON() string {
return r.raw
}