-
Notifications
You must be signed in to change notification settings - Fork 542
/
settingipgeolocation.go
240 lines (206 loc) · 7.72 KB
/
settingipgeolocation.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
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package zones
import (
"context"
"fmt"
"net/http"
"time"
"github.com/cloudflare/cloudflare-go/v2/internal/apijson"
"github.com/cloudflare/cloudflare-go/v2/internal/param"
"github.com/cloudflare/cloudflare-go/v2/internal/requestconfig"
"github.com/cloudflare/cloudflare-go/v2/option"
"github.com/cloudflare/cloudflare-go/v2/shared"
)
// SettingIPGeolocationService 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 [NewSettingIPGeolocationService]
// method instead.
type SettingIPGeolocationService struct {
Options []option.RequestOption
}
// NewSettingIPGeolocationService 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 NewSettingIPGeolocationService(opts ...option.RequestOption) (r *SettingIPGeolocationService) {
r = &SettingIPGeolocationService{}
r.Options = opts
return
}
// Enable IP Geolocation to have Cloudflare geolocate visitors to your website and
// pass the country code to you.
// (https://support.cloudflare.com/hc/en-us/articles/200168236).
func (r *SettingIPGeolocationService) Edit(ctx context.Context, params SettingIPGeolocationEditParams, opts ...option.RequestOption) (res *IPGeolocation, err error) {
opts = append(r.Options[:], opts...)
var env SettingIPGeolocationEditResponseEnvelope
path := fmt.Sprintf("zones/%s/settings/ip_geolocation", params.ZoneID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPatch, path, params, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Enable IP Geolocation to have Cloudflare geolocate visitors to your website and
// pass the country code to you.
// (https://support.cloudflare.com/hc/en-us/articles/200168236).
func (r *SettingIPGeolocationService) Get(ctx context.Context, query SettingIPGeolocationGetParams, opts ...option.RequestOption) (res *IPGeolocation, err error) {
opts = append(r.Options[:], opts...)
var env SettingIPGeolocationGetResponseEnvelope
path := fmt.Sprintf("zones/%s/settings/ip_geolocation", query.ZoneID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Enable IP Geolocation to have Cloudflare geolocate visitors to your website and
// pass the country code to you.
// (https://support.cloudflare.com/hc/en-us/articles/200168236).
type IPGeolocation struct {
// ID of the zone setting.
ID IPGeolocationID `json:"id,required"`
// Current value of the zone setting.
Value IPGeolocationValue `json:"value,required"`
// Whether or not this setting can be modified for this zone (based on your
// Cloudflare plan level).
Editable IPGeolocationEditable `json:"editable"`
// last time this setting was modified.
ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
JSON ipGeolocationJSON `json:"-"`
}
// ipGeolocationJSON contains the JSON metadata for the struct [IPGeolocation]
type ipGeolocationJSON struct {
ID apijson.Field
Value apijson.Field
Editable apijson.Field
ModifiedOn apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *IPGeolocation) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r ipGeolocationJSON) RawJSON() string {
return r.raw
}
// ID of the zone setting.
type IPGeolocationID string
const (
IPGeolocationIDIPGeolocation IPGeolocationID = "ip_geolocation"
)
func (r IPGeolocationID) IsKnown() bool {
switch r {
case IPGeolocationIDIPGeolocation:
return true
}
return false
}
// Current value of the zone setting.
type IPGeolocationValue string
const (
IPGeolocationValueOn IPGeolocationValue = "on"
IPGeolocationValueOff IPGeolocationValue = "off"
)
func (r IPGeolocationValue) IsKnown() bool {
switch r {
case IPGeolocationValueOn, IPGeolocationValueOff:
return true
}
return false
}
// Whether or not this setting can be modified for this zone (based on your
// Cloudflare plan level).
type IPGeolocationEditable bool
const (
IPGeolocationEditableTrue IPGeolocationEditable = true
IPGeolocationEditableFalse IPGeolocationEditable = false
)
func (r IPGeolocationEditable) IsKnown() bool {
switch r {
case IPGeolocationEditableTrue, IPGeolocationEditableFalse:
return true
}
return false
}
type SettingIPGeolocationEditParams struct {
// Identifier
ZoneID param.Field[string] `path:"zone_id,required"`
// Value of the zone setting.
Value param.Field[SettingIPGeolocationEditParamsValue] `json:"value,required"`
}
func (r SettingIPGeolocationEditParams) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// Value of the zone setting.
type SettingIPGeolocationEditParamsValue string
const (
SettingIPGeolocationEditParamsValueOn SettingIPGeolocationEditParamsValue = "on"
SettingIPGeolocationEditParamsValueOff SettingIPGeolocationEditParamsValue = "off"
)
func (r SettingIPGeolocationEditParamsValue) IsKnown() bool {
switch r {
case SettingIPGeolocationEditParamsValueOn, SettingIPGeolocationEditParamsValueOff:
return true
}
return false
}
type SettingIPGeolocationEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success bool `json:"success,required"`
// Enable IP Geolocation to have Cloudflare geolocate visitors to your website and
// pass the country code to you.
// (https://support.cloudflare.com/hc/en-us/articles/200168236).
Result IPGeolocation `json:"result"`
JSON settingIPGeolocationEditResponseEnvelopeJSON `json:"-"`
}
// settingIPGeolocationEditResponseEnvelopeJSON contains the JSON metadata for the
// struct [SettingIPGeolocationEditResponseEnvelope]
type settingIPGeolocationEditResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *SettingIPGeolocationEditResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r settingIPGeolocationEditResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
type SettingIPGeolocationGetParams struct {
// Identifier
ZoneID param.Field[string] `path:"zone_id,required"`
}
type SettingIPGeolocationGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success bool `json:"success,required"`
// Enable IP Geolocation to have Cloudflare geolocate visitors to your website and
// pass the country code to you.
// (https://support.cloudflare.com/hc/en-us/articles/200168236).
Result IPGeolocation `json:"result"`
JSON settingIPGeolocationGetResponseEnvelopeJSON `json:"-"`
}
// settingIPGeolocationGetResponseEnvelopeJSON contains the JSON metadata for the
// struct [SettingIPGeolocationGetResponseEnvelope]
type settingIPGeolocationGetResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *SettingIPGeolocationGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r settingIPGeolocationGetResponseEnvelopeJSON) RawJSON() string {
return r.raw
}