Skip to content

Commit f6a3e5c

Browse files
chore(api): update composite API spec
1 parent fecd84e commit f6a3e5c

File tree

3 files changed

+143
-2
lines changed

3 files changed

+143
-2
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 1839
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-72ce892ddf4f0cfe8ab511c2f84e4f8612d839ba17e981262ccc0e29c7c4c5df.yml
3-
openapi_spec_hash: e93d4fcda4bcd5ec1a77ddb5782ffd78
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-15982839c3e7b1be15bee16e97c5dcef8397120052303cf3fc3b2b75d9bee219.yml
3+
openapi_spec_hash: 6d2e235e75f6ce217b0b84c07c6f5aac
44
config_hash: 59212900ef3970ac3c41ca2537fabe7b

bot_management/botmanagement.go

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,8 @@ type BotFightModeConfiguration struct {
142142
// Enable rule to block AI Scrapers and Crawlers. Please note the value
143143
// `only_on_ad_pages` is currently not available for Enterprise customers.
144144
AIBotsProtection BotFightModeConfigurationAIBotsProtection `json:"ai_bots_protection"`
145+
// Specifies the Robots Access Control License variant to use.
146+
CfRobotsVariant BotFightModeConfigurationCfRobotsVariant `json:"cf_robots_variant"`
145147
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
146148
CrawlerProtection BotFightModeConfigurationCrawlerProtection `json:"crawler_protection"`
147149
// Use lightweight, invisible JavaScript detections to improve Bot Management.
@@ -165,6 +167,7 @@ type BotFightModeConfiguration struct {
165167
// [BotFightModeConfiguration]
166168
type botFightModeConfigurationJSON struct {
167169
AIBotsProtection apijson.Field
170+
CfRobotsVariant apijson.Field
168171
CrawlerProtection apijson.Field
169172
EnableJS apijson.Field
170173
FightMode apijson.Field
@@ -205,6 +208,22 @@ func (r BotFightModeConfigurationAIBotsProtection) IsKnown() bool {
205208
return false
206209
}
207210

211+
// Specifies the Robots Access Control License variant to use.
212+
type BotFightModeConfigurationCfRobotsVariant string
213+
214+
const (
215+
BotFightModeConfigurationCfRobotsVariantOff BotFightModeConfigurationCfRobotsVariant = "off"
216+
BotFightModeConfigurationCfRobotsVariantPolicyOnly BotFightModeConfigurationCfRobotsVariant = "policy_only"
217+
)
218+
219+
func (r BotFightModeConfigurationCfRobotsVariant) IsKnown() bool {
220+
switch r {
221+
case BotFightModeConfigurationCfRobotsVariantOff, BotFightModeConfigurationCfRobotsVariantPolicyOnly:
222+
return true
223+
}
224+
return false
225+
}
226+
208227
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
209228
type BotFightModeConfigurationCrawlerProtection string
210229

@@ -266,6 +285,8 @@ type BotFightModeConfigurationParam struct {
266285
// Enable rule to block AI Scrapers and Crawlers. Please note the value
267286
// `only_on_ad_pages` is currently not available for Enterprise customers.
268287
AIBotsProtection param.Field[BotFightModeConfigurationAIBotsProtection] `json:"ai_bots_protection"`
288+
// Specifies the Robots Access Control License variant to use.
289+
CfRobotsVariant param.Field[BotFightModeConfigurationCfRobotsVariant] `json:"cf_robots_variant"`
269290
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
270291
CrawlerProtection param.Field[BotFightModeConfigurationCrawlerProtection] `json:"crawler_protection"`
271292
// Use lightweight, invisible JavaScript detections to improve Bot Management.
@@ -318,6 +339,8 @@ type SubscriptionConfiguration struct {
318339
// Indicates that the bot management cookie can be placed on end user devices
319340
// accessing the site. Defaults to true
320341
BmCookieEnabled bool `json:"bm_cookie_enabled"`
342+
// Specifies the Robots Access Control License variant to use.
343+
CfRobotsVariant SubscriptionConfigurationCfRobotsVariant `json:"cf_robots_variant"`
321344
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
322345
CrawlerProtection SubscriptionConfigurationCrawlerProtection `json:"crawler_protection"`
323346
// Use lightweight, invisible JavaScript detections to improve Bot Management.
@@ -344,6 +367,7 @@ type subscriptionConfigurationJSON struct {
344367
AIBotsProtection apijson.Field
345368
AutoUpdateModel apijson.Field
346369
BmCookieEnabled apijson.Field
370+
CfRobotsVariant apijson.Field
347371
CrawlerProtection apijson.Field
348372
EnableJS apijson.Field
349373
IsRobotsTXTManaged apijson.Field
@@ -384,6 +408,22 @@ func (r SubscriptionConfigurationAIBotsProtection) IsKnown() bool {
384408
return false
385409
}
386410

411+
// Specifies the Robots Access Control License variant to use.
412+
type SubscriptionConfigurationCfRobotsVariant string
413+
414+
const (
415+
SubscriptionConfigurationCfRobotsVariantOff SubscriptionConfigurationCfRobotsVariant = "off"
416+
SubscriptionConfigurationCfRobotsVariantPolicyOnly SubscriptionConfigurationCfRobotsVariant = "policy_only"
417+
)
418+
419+
func (r SubscriptionConfigurationCfRobotsVariant) IsKnown() bool {
420+
switch r {
421+
case SubscriptionConfigurationCfRobotsVariantOff, SubscriptionConfigurationCfRobotsVariantPolicyOnly:
422+
return true
423+
}
424+
return false
425+
}
426+
387427
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
388428
type SubscriptionConfigurationCrawlerProtection string
389429

@@ -452,6 +492,8 @@ type SubscriptionConfigurationParam struct {
452492
// Indicates that the bot management cookie can be placed on end user devices
453493
// accessing the site. Defaults to true
454494
BmCookieEnabled param.Field[bool] `json:"bm_cookie_enabled"`
495+
// Specifies the Robots Access Control License variant to use.
496+
CfRobotsVariant param.Field[SubscriptionConfigurationCfRobotsVariant] `json:"cf_robots_variant"`
455497
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
456498
CrawlerProtection param.Field[SubscriptionConfigurationCrawlerProtection] `json:"crawler_protection"`
457499
// Use lightweight, invisible JavaScript detections to improve Bot Management.
@@ -498,6 +540,8 @@ type SuperBotFightModeDefinitelyConfiguration struct {
498540
// Enable rule to block AI Scrapers and Crawlers. Please note the value
499541
// `only_on_ad_pages` is currently not available for Enterprise customers.
500542
AIBotsProtection SuperBotFightModeDefinitelyConfigurationAIBotsProtection `json:"ai_bots_protection"`
543+
// Specifies the Robots Access Control License variant to use.
544+
CfRobotsVariant SuperBotFightModeDefinitelyConfigurationCfRobotsVariant `json:"cf_robots_variant"`
501545
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
502546
CrawlerProtection SuperBotFightModeDefinitelyConfigurationCrawlerProtection `json:"crawler_protection"`
503547
// Use lightweight, invisible JavaScript detections to improve Bot Management.
@@ -529,6 +573,7 @@ type SuperBotFightModeDefinitelyConfiguration struct {
529573
// struct [SuperBotFightModeDefinitelyConfiguration]
530574
type superBotFightModeDefinitelyConfigurationJSON struct {
531575
AIBotsProtection apijson.Field
576+
CfRobotsVariant apijson.Field
532577
CrawlerProtection apijson.Field
533578
EnableJS apijson.Field
534579
IsRobotsTXTManaged apijson.Field
@@ -572,6 +617,22 @@ func (r SuperBotFightModeDefinitelyConfigurationAIBotsProtection) IsKnown() bool
572617
return false
573618
}
574619

620+
// Specifies the Robots Access Control License variant to use.
621+
type SuperBotFightModeDefinitelyConfigurationCfRobotsVariant string
622+
623+
const (
624+
SuperBotFightModeDefinitelyConfigurationCfRobotsVariantOff SuperBotFightModeDefinitelyConfigurationCfRobotsVariant = "off"
625+
SuperBotFightModeDefinitelyConfigurationCfRobotsVariantPolicyOnly SuperBotFightModeDefinitelyConfigurationCfRobotsVariant = "policy_only"
626+
)
627+
628+
func (r SuperBotFightModeDefinitelyConfigurationCfRobotsVariant) IsKnown() bool {
629+
switch r {
630+
case SuperBotFightModeDefinitelyConfigurationCfRobotsVariantOff, SuperBotFightModeDefinitelyConfigurationCfRobotsVariantPolicyOnly:
631+
return true
632+
}
633+
return false
634+
}
635+
575636
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
576637
type SuperBotFightModeDefinitelyConfigurationCrawlerProtection string
577638

@@ -654,6 +715,8 @@ type SuperBotFightModeDefinitelyConfigurationParam struct {
654715
// Enable rule to block AI Scrapers and Crawlers. Please note the value
655716
// `only_on_ad_pages` is currently not available for Enterprise customers.
656717
AIBotsProtection param.Field[SuperBotFightModeDefinitelyConfigurationAIBotsProtection] `json:"ai_bots_protection"`
718+
// Specifies the Robots Access Control License variant to use.
719+
CfRobotsVariant param.Field[SuperBotFightModeDefinitelyConfigurationCfRobotsVariant] `json:"cf_robots_variant"`
657720
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
658721
CrawlerProtection param.Field[SuperBotFightModeDefinitelyConfigurationCrawlerProtection] `json:"crawler_protection"`
659722
// Use lightweight, invisible JavaScript detections to improve Bot Management.
@@ -699,6 +762,8 @@ type SuperBotFightModeLikelyConfiguration struct {
699762
// Enable rule to block AI Scrapers and Crawlers. Please note the value
700763
// `only_on_ad_pages` is currently not available for Enterprise customers.
701764
AIBotsProtection SuperBotFightModeLikelyConfigurationAIBotsProtection `json:"ai_bots_protection"`
765+
// Specifies the Robots Access Control License variant to use.
766+
CfRobotsVariant SuperBotFightModeLikelyConfigurationCfRobotsVariant `json:"cf_robots_variant"`
702767
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
703768
CrawlerProtection SuperBotFightModeLikelyConfigurationCrawlerProtection `json:"crawler_protection"`
704769
// Use lightweight, invisible JavaScript detections to improve Bot Management.
@@ -732,6 +797,7 @@ type SuperBotFightModeLikelyConfiguration struct {
732797
// struct [SuperBotFightModeLikelyConfiguration]
733798
type superBotFightModeLikelyConfigurationJSON struct {
734799
AIBotsProtection apijson.Field
800+
CfRobotsVariant apijson.Field
735801
CrawlerProtection apijson.Field
736802
EnableJS apijson.Field
737803
IsRobotsTXTManaged apijson.Field
@@ -776,6 +842,22 @@ func (r SuperBotFightModeLikelyConfigurationAIBotsProtection) IsKnown() bool {
776842
return false
777843
}
778844

845+
// Specifies the Robots Access Control License variant to use.
846+
type SuperBotFightModeLikelyConfigurationCfRobotsVariant string
847+
848+
const (
849+
SuperBotFightModeLikelyConfigurationCfRobotsVariantOff SuperBotFightModeLikelyConfigurationCfRobotsVariant = "off"
850+
SuperBotFightModeLikelyConfigurationCfRobotsVariantPolicyOnly SuperBotFightModeLikelyConfigurationCfRobotsVariant = "policy_only"
851+
)
852+
853+
func (r SuperBotFightModeLikelyConfigurationCfRobotsVariant) IsKnown() bool {
854+
switch r {
855+
case SuperBotFightModeLikelyConfigurationCfRobotsVariantOff, SuperBotFightModeLikelyConfigurationCfRobotsVariantPolicyOnly:
856+
return true
857+
}
858+
return false
859+
}
860+
779861
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
780862
type SuperBotFightModeLikelyConfigurationCrawlerProtection string
781863

@@ -871,6 +953,8 @@ type SuperBotFightModeLikelyConfigurationParam struct {
871953
// Enable rule to block AI Scrapers and Crawlers. Please note the value
872954
// `only_on_ad_pages` is currently not available for Enterprise customers.
873955
AIBotsProtection param.Field[SuperBotFightModeLikelyConfigurationAIBotsProtection] `json:"ai_bots_protection"`
956+
// Specifies the Robots Access Control License variant to use.
957+
CfRobotsVariant param.Field[SuperBotFightModeLikelyConfigurationCfRobotsVariant] `json:"cf_robots_variant"`
874958
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
875959
CrawlerProtection param.Field[SuperBotFightModeLikelyConfigurationCrawlerProtection] `json:"crawler_protection"`
876960
// Use lightweight, invisible JavaScript detections to improve Bot Management.
@@ -921,6 +1005,8 @@ type BotManagementUpdateResponse struct {
9211005
// Indicates that the bot management cookie can be placed on end user devices
9221006
// accessing the site. Defaults to true
9231007
BmCookieEnabled bool `json:"bm_cookie_enabled"`
1008+
// Specifies the Robots Access Control License variant to use.
1009+
CfRobotsVariant BotManagementUpdateResponseCfRobotsVariant `json:"cf_robots_variant"`
9241010
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
9251011
CrawlerProtection BotManagementUpdateResponseCrawlerProtection `json:"crawler_protection"`
9261012
// Use lightweight, invisible JavaScript detections to improve Bot Management.
@@ -965,6 +1051,7 @@ type botManagementUpdateResponseJSON struct {
9651051
AIBotsProtection apijson.Field
9661052
AutoUpdateModel apijson.Field
9671053
BmCookieEnabled apijson.Field
1054+
CfRobotsVariant apijson.Field
9681055
CrawlerProtection apijson.Field
9691056
EnableJS apijson.Field
9701057
FightMode apijson.Field
@@ -1052,6 +1139,22 @@ func (r BotManagementUpdateResponseAIBotsProtection) IsKnown() bool {
10521139
return false
10531140
}
10541141

1142+
// Specifies the Robots Access Control License variant to use.
1143+
type BotManagementUpdateResponseCfRobotsVariant string
1144+
1145+
const (
1146+
BotManagementUpdateResponseCfRobotsVariantOff BotManagementUpdateResponseCfRobotsVariant = "off"
1147+
BotManagementUpdateResponseCfRobotsVariantPolicyOnly BotManagementUpdateResponseCfRobotsVariant = "policy_only"
1148+
)
1149+
1150+
func (r BotManagementUpdateResponseCfRobotsVariant) IsKnown() bool {
1151+
switch r {
1152+
case BotManagementUpdateResponseCfRobotsVariantOff, BotManagementUpdateResponseCfRobotsVariantPolicyOnly:
1153+
return true
1154+
}
1155+
return false
1156+
}
1157+
10551158
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
10561159
type BotManagementUpdateResponseCrawlerProtection string
10571160

@@ -1129,6 +1232,8 @@ type BotManagementGetResponse struct {
11291232
// Indicates that the bot management cookie can be placed on end user devices
11301233
// accessing the site. Defaults to true
11311234
BmCookieEnabled bool `json:"bm_cookie_enabled"`
1235+
// Specifies the Robots Access Control License variant to use.
1236+
CfRobotsVariant BotManagementGetResponseCfRobotsVariant `json:"cf_robots_variant"`
11321237
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
11331238
CrawlerProtection BotManagementGetResponseCrawlerProtection `json:"crawler_protection"`
11341239
// Use lightweight, invisible JavaScript detections to improve Bot Management.
@@ -1173,6 +1278,7 @@ type botManagementGetResponseJSON struct {
11731278
AIBotsProtection apijson.Field
11741279
AutoUpdateModel apijson.Field
11751280
BmCookieEnabled apijson.Field
1281+
CfRobotsVariant apijson.Field
11761282
CrawlerProtection apijson.Field
11771283
EnableJS apijson.Field
11781284
FightMode apijson.Field
@@ -1260,6 +1366,22 @@ func (r BotManagementGetResponseAIBotsProtection) IsKnown() bool {
12601366
return false
12611367
}
12621368

1369+
// Specifies the Robots Access Control License variant to use.
1370+
type BotManagementGetResponseCfRobotsVariant string
1371+
1372+
const (
1373+
BotManagementGetResponseCfRobotsVariantOff BotManagementGetResponseCfRobotsVariant = "off"
1374+
BotManagementGetResponseCfRobotsVariantPolicyOnly BotManagementGetResponseCfRobotsVariant = "policy_only"
1375+
)
1376+
1377+
func (r BotManagementGetResponseCfRobotsVariant) IsKnown() bool {
1378+
switch r {
1379+
case BotManagementGetResponseCfRobotsVariantOff, BotManagementGetResponseCfRobotsVariantPolicyOnly:
1380+
return true
1381+
}
1382+
return false
1383+
}
1384+
12631385
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
12641386
type BotManagementGetResponseCrawlerProtection string
12651387

@@ -1347,6 +1469,8 @@ type BotManagementUpdateParamsBody struct {
13471469
// Indicates that the bot management cookie can be placed on end user devices
13481470
// accessing the site. Defaults to true
13491471
BmCookieEnabled param.Field[bool] `json:"bm_cookie_enabled"`
1472+
// Specifies the Robots Access Control License variant to use.
1473+
CfRobotsVariant param.Field[BotManagementUpdateParamsBodyCfRobotsVariant] `json:"cf_robots_variant"`
13501474
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
13511475
CrawlerProtection param.Field[BotManagementUpdateParamsBodyCrawlerProtection] `json:"crawler_protection"`
13521476
// Use lightweight, invisible JavaScript detections to improve Bot Management.
@@ -1408,6 +1532,22 @@ func (r BotManagementUpdateParamsBodyAIBotsProtection) IsKnown() bool {
14081532
return false
14091533
}
14101534

1535+
// Specifies the Robots Access Control License variant to use.
1536+
type BotManagementUpdateParamsBodyCfRobotsVariant string
1537+
1538+
const (
1539+
BotManagementUpdateParamsBodyCfRobotsVariantOff BotManagementUpdateParamsBodyCfRobotsVariant = "off"
1540+
BotManagementUpdateParamsBodyCfRobotsVariantPolicyOnly BotManagementUpdateParamsBodyCfRobotsVariant = "policy_only"
1541+
)
1542+
1543+
func (r BotManagementUpdateParamsBodyCfRobotsVariant) IsKnown() bool {
1544+
switch r {
1545+
case BotManagementUpdateParamsBodyCfRobotsVariantOff, BotManagementUpdateParamsBodyCfRobotsVariantPolicyOnly:
1546+
return true
1547+
}
1548+
return false
1549+
}
1550+
14111551
// Enable rule to punish AI Scrapers and Crawlers via a link maze.
14121552
type BotManagementUpdateParamsBodyCrawlerProtection string
14131553

bot_management/botmanagement_test.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ func TestBotManagementUpdateWithOptionalParams(t *testing.T) {
3131
ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
3232
Body: bot_management.BotFightModeConfigurationParam{
3333
AIBotsProtection: cloudflare.F(bot_management.BotFightModeConfigurationAIBotsProtectionDisabled),
34+
CfRobotsVariant: cloudflare.F(bot_management.BotFightModeConfigurationCfRobotsVariantOff),
3435
CrawlerProtection: cloudflare.F(bot_management.BotFightModeConfigurationCrawlerProtectionDisabled),
3536
EnableJS: cloudflare.F(true),
3637
FightMode: cloudflare.F(true),

0 commit comments

Comments
 (0)