Skip to content

Commit 8833eee

Browse files
feat(api): api update
1 parent 41ae373 commit 8833eee

File tree

8 files changed

+60
-35
lines changed

8 files changed

+60
-35
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: 1692
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-41c469f7ea4b3f84079763aaf61517bd4c35b2c9430dbacdd2528bc47ac93cab.yml
3-
openapi_spec_hash: 580bd124dca6f0249739fed1bec99b3d
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-629af039fa4db39b2a9871f210f77e702fce60339846c8c0503f860ece636d9a.yml
3+
openapi_spec_hash: 6084baeac5ecebc75849781e4a86343d
44
config_hash: 92ed089a306b4e31a35318562d26d51a

src/resources/waiting-rooms/events/details.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ export interface DetailGetResponse {
190190

191191
export interface DetailGetParams {
192192
/**
193-
* Identifier
193+
* Identifier.
194194
*/
195195
zone_id: string;
196196
}

src/resources/waiting-rooms/events/events.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -232,7 +232,7 @@ export interface EventDeleteResponse {
232232

233233
export interface EventCreateParams {
234234
/**
235-
* Path param: Identifier
235+
* Path param: Identifier.
236236
*/
237237
zone_id: string;
238238

@@ -341,7 +341,7 @@ export interface EventCreateParams {
341341

342342
export interface EventUpdateParams {
343343
/**
344-
* Path param: Identifier
344+
* Path param: Identifier.
345345
*/
346346
zone_id: string;
347347

@@ -450,21 +450,21 @@ export interface EventUpdateParams {
450450

451451
export interface EventListParams extends V4PagePaginationArrayParams {
452452
/**
453-
* Path param: Identifier
453+
* Path param: Identifier.
454454
*/
455455
zone_id: string;
456456
}
457457

458458
export interface EventDeleteParams {
459459
/**
460-
* Identifier
460+
* Identifier.
461461
*/
462462
zone_id: string;
463463
}
464464

465465
export interface EventEditParams {
466466
/**
467-
* Path param: Identifier
467+
* Path param: Identifier.
468468
*/
469469
zone_id: string;
470470

@@ -573,7 +573,7 @@ export interface EventEditParams {
573573

574574
export interface EventGetParams {
575575
/**
576-
* Identifier
576+
* Identifier.
577577
*/
578578
zone_id: string;
579579
}

src/resources/waiting-rooms/page.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export class Page extends APIResource {
2121
* waiting room page will only be displayed if `force_queue=true` or
2222
* `event=prequeueing` — for other cases the request will pass through to the
2323
* origin. For our preview, this will be a fake origin website returning
24-
* "Welcome".
24+
* \"Welcome\".
2525
* - **reject** indicates a Reject queue.
2626
* 4. `event`: Used to preview a waiting room event.
2727
* - **none** indicates no event is occurring.
@@ -61,7 +61,7 @@ export interface PagePreviewResponse {
6161

6262
export interface PagePreviewParams {
6363
/**
64-
* Path param: Identifier
64+
* Path param: Identifier.
6565
*/
6666
zone_id: string;
6767

src/resources/waiting-rooms/rules.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ export interface WaitingRoomRule {
128128

129129
export interface RuleCreateParams {
130130
/**
131-
* Path param: Identifier
131+
* Path param: Identifier.
132132
*/
133133
zone_id: string;
134134

@@ -164,7 +164,7 @@ export namespace RuleCreateParams {
164164

165165
export interface RuleUpdateParams {
166166
/**
167-
* Path param: Identifier
167+
* Path param: Identifier.
168168
*/
169169
zone_id: string;
170170

@@ -200,14 +200,14 @@ export namespace RuleUpdateParams {
200200

201201
export interface RuleDeleteParams {
202202
/**
203-
* Identifier
203+
* Identifier.
204204
*/
205205
zone_id: string;
206206
}
207207

208208
export interface RuleEditParams {
209209
/**
210-
* Path param: Identifier
210+
* Path param: Identifier.
211211
*/
212212
zone_id: string;
213213

@@ -267,7 +267,7 @@ export namespace RuleEditParams {
267267

268268
export interface RuleGetParams {
269269
/**
270-
* Identifier
270+
* Identifier.
271271
*/
272272
zone_id: string;
273273
}

src/resources/waiting-rooms/settings.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ export interface SettingGetResponse {
8080

8181
export interface SettingUpdateParams {
8282
/**
83-
* Path param: Identifier
83+
* Path param: Identifier.
8484
*/
8585
zone_id: string;
8686

@@ -95,7 +95,7 @@ export interface SettingUpdateParams {
9595

9696
export interface SettingEditParams {
9797
/**
98-
* Path param: Identifier
98+
* Path param: Identifier.
9999
*/
100100
zone_id: string;
101101

@@ -110,7 +110,7 @@ export interface SettingEditParams {
110110

111111
export interface SettingGetParams {
112112
/**
113-
* Identifier
113+
* Identifier.
114114
*/
115115
zone_id: string;
116116
}

src/resources/waiting-rooms/statuses.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ export interface StatusGetResponse {
5454

5555
export interface StatusGetParams {
5656
/**
57-
* Identifier
57+
* Identifier.
5858
*/
5959
zone_id: string;
6060
}

src/resources/waiting-rooms/waiting-rooms.ts

Lines changed: 40 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -432,7 +432,7 @@ export interface Query {
432432
* 11. `refreshIntervalSeconds`: Integer indicating the number of seconds after
433433
* `lastUpdated` until the user is able to make another attempt to leave the
434434
* waiting room and be let into the origin website. When the `queueingMethod`
435-
* is `reject`, there is no specified refresh time — it will always be
435+
* is `reject`, there is no specified refresh time —\_it will always be
436436
* **zero**.
437437
* 12. `queueingMethod`: The queueing method currently used by the waiting room. It
438438
* is either **fifo**, **random**, **passthrough**, or **reject**.
@@ -468,6 +468,11 @@ export interface Query {
468468
* 23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean
469469
* indicating if the users in the prequeue are shuffled randomly when the event
470470
* starts.
471+
* 24. `turnstile`: Empty when turnstile isn't enabled. String displaying an html
472+
* tag to display the Turnstile widget. Please add the `{{{turnstile}}}` tag to
473+
* the `custom_html` template to ensure the Turnstile widget appears.
474+
* 25. `infiniteQueue`: Boolean indicating whether the response is for a user in
475+
* the infinite queue.
471476
*
472477
* An example cURL to a waiting room could be:
473478
*
@@ -536,7 +541,7 @@ export interface Query {
536541
* "timeUntilEventEndFormatted": "15 minutes",
537542
* "shuffleAtEventStart": true
538543
* }
539-
* }.
544+
* }
540545
*/
541546
json_response_enabled?: boolean;
542547

@@ -785,7 +790,7 @@ export interface WaitingRoom {
785790
* 11. `refreshIntervalSeconds`: Integer indicating the number of seconds after
786791
* `lastUpdated` until the user is able to make another attempt to leave the
787792
* waiting room and be let into the origin website. When the `queueingMethod`
788-
* is `reject`, there is no specified refresh time — it will always be
793+
* is `reject`, there is no specified refresh time —\_it will always be
789794
* **zero**.
790795
* 12. `queueingMethod`: The queueing method currently used by the waiting room. It
791796
* is either **fifo**, **random**, **passthrough**, or **reject**.
@@ -821,6 +826,11 @@ export interface WaitingRoom {
821826
* 23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean
822827
* indicating if the users in the prequeue are shuffled randomly when the event
823828
* starts.
829+
* 24. `turnstile`: Empty when turnstile isn't enabled. String displaying an html
830+
* tag to display the Turnstile widget. Please add the `{{{turnstile}}}` tag to
831+
* the `custom_html` template to ensure the Turnstile widget appears.
832+
* 25. `infiniteQueue`: Boolean indicating whether the response is for a user in
833+
* the infinite queue.
824834
*
825835
* An example cURL to a waiting room could be:
826836
*
@@ -889,7 +899,7 @@ export interface WaitingRoom {
889899
* "timeUntilEventEndFormatted": "15 minutes",
890900
* "shuffleAtEventStart": true
891901
* }
892-
* }.
902+
* }
893903
*/
894904
json_response_enabled?: boolean;
895905

@@ -1018,7 +1028,7 @@ export interface WaitingRoomDeleteResponse {
10181028

10191029
export interface WaitingRoomCreateParams {
10201030
/**
1021-
* Path param: Identifier
1031+
* Path param: Identifier.
10221032
*/
10231033
zone_id: string;
10241034

@@ -1206,7 +1216,7 @@ export interface WaitingRoomCreateParams {
12061216
* 11. `refreshIntervalSeconds`: Integer indicating the number of seconds after
12071217
* `lastUpdated` until the user is able to make another attempt to leave the
12081218
* waiting room and be let into the origin website. When the `queueingMethod`
1209-
* is `reject`, there is no specified refresh time — it will always be
1219+
* is `reject`, there is no specified refresh time —\_it will always be
12101220
* **zero**.
12111221
* 12. `queueingMethod`: The queueing method currently used by the waiting room. It
12121222
* is either **fifo**, **random**, **passthrough**, or **reject**.
@@ -1242,6 +1252,11 @@ export interface WaitingRoomCreateParams {
12421252
* 23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean
12431253
* indicating if the users in the prequeue are shuffled randomly when the event
12441254
* starts.
1255+
* 24. `turnstile`: Empty when turnstile isn't enabled. String displaying an html
1256+
* tag to display the Turnstile widget. Please add the `{{{turnstile}}}` tag to
1257+
* the `custom_html` template to ensure the Turnstile widget appears.
1258+
* 25. `infiniteQueue`: Boolean indicating whether the response is for a user in
1259+
* the infinite queue.
12451260
*
12461261
* An example cURL to a waiting room could be:
12471262
*
@@ -1310,7 +1325,7 @@ export interface WaitingRoomCreateParams {
13101325
* "timeUntilEventEndFormatted": "15 minutes",
13111326
* "shuffleAtEventStart": true
13121327
* }
1313-
* }.
1328+
* }
13141329
*/
13151330
json_response_enabled?: boolean;
13161331

@@ -1399,7 +1414,7 @@ export interface WaitingRoomCreateParams {
13991414

14001415
export interface WaitingRoomUpdateParams {
14011416
/**
1402-
* Path param: Identifier
1417+
* Path param: Identifier.
14031418
*/
14041419
zone_id: string;
14051420

@@ -1587,7 +1602,7 @@ export interface WaitingRoomUpdateParams {
15871602
* 11. `refreshIntervalSeconds`: Integer indicating the number of seconds after
15881603
* `lastUpdated` until the user is able to make another attempt to leave the
15891604
* waiting room and be let into the origin website. When the `queueingMethod`
1590-
* is `reject`, there is no specified refresh time — it will always be
1605+
* is `reject`, there is no specified refresh time —\_it will always be
15911606
* **zero**.
15921607
* 12. `queueingMethod`: The queueing method currently used by the waiting room. It
15931608
* is either **fifo**, **random**, **passthrough**, or **reject**.
@@ -1623,6 +1638,11 @@ export interface WaitingRoomUpdateParams {
16231638
* 23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean
16241639
* indicating if the users in the prequeue are shuffled randomly when the event
16251640
* starts.
1641+
* 24. `turnstile`: Empty when turnstile isn't enabled. String displaying an html
1642+
* tag to display the Turnstile widget. Please add the `{{{turnstile}}}` tag to
1643+
* the `custom_html` template to ensure the Turnstile widget appears.
1644+
* 25. `infiniteQueue`: Boolean indicating whether the response is for a user in
1645+
* the infinite queue.
16261646
*
16271647
* An example cURL to a waiting room could be:
16281648
*
@@ -1691,7 +1711,7 @@ export interface WaitingRoomUpdateParams {
16911711
* "timeUntilEventEndFormatted": "15 minutes",
16921712
* "shuffleAtEventStart": true
16931713
* }
1694-
* }.
1714+
* }
16951715
*/
16961716
json_response_enabled?: boolean;
16971717

@@ -1794,14 +1814,14 @@ export interface WaitingRoomListParams extends V4PagePaginationArrayParams {
17941814

17951815
export interface WaitingRoomDeleteParams {
17961816
/**
1797-
* Identifier
1817+
* Identifier.
17981818
*/
17991819
zone_id: string;
18001820
}
18011821

18021822
export interface WaitingRoomEditParams {
18031823
/**
1804-
* Path param: Identifier
1824+
* Path param: Identifier.
18051825
*/
18061826
zone_id: string;
18071827

@@ -1989,7 +2009,7 @@ export interface WaitingRoomEditParams {
19892009
* 11. `refreshIntervalSeconds`: Integer indicating the number of seconds after
19902010
* `lastUpdated` until the user is able to make another attempt to leave the
19912011
* waiting room and be let into the origin website. When the `queueingMethod`
1992-
* is `reject`, there is no specified refresh time — it will always be
2012+
* is `reject`, there is no specified refresh time —\_it will always be
19932013
* **zero**.
19942014
* 12. `queueingMethod`: The queueing method currently used by the waiting room. It
19952015
* is either **fifo**, **random**, **passthrough**, or **reject**.
@@ -2025,6 +2045,11 @@ export interface WaitingRoomEditParams {
20252045
* 23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean
20262046
* indicating if the users in the prequeue are shuffled randomly when the event
20272047
* starts.
2048+
* 24. `turnstile`: Empty when turnstile isn't enabled. String displaying an html
2049+
* tag to display the Turnstile widget. Please add the `{{{turnstile}}}` tag to
2050+
* the `custom_html` template to ensure the Turnstile widget appears.
2051+
* 25. `infiniteQueue`: Boolean indicating whether the response is for a user in
2052+
* the infinite queue.
20282053
*
20292054
* An example cURL to a waiting room could be:
20302055
*
@@ -2093,7 +2118,7 @@ export interface WaitingRoomEditParams {
20932118
* "timeUntilEventEndFormatted": "15 minutes",
20942119
* "shuffleAtEventStart": true
20952120
* }
2096-
* }.
2121+
* }
20972122
*/
20982123
json_response_enabled?: boolean;
20992124

@@ -2182,7 +2207,7 @@ export interface WaitingRoomEditParams {
21822207

21832208
export interface WaitingRoomGetParams {
21842209
/**
2185-
* Identifier
2210+
* Identifier.
21862211
*/
21872212
zone_id: string;
21882213
}

0 commit comments

Comments
 (0)