-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi_filters.go
More file actions
816 lines (677 loc) · 32 KB
/
Copy pathapi_filters.go
File metadata and controls
816 lines (677 loc) · 32 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
/*
GoAdServer Public API
Public REST API for advertisers and publishers on the GoAdServer platform. **Authentication.** All endpoints (except `/api/public/_*`) require an API key passed as `Authorization: Bearer gas_live_…`. Create and manage keys in your account settings — each key has its own scopes, optional resource pinning, optional IP allowlist, and per-key rate limit. **System rules apply over API rules.** The public API never lets a key bypass restrictions the same user faces in the panel: - **Source names** (`stats_source_names` right). When the user lacks this right, advertiser stats responses return `{id, name}` with `name` equal to the id — no human label leaks through. - **SubID encoding** (`modules.global.subid_encoding`). When enabled for the system, the user only ever sees encoded SubIDs in the panel. The API mirrors this both ways: `subid_excl`/`subid_incl` filter endpoints accept the encoded form on write (decoded server-side before storage) and emit the encoded form on read. - **Module gating.** Endpoints whose module is disabled for the tenant don't appear in the spec or routes.txt at all. **Client SDKs.** Each SDK is generated from this spec and published as a public GitHub repository under the `goadserver` organization. The same tarball is also embedded in the API server and downloadable from `/api/public/sdk/<lang>.tgz` — useful when GitHub is unreachable. > **Per-network host.** The default `https://up.go-adserver.com` > baked into the published SDKs is a reference host. Every white-label > tenant runs on its own panel domain — override the host on first use > (`setHost()` / `Configuration.host` / `basePath` etc.). Or, fetch the > spec from your own tenant (`/api/public/openapi.yaml` returns it with > *your* hostname as the default) and regenerate the SDK locally — the > regenerated client has your URL baked in. - **PHP** — `github.com/goadserver/goadserver-php` (namespace `GoAdServer\\Api`, composer name `goadserver/sdk`). ```bash composer config repositories.goadserver vcs https://github.com/goadserver/goadserver-php composer require goadserver/sdk:dev-main ``` ```php $cfg = GoAdServer\\Api\\Configuration::getDefaultConfiguration() ->setHost('https://up.go-adserver.com') ->setAccessToken('gas_live_…'); $api = new GoAdServer\\Api\\Api\\AccountAPIApi(null, $cfg); $me = $api->apiV1AccountGet(); ``` - **Go** — `github.com/goadserver/goadserver-go`. ```bash go get github.com/goadserver/goadserver-go@latest ``` ```go import gas \"github.com/goadserver/goadserver-go\" cfg := gas.NewConfiguration() cfg.Servers = gas.ServerConfigurations{{URL: \"https://up.go-adserver.com\"}} cli := gas.NewAPIClient(cfg) ctx := context.WithValue(context.Background(), gas.ContextAccessToken, \"gas_live_…\") me, _, err := cli.AccountAPI.ApiV1AccountGet(ctx).Execute() ``` - **Python** — `github.com/goadserver/goadserver-python` (package `goadserver`). Pulls `pydantic` + `urllib3` automatically. ```bash pip install git+https://github.com/goadserver/goadserver-python.git ``` ```python from goadserver import ApiClient, Configuration from goadserver.api import AccountApi, CampaignsApi cfg = Configuration(host=\"https://up.go-adserver.com\") cfg.access_token = \"gas_live_…\" client = ApiClient(cfg) me = AccountApi(client).api_v1_account_get() camps = CampaignsApi(client).api_v1_campaigns_get(per_page=10) ``` - **JavaScript / TypeScript** — `github.com/goadserver/goadserver-js` (npm name `goadserver-sdk`, generator `typescript-fetch`). ```bash npm install github:goadserver/goadserver-js ``` ```ts import { Configuration, AccountApi, CampaignsApi } from \"goadserver-sdk\"; const cfg = new Configuration({ basePath: \"https://up.go-adserver.com\", accessToken: \"gas_live_…\", }); const me = await new AccountApi(cfg).apiV1AccountGet(); const list = await new CampaignsApi(cfg).apiV1CampaignsGet({ perPage: 10 }); ``` The CJS build is broadly compatible (Node + bundlers); the ESM build is missing trailing `.js` extensions in its imports, a known `typescript-fetch` quirk — most consumers use CJS. **Offline / firewalled install.** If the customer's network can't reach GitHub, every SDK's source is also served as a tarball from the API host: ```bash curl -O https://up.go-adserver.com/api/public/sdk/python.tgz tar xzf python.tgz && pip install ./python ``` Round-trip smoke tests for all four SDKs live at `clients/_smoke/` in the platform repo.
API version: 1.0.0
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package goadserver
import (
"bytes"
"context"
"io"
"net/http"
"net/url"
"strings"
)
// FiltersAPIService FiltersAPI service
type FiltersAPIService service
type ApiApiV1FiltersGetRequest struct {
ctx context.Context
ApiService *FiltersAPIService
type_ *string
}
// Filter to one type.
func (r ApiApiV1FiltersGetRequest) Type_(type_ string) ApiApiV1FiltersGetRequest {
r.type_ = &type_
return r
}
func (r ApiApiV1FiltersGetRequest) Execute() (*ApiV1FiltersGet200Response, *http.Response, error) {
return r.ApiService.ApiV1FiltersGetExecute(r)
}
/*
ApiV1FiltersGet List all filters across types.
Each filter has a **type** and may apply globally or to specific
campaigns. Types:
| type | meaning | toggleable |
|---------------|----------------------------------|:----------:|
| `domain_excl` | Block these domains | yes |
| `domain_incl` | Only allow these domains | no |
| `adzone_excl` | Block these ad zones | yes |
| `adzone_incl` | Only allow these ad zones | no |
| `isp_excl` | Block these ISPs | yes |
| `subid_excl` | Block these SubIDs | yes |
| `subid_incl` | Only allow these SubIDs | no |
| `ip` | IP-pool blocking | no |
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiApiV1FiltersGetRequest
*/
func (a *FiltersAPIService) ApiV1FiltersGet(ctx context.Context) ApiApiV1FiltersGetRequest {
return ApiApiV1FiltersGetRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
// @return ApiV1FiltersGet200Response
func (a *FiltersAPIService) ApiV1FiltersGetExecute(r ApiApiV1FiltersGetRequest) (*ApiV1FiltersGet200Response, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *ApiV1FiltersGet200Response
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FiltersAPIService.ApiV1FiltersGet")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/filters"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.type_ != nil {
parameterAddToHeaderOrQuery(localVarQueryParams, "type", r.type_, "form", "")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type ApiApiV1FiltersPostRequest struct {
ctx context.Context
ApiService *FiltersAPIService
apiV1FiltersPostRequest *ApiV1FiltersPostRequest
}
func (r ApiApiV1FiltersPostRequest) ApiV1FiltersPostRequest(apiV1FiltersPostRequest ApiV1FiltersPostRequest) ApiApiV1FiltersPostRequest {
r.apiV1FiltersPostRequest = &apiV1FiltersPostRequest
return r
}
func (r ApiApiV1FiltersPostRequest) Execute() (*FilterDetail, *http.Response, error) {
return r.ApiService.ApiV1FiltersPostExecute(r)
}
/*
ApiV1FiltersPost Create a filter and populate it with items.
For `domain_excl` / `domain_incl`: items can be domain URLs
(`"https://evil.com/x"`) — automatically resolved to internal
domain IDs — or numeric domain IDs as strings.
For `adzone_excl` / `adzone_incl` / `isp_excl`: items must be
numeric IDs.
For `subid_excl` / `subid_incl`: items are raw SubID strings.
IP pool creation is not yet exposed via the public API.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiApiV1FiltersPostRequest
*/
func (a *FiltersAPIService) ApiV1FiltersPost(ctx context.Context) ApiApiV1FiltersPostRequest {
return ApiApiV1FiltersPostRequest{
ApiService: a,
ctx: ctx,
}
}
// Execute executes the request
// @return FilterDetail
func (a *FiltersAPIService) ApiV1FiltersPostExecute(r ApiApiV1FiltersPostRequest) (*FilterDetail, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *FilterDetail
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FiltersAPIService.ApiV1FiltersPost")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/filters"
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.apiV1FiltersPostRequest == nil {
return localVarReturnValue, nil, reportError("apiV1FiltersPostRequest is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.apiV1FiltersPostRequest
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type ApiApiV1FiltersTypeIdActivePatchRequest struct {
ctx context.Context
ApiService *FiltersAPIService
type_ string
id int32
apiV1CampaignsTypeIdActivePatchRequest *ApiV1CampaignsTypeIdActivePatchRequest
}
func (r ApiApiV1FiltersTypeIdActivePatchRequest) ApiV1CampaignsTypeIdActivePatchRequest(apiV1CampaignsTypeIdActivePatchRequest ApiV1CampaignsTypeIdActivePatchRequest) ApiApiV1FiltersTypeIdActivePatchRequest {
r.apiV1CampaignsTypeIdActivePatchRequest = &apiV1CampaignsTypeIdActivePatchRequest
return r
}
func (r ApiApiV1FiltersTypeIdActivePatchRequest) Execute() (*ApiV1FiltersTypeIdActivePatch200Response, *http.Response, error) {
return r.ApiService.ApiV1FiltersTypeIdActivePatchExecute(r)
}
/*
ApiV1FiltersTypeIdActivePatch Activate or deactivate a filter (exclusion types only).
Only `*_excl` filters have an active/inactive state. Inclusion
filters and IP pools always apply when a campaign references them
— disable by removing the reference instead.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param type_
@param id
@return ApiApiV1FiltersTypeIdActivePatchRequest
*/
func (a *FiltersAPIService) ApiV1FiltersTypeIdActivePatch(ctx context.Context, type_ string, id int32) ApiApiV1FiltersTypeIdActivePatchRequest {
return ApiApiV1FiltersTypeIdActivePatchRequest{
ApiService: a,
ctx: ctx,
type_: type_,
id: id,
}
}
// Execute executes the request
// @return ApiV1FiltersTypeIdActivePatch200Response
func (a *FiltersAPIService) ApiV1FiltersTypeIdActivePatchExecute(r ApiApiV1FiltersTypeIdActivePatchRequest) (*ApiV1FiltersTypeIdActivePatch200Response, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPatch
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *ApiV1FiltersTypeIdActivePatch200Response
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FiltersAPIService.ApiV1FiltersTypeIdActivePatch")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/filters/{type}/{id}/active"
localVarPath = strings.Replace(localVarPath, "{"+"type"+"}", url.PathEscape(parameterValueToString(r.type_, "type_")), -1)
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.apiV1CampaignsTypeIdActivePatchRequest == nil {
return localVarReturnValue, nil, reportError("apiV1CampaignsTypeIdActivePatchRequest is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.apiV1CampaignsTypeIdActivePatchRequest
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type ApiApiV1FiltersTypeIdDeleteRequest struct {
ctx context.Context
ApiService *FiltersAPIService
type_ string
id int32
}
func (r ApiApiV1FiltersTypeIdDeleteRequest) Execute() (*http.Response, error) {
return r.ApiService.ApiV1FiltersTypeIdDeleteExecute(r)
}
/*
ApiV1FiltersTypeIdDelete Delete a filter (and its items, for IP pools).
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param type_
@param id
@return ApiApiV1FiltersTypeIdDeleteRequest
*/
func (a *FiltersAPIService) ApiV1FiltersTypeIdDelete(ctx context.Context, type_ string, id int32) ApiApiV1FiltersTypeIdDeleteRequest {
return ApiApiV1FiltersTypeIdDeleteRequest{
ApiService: a,
ctx: ctx,
type_: type_,
id: id,
}
}
// Execute executes the request
func (a *FiltersAPIService) ApiV1FiltersTypeIdDeleteExecute(r ApiApiV1FiltersTypeIdDeleteRequest) (*http.Response, error) {
var (
localVarHTTPMethod = http.MethodDelete
localVarPostBody interface{}
formFiles []formFile
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FiltersAPIService.ApiV1FiltersTypeIdDelete")
if err != nil {
return nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/filters/{type}/{id}"
localVarPath = strings.Replace(localVarPath, "{"+"type"+"}", url.PathEscape(parameterValueToString(r.type_, "type_")), -1)
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarHTTPResponse, newErr
}
return localVarHTTPResponse, nil
}
type ApiApiV1FiltersTypeIdGetRequest struct {
ctx context.Context
ApiService *FiltersAPIService
type_ string
id int32
}
func (r ApiApiV1FiltersTypeIdGetRequest) Execute() (*FilterDetail, *http.Response, error) {
return r.ApiService.ApiV1FiltersTypeIdGetExecute(r)
}
/*
ApiV1FiltersTypeIdGet Get a single filter with its items.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param type_
@param id
@return ApiApiV1FiltersTypeIdGetRequest
*/
func (a *FiltersAPIService) ApiV1FiltersTypeIdGet(ctx context.Context, type_ string, id int32) ApiApiV1FiltersTypeIdGetRequest {
return ApiApiV1FiltersTypeIdGetRequest{
ApiService: a,
ctx: ctx,
type_: type_,
id: id,
}
}
// Execute executes the request
// @return FilterDetail
func (a *FiltersAPIService) ApiV1FiltersTypeIdGetExecute(r ApiApiV1FiltersTypeIdGetRequest) (*FilterDetail, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodGet
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *FilterDetail
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FiltersAPIService.ApiV1FiltersTypeIdGet")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/filters/{type}/{id}"
localVarPath = strings.Replace(localVarPath, "{"+"type"+"}", url.PathEscape(parameterValueToString(r.type_, "type_")), -1)
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type ApiApiV1FiltersTypeIdItemsItemDeleteRequest struct {
ctx context.Context
ApiService *FiltersAPIService
type_ string
id int32
item string
}
func (r ApiApiV1FiltersTypeIdItemsItemDeleteRequest) Execute() (*ApiV1FiltersTypeIdItemsItemDelete200Response, *http.Response, error) {
return r.ApiService.ApiV1FiltersTypeIdItemsItemDeleteExecute(r)
}
/*
ApiV1FiltersTypeIdItemsItemDelete Remove a single item from a filter.
`{item}` is the stored value — domain ID, adzone ID, ISP ID, or SubID string. URL-encode special characters.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param type_
@param id
@param item
@return ApiApiV1FiltersTypeIdItemsItemDeleteRequest
*/
func (a *FiltersAPIService) ApiV1FiltersTypeIdItemsItemDelete(ctx context.Context, type_ string, id int32, item string) ApiApiV1FiltersTypeIdItemsItemDeleteRequest {
return ApiApiV1FiltersTypeIdItemsItemDeleteRequest{
ApiService: a,
ctx: ctx,
type_: type_,
id: id,
item: item,
}
}
// Execute executes the request
// @return ApiV1FiltersTypeIdItemsItemDelete200Response
func (a *FiltersAPIService) ApiV1FiltersTypeIdItemsItemDeleteExecute(r ApiApiV1FiltersTypeIdItemsItemDeleteRequest) (*ApiV1FiltersTypeIdItemsItemDelete200Response, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodDelete
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *ApiV1FiltersTypeIdItemsItemDelete200Response
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FiltersAPIService.ApiV1FiltersTypeIdItemsItemDelete")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/filters/{type}/{id}/items/{item}"
localVarPath = strings.Replace(localVarPath, "{"+"type"+"}", url.PathEscape(parameterValueToString(r.type_, "type_")), -1)
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarPath = strings.Replace(localVarPath, "{"+"item"+"}", url.PathEscape(parameterValueToString(r.item, "item")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}
type ApiApiV1FiltersTypeIdItemsPostRequest struct {
ctx context.Context
ApiService *FiltersAPIService
type_ string
id int32
apiV1FiltersTypeIdItemsPostRequest *ApiV1FiltersTypeIdItemsPostRequest
}
func (r ApiApiV1FiltersTypeIdItemsPostRequest) ApiV1FiltersTypeIdItemsPostRequest(apiV1FiltersTypeIdItemsPostRequest ApiV1FiltersTypeIdItemsPostRequest) ApiApiV1FiltersTypeIdItemsPostRequest {
r.apiV1FiltersTypeIdItemsPostRequest = &apiV1FiltersTypeIdItemsPostRequest
return r
}
func (r ApiApiV1FiltersTypeIdItemsPostRequest) Execute() (*ApiV1FiltersTypeIdItemsPost200Response, *http.Response, error) {
return r.ApiService.ApiV1FiltersTypeIdItemsPostExecute(r)
}
/*
ApiV1FiltersTypeIdItemsPost Add items to an existing filter.
Same input format as creating a filter — domain URLs are
auto-resolved to IDs for domain filters, numeric IDs required
for adzone/ISP filters, raw strings for SubID filters.
Already-present items are deduplicated silently.
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param type_
@param id
@return ApiApiV1FiltersTypeIdItemsPostRequest
*/
func (a *FiltersAPIService) ApiV1FiltersTypeIdItemsPost(ctx context.Context, type_ string, id int32) ApiApiV1FiltersTypeIdItemsPostRequest {
return ApiApiV1FiltersTypeIdItemsPostRequest{
ApiService: a,
ctx: ctx,
type_: type_,
id: id,
}
}
// Execute executes the request
// @return ApiV1FiltersTypeIdItemsPost200Response
func (a *FiltersAPIService) ApiV1FiltersTypeIdItemsPostExecute(r ApiApiV1FiltersTypeIdItemsPostRequest) (*ApiV1FiltersTypeIdItemsPost200Response, *http.Response, error) {
var (
localVarHTTPMethod = http.MethodPost
localVarPostBody interface{}
formFiles []formFile
localVarReturnValue *ApiV1FiltersTypeIdItemsPost200Response
)
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FiltersAPIService.ApiV1FiltersTypeIdItemsPost")
if err != nil {
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
}
localVarPath := localBasePath + "/api/v1/filters/{type}/{id}/items"
localVarPath = strings.Replace(localVarPath, "{"+"type"+"}", url.PathEscape(parameterValueToString(r.type_, "type_")), -1)
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
localVarHeaderParams := make(map[string]string)
localVarQueryParams := url.Values{}
localVarFormParams := url.Values{}
if r.apiV1FiltersTypeIdItemsPostRequest == nil {
return localVarReturnValue, nil, reportError("apiV1FiltersTypeIdItemsPostRequest is required and must be specified")
}
// to determine the Content-Type header
localVarHTTPContentTypes := []string{"application/json"}
// set Content-Type header
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
if localVarHTTPContentType != "" {
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
}
// to determine the Accept header
localVarHTTPHeaderAccepts := []string{"application/json"}
// set Accept header
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
if localVarHTTPHeaderAccept != "" {
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
}
// body params
localVarPostBody = r.apiV1FiltersTypeIdItemsPostRequest
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
if err != nil {
return localVarReturnValue, nil, err
}
localVarHTTPResponse, err := a.client.callAPI(req)
if err != nil || localVarHTTPResponse == nil {
return localVarReturnValue, localVarHTTPResponse, err
}
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
localVarHTTPResponse.Body.Close()
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
if err != nil {
return localVarReturnValue, localVarHTTPResponse, err
}
if localVarHTTPResponse.StatusCode >= 300 {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: localVarHTTPResponse.Status,
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
if err != nil {
newErr := &GenericOpenAPIError{
body: localVarBody,
error: err.Error(),
}
return localVarReturnValue, localVarHTTPResponse, newErr
}
return localVarReturnValue, localVarHTTPResponse, nil
}