-
Notifications
You must be signed in to change notification settings - Fork 542
/
settingchallengettl.go
274 lines (240 loc) · 11 KB
/
settingchallengettl.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
// 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"
)
// SettingChallengeTTLService 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 [NewSettingChallengeTTLService]
// method instead.
type SettingChallengeTTLService struct {
Options []option.RequestOption
}
// NewSettingChallengeTTLService 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 NewSettingChallengeTTLService(opts ...option.RequestOption) (r *SettingChallengeTTLService) {
r = &SettingChallengeTTLService{}
r.Options = opts
return
}
// Specify how long a visitor is allowed access to your site after successfully
// completing a challenge (such as a CAPTCHA). After the TTL has expired the
// visitor will have to complete a new challenge. We recommend a 15 - 45 minute
// setting and will attempt to honor any setting above 45 minutes.
// (https://support.cloudflare.com/hc/en-us/articles/200170136).
func (r *SettingChallengeTTLService) Edit(ctx context.Context, params SettingChallengeTTLEditParams, opts ...option.RequestOption) (res *ChallengeTTL, err error) {
opts = append(r.Options[:], opts...)
var env SettingChallengeTTLEditResponseEnvelope
path := fmt.Sprintf("zones/%s/settings/challenge_ttl", params.ZoneID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPatch, path, params, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Specify how long a visitor is allowed access to your site after successfully
// completing a challenge (such as a CAPTCHA). After the TTL has expired the
// visitor will have to complete a new challenge. We recommend a 15 - 45 minute
// setting and will attempt to honor any setting above 45 minutes.
// (https://support.cloudflare.com/hc/en-us/articles/200170136).
func (r *SettingChallengeTTLService) Get(ctx context.Context, query SettingChallengeTTLGetParams, opts ...option.RequestOption) (res *ChallengeTTL, err error) {
opts = append(r.Options[:], opts...)
var env SettingChallengeTTLGetResponseEnvelope
path := fmt.Sprintf("zones/%s/settings/challenge_ttl", query.ZoneID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Specify how long a visitor is allowed access to your site after successfully
// completing a challenge (such as a CAPTCHA). After the TTL has expired the
// visitor will have to complete a new challenge. We recommend a 15 - 45 minute
// setting and will attempt to honor any setting above 45 minutes.
// (https://support.cloudflare.com/hc/en-us/articles/200170136).
type ChallengeTTL struct {
// ID of the zone setting.
ID ChallengeTTLID `json:"id,required"`
// Current value of the zone setting.
Value ChallengeTTLValue `json:"value,required"`
// Whether or not this setting can be modified for this zone (based on your
// Cloudflare plan level).
Editable ChallengeTTLEditable `json:"editable"`
// last time this setting was modified.
ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
JSON challengeTTLJSON `json:"-"`
}
// challengeTTLJSON contains the JSON metadata for the struct [ChallengeTTL]
type challengeTTLJSON struct {
ID apijson.Field
Value apijson.Field
Editable apijson.Field
ModifiedOn apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *ChallengeTTL) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r challengeTTLJSON) RawJSON() string {
return r.raw
}
// ID of the zone setting.
type ChallengeTTLID string
const (
ChallengeTTLIDChallengeTTL ChallengeTTLID = "challenge_ttl"
)
func (r ChallengeTTLID) IsKnown() bool {
switch r {
case ChallengeTTLIDChallengeTTL:
return true
}
return false
}
// Current value of the zone setting.
type ChallengeTTLValue float64
const (
ChallengeTTLValue300 ChallengeTTLValue = 300
ChallengeTTLValue900 ChallengeTTLValue = 900
ChallengeTTLValue1800 ChallengeTTLValue = 1800
ChallengeTTLValue2700 ChallengeTTLValue = 2700
ChallengeTTLValue3600 ChallengeTTLValue = 3600
ChallengeTTLValue7200 ChallengeTTLValue = 7200
ChallengeTTLValue10800 ChallengeTTLValue = 10800
ChallengeTTLValue14400 ChallengeTTLValue = 14400
ChallengeTTLValue28800 ChallengeTTLValue = 28800
ChallengeTTLValue57600 ChallengeTTLValue = 57600
ChallengeTTLValue86400 ChallengeTTLValue = 86400
ChallengeTTLValue604800 ChallengeTTLValue = 604800
ChallengeTTLValue2592000 ChallengeTTLValue = 2592000
ChallengeTTLValue31536000 ChallengeTTLValue = 31536000
)
func (r ChallengeTTLValue) IsKnown() bool {
switch r {
case ChallengeTTLValue300, ChallengeTTLValue900, ChallengeTTLValue1800, ChallengeTTLValue2700, ChallengeTTLValue3600, ChallengeTTLValue7200, ChallengeTTLValue10800, ChallengeTTLValue14400, ChallengeTTLValue28800, ChallengeTTLValue57600, ChallengeTTLValue86400, ChallengeTTLValue604800, ChallengeTTLValue2592000, ChallengeTTLValue31536000:
return true
}
return false
}
// Whether or not this setting can be modified for this zone (based on your
// Cloudflare plan level).
type ChallengeTTLEditable bool
const (
ChallengeTTLEditableTrue ChallengeTTLEditable = true
ChallengeTTLEditableFalse ChallengeTTLEditable = false
)
func (r ChallengeTTLEditable) IsKnown() bool {
switch r {
case ChallengeTTLEditableTrue, ChallengeTTLEditableFalse:
return true
}
return false
}
type SettingChallengeTTLEditParams struct {
// Identifier
ZoneID param.Field[string] `path:"zone_id,required"`
// Value of the zone setting.
Value param.Field[SettingChallengeTTLEditParamsValue] `json:"value,required"`
}
func (r SettingChallengeTTLEditParams) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// Value of the zone setting.
type SettingChallengeTTLEditParamsValue float64
const (
SettingChallengeTTLEditParamsValue300 SettingChallengeTTLEditParamsValue = 300
SettingChallengeTTLEditParamsValue900 SettingChallengeTTLEditParamsValue = 900
SettingChallengeTTLEditParamsValue1800 SettingChallengeTTLEditParamsValue = 1800
SettingChallengeTTLEditParamsValue2700 SettingChallengeTTLEditParamsValue = 2700
SettingChallengeTTLEditParamsValue3600 SettingChallengeTTLEditParamsValue = 3600
SettingChallengeTTLEditParamsValue7200 SettingChallengeTTLEditParamsValue = 7200
SettingChallengeTTLEditParamsValue10800 SettingChallengeTTLEditParamsValue = 10800
SettingChallengeTTLEditParamsValue14400 SettingChallengeTTLEditParamsValue = 14400
SettingChallengeTTLEditParamsValue28800 SettingChallengeTTLEditParamsValue = 28800
SettingChallengeTTLEditParamsValue57600 SettingChallengeTTLEditParamsValue = 57600
SettingChallengeTTLEditParamsValue86400 SettingChallengeTTLEditParamsValue = 86400
SettingChallengeTTLEditParamsValue604800 SettingChallengeTTLEditParamsValue = 604800
SettingChallengeTTLEditParamsValue2592000 SettingChallengeTTLEditParamsValue = 2592000
SettingChallengeTTLEditParamsValue31536000 SettingChallengeTTLEditParamsValue = 31536000
)
func (r SettingChallengeTTLEditParamsValue) IsKnown() bool {
switch r {
case SettingChallengeTTLEditParamsValue300, SettingChallengeTTLEditParamsValue900, SettingChallengeTTLEditParamsValue1800, SettingChallengeTTLEditParamsValue2700, SettingChallengeTTLEditParamsValue3600, SettingChallengeTTLEditParamsValue7200, SettingChallengeTTLEditParamsValue10800, SettingChallengeTTLEditParamsValue14400, SettingChallengeTTLEditParamsValue28800, SettingChallengeTTLEditParamsValue57600, SettingChallengeTTLEditParamsValue86400, SettingChallengeTTLEditParamsValue604800, SettingChallengeTTLEditParamsValue2592000, SettingChallengeTTLEditParamsValue31536000:
return true
}
return false
}
type SettingChallengeTTLEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success bool `json:"success,required"`
// Specify how long a visitor is allowed access to your site after successfully
// completing a challenge (such as a CAPTCHA). After the TTL has expired the
// visitor will have to complete a new challenge. We recommend a 15 - 45 minute
// setting and will attempt to honor any setting above 45 minutes.
// (https://support.cloudflare.com/hc/en-us/articles/200170136).
Result ChallengeTTL `json:"result"`
JSON settingChallengeTTLEditResponseEnvelopeJSON `json:"-"`
}
// settingChallengeTTLEditResponseEnvelopeJSON contains the JSON metadata for the
// struct [SettingChallengeTTLEditResponseEnvelope]
type settingChallengeTTLEditResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *SettingChallengeTTLEditResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r settingChallengeTTLEditResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
type SettingChallengeTTLGetParams struct {
// Identifier
ZoneID param.Field[string] `path:"zone_id,required"`
}
type SettingChallengeTTLGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success bool `json:"success,required"`
// Specify how long a visitor is allowed access to your site after successfully
// completing a challenge (such as a CAPTCHA). After the TTL has expired the
// visitor will have to complete a new challenge. We recommend a 15 - 45 minute
// setting and will attempt to honor any setting above 45 minutes.
// (https://support.cloudflare.com/hc/en-us/articles/200170136).
Result ChallengeTTL `json:"result"`
JSON settingChallengeTTLGetResponseEnvelopeJSON `json:"-"`
}
// settingChallengeTTLGetResponseEnvelopeJSON contains the JSON metadata for the
// struct [SettingChallengeTTLGetResponseEnvelope]
type settingChallengeTTLGetResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *SettingChallengeTTLGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r settingChallengeTTLGetResponseEnvelopeJSON) RawJSON() string {
return r.raw
}