-
Notifications
You must be signed in to change notification settings - Fork 542
/
settingearlyhint.go
245 lines (211 loc) · 7.82 KB
/
settingearlyhint.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
// 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"
)
// SettingEarlyHintService 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 [NewSettingEarlyHintService] method
// instead.
type SettingEarlyHintService struct {
Options []option.RequestOption
}
// NewSettingEarlyHintService 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 NewSettingEarlyHintService(opts ...option.RequestOption) (r *SettingEarlyHintService) {
r = &SettingEarlyHintService{}
r.Options = opts
return
}
// When enabled, Cloudflare will attempt to speed up overall page loads by serving
// `103` responses with `Link` headers from the final response. Refer to
// [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for
// more information.
func (r *SettingEarlyHintService) Edit(ctx context.Context, params SettingEarlyHintEditParams, opts ...option.RequestOption) (res *EarlyHints, err error) {
opts = append(r.Options[:], opts...)
var env SettingEarlyHintEditResponseEnvelope
path := fmt.Sprintf("zones/%s/settings/early_hints", params.ZoneID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPatch, path, params, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// When enabled, Cloudflare will attempt to speed up overall page loads by serving
// `103` responses with `Link` headers from the final response. Refer to
// [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for
// more information.
func (r *SettingEarlyHintService) Get(ctx context.Context, query SettingEarlyHintGetParams, opts ...option.RequestOption) (res *EarlyHints, err error) {
opts = append(r.Options[:], opts...)
var env SettingEarlyHintGetResponseEnvelope
path := fmt.Sprintf("zones/%s/settings/early_hints", query.ZoneID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// When enabled, Cloudflare will attempt to speed up overall page loads by serving
// `103` responses with `Link` headers from the final response. Refer to
// [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for
// more information.
type EarlyHints struct {
// ID of the zone setting.
ID EarlyHintsID `json:"id,required"`
// Current value of the zone setting.
Value EarlyHintsValue `json:"value,required"`
// Whether or not this setting can be modified for this zone (based on your
// Cloudflare plan level).
Editable EarlyHintsEditable `json:"editable"`
// last time this setting was modified.
ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
JSON earlyHintsJSON `json:"-"`
}
// earlyHintsJSON contains the JSON metadata for the struct [EarlyHints]
type earlyHintsJSON struct {
ID apijson.Field
Value apijson.Field
Editable apijson.Field
ModifiedOn apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *EarlyHints) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r earlyHintsJSON) RawJSON() string {
return r.raw
}
// ID of the zone setting.
type EarlyHintsID string
const (
EarlyHintsIDEarlyHints EarlyHintsID = "early_hints"
)
func (r EarlyHintsID) IsKnown() bool {
switch r {
case EarlyHintsIDEarlyHints:
return true
}
return false
}
// Current value of the zone setting.
type EarlyHintsValue string
const (
EarlyHintsValueOn EarlyHintsValue = "on"
EarlyHintsValueOff EarlyHintsValue = "off"
)
func (r EarlyHintsValue) IsKnown() bool {
switch r {
case EarlyHintsValueOn, EarlyHintsValueOff:
return true
}
return false
}
// Whether or not this setting can be modified for this zone (based on your
// Cloudflare plan level).
type EarlyHintsEditable bool
const (
EarlyHintsEditableTrue EarlyHintsEditable = true
EarlyHintsEditableFalse EarlyHintsEditable = false
)
func (r EarlyHintsEditable) IsKnown() bool {
switch r {
case EarlyHintsEditableTrue, EarlyHintsEditableFalse:
return true
}
return false
}
type SettingEarlyHintEditParams struct {
// Identifier
ZoneID param.Field[string] `path:"zone_id,required"`
// Value of the zone setting.
Value param.Field[SettingEarlyHintEditParamsValue] `json:"value,required"`
}
func (r SettingEarlyHintEditParams) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// Value of the zone setting.
type SettingEarlyHintEditParamsValue string
const (
SettingEarlyHintEditParamsValueOn SettingEarlyHintEditParamsValue = "on"
SettingEarlyHintEditParamsValueOff SettingEarlyHintEditParamsValue = "off"
)
func (r SettingEarlyHintEditParamsValue) IsKnown() bool {
switch r {
case SettingEarlyHintEditParamsValueOn, SettingEarlyHintEditParamsValueOff:
return true
}
return false
}
type SettingEarlyHintEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success bool `json:"success,required"`
// When enabled, Cloudflare will attempt to speed up overall page loads by serving
// `103` responses with `Link` headers from the final response. Refer to
// [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for
// more information.
Result EarlyHints `json:"result"`
JSON settingEarlyHintEditResponseEnvelopeJSON `json:"-"`
}
// settingEarlyHintEditResponseEnvelopeJSON contains the JSON metadata for the
// struct [SettingEarlyHintEditResponseEnvelope]
type settingEarlyHintEditResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *SettingEarlyHintEditResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r settingEarlyHintEditResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
type SettingEarlyHintGetParams struct {
// Identifier
ZoneID param.Field[string] `path:"zone_id,required"`
}
type SettingEarlyHintGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success bool `json:"success,required"`
// When enabled, Cloudflare will attempt to speed up overall page loads by serving
// `103` responses with `Link` headers from the final response. Refer to
// [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for
// more information.
Result EarlyHints `json:"result"`
JSON settingEarlyHintGetResponseEnvelopeJSON `json:"-"`
}
// settingEarlyHintGetResponseEnvelopeJSON contains the JSON metadata for the
// struct [SettingEarlyHintGetResponseEnvelope]
type settingEarlyHintGetResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *SettingEarlyHintGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r settingEarlyHintGetResponseEnvelopeJSON) RawJSON() string {
return r.raw
}