/
settingprefetchpreload.go
235 lines (201 loc) · 7.59 KB
/
settingprefetchpreload.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
// 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/internal/shared"
"github.com/cloudflare/cloudflare-go/v2/option"
)
// SettingPrefetchPreloadService 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 [NewSettingPrefetchPreloadService]
// method instead.
type SettingPrefetchPreloadService struct {
Options []option.RequestOption
}
// NewSettingPrefetchPreloadService 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 NewSettingPrefetchPreloadService(opts ...option.RequestOption) (r *SettingPrefetchPreloadService) {
r = &SettingPrefetchPreloadService{}
r.Options = opts
return
}
// Cloudflare will prefetch any URLs that are included in the response headers.
// This is limited to Enterprise Zones.
func (r *SettingPrefetchPreloadService) Edit(ctx context.Context, params SettingPrefetchPreloadEditParams, opts ...option.RequestOption) (res *PrefetchPreload, err error) {
opts = append(r.Options[:], opts...)
var env SettingPrefetchPreloadEditResponseEnvelope
path := fmt.Sprintf("zones/%s/settings/prefetch_preload", params.ZoneID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPatch, path, params, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Cloudflare will prefetch any URLs that are included in the response headers.
// This is limited to Enterprise Zones.
func (r *SettingPrefetchPreloadService) Get(ctx context.Context, query SettingPrefetchPreloadGetParams, opts ...option.RequestOption) (res *PrefetchPreload, err error) {
opts = append(r.Options[:], opts...)
var env SettingPrefetchPreloadGetResponseEnvelope
path := fmt.Sprintf("zones/%s/settings/prefetch_preload", query.ZoneID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Cloudflare will prefetch any URLs that are included in the response headers.
// This is limited to Enterprise Zones.
type PrefetchPreload struct {
// ID of the zone setting.
ID PrefetchPreloadID `json:"id,required"`
// Current value of the zone setting.
Value PrefetchPreloadValue `json:"value,required"`
// Whether or not this setting can be modified for this zone (based on your
// Cloudflare plan level).
Editable PrefetchPreloadEditable `json:"editable"`
// last time this setting was modified.
ModifiedOn time.Time `json:"modified_on,nullable" format:"date-time"`
JSON prefetchPreloadJSON `json:"-"`
}
// prefetchPreloadJSON contains the JSON metadata for the struct [PrefetchPreload]
type prefetchPreloadJSON struct {
ID apijson.Field
Value apijson.Field
Editable apijson.Field
ModifiedOn apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *PrefetchPreload) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r prefetchPreloadJSON) RawJSON() string {
return r.raw
}
// ID of the zone setting.
type PrefetchPreloadID string
const (
PrefetchPreloadIDPrefetchPreload PrefetchPreloadID = "prefetch_preload"
)
func (r PrefetchPreloadID) IsKnown() bool {
switch r {
case PrefetchPreloadIDPrefetchPreload:
return true
}
return false
}
// Current value of the zone setting.
type PrefetchPreloadValue string
const (
PrefetchPreloadValueOn PrefetchPreloadValue = "on"
PrefetchPreloadValueOff PrefetchPreloadValue = "off"
)
func (r PrefetchPreloadValue) IsKnown() bool {
switch r {
case PrefetchPreloadValueOn, PrefetchPreloadValueOff:
return true
}
return false
}
// Whether or not this setting can be modified for this zone (based on your
// Cloudflare plan level).
type PrefetchPreloadEditable bool
const (
PrefetchPreloadEditableTrue PrefetchPreloadEditable = true
PrefetchPreloadEditableFalse PrefetchPreloadEditable = false
)
func (r PrefetchPreloadEditable) IsKnown() bool {
switch r {
case PrefetchPreloadEditableTrue, PrefetchPreloadEditableFalse:
return true
}
return false
}
type SettingPrefetchPreloadEditParams struct {
// Identifier
ZoneID param.Field[string] `path:"zone_id,required"`
// Value of the zone setting.
Value param.Field[SettingPrefetchPreloadEditParamsValue] `json:"value,required"`
}
func (r SettingPrefetchPreloadEditParams) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
// Value of the zone setting.
type SettingPrefetchPreloadEditParamsValue string
const (
SettingPrefetchPreloadEditParamsValueOn SettingPrefetchPreloadEditParamsValue = "on"
SettingPrefetchPreloadEditParamsValueOff SettingPrefetchPreloadEditParamsValue = "off"
)
func (r SettingPrefetchPreloadEditParamsValue) IsKnown() bool {
switch r {
case SettingPrefetchPreloadEditParamsValueOn, SettingPrefetchPreloadEditParamsValueOff:
return true
}
return false
}
type SettingPrefetchPreloadEditResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success bool `json:"success,required"`
// Cloudflare will prefetch any URLs that are included in the response headers.
// This is limited to Enterprise Zones.
Result PrefetchPreload `json:"result"`
JSON settingPrefetchPreloadEditResponseEnvelopeJSON `json:"-"`
}
// settingPrefetchPreloadEditResponseEnvelopeJSON contains the JSON metadata for
// the struct [SettingPrefetchPreloadEditResponseEnvelope]
type settingPrefetchPreloadEditResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *SettingPrefetchPreloadEditResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r settingPrefetchPreloadEditResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
type SettingPrefetchPreloadGetParams struct {
// Identifier
ZoneID param.Field[string] `path:"zone_id,required"`
}
type SettingPrefetchPreloadGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
// Whether the API call was successful
Success bool `json:"success,required"`
// Cloudflare will prefetch any URLs that are included in the response headers.
// This is limited to Enterprise Zones.
Result PrefetchPreload `json:"result"`
JSON settingPrefetchPreloadGetResponseEnvelopeJSON `json:"-"`
}
// settingPrefetchPreloadGetResponseEnvelopeJSON contains the JSON metadata for the
// struct [SettingPrefetchPreloadGetResponseEnvelope]
type settingPrefetchPreloadGetResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Success apijson.Field
Result apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *SettingPrefetchPreloadGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r settingPrefetchPreloadGetResponseEnvelopeJSON) RawJSON() string {
return r.raw
}