Skip to content

Commit 71117ac

Browse files
chore(api): update composite API spec
1 parent 477becf commit 71117ac

File tree

9 files changed

+686
-3
lines changed

9 files changed

+686
-3
lines changed

.stats.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
configured_endpoints: 1809
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-fb1eac231d9b7a2cd002dd4fd953debb42dc838309f146341be49138c2bf0171.yml
3-
openapi_spec_hash: b18fccb4d0e37766b5294dde329eb911
1+
configured_endpoints: 1815
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-f398b4bcf6552a77a9c14a0e3165414b374eca05fbe32d11e9260b1ee81384a8.yml
3+
openapi_spec_hash: 23bca0fe3706fb66e8ee56b04af0fe5d
44
config_hash: 08d1e85e3d6166780e91482de72fa93c

api.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8878,10 +8878,40 @@ Methods:
88788878

88798879
# ContentScanning
88808880

8881+
Response Types:
8882+
8883+
- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#ContentScanningDisableResponse">ContentScanningDisableResponse</a>
8884+
- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#ContentScanningEnableResponse">ContentScanningEnableResponse</a>
8885+
8886+
Methods:
8887+
8888+
- <code title="post /zones/{zone_id}/content-upload-scan/disable">client.ContentScanning.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#ContentScanningService.Disable">Disable</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, body <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#ContentScanningDisableParams">ContentScanningDisableParams</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#ContentScanningDisableResponse">ContentScanningDisableResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
8889+
- <code title="post /zones/{zone_id}/content-upload-scan/enable">client.ContentScanning.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#ContentScanningService.Enable">Enable</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, body <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#ContentScanningEnableParams">ContentScanningEnableParams</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#ContentScanningEnableResponse">ContentScanningEnableResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
8890+
88818891
## Payloads
88828892

8893+
Response Types:
8894+
8895+
- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#PayloadNewResponse">PayloadNewResponse</a>
8896+
- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#PayloadListResponse">PayloadListResponse</a>
8897+
- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#PayloadDeleteResponse">PayloadDeleteResponse</a>
8898+
8899+
Methods:
8900+
8901+
- <code title="post /zones/{zone_id}/content-upload-scan/payloads">client.ContentScanning.Payloads.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#PayloadService.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/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#PayloadNewParams">PayloadNewParams</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/packages/pagination">pagination</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/packages/pagination#SinglePage">SinglePage</a>[<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#PayloadNewResponse">PayloadNewResponse</a>], <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
8902+
- <code title="get /zones/{zone_id}/content-upload-scan/payloads">client.ContentScanning.Payloads.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#PayloadService.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/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#PayloadListParams">PayloadListParams</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/packages/pagination">pagination</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/packages/pagination#SinglePage">SinglePage</a>[<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#PayloadListResponse">PayloadListResponse</a>], <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
8903+
- <code title="delete /zones/{zone_id}/content-upload-scan/payloads/{expression_id}">client.ContentScanning.Payloads.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#PayloadService.Delete">Delete</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, expressionID <a href="https://pkg.go.dev/builtin#string">string</a>, body <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#PayloadDeleteParams">PayloadDeleteParams</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/packages/pagination">pagination</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/packages/pagination#SinglePage">SinglePage</a>[<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#PayloadDeleteResponse">PayloadDeleteResponse</a>], <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
8904+
88838905
## Settings
88848906

8907+
Response Types:
8908+
8909+
- <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#SettingGetResponse">SettingGetResponse</a>
8910+
8911+
Methods:
8912+
8913+
- <code title="get /zones/{zone_id}/content-upload-scan/settings">client.ContentScanning.Settings.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#SettingService.Get">Get</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/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#SettingGetParams">SettingGetParams</a>) (<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning">content_scanning</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v6/content_scanning#SettingGetResponse">SettingGetResponse</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
8914+
88858915
# AbuseReports
88868916

88878917
Methods:

content_scanning/contentscanning.go

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,17 @@
33
package content_scanning
44

55
import (
6+
"context"
7+
"errors"
8+
"fmt"
9+
"net/http"
10+
"slices"
11+
12+
"github.com/cloudflare/cloudflare-go/v6/internal/apijson"
13+
"github.com/cloudflare/cloudflare-go/v6/internal/param"
14+
"github.com/cloudflare/cloudflare-go/v6/internal/requestconfig"
615
"github.com/cloudflare/cloudflare-go/v6/option"
16+
"github.com/cloudflare/cloudflare-go/v6/shared"
717
)
818

919
// ContentScanningService contains methods and other services that help with
@@ -28,3 +38,137 @@ func NewContentScanningService(opts ...option.RequestOption) (r *ContentScanning
2838
r.Settings = NewSettingService(opts...)
2939
return
3040
}
41+
42+
// Disable Content Scanning.
43+
func (r *ContentScanningService) Disable(ctx context.Context, body ContentScanningDisableParams, opts ...option.RequestOption) (res *ContentScanningDisableResponse, err error) {
44+
var env ContentScanningDisableResponseEnvelope
45+
opts = slices.Concat(r.Options, opts)
46+
if body.ZoneID.Value == "" {
47+
err = errors.New("missing required zone_id parameter")
48+
return
49+
}
50+
path := fmt.Sprintf("zones/%s/content-upload-scan/disable", body.ZoneID)
51+
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, nil, &env, opts...)
52+
if err != nil {
53+
return
54+
}
55+
res = &env.Result
56+
return
57+
}
58+
59+
// Enable Content Scanning.
60+
func (r *ContentScanningService) Enable(ctx context.Context, body ContentScanningEnableParams, opts ...option.RequestOption) (res *ContentScanningEnableResponse, err error) {
61+
var env ContentScanningEnableResponseEnvelope
62+
opts = slices.Concat(r.Options, opts)
63+
if body.ZoneID.Value == "" {
64+
err = errors.New("missing required zone_id parameter")
65+
return
66+
}
67+
path := fmt.Sprintf("zones/%s/content-upload-scan/enable", body.ZoneID)
68+
err = requestconfig.ExecuteNewRequest(ctx, http.MethodPost, path, nil, &env, opts...)
69+
if err != nil {
70+
return
71+
}
72+
res = &env.Result
73+
return
74+
}
75+
76+
type ContentScanningDisableResponse = interface{}
77+
78+
type ContentScanningEnableResponse = interface{}
79+
80+
type ContentScanningDisableParams struct {
81+
// Defines an identifier.
82+
ZoneID param.Field[string] `path:"zone_id,required"`
83+
}
84+
85+
type ContentScanningDisableResponseEnvelope struct {
86+
Errors []shared.ResponseInfo `json:"errors,required"`
87+
Messages []shared.ResponseInfo `json:"messages,required"`
88+
Result ContentScanningDisableResponse `json:"result,required"`
89+
// Whether the API call was successful.
90+
Success ContentScanningDisableResponseEnvelopeSuccess `json:"success,required"`
91+
JSON contentScanningDisableResponseEnvelopeJSON `json:"-"`
92+
}
93+
94+
// contentScanningDisableResponseEnvelopeJSON contains the JSON metadata for the
95+
// struct [ContentScanningDisableResponseEnvelope]
96+
type contentScanningDisableResponseEnvelopeJSON struct {
97+
Errors apijson.Field
98+
Messages apijson.Field
99+
Result apijson.Field
100+
Success apijson.Field
101+
raw string
102+
ExtraFields map[string]apijson.Field
103+
}
104+
105+
func (r *ContentScanningDisableResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
106+
return apijson.UnmarshalRoot(data, r)
107+
}
108+
109+
func (r contentScanningDisableResponseEnvelopeJSON) RawJSON() string {
110+
return r.raw
111+
}
112+
113+
// Whether the API call was successful.
114+
type ContentScanningDisableResponseEnvelopeSuccess bool
115+
116+
const (
117+
ContentScanningDisableResponseEnvelopeSuccessTrue ContentScanningDisableResponseEnvelopeSuccess = true
118+
)
119+
120+
func (r ContentScanningDisableResponseEnvelopeSuccess) IsKnown() bool {
121+
switch r {
122+
case ContentScanningDisableResponseEnvelopeSuccessTrue:
123+
return true
124+
}
125+
return false
126+
}
127+
128+
type ContentScanningEnableParams struct {
129+
// Defines an identifier.
130+
ZoneID param.Field[string] `path:"zone_id,required"`
131+
}
132+
133+
type ContentScanningEnableResponseEnvelope struct {
134+
Errors []shared.ResponseInfo `json:"errors,required"`
135+
Messages []shared.ResponseInfo `json:"messages,required"`
136+
Result ContentScanningEnableResponse `json:"result,required"`
137+
// Whether the API call was successful.
138+
Success ContentScanningEnableResponseEnvelopeSuccess `json:"success,required"`
139+
JSON contentScanningEnableResponseEnvelopeJSON `json:"-"`
140+
}
141+
142+
// contentScanningEnableResponseEnvelopeJSON contains the JSON metadata for the
143+
// struct [ContentScanningEnableResponseEnvelope]
144+
type contentScanningEnableResponseEnvelopeJSON struct {
145+
Errors apijson.Field
146+
Messages apijson.Field
147+
Result apijson.Field
148+
Success apijson.Field
149+
raw string
150+
ExtraFields map[string]apijson.Field
151+
}
152+
153+
func (r *ContentScanningEnableResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
154+
return apijson.UnmarshalRoot(data, r)
155+
}
156+
157+
func (r contentScanningEnableResponseEnvelopeJSON) RawJSON() string {
158+
return r.raw
159+
}
160+
161+
// Whether the API call was successful.
162+
type ContentScanningEnableResponseEnvelopeSuccess bool
163+
164+
const (
165+
ContentScanningEnableResponseEnvelopeSuccessTrue ContentScanningEnableResponseEnvelopeSuccess = true
166+
)
167+
168+
func (r ContentScanningEnableResponseEnvelopeSuccess) IsKnown() bool {
169+
switch r {
170+
case ContentScanningEnableResponseEnvelopeSuccessTrue:
171+
return true
172+
}
173+
return false
174+
}
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2+
3+
package content_scanning_test
4+
5+
import (
6+
"context"
7+
"errors"
8+
"os"
9+
"testing"
10+
11+
"github.com/cloudflare/cloudflare-go/v6"
12+
"github.com/cloudflare/cloudflare-go/v6/content_scanning"
13+
"github.com/cloudflare/cloudflare-go/v6/internal/testutil"
14+
"github.com/cloudflare/cloudflare-go/v6/option"
15+
)
16+
17+
func TestContentScanningDisable(t *testing.T) {
18+
baseURL := "http://localhost:4010"
19+
if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
20+
baseURL = envURL
21+
}
22+
if !testutil.CheckTestServer(t, baseURL) {
23+
return
24+
}
25+
client := cloudflare.NewClient(
26+
option.WithBaseURL(baseURL),
27+
option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
28+
option.WithAPIEmail("user@example.com"),
29+
)
30+
_, err := client.ContentScanning.Disable(context.TODO(), content_scanning.ContentScanningDisableParams{
31+
ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
32+
})
33+
if err != nil {
34+
var apierr *cloudflare.Error
35+
if errors.As(err, &apierr) {
36+
t.Log(string(apierr.DumpRequest(true)))
37+
}
38+
t.Fatalf("err should be nil: %s", err.Error())
39+
}
40+
}
41+
42+
func TestContentScanningEnable(t *testing.T) {
43+
baseURL := "http://localhost:4010"
44+
if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
45+
baseURL = envURL
46+
}
47+
if !testutil.CheckTestServer(t, baseURL) {
48+
return
49+
}
50+
client := cloudflare.NewClient(
51+
option.WithBaseURL(baseURL),
52+
option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
53+
option.WithAPIEmail("user@example.com"),
54+
)
55+
_, err := client.ContentScanning.Enable(context.TODO(), content_scanning.ContentScanningEnableParams{
56+
ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
57+
})
58+
if err != nil {
59+
var apierr *cloudflare.Error
60+
if errors.As(err, &apierr) {
61+
t.Log(string(apierr.DumpRequest(true)))
62+
}
63+
t.Fatalf("err should be nil: %s", err.Error())
64+
}
65+
}

0 commit comments

Comments
 (0)