Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 4885383

Browse files
committedMar 13, 2025
chore(internal): mark VPC and PDF as initialisms (#3963)
1 parent 74b7996 commit 4885383

File tree

9 files changed

+184
-184
lines changed

9 files changed

+184
-184
lines changed
 

‎api.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3721,13 +3721,13 @@ Methods:
37213721

37223722
# MagicNetworkMonitoring
37233723

3724-
## VpcFlows
3724+
## VPCFlows
37253725

37263726
### Tokens
37273727

37283728
Methods:
37293729

3730-
- <code title="post /accounts/{account_id}/mnm/vpc-flows/token">client.MagicNetworkMonitoring.VpcFlows.Tokens.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v4/magic_network_monitoring#VpcFlowTokenService.New">New</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/v4/magic_network_monitoring">magic_network_monitoring</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v4/magic_network_monitoring#VpcFlowTokenNewParams">VpcFlowTokenNewParams</a>) (<a href="https://pkg.go.dev/builtin#string">string</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
3730+
- <code title="post /accounts/{account_id}/mnm/vpc-flows/token">client.MagicNetworkMonitoring.VPCFlows.Tokens.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v4/magic_network_monitoring#VPCFlowTokenService.New">New</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/v4/magic_network_monitoring">magic_network_monitoring</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v4/magic_network_monitoring#VPCFlowTokenNewParams">VPCFlowTokenNewParams</a>) (<a href="https://pkg.go.dev/builtin#string">string</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
37313731

37323732
## Configs
37333733

@@ -8128,11 +8128,11 @@ Methods:
81288128

81298129
- <code title="post /accounts/{accountId}/browser-rendering/content">client.BrowsingRendering.Content.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v4/browsing_rendering#ContentService.New">New</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, accountID <a href="https://pkg.go.dev/builtin#string">string</a>, params <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v4/browsing_rendering">browsing_rendering</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v4/browsing_rendering#ContentNewParams">ContentNewParams</a>) (<a href="https://pkg.go.dev/builtin#string">string</a>, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
81308130

8131-
## Pdf
8131+
## PDF
81328132

81338133
Methods:
81348134

8135-
- <code title="post /accounts/{accountId}/browser-rendering/pdf">client.BrowsingRendering.Pdf.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v4/browsing_rendering#PdfService.New">New</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, accountID <a href="https://pkg.go.dev/builtin#string">string</a>, params <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v4/browsing_rendering">browsing_rendering</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v4/browsing_rendering#PdfNewParams">PdfNewParams</a>) (http.Response, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
8135+
- <code title="post /accounts/{accountId}/browser-rendering/pdf">client.BrowsingRendering.PDF.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v4/browsing_rendering#PDFService.New">New</a>(ctx <a href="https://pkg.go.dev/context">context</a>.<a href="https://pkg.go.dev/context#Context">Context</a>, accountID <a href="https://pkg.go.dev/builtin#string">string</a>, params <a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v4/browsing_rendering">browsing_rendering</a>.<a href="https://pkg.go.dev/github.com/cloudflare/cloudflare-go/v4/browsing_rendering#PDFNewParams">PDFNewParams</a>) (http.Response, <a href="https://pkg.go.dev/builtin#error">error</a>)</code>
81368136

81378137
## Scrape
81388138

‎browsing_rendering/browsingrendering.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import (
1515
type BrowsingRenderingService struct {
1616
Options []option.RequestOption
1717
Content *ContentService
18-
Pdf *PdfService
18+
PDF *PDFService
1919
Scrape *ScrapeService
2020
Screenshot *ScreenshotService
2121
Snapshot *SnapshotService
@@ -28,7 +28,7 @@ func NewBrowsingRenderingService(opts ...option.RequestOption) (r *BrowsingRende
2828
r = &BrowsingRenderingService{}
2929
r.Options = opts
3030
r.Content = NewContentService(opts...)
31-
r.Pdf = NewPdfService(opts...)
31+
r.PDF = NewPDFService(opts...)
3232
r.Scrape = NewScrapeService(opts...)
3333
r.Screenshot = NewScreenshotService(opts...)
3434
r.Snapshot = NewSnapshotService(opts...)

‎browsing_rendering/pdf.go

+129-129
Large diffs are not rendered by default.

‎browsing_rendering/pdf_test.go

+18-18
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import (
1616
"github.com/cloudflare/cloudflare-go/v4/option"
1717
)
1818

19-
func TestPdfNewWithOptionalParams(t *testing.T) {
19+
func TestPDFNewWithOptionalParams(t *testing.T) {
2020
server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
2121
w.WriteHeader(200)
2222
w.Write([]byte("abc"))
@@ -28,73 +28,73 @@ func TestPdfNewWithOptionalParams(t *testing.T) {
2828
option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
2929
option.WithAPIEmail("user@example.com"),
3030
)
31-
resp, err := client.BrowsingRendering.Pdf.New(
31+
resp, err := client.BrowsingRendering.PDF.New(
3232
context.TODO(),
3333
"accountId",
34-
browsing_rendering.PdfNewParams{
34+
browsing_rendering.PDFNewParams{
3535
CacheTTL: cloudflare.F(86400.000000),
36-
AddScriptTag: cloudflare.F([]browsing_rendering.PdfNewParamsAddScriptTag{{
36+
AddScriptTag: cloudflare.F([]browsing_rendering.PDFNewParamsAddScriptTag{{
3737
ID: cloudflare.F("id"),
3838
Content: cloudflare.F("content"),
3939
Type: cloudflare.F("type"),
4040
URL: cloudflare.F("url"),
4141
}}),
42-
AddStyleTag: cloudflare.F([]browsing_rendering.PdfNewParamsAddStyleTag{{
42+
AddStyleTag: cloudflare.F([]browsing_rendering.PDFNewParamsAddStyleTag{{
4343
Content: cloudflare.F("content"),
4444
URL: cloudflare.F("url"),
4545
}}),
4646
AllowRequestPattern: cloudflare.F([]string{"string"}),
47-
AllowResourceTypes: cloudflare.F([]browsing_rendering.PdfNewParamsAllowResourceType{browsing_rendering.PdfNewParamsAllowResourceTypeDocument}),
48-
Authenticate: cloudflare.F(browsing_rendering.PdfNewParamsAuthenticate{
47+
AllowResourceTypes: cloudflare.F([]browsing_rendering.PDFNewParamsAllowResourceType{browsing_rendering.PDFNewParamsAllowResourceTypeDocument}),
48+
Authenticate: cloudflare.F(browsing_rendering.PDFNewParamsAuthenticate{
4949
Password: cloudflare.F("x"),
5050
Username: cloudflare.F("x"),
5151
}),
5252
BestAttempt: cloudflare.F(true),
53-
Cookies: cloudflare.F([]browsing_rendering.PdfNewParamsCookie{{
53+
Cookies: cloudflare.F([]browsing_rendering.PDFNewParamsCookie{{
5454
Name: cloudflare.F("name"),
5555
Value: cloudflare.F("value"),
5656
Domain: cloudflare.F("domain"),
5757
Expires: cloudflare.F(0.000000),
5858
HTTPOnly: cloudflare.F(true),
5959
PartitionKey: cloudflare.F("partitionKey"),
6060
Path: cloudflare.F("path"),
61-
Priority: cloudflare.F(browsing_rendering.PdfNewParamsCookiesPriorityLow),
61+
Priority: cloudflare.F(browsing_rendering.PDFNewParamsCookiesPriorityLow),
6262
SameParty: cloudflare.F(true),
63-
SameSite: cloudflare.F(browsing_rendering.PdfNewParamsCookiesSameSiteStrict),
63+
SameSite: cloudflare.F(browsing_rendering.PDFNewParamsCookiesSameSiteStrict),
6464
Secure: cloudflare.F(true),
6565
SourcePort: cloudflare.F(0.000000),
66-
SourceScheme: cloudflare.F(browsing_rendering.PdfNewParamsCookiesSourceSchemeUnset),
66+
SourceScheme: cloudflare.F(browsing_rendering.PDFNewParamsCookiesSourceSchemeUnset),
6767
URL: cloudflare.F("url"),
6868
}}),
6969
EmulateMediaType: cloudflare.F("emulateMediaType"),
70-
GotoOptions: cloudflare.F(browsing_rendering.PdfNewParamsGotoOptions{
70+
GotoOptions: cloudflare.F(browsing_rendering.PDFNewParamsGotoOptions{
7171
Referer: cloudflare.F("referer"),
7272
ReferrerPolicy: cloudflare.F("referrerPolicy"),
7373
Timeout: cloudflare.F(60000.000000),
74-
WaitUntil: cloudflare.F[browsing_rendering.PdfNewParamsGotoOptionsWaitUntilUnion](browsing_rendering.PdfNewParamsGotoOptionsWaitUntilString(browsing_rendering.PdfNewParamsGotoOptionsWaitUntilStringLoad)),
74+
WaitUntil: cloudflare.F[browsing_rendering.PDFNewParamsGotoOptionsWaitUntilUnion](browsing_rendering.PDFNewParamsGotoOptionsWaitUntilString(browsing_rendering.PDFNewParamsGotoOptionsWaitUntilStringLoad)),
7575
}),
7676
HTML: cloudflare.F("x"),
7777
RejectRequestPattern: cloudflare.F([]string{"string"}),
78-
RejectResourceTypes: cloudflare.F([]browsing_rendering.PdfNewParamsRejectResourceType{browsing_rendering.PdfNewParamsRejectResourceTypeDocument}),
78+
RejectResourceTypes: cloudflare.F([]browsing_rendering.PDFNewParamsRejectResourceType{browsing_rendering.PDFNewParamsRejectResourceTypeDocument}),
7979
SetExtraHTTPHeaders: cloudflare.F(map[string]string{
8080
"foo": "string",
8181
}),
8282
SetJavaScriptEnabled: cloudflare.F(true),
8383
URL: cloudflare.F("https://example.com"),
8484
UserAgent: cloudflare.F("userAgent"),
85-
Viewport: cloudflare.F(browsing_rendering.PdfNewParamsViewport{
85+
Viewport: cloudflare.F(browsing_rendering.PDFNewParamsViewport{
8686
Height: cloudflare.F(0.000000),
8787
Width: cloudflare.F(0.000000),
8888
DeviceScaleFactor: cloudflare.F(0.000000),
8989
HasTouch: cloudflare.F(true),
9090
IsLandscape: cloudflare.F(true),
9191
IsMobile: cloudflare.F(true),
9292
}),
93-
WaitForSelector: cloudflare.F(browsing_rendering.PdfNewParamsWaitForSelector{
93+
WaitForSelector: cloudflare.F(browsing_rendering.PDFNewParamsWaitForSelector{
9494
Selector: cloudflare.F("selector"),
95-
Hidden: cloudflare.F(browsing_rendering.PdfNewParamsWaitForSelectorHiddenTrue),
95+
Hidden: cloudflare.F(browsing_rendering.PDFNewParamsWaitForSelectorHiddenTrue),
9696
Timeout: cloudflare.F(60000.000000),
97-
Visible: cloudflare.F(browsing_rendering.PdfNewParamsWaitForSelectorVisibleTrue),
97+
Visible: cloudflare.F(browsing_rendering.PDFNewParamsWaitForSelectorVisibleTrue),
9898
}),
9999
WaitForTimeout: cloudflare.F(60000.000000),
100100
},

‎magic_network_monitoring/magicnetworkmonitoring.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import (
1414
// the [NewMagicNetworkMonitoringService] method instead.
1515
type MagicNetworkMonitoringService struct {
1616
Options []option.RequestOption
17-
VpcFlows *VpcFlowService
17+
VPCFlows *VPCFlowService
1818
Configs *ConfigService
1919
Rules *RuleService
2020
}
@@ -25,7 +25,7 @@ type MagicNetworkMonitoringService struct {
2525
func NewMagicNetworkMonitoringService(opts ...option.RequestOption) (r *MagicNetworkMonitoringService) {
2626
r = &MagicNetworkMonitoringService{}
2727
r.Options = opts
28-
r.VpcFlows = NewVpcFlowService(opts...)
28+
r.VPCFlows = NewVPCFlowService(opts...)
2929
r.Configs = NewConfigService(opts...)
3030
r.Rules = NewRuleService(opts...)
3131
return

‎magic_network_monitoring/vpcflow.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ import (
66
"github.com/cloudflare/cloudflare-go/v4/option"
77
)
88

9-
// VpcFlowService contains methods and other services that help with interacting
9+
// VPCFlowService contains methods and other services that help with interacting
1010
// with the cloudflare API.
1111
//
1212
// Note, unlike clients, this service does not read variables from the environment
1313
// automatically. You should not instantiate this service directly, and instead use
14-
// the [NewVpcFlowService] method instead.
15-
type VpcFlowService struct {
14+
// the [NewVPCFlowService] method instead.
15+
type VPCFlowService struct {
1616
Options []option.RequestOption
17-
Tokens *VpcFlowTokenService
17+
Tokens *VPCFlowTokenService
1818
}
1919

20-
// NewVpcFlowService generates a new service that applies the given options to each
20+
// NewVPCFlowService generates a new service that applies the given options to each
2121
// request. These options are applied after the parent client's options (if there
2222
// is one), and before any request-specific options.
23-
func NewVpcFlowService(opts ...option.RequestOption) (r *VpcFlowService) {
24-
r = &VpcFlowService{}
23+
func NewVPCFlowService(opts ...option.RequestOption) (r *VPCFlowService) {
24+
r = &VPCFlowService{}
2525
r.Options = opts
26-
r.Tokens = NewVpcFlowTokenService(opts...)
26+
r.Tokens = NewVPCFlowTokenService(opts...)
2727
return
2828
}

‎magic_network_monitoring/vpcflowtoken.go

+17-17
Original file line numberDiff line numberDiff line change
@@ -15,28 +15,28 @@ import (
1515
"github.com/cloudflare/cloudflare-go/v4/shared"
1616
)
1717

18-
// VpcFlowTokenService contains methods and other services that help with
18+
// VPCFlowTokenService contains methods and other services that help with
1919
// interacting with the cloudflare API.
2020
//
2121
// Note, unlike clients, this service does not read variables from the environment
2222
// automatically. You should not instantiate this service directly, and instead use
23-
// the [NewVpcFlowTokenService] method instead.
24-
type VpcFlowTokenService struct {
23+
// the [NewVPCFlowTokenService] method instead.
24+
type VPCFlowTokenService struct {
2525
Options []option.RequestOption
2626
}
2727

28-
// NewVpcFlowTokenService generates a new service that applies the given options to
28+
// NewVPCFlowTokenService generates a new service that applies the given options to
2929
// each request. These options are applied after the parent client's options (if
3030
// there is one), and before any request-specific options.
31-
func NewVpcFlowTokenService(opts ...option.RequestOption) (r *VpcFlowTokenService) {
32-
r = &VpcFlowTokenService{}
31+
func NewVPCFlowTokenService(opts ...option.RequestOption) (r *VPCFlowTokenService) {
32+
r = &VPCFlowTokenService{}
3333
r.Options = opts
3434
return
3535
}
3636

3737
// Generate authentication token for VPC flow logs export.
38-
func (r *VpcFlowTokenService) New(ctx context.Context, body VpcFlowTokenNewParams, opts ...option.RequestOption) (res *string, err error) {
39-
var env VpcFlowTokenNewResponseEnvelope
38+
func (r *VPCFlowTokenService) New(ctx context.Context, body VPCFlowTokenNewParams, opts ...option.RequestOption) (res *string, err error) {
39+
var env VPCFlowTokenNewResponseEnvelope
4040
opts = append(r.Options[:], opts...)
4141
if body.AccountID.Value == "" {
4242
err = errors.New("missing required account_id parameter")
@@ -51,22 +51,22 @@ func (r *VpcFlowTokenService) New(ctx context.Context, body VpcFlowTokenNewParam
5151
return
5252
}
5353

54-
type VpcFlowTokenNewParams struct {
54+
type VPCFlowTokenNewParams struct {
5555
AccountID param.Field[string] `path:"account_id,required"`
5656
}
5757

58-
type VpcFlowTokenNewResponseEnvelope struct {
58+
type VPCFlowTokenNewResponseEnvelope struct {
5959
Errors []shared.ResponseInfo `json:"errors,required"`
6060
Messages []shared.ResponseInfo `json:"messages,required"`
6161
// Authentication token to be used for VPC Flows export authentication.
6262
Result string `json:"result,required"`
6363
// Whether the API call was successful
64-
Success VpcFlowTokenNewResponseEnvelopeSuccess `json:"success,required"`
64+
Success VPCFlowTokenNewResponseEnvelopeSuccess `json:"success,required"`
6565
JSON vpcFlowTokenNewResponseEnvelopeJSON `json:"-"`
6666
}
6767

6868
// vpcFlowTokenNewResponseEnvelopeJSON contains the JSON metadata for the struct
69-
// [VpcFlowTokenNewResponseEnvelope]
69+
// [VPCFlowTokenNewResponseEnvelope]
7070
type vpcFlowTokenNewResponseEnvelopeJSON struct {
7171
Errors apijson.Field
7272
Messages apijson.Field
@@ -76,7 +76,7 @@ type vpcFlowTokenNewResponseEnvelopeJSON struct {
7676
ExtraFields map[string]apijson.Field
7777
}
7878

79-
func (r *VpcFlowTokenNewResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
79+
func (r *VPCFlowTokenNewResponseEnvelope) UnmarshalJSON(data []byte) (err error) {
8080
return apijson.UnmarshalRoot(data, r)
8181
}
8282

@@ -85,15 +85,15 @@ func (r vpcFlowTokenNewResponseEnvelopeJSON) RawJSON() string {
8585
}
8686

8787
// Whether the API call was successful
88-
type VpcFlowTokenNewResponseEnvelopeSuccess bool
88+
type VPCFlowTokenNewResponseEnvelopeSuccess bool
8989

9090
const (
91-
VpcFlowTokenNewResponseEnvelopeSuccessTrue VpcFlowTokenNewResponseEnvelopeSuccess = true
91+
VPCFlowTokenNewResponseEnvelopeSuccessTrue VPCFlowTokenNewResponseEnvelopeSuccess = true
9292
)
9393

94-
func (r VpcFlowTokenNewResponseEnvelopeSuccess) IsKnown() bool {
94+
func (r VPCFlowTokenNewResponseEnvelopeSuccess) IsKnown() bool {
9595
switch r {
96-
case VpcFlowTokenNewResponseEnvelopeSuccessTrue:
96+
case VPCFlowTokenNewResponseEnvelopeSuccessTrue:
9797
return true
9898
}
9999
return false

‎magic_network_monitoring/vpcflowtoken_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import (
1414
"github.com/cloudflare/cloudflare-go/v4/option"
1515
)
1616

17-
func TestVpcFlowTokenNew(t *testing.T) {
17+
func TestVPCFlowTokenNew(t *testing.T) {
1818
baseURL := "http://localhost:4010"
1919
if envURL, ok := os.LookupEnv("TEST_API_BASE_URL"); ok {
2020
baseURL = envURL
@@ -27,7 +27,7 @@ func TestVpcFlowTokenNew(t *testing.T) {
2727
option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
2828
option.WithAPIEmail("user@example.com"),
2929
)
30-
_, err := client.MagicNetworkMonitoring.VpcFlows.Tokens.New(context.TODO(), magic_network_monitoring.VpcFlowTokenNewParams{
30+
_, err := client.MagicNetworkMonitoring.VPCFlows.Tokens.New(context.TODO(), magic_network_monitoring.VPCFlowTokenNewParams{
3131
AccountID: cloudflare.F("6f91088a406011ed95aed352566e8d4c"),
3232
})
3333
if err != nil {

‎zero_trust/gatewayrule.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -940,7 +940,7 @@ type RuleSettingQuarantineFileType string
940940

941941
const (
942942
RuleSettingQuarantineFileTypeExe RuleSettingQuarantineFileType = "exe"
943-
RuleSettingQuarantineFileTypePdf RuleSettingQuarantineFileType = "pdf"
943+
RuleSettingQuarantineFileTypePDF RuleSettingQuarantineFileType = "pdf"
944944
RuleSettingQuarantineFileTypeDoc RuleSettingQuarantineFileType = "doc"
945945
RuleSettingQuarantineFileTypeDocm RuleSettingQuarantineFileType = "docm"
946946
RuleSettingQuarantineFileTypeDocx RuleSettingQuarantineFileType = "docx"
@@ -956,7 +956,7 @@ const (
956956

957957
func (r RuleSettingQuarantineFileType) IsKnown() bool {
958958
switch r {
959-
case RuleSettingQuarantineFileTypeExe, RuleSettingQuarantineFileTypePdf, RuleSettingQuarantineFileTypeDoc, RuleSettingQuarantineFileTypeDocm, RuleSettingQuarantineFileTypeDocx, RuleSettingQuarantineFileTypeRtf, RuleSettingQuarantineFileTypePpt, RuleSettingQuarantineFileTypePptx, RuleSettingQuarantineFileTypeXls, RuleSettingQuarantineFileTypeXlsm, RuleSettingQuarantineFileTypeXlsx, RuleSettingQuarantineFileTypeZip, RuleSettingQuarantineFileTypeRar:
959+
case RuleSettingQuarantineFileTypeExe, RuleSettingQuarantineFileTypePDF, RuleSettingQuarantineFileTypeDoc, RuleSettingQuarantineFileTypeDocm, RuleSettingQuarantineFileTypeDocx, RuleSettingQuarantineFileTypeRtf, RuleSettingQuarantineFileTypePpt, RuleSettingQuarantineFileTypePptx, RuleSettingQuarantineFileTypeXls, RuleSettingQuarantineFileTypeXlsm, RuleSettingQuarantineFileTypeXlsx, RuleSettingQuarantineFileTypeZip, RuleSettingQuarantineFileTypeRar:
960960
return true
961961
}
962962
return false

0 commit comments

Comments
 (0)
Please sign in to comment.