/
ownership.go
329 lines (282 loc) · 10.7 KB
/
ownership.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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
package pcaps
import (
"context"
"fmt"
"net/http"
"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"
)
// OwnershipService 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 [NewOwnershipService] method instead.
type OwnershipService struct {
Options []option.RequestOption
}
// NewOwnershipService 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 NewOwnershipService(opts ...option.RequestOption) (r *OwnershipService) {
r = &OwnershipService{}
r.Options = opts
return
}
// Adds an AWS or GCP bucket to use with full packet captures.
func (r *OwnershipService) New(ctx context.Context, params OwnershipNewParams, opts ...option.RequestOption) (res *Ownership, err error) {
opts = append(r.Options[:], opts...)
var env OwnershipNewResponseEnvelope
path := fmt.Sprintf("accounts/%s/pcaps/ownership", params.AccountID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Deletes buckets added to the packet captures API.
func (r *OwnershipService) Delete(ctx context.Context, ownershipID string, body OwnershipDeleteParams, opts ...option.RequestOption) (err error) {
opts = append(r.Options[:], opts...)
opts = append([]option.RequestOption{option.WithHeader("Accept", "")}, opts...)
path := fmt.Sprintf("accounts/%s/pcaps/ownership/%s", body.AccountID, ownershipID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodDelete, path, nil, nil, opts...)
return
}
// List all buckets configured for use with PCAPs API.
func (r *OwnershipService) Get(ctx context.Context, query OwnershipGetParams, opts ...option.RequestOption) (res *[]Ownership, err error) {
opts = append(r.Options[:], opts...)
var env OwnershipGetResponseEnvelope
path := fmt.Sprintf("accounts/%s/pcaps/ownership", query.AccountID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
// Validates buckets added to the packet captures API.
func (r *OwnershipService) Validate(ctx context.Context, params OwnershipValidateParams, opts ...option.RequestOption) (res *Ownership, err error) {
opts = append(r.Options[:], opts...)
var env OwnershipValidateResponseEnvelope
path := fmt.Sprintf("accounts/%s/pcaps/ownership/validate", params.AccountID)
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, params, &env, opts...)
if err != nil {
return
}
res = &env.Result
return
}
type Ownership struct {
// The bucket ID associated with the packet captures API.
ID string `json:"id,required"`
// The full URI for the bucket. This field only applies to `full` packet captures.
DestinationConf string `json:"destination_conf,required"`
// The ownership challenge filename stored in the bucket.
Filename string `json:"filename,required"`
// The status of the ownership challenge. Can be pending, success or failed.
Status OwnershipStatus `json:"status,required"`
// The RFC 3339 timestamp when the bucket was added to packet captures API.
Submitted string `json:"submitted,required"`
// The RFC 3339 timestamp when the bucket was validated.
Validated string `json:"validated"`
JSON ownershipJSON `json:"-"`
}
// ownershipJSON contains the JSON metadata for the struct [Ownership]
type ownershipJSON struct {
ID apijson.Field
DestinationConf apijson.Field
Filename apijson.Field
Status apijson.Field
Submitted apijson.Field
Validated apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *Ownership) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r ownershipJSON) RawJSON() string {
return r.raw
}
// The status of the ownership challenge. Can be pending, success or failed.
type OwnershipStatus string
const (
OwnershipStatusPending OwnershipStatus = "pending"
OwnershipStatusSuccess OwnershipStatus = "success"
OwnershipStatusFailed OwnershipStatus = "failed"
)
func (r OwnershipStatus) IsKnown() bool {
switch r {
case OwnershipStatusPending, OwnershipStatusSuccess, OwnershipStatusFailed:
return true
}
return false
}
type OwnershipNewParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The full URI for the bucket. This field only applies to `full` packet captures.
DestinationConf param.Field[string] `json:"destination_conf,required"`
}
func (r OwnershipNewParams) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type OwnershipNewResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result Ownership `json:"result,required"`
// Whether the API call was successful
Success OwnershipNewResponseEnvelopeSuccess `json:"success,required"`
JSON ownershipNewResponseEnvelopeJSON `json:"-"`
}
// ownershipNewResponseEnvelopeJSON contains the JSON metadata for the struct
// [OwnershipNewResponseEnvelope]
type ownershipNewResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *OwnershipNewResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r ownershipNewResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type OwnershipNewResponseEnvelopeSuccess bool
const (
OwnershipNewResponseEnvelopeSuccessTrue OwnershipNewResponseEnvelopeSuccess = true
)
func (r OwnershipNewResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case OwnershipNewResponseEnvelopeSuccessTrue:
return true
}
return false
}
type OwnershipDeleteParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
}
type OwnershipGetParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
}
type OwnershipGetResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result []Ownership `json:"result,required,nullable"`
// Whether the API call was successful
Success OwnershipGetResponseEnvelopeSuccess `json:"success,required"`
ResultInfo OwnershipGetResponseEnvelopeResultInfo `json:"result_info"`
JSON ownershipGetResponseEnvelopeJSON `json:"-"`
}
// ownershipGetResponseEnvelopeJSON contains the JSON metadata for the struct
// [OwnershipGetResponseEnvelope]
type ownershipGetResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Result apijson.Field
Success apijson.Field
ResultInfo apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *OwnershipGetResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r ownershipGetResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type OwnershipGetResponseEnvelopeSuccess bool
const (
OwnershipGetResponseEnvelopeSuccessTrue OwnershipGetResponseEnvelopeSuccess = true
)
func (r OwnershipGetResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case OwnershipGetResponseEnvelopeSuccessTrue:
return true
}
return false
}
type OwnershipGetResponseEnvelopeResultInfo struct {
// Total number of results for the requested service
Count float64 `json:"count"`
// Current page within paginated list of results
Page float64 `json:"page"`
// Number of results per page of results
PerPage float64 `json:"per_page"`
// Total results available without any search parameters
TotalCount float64 `json:"total_count"`
JSON ownershipGetResponseEnvelopeResultInfoJSON `json:"-"`
}
// ownershipGetResponseEnvelopeResultInfoJSON contains the JSON metadata for the
// struct [OwnershipGetResponseEnvelopeResultInfo]
type ownershipGetResponseEnvelopeResultInfoJSON struct {
Count apijson.Field
Page apijson.Field
PerPage apijson.Field
TotalCount apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *OwnershipGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r ownershipGetResponseEnvelopeResultInfoJSON) RawJSON() string {
return r.raw
}
type OwnershipValidateParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// The full URI for the bucket. This field only applies to `full` packet captures.
DestinationConf param.Field[string] `json:"destination_conf,required"`
// The ownership challenge filename stored in the bucket.
OwnershipChallenge param.Field[string] `json:"ownership_challenge,required"`
}
func (r OwnershipValidateParams) MarshalJSON() (data []byte, err error) {
return apijson.MarshalRoot(r)
}
type OwnershipValidateResponseEnvelope struct {
Errors []shared.ResponseInfo `json:"errors,required"`
Messages []shared.ResponseInfo `json:"messages,required"`
Result Ownership `json:"result,required"`
// Whether the API call was successful
Success OwnershipValidateResponseEnvelopeSuccess `json:"success,required"`
JSON ownershipValidateResponseEnvelopeJSON `json:"-"`
}
// ownershipValidateResponseEnvelopeJSON contains the JSON metadata for the struct
// [OwnershipValidateResponseEnvelope]
type ownershipValidateResponseEnvelopeJSON struct {
Errors apijson.Field
Messages apijson.Field
Result apijson.Field
Success apijson.Field
raw string
ExtraFields map[string]apijson.Field
}
func (r *OwnershipValidateResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
return apijson.UnmarshalRoot(data, r)
}
func (r ownershipValidateResponseEnvelopeJSON) RawJSON() string {
return r.raw
}
// Whether the API call was successful
type OwnershipValidateResponseEnvelopeSuccess bool
const (
OwnershipValidateResponseEnvelopeSuccessTrue OwnershipValidateResponseEnvelopeSuccess = true
)
func (r OwnershipValidateResponseEnvelopeSuccess) IsKnown() bool {
switch r {
case OwnershipValidateResponseEnvelopeSuccessTrue:
return true
}
return false
}