Skip to content

Commit 639b8af

Browse files
chore(api): update composite API spec
1 parent 43cca81 commit 639b8af

6 files changed

Lines changed: 299 additions & 100 deletions

File tree

‎.stats.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 2426
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare/cloudflare-390a1858f30b8d927f55b608de32c0af9117819b1b17ef35376447cd537b91ae.yml
3-
openapi_spec_hash: bacabcf09c5206d41639afc39af8f2ac
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare/cloudflare-59f76d419fb40364c15f3c2b57f38cca5ea9e88d8eddbd45bb729f8480967c25.yml
3+
openapi_spec_hash: 0c620418d87503a65cd244aa980fd774
44
config_hash: cd80863b2a094f3805409e4a5676b0b8

‎cloudforce_one/api.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Response Types:
184184
Methods:
185185

186186
- <code title="post /accounts/{account_id}/cloudforce-one/events/dataset/create">client.CloudforceOne.ThreatEvents.Datasets.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetService.New">New</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, params <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one">cloudforce_one</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetNewParams">ThreatEventDatasetNewParams</a>) (\*<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one">cloudforce_one</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetNewResponse">ThreatEventDatasetNewResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
187-
- <code title="get /accounts/{account_id}/cloudforce-one/events/dataset">client.CloudforceOne.ThreatEvents.Datasets.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetService.List">List</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, query <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one">cloudforce_one</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetListParams">ThreatEventDatasetListParams</a>) (\*[]<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one">cloudforce_one</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetListResponse">ThreatEventDatasetListResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
187+
- <code title="get /accounts/{account_id}/cloudforce-one/events/dataset">client.CloudforceOne.ThreatEvents.Datasets.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetService.List">List</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, params <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one">cloudforce_one</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetListParams">ThreatEventDatasetListParams</a>) (\*[]<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one">cloudforce_one</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetListResponse">ThreatEventDatasetListResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
188188
- <code title="patch /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}">client.CloudforceOne.ThreatEvents.Datasets.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetService.Edit">Edit</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, datasetID <a href="https://pkg.go.dev/builtin#string">string</a>, params <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one">cloudforce_one</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetEditParams">ThreatEventDatasetEditParams</a>) (\*<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one">cloudforce_one</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetEditResponse">ThreatEventDatasetEditResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
189189
- <code title="get /accounts/{account_id}/cloudforce-one/events/dataset/{dataset_id}">client.CloudforceOne.ThreatEvents.Datasets.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetService.Get">Get</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, datasetID <a href="https://pkg.go.dev/builtin#string">string</a>, query <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one">cloudforce_one</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetGetParams">ThreatEventDatasetGetParams</a>) (\*<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one">cloudforce_one</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetGetResponse">ThreatEventDatasetGetResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
190190
- <code title="get /accounts/{account_id}/cloudforce-one/events/raw/{dataset_id}/{event_id}">client.CloudforceOne.ThreatEvents.Datasets.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetService.Raw">Raw</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, datasetID <a href="https://pkg.go.dev/builtin#string">string</a>, eventID <a href="https://pkg.go.dev/builtin#string">string</a>, query <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one">cloudforce_one</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetRawParams">ThreatEventDatasetRawParams</a>) (\*<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one">cloudforce_one</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v7/cloudforce_one#ThreatEventDatasetRawResponse">ThreatEventDatasetRawResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>

‎cloudforce_one/threateventdataset.go‎

Lines changed: 42 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ import (
77
"errors"
88
"fmt"
99
"net/http"
10+
"net/url"
1011
"slices"
1112

1213
"github.com/cloudflare/cloudflare-go/v7/internal/apijson"
14+
"github.com/cloudflare/cloudflare-go/v7/internal/apiquery"
1315
"github.com/cloudflare/cloudflare-go/v7/internal/param"
1416
"github.com/cloudflare/cloudflare-go/v7/internal/requestconfig"
1517
"github.com/cloudflare/cloudflare-go/v7/option"
@@ -49,14 +51,14 @@ func (r *ThreatEventDatasetService) New(ctx context.Context, params ThreatEventD
4951
}
5052

5153
// Lists all datasets in an account
52-
func (r *ThreatEventDatasetService) List(ctx context.Context, query ThreatEventDatasetListParams, opts ...option.RequestOption) (res *[]ThreatEventDatasetListResponse, err error) {
54+
func (r *ThreatEventDatasetService) List(ctx context.Context, params ThreatEventDatasetListParams, opts ...option.RequestOption) (res *[]ThreatEventDatasetListResponse, err error) {
5355
opts = slices.Concat(r.Options, opts)
54-
if query.AccountID.Value == "" {
56+
if params.AccountID.Value == "" {
5557
err = errors.New("missing required account_id parameter")
5658
return nil, err
5759
}
58-
path := fmt.Sprintf("accounts/%s/cloudforce-one/events/dataset", query.AccountID)
59-
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, nil, &res, opts...)
60+
path := fmt.Sprintf("accounts/%s/cloudforce-one/events/dataset", params.AccountID)
61+
err = requestconfig.ExecuteNewRequest(ctx, http.MethodGet, path, params, &res, opts...)
6062
return res, err
6163
}
6264

@@ -114,10 +116,11 @@ func (r *ThreatEventDatasetService) Raw(ctx context.Context, datasetID string, e
114116
}
115117

116118
type ThreatEventDatasetNewResponse struct {
117-
IsPublic bool `json:"isPublic" api:"required"`
118-
Name string `json:"name" api:"required"`
119-
UUID string `json:"uuid" api:"required"`
120-
JSON threatEventDatasetNewResponseJSON `json:"-"`
119+
IsPublic bool `json:"isPublic" api:"required"`
120+
Name string `json:"name" api:"required"`
121+
UUID string `json:"uuid" api:"required"`
122+
DeletedAt string `json:"deletedAt"`
123+
JSON threatEventDatasetNewResponseJSON `json:"-"`
121124
}
122125

123126
// threatEventDatasetNewResponseJSON contains the JSON metadata for the struct
@@ -126,6 +129,7 @@ type threatEventDatasetNewResponseJSON struct {
126129
IsPublic apijson.Field
127130
Name apijson.Field
128131
UUID apijson.Field
132+
DeletedAt apijson.Field
129133
raw string
130134
ExtraFields map[string]apijson.Field
131135
}
@@ -139,10 +143,11 @@ func (r threatEventDatasetNewResponseJSON) RawJSON() string {
139143
}
140144

141145
type ThreatEventDatasetListResponse struct {
142-
IsPublic bool `json:"isPublic" api:"required"`
143-
Name string `json:"name" api:"required"`
144-
UUID string `json:"uuid" api:"required"`
145-
JSON threatEventDatasetListResponseJSON `json:"-"`
146+
IsPublic bool `json:"isPublic" api:"required"`
147+
Name string `json:"name" api:"required"`
148+
UUID string `json:"uuid" api:"required"`
149+
DeletedAt string `json:"deletedAt"`
150+
JSON threatEventDatasetListResponseJSON `json:"-"`
146151
}
147152

148153
// threatEventDatasetListResponseJSON contains the JSON metadata for the struct
@@ -151,6 +156,7 @@ type threatEventDatasetListResponseJSON struct {
151156
IsPublic apijson.Field
152157
Name apijson.Field
153158
UUID apijson.Field
159+
DeletedAt apijson.Field
154160
raw string
155161
ExtraFields map[string]apijson.Field
156162
}
@@ -164,10 +170,11 @@ func (r threatEventDatasetListResponseJSON) RawJSON() string {
164170
}
165171

166172
type ThreatEventDatasetEditResponse struct {
167-
IsPublic bool `json:"isPublic" api:"required"`
168-
Name string `json:"name" api:"required"`
169-
UUID string `json:"uuid" api:"required"`
170-
JSON threatEventDatasetEditResponseJSON `json:"-"`
173+
IsPublic bool `json:"isPublic" api:"required"`
174+
Name string `json:"name" api:"required"`
175+
UUID string `json:"uuid" api:"required"`
176+
DeletedAt string `json:"deletedAt"`
177+
JSON threatEventDatasetEditResponseJSON `json:"-"`
171178
}
172179

173180
// threatEventDatasetEditResponseJSON contains the JSON metadata for the struct
@@ -176,6 +183,7 @@ type threatEventDatasetEditResponseJSON struct {
176183
IsPublic apijson.Field
177184
Name apijson.Field
178185
UUID apijson.Field
186+
DeletedAt apijson.Field
179187
raw string
180188
ExtraFields map[string]apijson.Field
181189
}
@@ -189,10 +197,11 @@ func (r threatEventDatasetEditResponseJSON) RawJSON() string {
189197
}
190198

191199
type ThreatEventDatasetGetResponse struct {
192-
IsPublic bool `json:"isPublic" api:"required"`
193-
Name string `json:"name" api:"required"`
194-
UUID string `json:"uuid" api:"required"`
195-
JSON threatEventDatasetGetResponseJSON `json:"-"`
200+
IsPublic bool `json:"isPublic" api:"required"`
201+
Name string `json:"name" api:"required"`
202+
UUID string `json:"uuid" api:"required"`
203+
DeletedAt string `json:"deletedAt"`
204+
JSON threatEventDatasetGetResponseJSON `json:"-"`
196205
}
197206

198207
// threatEventDatasetGetResponseJSON contains the JSON metadata for the struct
@@ -201,6 +210,7 @@ type threatEventDatasetGetResponseJSON struct {
201210
IsPublic apijson.Field
202211
Name apijson.Field
203212
UUID apijson.Field
213+
DeletedAt apijson.Field
204214
raw string
205215
ExtraFields map[string]apijson.Field
206216
}
@@ -261,6 +271,18 @@ func (r ThreatEventDatasetNewParams) MarshalJSON() (data []byte, err error) {
261271
type ThreatEventDatasetListParams struct {
262272
// Account ID.
263273
AccountID param.Field[string] `path:"account_id" api:"required"`
274+
// When true, include soft-deleted datasets in the response. Each item includes a
275+
// `deletedAt` field (ISO 8601 or null). Default: false.
276+
IncludeDeleted param.Field[bool] `query:"includeDeleted"`
277+
}
278+
279+
// URLQuery serializes [ThreatEventDatasetListParams]'s query parameters as
280+
// `url.Values`.
281+
func (r ThreatEventDatasetListParams) URLQuery() (v url.Values) {
282+
return apiquery.MarshalWithSettings(r, apiquery.QuerySettings{
283+
ArrayFormat: apiquery.ArrayQueryFormatRepeat,
284+
NestedFormat: apiquery.NestedQueryFormatDots,
285+
})
264286
}
265287

266288
type ThreatEventDatasetEditParams struct {

‎cloudforce_one/threateventdataset_test.go‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ func TestThreatEventDatasetNew(t *testing.T) {
4343
}
4444
}
4545

46-
func TestThreatEventDatasetList(t *testing.T) {
46+
func TestThreatEventDatasetListWithOptionalParams(t *testing.T) {
4747
t.Skip("TODO: HTTP 401 from prism")
4848
baseURL := "http://localhost:4010"
4949
if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
@@ -59,7 +59,8 @@ func TestThreatEventDatasetList(t *testing.T) {
5959
option.WithAPIEmail("user@example.com"),
6060
)
6161
_, err := client.CloudforceOne.ThreatEvents.Datasets.List(context.TODO(), cloudforce_one.ThreatEventDatasetListParams{
62-
AccountID: cloudflare.F("account_id"),
62+
AccountID: cloudflare.F("account_id"),
63+
IncludeDeleted: cloudflare.F(true),
6364
})
6465
if err != nil {
6566
var apierr *cloudflare.Error

0 commit comments

Comments
 (0)