-
Notifications
You must be signed in to change notification settings - Fork 541
/
gatewaycategory.go
181 lines (159 loc) · 6.48 KB
/
gatewaycategory.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
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package zero_trust
import (
"context"
"fmt"
"net/http"
"github.com/cloudflare/cloudflare-go/v2/internal/apijson"
"github.com/cloudflare/cloudflare-go/v2/internal/pagination"
"github.com/cloudflare/cloudflare-go/v2/internal/param"
"github.com/cloudflare/cloudflare-go/v2/internal/requestconfig"
"github.com/cloudflare/cloudflare-go/v2/option"
)
// GatewayCategoryService 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 [NewGatewayCategoryService] method
// instead.
type GatewayCategoryService struct {
Options []option.RequestOption
}
// NewGatewayCategoryService 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 NewGatewayCategoryService(opts ...option.RequestOption) (r *GatewayCategoryService) {
r = &GatewayCategoryService{}
r.Options = opts
return
}
// Fetches a list of all categories.
func (r *GatewayCategoryService) List(ctx context.Context, query GatewayCategoryListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Category], err error) {
var raw *http.Response
opts = append(r.Options, opts...)
opts = append([]option.RequestOption{option.WithResponseInto(&raw)}, opts...)
path := fmt.Sprintf("accounts/%s/gateway/categories", query.AccountID)
cfg, err := requestconfig.NewRequestConfig(ctx, http.MethodGet, path, nil, &res, opts...)
if err != nil {
return nil, err
}
err = cfg.Execute()
if err != nil {
return nil, err
}
res.SetPageConfig(cfg, raw)
return res, nil
}
// Fetches a list of all categories.
func (r *GatewayCategoryService) ListAutoPaging(ctx context.Context, query GatewayCategoryListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Category] {
return pagination.NewSinglePageAutoPager(r.List(ctx, query, opts...))
}
type Category struct {
// The identifier for this category. There is only one category per ID.
ID int64 `json:"id"`
// True if the category is in beta and subject to change.
Beta bool `json:"beta"`
// Which account types are allowed to create policies based on this category.
// `blocked` categories are blocked unconditionally for all accounts.
// `removalPending` categories can be removed from policies but not added.
// `noBlock` categories cannot be blocked.
Class CategoryClass `json:"class"`
// A short summary of domains in the category.
Description string `json:"description"`
// The name of the category.
Name string `json:"name"`
// All subcategories for this category.
Subcategories []CategorySubcategory `json:"subcategories"`
JSON categoryJSON `json:"-"`
}
// categoryJSON contains the JSON metadata for the struct [Category]
type categoryJSON struct {
ID apijson.Field
Beta apijson.Field
Class apijson.Field
Description apijson.Field
Name apijson.Field
Subcategories apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *Category) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r categoryJSON) RawJSON() string {
return r.raw
}
// Which account types are allowed to create policies based on this category.
// `blocked` categories are blocked unconditionally for all accounts.
// `removalPending` categories can be removed from policies but not added.
// `noBlock` categories cannot be blocked.
type CategoryClass string
const (
CategoryClassFree CategoryClass = "free"
CategoryClassPremium CategoryClass = "premium"
CategoryClassBlocked CategoryClass = "blocked"
CategoryClassRemovalPending CategoryClass = "removalPending"
CategoryClassNoBlock CategoryClass = "noBlock"
)
func (r CategoryClass) IsKnown() bool {
switch r {
case CategoryClassFree, CategoryClassPremium, CategoryClassBlocked, CategoryClassRemovalPending, CategoryClassNoBlock:
return true
}
return false
}
type CategorySubcategory struct {
// The identifier for this category. There is only one category per ID.
ID int64 `json:"id"`
// True if the category is in beta and subject to change.
Beta bool `json:"beta"`
// Which account types are allowed to create policies based on this category.
// `blocked` categories are blocked unconditionally for all accounts.
// `removalPending` categories can be removed from policies but not added.
// `noBlock` categories cannot be blocked.
Class CategorySubcategoriesClass `json:"class"`
// A short summary of domains in the category.
Description string `json:"description"`
// The name of the category.
Name string `json:"name"`
JSON categorySubcategoryJSON `json:"-"`
}
// categorySubcategoryJSON contains the JSON metadata for the struct
// [CategorySubcategory]
type categorySubcategoryJSON struct {
ID apijson.Field
Beta apijson.Field
Class apijson.Field
Description apijson.Field
Name apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *CategorySubcategory) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r categorySubcategoryJSON) RawJSON() string {
return r.raw
}
// Which account types are allowed to create policies based on this category.
// `blocked` categories are blocked unconditionally for all accounts.
// `removalPending` categories can be removed from policies but not added.
// `noBlock` categories cannot be blocked.
type CategorySubcategoriesClass string
const (
CategorySubcategoriesClassFree CategorySubcategoriesClass = "free"
CategorySubcategoriesClassPremium CategorySubcategoriesClass = "premium"
CategorySubcategoriesClassBlocked CategorySubcategoriesClass = "blocked"
CategorySubcategoriesClassRemovalPending CategorySubcategoriesClass = "removalPending"
CategorySubcategoriesClassNoBlock CategorySubcategoriesClass = "noBlock"
)
func (r CategorySubcategoriesClass) IsKnown() bool {
switch r {
case CategorySubcategoriesClassFree, CategorySubcategoriesClassPremium, CategorySubcategoriesClassBlocked, CategorySubcategoriesClassRemovalPending, CategorySubcategoriesClassNoBlock:
return true
}
return false
}
type GatewayCategoryListParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
}