-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathproxy.go
More file actions
1586 lines (1440 loc) · 58.3 KB
/
proxy.go
File metadata and controls
1586 lines (1440 loc) · 58.3 KB
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 kernel
import (
"context"
"encoding/json"
"errors"
"fmt"
"net/http"
"slices"
"time"
"github.com/kernel/kernel-go-sdk/internal/apijson"
"github.com/kernel/kernel-go-sdk/internal/requestconfig"
"github.com/kernel/kernel-go-sdk/option"
"github.com/kernel/kernel-go-sdk/packages/param"
"github.com/kernel/kernel-go-sdk/packages/respjson"
)
// Create and manage proxy configurations for routing browser traffic.
//
// ProxyService contains methods and other services that help with interacting with
// the kernel 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 [NewProxyService] method instead.
type ProxyService struct {
Options []option.RequestOption
}
// NewProxyService 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 NewProxyService(opts ...option.RequestOption) (r ProxyService) {
r = ProxyService{}
r.Options = opts
return
}
// Create a new proxy configuration for the caller's organization.
func (r *ProxyService) New(ctx context.Context, body ProxyNewParams, opts ...option.RequestOption) (res *ProxyNewResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "proxies"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, body, &res, opts...)
return
}
// Retrieve a proxy belonging to the caller's organization by ID.
func (r *ProxyService) Get(ctx context.Context, id string, opts ...option.RequestOption) (res *ProxyGetResponse, err error) {
opts = slices.Concat(r.Options, opts)
if id == "" {
err = errors.New("missing required id parameter")
return
}
path := fmt.Sprintf("proxies/%s", id)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
return
}
// List proxies owned by the caller's organization.
func (r *ProxyService) List(ctx context.Context, opts ...option.RequestOption) (res *[]ProxyListResponse, err error) {
opts = slices.Concat(r.Options, opts)
path := "proxies"
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
return
}
// Soft delete a proxy. Sessions referencing it are not modified.
func (r *ProxyService) Delete(ctx context.Context, id string, opts ...option.RequestOption) (err error) {
opts = slices.Concat(r.Options, opts)
opts = append([]option.RequestOption{option.WithHeader("Accept", "*/*")}, opts...)
if id == "" {
err = errors.New("missing required id parameter")
return
}
path := fmt.Sprintf("proxies/%s", id)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodDelete, path, nil, nil, opts...)
return
}
// Run a health check on the proxy to verify it's working.
func (r *ProxyService) Check(ctx context.Context, id string, opts ...option.RequestOption) (res *ProxyCheckResponse, err error) {
opts = slices.Concat(r.Options, opts)
if id == "" {
err = errors.New("missing required id parameter")
return
}
path := fmt.Sprintf("proxies/%s/check", id)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, nil, &res, opts...)
return
}
// Configuration for routing traffic through a proxy.
type ProxyNewResponse struct {
// Proxy type to use. In terms of quality for avoiding bot-detection, from best to
// worst: `mobile` > `residential` > `isp` > `datacenter`.
//
// Any of "datacenter", "isp", "residential", "mobile", "custom".
Type ProxyNewResponseType `json:"type" api:"required"`
ID string `json:"id"`
// Hostnames that should bypass the parent proxy and connect directly.
BypassHosts []string `json:"bypass_hosts"`
// Configuration specific to the selected proxy `type`.
Config ProxyNewResponseConfigUnion `json:"config"`
// IP address that the proxy uses when making requests.
IPAddress string `json:"ip_address"`
// Timestamp of the last health check performed on this proxy.
LastChecked time.Time `json:"last_checked" format:"date-time"`
// Readable name of the proxy.
Name string `json:"name"`
// Protocol to use for the proxy connection.
//
// Any of "http", "https".
Protocol ProxyNewResponseProtocol `json:"protocol"`
// Current health status of the proxy.
//
// Any of "available", "unavailable".
Status ProxyNewResponseStatus `json:"status"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Type respjson.Field
ID respjson.Field
BypassHosts respjson.Field
Config respjson.Field
IPAddress respjson.Field
LastChecked respjson.Field
Name respjson.Field
Protocol respjson.Field
Status respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyNewResponse) RawJSON() string { return r.JSON.raw }
func (r *ProxyNewResponse) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Proxy type to use. In terms of quality for avoiding bot-detection, from best to
// worst: `mobile` > `residential` > `isp` > `datacenter`.
type ProxyNewResponseType string
const (
ProxyNewResponseTypeDatacenter ProxyNewResponseType = "datacenter"
ProxyNewResponseTypeIsp ProxyNewResponseType = "isp"
ProxyNewResponseTypeResidential ProxyNewResponseType = "residential"
ProxyNewResponseTypeMobile ProxyNewResponseType = "mobile"
ProxyNewResponseTypeCustom ProxyNewResponseType = "custom"
)
// ProxyNewResponseConfigUnion contains all possible properties and values from
// [ProxyNewResponseConfigDatacenterProxyConfig],
// [ProxyNewResponseConfigIspProxyConfig],
// [ProxyNewResponseConfigResidentialProxyConfig],
// [ProxyNewResponseConfigMobileProxyConfig],
// [ProxyNewResponseConfigCustomProxyConfig].
//
// Use the methods beginning with 'As' to cast the union to one of its variants.
type ProxyNewResponseConfigUnion struct {
Country string `json:"country"`
Asn string `json:"asn"`
City string `json:"city"`
// This field is from variant [ProxyNewResponseConfigResidentialProxyConfig].
Os string `json:"os"`
State string `json:"state"`
Zip string `json:"zip"`
// This field is from variant [ProxyNewResponseConfigMobileProxyConfig].
Carrier string `json:"carrier"`
// This field is from variant [ProxyNewResponseConfigCustomProxyConfig].
Host string `json:"host"`
// This field is from variant [ProxyNewResponseConfigCustomProxyConfig].
Port int64 `json:"port"`
// This field is from variant [ProxyNewResponseConfigCustomProxyConfig].
HasPassword bool `json:"has_password"`
// This field is from variant [ProxyNewResponseConfigCustomProxyConfig].
Username string `json:"username"`
JSON struct {
Country respjson.Field
Asn respjson.Field
City respjson.Field
Os respjson.Field
State respjson.Field
Zip respjson.Field
Carrier respjson.Field
Host respjson.Field
Port respjson.Field
HasPassword respjson.Field
Username respjson.Field
raw string
} `json:"-"`
}
func (u ProxyNewResponseConfigUnion) AsProxyNewResponseConfigDatacenterProxyConfig() (v ProxyNewResponseConfigDatacenterProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
func (u ProxyNewResponseConfigUnion) AsProxyNewResponseConfigIspProxyConfig() (v ProxyNewResponseConfigIspProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
func (u ProxyNewResponseConfigUnion) AsProxyNewResponseConfigResidentialProxyConfig() (v ProxyNewResponseConfigResidentialProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
func (u ProxyNewResponseConfigUnion) AsProxyNewResponseConfigMobileProxyConfig() (v ProxyNewResponseConfigMobileProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
func (u ProxyNewResponseConfigUnion) AsProxyNewResponseConfigCustomProxyConfig() (v ProxyNewResponseConfigCustomProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
// Returns the unmodified JSON received from the API
func (u ProxyNewResponseConfigUnion) RawJSON() string { return u.JSON.raw }
func (r *ProxyNewResponseConfigUnion) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for a datacenter proxy.
type ProxyNewResponseConfigDatacenterProxyConfig struct {
// ISO 3166 country code. Defaults to US if not provided.
Country string `json:"country"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Country respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyNewResponseConfigDatacenterProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyNewResponseConfigDatacenterProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for an ISP proxy.
type ProxyNewResponseConfigIspProxyConfig struct {
// ISO 3166 country code. Defaults to US if not provided.
Country string `json:"country"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Country respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyNewResponseConfigIspProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyNewResponseConfigIspProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for residential proxies.
type ProxyNewResponseConfigResidentialProxyConfig struct {
// Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
Asn string `json:"asn"`
// City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
// provided.
City string `json:"city"`
// ISO 3166 country code.
Country string `json:"country"`
// Operating system of the residential device.
//
// Any of "windows", "macos", "android".
//
// Deprecated: deprecated
Os string `json:"os"`
// Two-letter state code.
State string `json:"state"`
// US ZIP code.
Zip string `json:"zip"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Asn respjson.Field
City respjson.Field
Country respjson.Field
Os respjson.Field
State respjson.Field
Zip respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyNewResponseConfigResidentialProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyNewResponseConfigResidentialProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for mobile proxies.
type ProxyNewResponseConfigMobileProxyConfig struct {
// Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
Asn string `json:"asn"`
// Mobile carrier.
//
// Any of "a1", "aircel", "airtel", "att", "celcom", "chinamobile", "claro",
// "comcast", "cox", "digi", "dt", "docomo", "dtac", "etisalat", "idea",
// "kyivstar", "meo", "megafon", "mtn", "mtnza", "mts", "optus", "orange", "qwest",
// "reliance_jio", "robi", "sprint", "telefonica", "telstra", "tmobile", "tigo",
// "tim", "verizon", "vimpelcom", "vodacomza", "vodafone", "vivo", "zain",
// "vivabo", "telenormyanmar", "kcelljsc", "swisscom", "singtel", "asiacell",
// "windit", "cellc", "ooredoo", "drei", "umobile", "cableone", "proximus",
// "tele2", "mobitel", "o2", "bouygues", "free", "sfr", "digicel".
Carrier string `json:"carrier"`
// City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
// provided.
City string `json:"city"`
// ISO 3166 country code
Country string `json:"country"`
// Two-letter state code.
State string `json:"state"`
// US ZIP code.
Zip string `json:"zip"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Asn respjson.Field
Carrier respjson.Field
City respjson.Field
Country respjson.Field
State respjson.Field
Zip respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyNewResponseConfigMobileProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyNewResponseConfigMobileProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for a custom proxy (e.g., private proxy server).
type ProxyNewResponseConfigCustomProxyConfig struct {
// Proxy host address or IP.
Host string `json:"host" api:"required"`
// Proxy port.
Port int64 `json:"port" api:"required"`
// Whether the proxy has a password.
HasPassword bool `json:"has_password"`
// Username for proxy authentication.
Username string `json:"username"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Host respjson.Field
Port respjson.Field
HasPassword respjson.Field
Username respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyNewResponseConfigCustomProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyNewResponseConfigCustomProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Protocol to use for the proxy connection.
type ProxyNewResponseProtocol string
const (
ProxyNewResponseProtocolHTTP ProxyNewResponseProtocol = "http"
ProxyNewResponseProtocolHTTPS ProxyNewResponseProtocol = "https"
)
// Current health status of the proxy.
type ProxyNewResponseStatus string
const (
ProxyNewResponseStatusAvailable ProxyNewResponseStatus = "available"
ProxyNewResponseStatusUnavailable ProxyNewResponseStatus = "unavailable"
)
// Configuration for routing traffic through a proxy.
type ProxyGetResponse struct {
// Proxy type to use. In terms of quality for avoiding bot-detection, from best to
// worst: `mobile` > `residential` > `isp` > `datacenter`.
//
// Any of "datacenter", "isp", "residential", "mobile", "custom".
Type ProxyGetResponseType `json:"type" api:"required"`
ID string `json:"id"`
// Hostnames that should bypass the parent proxy and connect directly.
BypassHosts []string `json:"bypass_hosts"`
// Configuration specific to the selected proxy `type`.
Config ProxyGetResponseConfigUnion `json:"config"`
// IP address that the proxy uses when making requests.
IPAddress string `json:"ip_address"`
// Timestamp of the last health check performed on this proxy.
LastChecked time.Time `json:"last_checked" format:"date-time"`
// Readable name of the proxy.
Name string `json:"name"`
// Protocol to use for the proxy connection.
//
// Any of "http", "https".
Protocol ProxyGetResponseProtocol `json:"protocol"`
// Current health status of the proxy.
//
// Any of "available", "unavailable".
Status ProxyGetResponseStatus `json:"status"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Type respjson.Field
ID respjson.Field
BypassHosts respjson.Field
Config respjson.Field
IPAddress respjson.Field
LastChecked respjson.Field
Name respjson.Field
Protocol respjson.Field
Status respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyGetResponse) RawJSON() string { return r.JSON.raw }
func (r *ProxyGetResponse) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Proxy type to use. In terms of quality for avoiding bot-detection, from best to
// worst: `mobile` > `residential` > `isp` > `datacenter`.
type ProxyGetResponseType string
const (
ProxyGetResponseTypeDatacenter ProxyGetResponseType = "datacenter"
ProxyGetResponseTypeIsp ProxyGetResponseType = "isp"
ProxyGetResponseTypeResidential ProxyGetResponseType = "residential"
ProxyGetResponseTypeMobile ProxyGetResponseType = "mobile"
ProxyGetResponseTypeCustom ProxyGetResponseType = "custom"
)
// ProxyGetResponseConfigUnion contains all possible properties and values from
// [ProxyGetResponseConfigDatacenterProxyConfig],
// [ProxyGetResponseConfigIspProxyConfig],
// [ProxyGetResponseConfigResidentialProxyConfig],
// [ProxyGetResponseConfigMobileProxyConfig],
// [ProxyGetResponseConfigCustomProxyConfig].
//
// Use the methods beginning with 'As' to cast the union to one of its variants.
type ProxyGetResponseConfigUnion struct {
Country string `json:"country"`
Asn string `json:"asn"`
City string `json:"city"`
// This field is from variant [ProxyGetResponseConfigResidentialProxyConfig].
Os string `json:"os"`
State string `json:"state"`
Zip string `json:"zip"`
// This field is from variant [ProxyGetResponseConfigMobileProxyConfig].
Carrier string `json:"carrier"`
// This field is from variant [ProxyGetResponseConfigCustomProxyConfig].
Host string `json:"host"`
// This field is from variant [ProxyGetResponseConfigCustomProxyConfig].
Port int64 `json:"port"`
// This field is from variant [ProxyGetResponseConfigCustomProxyConfig].
HasPassword bool `json:"has_password"`
// This field is from variant [ProxyGetResponseConfigCustomProxyConfig].
Username string `json:"username"`
JSON struct {
Country respjson.Field
Asn respjson.Field
City respjson.Field
Os respjson.Field
State respjson.Field
Zip respjson.Field
Carrier respjson.Field
Host respjson.Field
Port respjson.Field
HasPassword respjson.Field
Username respjson.Field
raw string
} `json:"-"`
}
func (u ProxyGetResponseConfigUnion) AsProxyGetResponseConfigDatacenterProxyConfig() (v ProxyGetResponseConfigDatacenterProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
func (u ProxyGetResponseConfigUnion) AsProxyGetResponseConfigIspProxyConfig() (v ProxyGetResponseConfigIspProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
func (u ProxyGetResponseConfigUnion) AsProxyGetResponseConfigResidentialProxyConfig() (v ProxyGetResponseConfigResidentialProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
func (u ProxyGetResponseConfigUnion) AsProxyGetResponseConfigMobileProxyConfig() (v ProxyGetResponseConfigMobileProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
func (u ProxyGetResponseConfigUnion) AsProxyGetResponseConfigCustomProxyConfig() (v ProxyGetResponseConfigCustomProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
// Returns the unmodified JSON received from the API
func (u ProxyGetResponseConfigUnion) RawJSON() string { return u.JSON.raw }
func (r *ProxyGetResponseConfigUnion) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for a datacenter proxy.
type ProxyGetResponseConfigDatacenterProxyConfig struct {
// ISO 3166 country code. Defaults to US if not provided.
Country string `json:"country"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Country respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyGetResponseConfigDatacenterProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyGetResponseConfigDatacenterProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for an ISP proxy.
type ProxyGetResponseConfigIspProxyConfig struct {
// ISO 3166 country code. Defaults to US if not provided.
Country string `json:"country"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Country respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyGetResponseConfigIspProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyGetResponseConfigIspProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for residential proxies.
type ProxyGetResponseConfigResidentialProxyConfig struct {
// Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
Asn string `json:"asn"`
// City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
// provided.
City string `json:"city"`
// ISO 3166 country code.
Country string `json:"country"`
// Operating system of the residential device.
//
// Any of "windows", "macos", "android".
//
// Deprecated: deprecated
Os string `json:"os"`
// Two-letter state code.
State string `json:"state"`
// US ZIP code.
Zip string `json:"zip"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Asn respjson.Field
City respjson.Field
Country respjson.Field
Os respjson.Field
State respjson.Field
Zip respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyGetResponseConfigResidentialProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyGetResponseConfigResidentialProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for mobile proxies.
type ProxyGetResponseConfigMobileProxyConfig struct {
// Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
Asn string `json:"asn"`
// Mobile carrier.
//
// Any of "a1", "aircel", "airtel", "att", "celcom", "chinamobile", "claro",
// "comcast", "cox", "digi", "dt", "docomo", "dtac", "etisalat", "idea",
// "kyivstar", "meo", "megafon", "mtn", "mtnza", "mts", "optus", "orange", "qwest",
// "reliance_jio", "robi", "sprint", "telefonica", "telstra", "tmobile", "tigo",
// "tim", "verizon", "vimpelcom", "vodacomza", "vodafone", "vivo", "zain",
// "vivabo", "telenormyanmar", "kcelljsc", "swisscom", "singtel", "asiacell",
// "windit", "cellc", "ooredoo", "drei", "umobile", "cableone", "proximus",
// "tele2", "mobitel", "o2", "bouygues", "free", "sfr", "digicel".
Carrier string `json:"carrier"`
// City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
// provided.
City string `json:"city"`
// ISO 3166 country code
Country string `json:"country"`
// Two-letter state code.
State string `json:"state"`
// US ZIP code.
Zip string `json:"zip"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Asn respjson.Field
Carrier respjson.Field
City respjson.Field
Country respjson.Field
State respjson.Field
Zip respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyGetResponseConfigMobileProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyGetResponseConfigMobileProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for a custom proxy (e.g., private proxy server).
type ProxyGetResponseConfigCustomProxyConfig struct {
// Proxy host address or IP.
Host string `json:"host" api:"required"`
// Proxy port.
Port int64 `json:"port" api:"required"`
// Whether the proxy has a password.
HasPassword bool `json:"has_password"`
// Username for proxy authentication.
Username string `json:"username"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Host respjson.Field
Port respjson.Field
HasPassword respjson.Field
Username respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyGetResponseConfigCustomProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyGetResponseConfigCustomProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Protocol to use for the proxy connection.
type ProxyGetResponseProtocol string
const (
ProxyGetResponseProtocolHTTP ProxyGetResponseProtocol = "http"
ProxyGetResponseProtocolHTTPS ProxyGetResponseProtocol = "https"
)
// Current health status of the proxy.
type ProxyGetResponseStatus string
const (
ProxyGetResponseStatusAvailable ProxyGetResponseStatus = "available"
ProxyGetResponseStatusUnavailable ProxyGetResponseStatus = "unavailable"
)
// Configuration for routing traffic through a proxy.
type ProxyListResponse struct {
// Proxy type to use. In terms of quality for avoiding bot-detection, from best to
// worst: `mobile` > `residential` > `isp` > `datacenter`.
//
// Any of "datacenter", "isp", "residential", "mobile", "custom".
Type ProxyListResponseType `json:"type" api:"required"`
ID string `json:"id"`
// Hostnames that should bypass the parent proxy and connect directly.
BypassHosts []string `json:"bypass_hosts"`
// Configuration specific to the selected proxy `type`.
Config ProxyListResponseConfigUnion `json:"config"`
// IP address that the proxy uses when making requests.
IPAddress string `json:"ip_address"`
// Timestamp of the last health check performed on this proxy.
LastChecked time.Time `json:"last_checked" format:"date-time"`
// Readable name of the proxy.
Name string `json:"name"`
// Protocol to use for the proxy connection.
//
// Any of "http", "https".
Protocol ProxyListResponseProtocol `json:"protocol"`
// Current health status of the proxy.
//
// Any of "available", "unavailable".
Status ProxyListResponseStatus `json:"status"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Type respjson.Field
ID respjson.Field
BypassHosts respjson.Field
Config respjson.Field
IPAddress respjson.Field
LastChecked respjson.Field
Name respjson.Field
Protocol respjson.Field
Status respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyListResponse) RawJSON() string { return r.JSON.raw }
func (r *ProxyListResponse) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Proxy type to use. In terms of quality for avoiding bot-detection, from best to
// worst: `mobile` > `residential` > `isp` > `datacenter`.
type ProxyListResponseType string
const (
ProxyListResponseTypeDatacenter ProxyListResponseType = "datacenter"
ProxyListResponseTypeIsp ProxyListResponseType = "isp"
ProxyListResponseTypeResidential ProxyListResponseType = "residential"
ProxyListResponseTypeMobile ProxyListResponseType = "mobile"
ProxyListResponseTypeCustom ProxyListResponseType = "custom"
)
// ProxyListResponseConfigUnion contains all possible properties and values from
// [ProxyListResponseConfigDatacenterProxyConfig],
// [ProxyListResponseConfigIspProxyConfig],
// [ProxyListResponseConfigResidentialProxyConfig],
// [ProxyListResponseConfigMobileProxyConfig],
// [ProxyListResponseConfigCustomProxyConfig].
//
// Use the methods beginning with 'As' to cast the union to one of its variants.
type ProxyListResponseConfigUnion struct {
Country string `json:"country"`
Asn string `json:"asn"`
City string `json:"city"`
// This field is from variant [ProxyListResponseConfigResidentialProxyConfig].
Os string `json:"os"`
State string `json:"state"`
Zip string `json:"zip"`
// This field is from variant [ProxyListResponseConfigMobileProxyConfig].
Carrier string `json:"carrier"`
// This field is from variant [ProxyListResponseConfigCustomProxyConfig].
Host string `json:"host"`
// This field is from variant [ProxyListResponseConfigCustomProxyConfig].
Port int64 `json:"port"`
// This field is from variant [ProxyListResponseConfigCustomProxyConfig].
HasPassword bool `json:"has_password"`
// This field is from variant [ProxyListResponseConfigCustomProxyConfig].
Username string `json:"username"`
JSON struct {
Country respjson.Field
Asn respjson.Field
City respjson.Field
Os respjson.Field
State respjson.Field
Zip respjson.Field
Carrier respjson.Field
Host respjson.Field
Port respjson.Field
HasPassword respjson.Field
Username respjson.Field
raw string
} `json:"-"`
}
func (u ProxyListResponseConfigUnion) AsProxyListResponseConfigDatacenterProxyConfig() (v ProxyListResponseConfigDatacenterProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
func (u ProxyListResponseConfigUnion) AsProxyListResponseConfigIspProxyConfig() (v ProxyListResponseConfigIspProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
func (u ProxyListResponseConfigUnion) AsProxyListResponseConfigResidentialProxyConfig() (v ProxyListResponseConfigResidentialProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
func (u ProxyListResponseConfigUnion) AsProxyListResponseConfigMobileProxyConfig() (v ProxyListResponseConfigMobileProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
func (u ProxyListResponseConfigUnion) AsProxyListResponseConfigCustomProxyConfig() (v ProxyListResponseConfigCustomProxyConfig) {
apijson.UnmarshalRoot(json.RawMessage(u.JSON.raw), &v)
return
}
// Returns the unmodified JSON received from the API
func (u ProxyListResponseConfigUnion) RawJSON() string { return u.JSON.raw }
func (r *ProxyListResponseConfigUnion) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for a datacenter proxy.
type ProxyListResponseConfigDatacenterProxyConfig struct {
// ISO 3166 country code. Defaults to US if not provided.
Country string `json:"country"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Country respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyListResponseConfigDatacenterProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyListResponseConfigDatacenterProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for an ISP proxy.
type ProxyListResponseConfigIspProxyConfig struct {
// ISO 3166 country code. Defaults to US if not provided.
Country string `json:"country"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Country respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyListResponseConfigIspProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyListResponseConfigIspProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for residential proxies.
type ProxyListResponseConfigResidentialProxyConfig struct {
// Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
Asn string `json:"asn"`
// City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
// provided.
City string `json:"city"`
// ISO 3166 country code.
Country string `json:"country"`
// Operating system of the residential device.
//
// Any of "windows", "macos", "android".
//
// Deprecated: deprecated
Os string `json:"os"`
// Two-letter state code.
State string `json:"state"`
// US ZIP code.
Zip string `json:"zip"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Asn respjson.Field
City respjson.Field
Country respjson.Field
Os respjson.Field
State respjson.Field
Zip respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyListResponseConfigResidentialProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyListResponseConfigResidentialProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for mobile proxies.
type ProxyListResponseConfigMobileProxyConfig struct {
// Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
Asn string `json:"asn"`
// Mobile carrier.
//
// Any of "a1", "aircel", "airtel", "att", "celcom", "chinamobile", "claro",
// "comcast", "cox", "digi", "dt", "docomo", "dtac", "etisalat", "idea",
// "kyivstar", "meo", "megafon", "mtn", "mtnza", "mts", "optus", "orange", "qwest",
// "reliance_jio", "robi", "sprint", "telefonica", "telstra", "tmobile", "tigo",
// "tim", "verizon", "vimpelcom", "vodacomza", "vodafone", "vivo", "zain",
// "vivabo", "telenormyanmar", "kcelljsc", "swisscom", "singtel", "asiacell",
// "windit", "cellc", "ooredoo", "drei", "umobile", "cableone", "proximus",
// "tele2", "mobitel", "o2", "bouygues", "free", "sfr", "digicel".
Carrier string `json:"carrier"`
// City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
// provided.
City string `json:"city"`
// ISO 3166 country code
Country string `json:"country"`
// Two-letter state code.
State string `json:"state"`
// US ZIP code.
Zip string `json:"zip"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Asn respjson.Field
Carrier respjson.Field
City respjson.Field
Country respjson.Field
State respjson.Field
Zip respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyListResponseConfigMobileProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyListResponseConfigMobileProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Configuration for a custom proxy (e.g., private proxy server).
type ProxyListResponseConfigCustomProxyConfig struct {
// Proxy host address or IP.
Host string `json:"host" api:"required"`
// Proxy port.
Port int64 `json:"port" api:"required"`
// Whether the proxy has a password.
HasPassword bool `json:"has_password"`
// Username for proxy authentication.
Username string `json:"username"`
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
JSON struct {
Host respjson.Field
Port respjson.Field
HasPassword respjson.Field
Username respjson.Field
ExtraFields map[string]respjson.Field
raw string
} `json:"-"`
}
// Returns the unmodified JSON received from the API
func (r ProxyListResponseConfigCustomProxyConfig) RawJSON() string { return r.JSON.raw }
func (r *ProxyListResponseConfigCustomProxyConfig) UnmarshalJSON(data []byte) error {
return apijson.UnmarshalRoot(data, r)
}
// Protocol to use for the proxy connection.
type ProxyListResponseProtocol string
const (
ProxyListResponseProtocolHTTP ProxyListResponseProtocol = "http"
ProxyListResponseProtocolHTTPS ProxyListResponseProtocol = "https"
)
// Current health status of the proxy.
type ProxyListResponseStatus string
const (
ProxyListResponseStatusAvailable ProxyListResponseStatus = "available"
ProxyListResponseStatusUnavailable ProxyListResponseStatus = "unavailable"
)
// Configuration for routing traffic through a proxy.
type ProxyCheckResponse struct {
// Proxy type to use. In terms of quality for avoiding bot-detection, from best to
// worst: `mobile` > `residential` > `isp` > `datacenter`.
//
// Any of "datacenter", "isp", "residential", "mobile", "custom".
Type ProxyCheckResponseType `json:"type" api:"required"`
ID string `json:"id"`
// Hostnames that should bypass the parent proxy and connect directly.
BypassHosts []string `json:"bypass_hosts"`
// Configuration specific to the selected proxy `type`.
Config ProxyCheckResponseConfigUnion `json:"config"`
// IP address that the proxy uses when making requests.
IPAddress string `json:"ip_address"`
// Timestamp of the last health check performed on this proxy.
LastChecked time.Time `json:"last_checked" format:"date-time"`
// Readable name of the proxy.
Name string `json:"name"`
// Protocol to use for the proxy connection.
//
// Any of "http", "https".
Protocol ProxyCheckResponseProtocol `json:"protocol"`
// Current health status of the proxy.
//