-
Notifications
You must be signed in to change notification settings - Fork 542
/
settingdevelopmentmode.go
260 lines (226 loc) · 9.52 KB
/
settingdevelopmentmode.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
// 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"
)
// SettingDevelopmentModeService 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 [NewSettingDevelopmentModeService]
// method instead.
type SettingDevelopmentModeService struct {
Options []option.RequestOption
}
// NewSettingDevelopmentModeService 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 NewSettingDevelopmentModeService(opts ...option.RequestOption) (r *SettingDevelopmentModeService) {
r = &SettingDevelopmentModeService{}
r.Options = opts
return
}
// Development Mode temporarily allows you to enter development mode for your
// websites if you need to make changes to your site. This will bypass Cloudflare's
// accelerated cache and slow down your site, but is useful if you are making
// changes to cacheable content (like images, css, or JavaScript) and would like to
// see those changes right away. Once entered, development mode will last for 3
// hours and then automatically toggle off.
func (r *SettingDevelopmentModeService) Edit(ctx context.Context, params SettingDevelopmentModeEditParams, opts ...option.RequestOption) (res *DevelopmentMode, err error) {
opts = append(r.Options[:], opts...)
var env SettingDevelopmentModeEditResponseEnvelope
path := fmt.Sprintf("zones/%s/settings/development_mode", params.ZoneID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPatch, path, params, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Development Mode temporarily allows you to enter development mode for your
// websites if you need to make changes to your site. This will bypass Cloudflare's
// accelerated cache and slow down your site, but is useful if you are making
// changes to cacheable content (like images, css, or JavaScript) and would like to
// see those changes right away. Once entered, development mode will last for 3
// hours and then automatically toggle off.
func (r *SettingDevelopmentModeService) Get(ctx context.Context, query SettingDevelopmentModeGetParams, opts ...option.RequestOption) (res *DevelopmentMode, err error) {
opts = append(r.Options[:], opts...)
var env SettingDevelopmentModeGetResponseEnvelope
path := fmt.Sprintf("zones/%s/settings/development_mode", query.ZoneID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Development Mode temporarily allows you to enter development mode for your
// websites if you need to make changes to your site. This will bypass Cloudflare's
// accelerated cache and slow down your site, but is useful if you are making
// changes to cacheable content (like images, css, or JavaScript) and would like to
// see those changes right away. Once entered, development mode will last for 3
// hours and then automatically toggle off.
type DevelopmentMode struct {
// ID of the zone setting.
ID DevelopmentModeID `json:"id,required"`
// Current value of the zone setting.
Value DevelopmentModeValue `json:"value,required"`
// Whether or not this setting can be modified for this zone (based on your
// Cloudflare plan level).
Editable DevelopmentModeEditable `json:"editable"`
// last time this setting was modified.
ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
// Value of the zone setting. Notes: The interval (in seconds) from when
// development mode expires (positive integer) or last expired (negative integer)
// for the domain. If development mode has never been enabled, this value is false.
TimeRemaining float64 `json:"time_remaining"`
JSON developmentModeJSON `json:"-"`
}
// developmentModeJSON contains the JSON metadata for the struct [DevelopmentMode]
type developmentModeJSON struct {
ID apijson.Field
Value apijson.Field
Editable apijson.Field
ModifiedOn apijson.Field
TimeRemaining apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *DevelopmentMode) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r developmentModeJSON) RawJSON() string {
return r.raw
}
// ID of the zone setting.
type DevelopmentModeID string
const (
DevelopmentModeIDDevelopmentMode DevelopmentModeID = "development_mode"
)
func (r DevelopmentModeID) IsKnown() bool {
switch r {
case DevelopmentModeIDDevelopmentMode:
return true
}
return false
}
// Current value of the zone setting.
type DevelopmentModeValue string
const (
DevelopmentModeValueOn DevelopmentModeValue = "on"
DevelopmentModeValueOff DevelopmentModeValue = "off"
)
func (r DevelopmentModeValue) IsKnown() bool {
switch r {
case DevelopmentModeValueOn, DevelopmentModeValueOff:
return true
}
return false
}
// Whether or not this setting can be modified for this zone (based on your
// Cloudflare plan level).
type DevelopmentModeEditable bool
const (
DevelopmentModeEditableTrue DevelopmentModeEditable = true
DevelopmentModeEditableFalse DevelopmentModeEditable = false
)
func (r DevelopmentModeEditable) IsKnown() bool {
switch r {
case DevelopmentModeEditableTrue, DevelopmentModeEditableFalse:
return true
}
return false
}
type SettingDevelopmentModeEditParams struct {
// Identifier
ZoneID param.Field[string] `path:"zone_id,required"`
// Value of the zone setting.
Value param.Field[SettingDevelopmentModeEditParamsValue] `json:"value,required"`
}
func (r SettingDevelopmentModeEditParams) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// Value of the zone setting.
type SettingDevelopmentModeEditParamsValue string
const (
SettingDevelopmentModeEditParamsValueOn SettingDevelopmentModeEditParamsValue = "on"
SettingDevelopmentModeEditParamsValueOff SettingDevelopmentModeEditParamsValue = "off"
)
func (r SettingDevelopmentModeEditParamsValue) IsKnown() bool {
switch r {
case SettingDevelopmentModeEditParamsValueOn, SettingDevelopmentModeEditParamsValueOff:
return true
}
return false
}
type SettingDevelopmentModeEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success bool `json:"success,required"`
// Development Mode temporarily allows you to enter development mode for your
// websites if you need to make changes to your site. This will bypass Cloudflare's
// accelerated cache and slow down your site, but is useful if you are making
// changes to cacheable content (like images, css, or JavaScript) and would like to
// see those changes right away. Once entered, development mode will last for 3
// hours and then automatically toggle off.
Result DevelopmentMode `json:"result"`
JSON settingDevelopmentModeEditResponseEnvelopeJSON `json:"-"`
}
// settingDevelopmentModeEditResponseEnvelopeJSON contains the JSON metadata for
// the struct [SettingDevelopmentModeEditResponseEnvelope]
type settingDevelopmentModeEditResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *SettingDevelopmentModeEditResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r settingDevelopmentModeEditResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
type SettingDevelopmentModeGetParams struct {
// Identifier
ZoneID param.Field[string] `path:"zone_id,required"`
}
type SettingDevelopmentModeGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success bool `json:"success,required"`
// Development Mode temporarily allows you to enter development mode for your
// websites if you need to make changes to your site. This will bypass Cloudflare's
// accelerated cache and slow down your site, but is useful if you are making
// changes to cacheable content (like images, css, or JavaScript) and would like to
// see those changes right away. Once entered, development mode will last for 3
// hours and then automatically toggle off.
Result DevelopmentMode `json:"result"`
JSON settingDevelopmentModeGetResponseEnvelopeJSON `json:"-"`
}
// settingDevelopmentModeGetResponseEnvelopeJSON contains the JSON metadata for the
// struct [SettingDevelopmentModeGetResponseEnvelope]
type settingDevelopmentModeGetResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *SettingDevelopmentModeGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r settingDevelopmentModeGetResponseEnvelopeJSON) RawJSON() string {
return r.raw
}