/
httpasebotclass.go
438 lines (375 loc) · 17.6 KB
/
httpasebotclass.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
// 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"
)
// HTTPAseBotClassService 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 [NewHTTPAseBotClassService] method
// instead.
type HTTPAseBotClassService struct {
Options []option.RequestOption
}
// NewHTTPAseBotClassService 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 NewHTTPAseBotClassService(opts ...option.RequestOption) (r *HTTPAseBotClassService) {
r = &HTTPAseBotClassService{}
r.Options = opts
return
}
// Get the top autonomous systems (AS), by HTTP traffic, of the requested bot
// class. These two categories use Cloudflare's bot score - refer to
// [Bot Scores](https://developers.cloudflare.com/bots/concepts/bot-score) for more
// information. Values are a percentage out of the total traffic.
func (r *HTTPAseBotClassService) Get(ctx context.Context, botClass HTTPAseBotClassGetParamsBotClass, query HTTPAseBotClassGetParams, opts ...option.RequestOption) (res *HTTPAseBotClassGetResponse, err error) {
opts = append(r.Options[:], opts...)
var env HTTPAseBotClassGetResponseEnvelope
path := fmt.Sprintf("radar/http/top/ases/bot_class/%v", botClass)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, query, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
type HTTPAseBotClassGetResponse struct {
Meta HTTPAseBotClassGetResponseMeta `json:"meta,required"`
Top0 []HTTPAseBotClassGetResponseTop0 `json:"top_0,required"`
JSON httpAseBotClassGetResponseJSON `json:"-"`
}
// httpAseBotClassGetResponseJSON contains the JSON metadata for the struct
// [HTTPAseBotClassGetResponse]
type httpAseBotClassGetResponseJSON struct {
Meta apijson.Field
Top0 apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPAseBotClassGetResponse) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpAseBotClassGetResponseJSON) RawJSON() string {
return r.raw
}
type HTTPAseBotClassGetResponseMeta struct {
DateRange []HTTPAseBotClassGetResponseMetaDateRange `json:"dateRange,required"`
LastUpdated string `json:"lastUpdated,required"`
ConfidenceInfo HTTPAseBotClassGetResponseMetaConfidenceInfo `json:"confidenceInfo"`
JSON httpAseBotClassGetResponseMetaJSON `json:"-"`
}
// httpAseBotClassGetResponseMetaJSON contains the JSON metadata for the struct
// [HTTPAseBotClassGetResponseMeta]
type httpAseBotClassGetResponseMetaJSON struct {
DateRange apijson.Field
LastUpdated apijson.Field
ConfidenceInfo apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPAseBotClassGetResponseMeta) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpAseBotClassGetResponseMetaJSON) RawJSON() string {
return r.raw
}
type HTTPAseBotClassGetResponseMetaDateRange 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 httpAseBotClassGetResponseMetaDateRangeJSON `json:"-"`
}
// httpAseBotClassGetResponseMetaDateRangeJSON contains the JSON metadata for the
// struct [HTTPAseBotClassGetResponseMetaDateRange]
type httpAseBotClassGetResponseMetaDateRangeJSON struct {
EndTime apijson.Field
StartTime apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPAseBotClassGetResponseMetaDateRange) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpAseBotClassGetResponseMetaDateRangeJSON) RawJSON() string {
return r.raw
}
type HTTPAseBotClassGetResponseMetaConfidenceInfo struct {
Annotations []HTTPAseBotClassGetResponseMetaConfidenceInfoAnnotation `json:"annotations"`
Level int64 `json:"level"`
JSON httpAseBotClassGetResponseMetaConfidenceInfoJSON `json:"-"`
}
// httpAseBotClassGetResponseMetaConfidenceInfoJSON contains the JSON metadata for
// the struct [HTTPAseBotClassGetResponseMetaConfidenceInfo]
type httpAseBotClassGetResponseMetaConfidenceInfoJSON struct {
Annotations apijson.Field
Level apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPAseBotClassGetResponseMetaConfidenceInfo) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpAseBotClassGetResponseMetaConfidenceInfoJSON) RawJSON() string {
return r.raw
}
type HTTPAseBotClassGetResponseMetaConfidenceInfoAnnotation 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 httpAseBotClassGetResponseMetaConfidenceInfoAnnotationJSON `json:"-"`
}
// httpAseBotClassGetResponseMetaConfidenceInfoAnnotationJSON contains the JSON
// metadata for the struct [HTTPAseBotClassGetResponseMetaConfidenceInfoAnnotation]
type httpAseBotClassGetResponseMetaConfidenceInfoAnnotationJSON 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 *HTTPAseBotClassGetResponseMetaConfidenceInfoAnnotation) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpAseBotClassGetResponseMetaConfidenceInfoAnnotationJSON) RawJSON() string {
return r.raw
}
type HTTPAseBotClassGetResponseTop0 struct {
ClientASN int64 `json:"clientASN,required"`
ClientAsName string `json:"clientASName,required"`
Value string `json:"value,required"`
JSON httpAseBotClassGetResponseTop0JSON `json:"-"`
}
// httpAseBotClassGetResponseTop0JSON contains the JSON metadata for the struct
// [HTTPAseBotClassGetResponseTop0]
type httpAseBotClassGetResponseTop0JSON struct {
ClientASN apijson.Field
ClientAsName apijson.Field
Value apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPAseBotClassGetResponseTop0) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpAseBotClassGetResponseTop0JSON) RawJSON() string {
return r.raw
}
type HTTPAseBotClassGetParams struct {
// Array of comma separated list of ASNs, start with `-` to exclude from results.
// For example, `-174, 3356` excludes results from AS174, but includes results from
// AS3356.
ASN param.Field[[]string] `query:"asn"`
// Array of comma separated list of continents (alpha-2 continent codes). Start
// with `-` to exclude from results. For example, `-EU,NA` excludes results from
// Europe, but includes results from North America.
Continent param.Field[[]string] `query:"continent"`
// 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[[]HTTPAseBotClassGetParamsDateRange] `query:"dateRange"`
// Array of datetimes to filter the start of a series.
DateStart param.Field[[]time.Time] `query:"dateStart" format:"date-time"`
// Filter for device type.
DeviceType param.Field[[]HTTPAseBotClassGetParamsDeviceType] `query:"deviceType"`
// Format results are returned in.
Format param.Field[HTTPAseBotClassGetParamsFormat] `query:"format"`
// Filter for http protocol.
HTTPProtocol param.Field[[]HTTPAseBotClassGetParamsHTTPProtocol] `query:"httpProtocol"`
// Filter for http version.
HTTPVersion param.Field[[]HTTPAseBotClassGetParamsHTTPVersion] `query:"httpVersion"`
// Filter for ip version.
IPVersion param.Field[[]HTTPAseBotClassGetParamsIPVersion] `query:"ipVersion"`
// Limit the number of objects in the response.
Limit param.Field[int64] `query:"limit"`
// Array of comma separated list of locations (alpha-2 country codes). Start with
// `-` to exclude from results. For example, `-US,PT` excludes results from the US,
// but includes results from PT.
Location param.Field[[]string] `query:"location"`
// Array of names that will be used to name the series in responses.
Name param.Field[[]string] `query:"name"`
// Filter for os name.
OS param.Field[[]HTTPAseBotClassGetParamsOS] `query:"os"`
// Filter for tls version.
TLSVersion param.Field[[]HTTPAseBotClassGetParamsTLSVersion] `query:"tlsVersion"`
}
// URLQuery serializes [HTTPAseBotClassGetParams]'s query parameters as
// `url.Values`.
func (r HTTPAseBotClassGetParams) URLQuery() (v url.Values) {
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
NestedFormat: apiquery.NestedQueryFormatBrackets,
})
}
// Bot class.
type HTTPAseBotClassGetParamsBotClass string
const (
HTTPAseBotClassGetParamsBotClassLikelyAutomated HTTPAseBotClassGetParamsBotClass = "LIKELY_AUTOMATED"
HTTPAseBotClassGetParamsBotClassLikelyHuman HTTPAseBotClassGetParamsBotClass = "LIKELY_HUMAN"
)
func (r HTTPAseBotClassGetParamsBotClass) IsKnown() bool {
switch r {
case HTTPAseBotClassGetParamsBotClassLikelyAutomated, HTTPAseBotClassGetParamsBotClassLikelyHuman:
return true
}
return false
}
type HTTPAseBotClassGetParamsDateRange string
const (
HTTPAseBotClassGetParamsDateRange1d HTTPAseBotClassGetParamsDateRange = "1d"
HTTPAseBotClassGetParamsDateRange2d HTTPAseBotClassGetParamsDateRange = "2d"
HTTPAseBotClassGetParamsDateRange7d HTTPAseBotClassGetParamsDateRange = "7d"
HTTPAseBotClassGetParamsDateRange14d HTTPAseBotClassGetParamsDateRange = "14d"
HTTPAseBotClassGetParamsDateRange28d HTTPAseBotClassGetParamsDateRange = "28d"
HTTPAseBotClassGetParamsDateRange12w HTTPAseBotClassGetParamsDateRange = "12w"
HTTPAseBotClassGetParamsDateRange24w HTTPAseBotClassGetParamsDateRange = "24w"
HTTPAseBotClassGetParamsDateRange52w HTTPAseBotClassGetParamsDateRange = "52w"
HTTPAseBotClassGetParamsDateRange1dControl HTTPAseBotClassGetParamsDateRange = "1dControl"
HTTPAseBotClassGetParamsDateRange2dControl HTTPAseBotClassGetParamsDateRange = "2dControl"
HTTPAseBotClassGetParamsDateRange7dControl HTTPAseBotClassGetParamsDateRange = "7dControl"
HTTPAseBotClassGetParamsDateRange14dControl HTTPAseBotClassGetParamsDateRange = "14dControl"
HTTPAseBotClassGetParamsDateRange28dControl HTTPAseBotClassGetParamsDateRange = "28dControl"
HTTPAseBotClassGetParamsDateRange12wControl HTTPAseBotClassGetParamsDateRange = "12wControl"
HTTPAseBotClassGetParamsDateRange24wControl HTTPAseBotClassGetParamsDateRange = "24wControl"
)
func (r HTTPAseBotClassGetParamsDateRange) IsKnown() bool {
switch r {
case HTTPAseBotClassGetParamsDateRange1d, HTTPAseBotClassGetParamsDateRange2d, HTTPAseBotClassGetParamsDateRange7d, HTTPAseBotClassGetParamsDateRange14d, HTTPAseBotClassGetParamsDateRange28d, HTTPAseBotClassGetParamsDateRange12w, HTTPAseBotClassGetParamsDateRange24w, HTTPAseBotClassGetParamsDateRange52w, HTTPAseBotClassGetParamsDateRange1dControl, HTTPAseBotClassGetParamsDateRange2dControl, HTTPAseBotClassGetParamsDateRange7dControl, HTTPAseBotClassGetParamsDateRange14dControl, HTTPAseBotClassGetParamsDateRange28dControl, HTTPAseBotClassGetParamsDateRange12wControl, HTTPAseBotClassGetParamsDateRange24wControl:
return true
}
return false
}
type HTTPAseBotClassGetParamsDeviceType string
const (
HTTPAseBotClassGetParamsDeviceTypeDesktop HTTPAseBotClassGetParamsDeviceType = "DESKTOP"
HTTPAseBotClassGetParamsDeviceTypeMobile HTTPAseBotClassGetParamsDeviceType = "MOBILE"
HTTPAseBotClassGetParamsDeviceTypeOther HTTPAseBotClassGetParamsDeviceType = "OTHER"
)
func (r HTTPAseBotClassGetParamsDeviceType) IsKnown() bool {
switch r {
case HTTPAseBotClassGetParamsDeviceTypeDesktop, HTTPAseBotClassGetParamsDeviceTypeMobile, HTTPAseBotClassGetParamsDeviceTypeOther:
return true
}
return false
}
// Format results are returned in.
type HTTPAseBotClassGetParamsFormat string
const (
HTTPAseBotClassGetParamsFormatJson HTTPAseBotClassGetParamsFormat = "JSON"
HTTPAseBotClassGetParamsFormatCsv HTTPAseBotClassGetParamsFormat = "CSV"
)
func (r HTTPAseBotClassGetParamsFormat) IsKnown() bool {
switch r {
case HTTPAseBotClassGetParamsFormatJson, HTTPAseBotClassGetParamsFormatCsv:
return true
}
return false
}
type HTTPAseBotClassGetParamsHTTPProtocol string
const (
HTTPAseBotClassGetParamsHTTPProtocolHTTP HTTPAseBotClassGetParamsHTTPProtocol = "HTTP"
HTTPAseBotClassGetParamsHTTPProtocolHTTPS HTTPAseBotClassGetParamsHTTPProtocol = "HTTPS"
)
func (r HTTPAseBotClassGetParamsHTTPProtocol) IsKnown() bool {
switch r {
case HTTPAseBotClassGetParamsHTTPProtocolHTTP, HTTPAseBotClassGetParamsHTTPProtocolHTTPS:
return true
}
return false
}
type HTTPAseBotClassGetParamsHTTPVersion string
const (
HTTPAseBotClassGetParamsHTTPVersionHttPv1 HTTPAseBotClassGetParamsHTTPVersion = "HTTPv1"
HTTPAseBotClassGetParamsHTTPVersionHttPv2 HTTPAseBotClassGetParamsHTTPVersion = "HTTPv2"
HTTPAseBotClassGetParamsHTTPVersionHttPv3 HTTPAseBotClassGetParamsHTTPVersion = "HTTPv3"
)
func (r HTTPAseBotClassGetParamsHTTPVersion) IsKnown() bool {
switch r {
case HTTPAseBotClassGetParamsHTTPVersionHttPv1, HTTPAseBotClassGetParamsHTTPVersionHttPv2, HTTPAseBotClassGetParamsHTTPVersionHttPv3:
return true
}
return false
}
type HTTPAseBotClassGetParamsIPVersion string
const (
HTTPAseBotClassGetParamsIPVersionIPv4 HTTPAseBotClassGetParamsIPVersion = "IPv4"
HTTPAseBotClassGetParamsIPVersionIPv6 HTTPAseBotClassGetParamsIPVersion = "IPv6"
)
func (r HTTPAseBotClassGetParamsIPVersion) IsKnown() bool {
switch r {
case HTTPAseBotClassGetParamsIPVersionIPv4, HTTPAseBotClassGetParamsIPVersionIPv6:
return true
}
return false
}
type HTTPAseBotClassGetParamsOS string
const (
HTTPAseBotClassGetParamsOSWindows HTTPAseBotClassGetParamsOS = "WINDOWS"
HTTPAseBotClassGetParamsOSMacosx HTTPAseBotClassGetParamsOS = "MACOSX"
HTTPAseBotClassGetParamsOSIos HTTPAseBotClassGetParamsOS = "IOS"
HTTPAseBotClassGetParamsOSAndroid HTTPAseBotClassGetParamsOS = "ANDROID"
HTTPAseBotClassGetParamsOSChromeos HTTPAseBotClassGetParamsOS = "CHROMEOS"
HTTPAseBotClassGetParamsOSLinux HTTPAseBotClassGetParamsOS = "LINUX"
HTTPAseBotClassGetParamsOSSmartTv HTTPAseBotClassGetParamsOS = "SMART_TV"
)
func (r HTTPAseBotClassGetParamsOS) IsKnown() bool {
switch r {
case HTTPAseBotClassGetParamsOSWindows, HTTPAseBotClassGetParamsOSMacosx, HTTPAseBotClassGetParamsOSIos, HTTPAseBotClassGetParamsOSAndroid, HTTPAseBotClassGetParamsOSChromeos, HTTPAseBotClassGetParamsOSLinux, HTTPAseBotClassGetParamsOSSmartTv:
return true
}
return false
}
type HTTPAseBotClassGetParamsTLSVersion string
const (
HTTPAseBotClassGetParamsTLSVersionTlSv1_0 HTTPAseBotClassGetParamsTLSVersion = "TLSv1_0"
HTTPAseBotClassGetParamsTLSVersionTlSv1_1 HTTPAseBotClassGetParamsTLSVersion = "TLSv1_1"
HTTPAseBotClassGetParamsTLSVersionTlSv1_2 HTTPAseBotClassGetParamsTLSVersion = "TLSv1_2"
HTTPAseBotClassGetParamsTLSVersionTlSv1_3 HTTPAseBotClassGetParamsTLSVersion = "TLSv1_3"
HTTPAseBotClassGetParamsTLSVersionTlSvQuic HTTPAseBotClassGetParamsTLSVersion = "TLSvQUIC"
)
func (r HTTPAseBotClassGetParamsTLSVersion) IsKnown() bool {
switch r {
case HTTPAseBotClassGetParamsTLSVersionTlSv1_0, HTTPAseBotClassGetParamsTLSVersionTlSv1_1, HTTPAseBotClassGetParamsTLSVersionTlSv1_2, HTTPAseBotClassGetParamsTLSVersionTlSv1_3, HTTPAseBotClassGetParamsTLSVersionTlSvQuic:
return true
}
return false
}
type HTTPAseBotClassGetResponseEnvelope struct {
Result HTTPAseBotClassGetResponse `json:"result,required"`
Success bool `json:"success,required"`
JSON httpAseBotClassGetResponseEnvelopeJSON `json:"-"`
}
// httpAseBotClassGetResponseEnvelopeJSON contains the JSON metadata for the struct
// [HTTPAseBotClassGetResponseEnvelope]
type httpAseBotClassGetResponseEnvelopeJSON struct {
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *HTTPAseBotClassGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r httpAseBotClassGetResponseEnvelopeJSON) RawJSON() string {
return r.raw
}