Skip to content

Commit be02a41

Browse files
chore(api): update composite API spec
1 parent 1f4de90 commit be02a41

File tree

7 files changed

+152
-64
lines changed

7 files changed

+152
-64
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: 2163
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-7675b265d629354e193126ffad8e93efb804186cd581c0d45059547a015b7151.yml
3-
openapi_spec_hash: 12d024b8abf3333c2326cf51a933ba39
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/cloudflare%2Fcloudflare-84d0d84326a7be69e6cd320f5e0c6b7e7ec559809c66195ec4326020091c47e7.yml
3+
openapi_spec_hash: 6e6c10f0ac9c9272670f1cb025e8523c
44
config_hash: aebbf0fc2e33e6126d43d201bfa58e25

api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2885,9 +2885,9 @@ from cloudflare.types.queues import (
28852885
Methods:
28862886

28872887
- <code title="post /accounts/{account_id}/queues/{queue_id}/messages/ack">client.queues.messages.<a href="./src/cloudflare/resources/queues/messages.py">ack</a>(queue_id, \*, account_id, \*\*<a href="src/cloudflare/types/queues/message_ack_params.py">params</a>) -> <a href="./src/cloudflare/types/queues/message_ack_response.py">Optional[MessageAckResponse]</a></code>
2888-
- <code title="post /accounts/{account_id}/queues/{queue_id}/messages/batch">client.queues.messages.<a href="./src/cloudflare/resources/queues/messages.py">bulk_push</a>(queue_id, \*, account_id, \*\*<a href="src/cloudflare/types/queues/message_bulk_push_params.py">params</a>) -> <a href="./src/cloudflare/types/queues/message_bulk_push_response.py">MessageBulkPushResponse</a></code>
2888+
- <code title="post /accounts/{account_id}/queues/{queue_id}/messages/batch">client.queues.messages.<a href="./src/cloudflare/resources/queues/messages.py">bulk_push</a>(queue_id, \*, account_id, \*\*<a href="src/cloudflare/types/queues/message_bulk_push_params.py">params</a>) -> <a href="./src/cloudflare/types/queues/message_bulk_push_response.py">Optional[MessageBulkPushResponse]</a></code>
28892889
- <code title="post /accounts/{account_id}/queues/{queue_id}/messages/pull">client.queues.messages.<a href="./src/cloudflare/resources/queues/messages.py">pull</a>(queue_id, \*, account_id, \*\*<a href="src/cloudflare/types/queues/message_pull_params.py">params</a>) -> <a href="./src/cloudflare/types/queues/message_pull_response.py">Optional[MessagePullResponse]</a></code>
2890-
- <code title="post /accounts/{account_id}/queues/{queue_id}/messages">client.queues.messages.<a href="./src/cloudflare/resources/queues/messages.py">push</a>(queue_id, \*, account_id, \*\*<a href="src/cloudflare/types/queues/message_push_params.py">params</a>) -> <a href="./src/cloudflare/types/queues/message_push_response.py">MessagePushResponse</a></code>
2890+
- <code title="post /accounts/{account_id}/queues/{queue_id}/messages">client.queues.messages.<a href="./src/cloudflare/resources/queues/messages.py">push</a>(queue_id, \*, account_id, \*\*<a href="src/cloudflare/types/queues/message_push_params.py">params</a>) -> <a href="./src/cloudflare/types/queues/message_push_response.py">Optional[MessagePushResponse]</a></code>
28912891

28922892
## Purge
28932893

src/cloudflare/resources/queues/messages.py

Lines changed: 32 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ def bulk_push(
116116
extra_query: Query | None = None,
117117
extra_body: Body | None = None,
118118
timeout: float | httpx.Timeout | None | NotGiven = not_given,
119-
) -> MessageBulkPushResponse:
119+
) -> Optional[MessageBulkPushResponse]:
120120
"""
121121
Push a batch of message to a Queue
122122
@@ -151,9 +151,13 @@ def bulk_push(
151151
message_bulk_push_params.MessageBulkPushParams,
152152
),
153153
options=make_request_options(
154-
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
154+
extra_headers=extra_headers,
155+
extra_query=extra_query,
156+
extra_body=extra_body,
157+
timeout=timeout,
158+
post_parser=ResultWrapper[Optional[MessageBulkPushResponse]]._unwrapper,
155159
),
156-
cast_to=MessageBulkPushResponse,
160+
cast_to=cast(Type[Optional[MessageBulkPushResponse]], ResultWrapper[MessageBulkPushResponse]),
157161
)
158162

159163
def pull(
@@ -231,7 +235,7 @@ def push(
231235
extra_query: Query | None = None,
232236
extra_body: Body | None = None,
233237
timeout: float | httpx.Timeout | None | NotGiven = not_given,
234-
) -> MessagePushResponse:
238+
) -> Optional[MessagePushResponse]:
235239
"""
236240
Push a message to a Queue
237241
@@ -268,7 +272,7 @@ def push(
268272
extra_query: Query | None = None,
269273
extra_body: Body | None = None,
270274
timeout: float | httpx.Timeout | None | NotGiven = not_given,
271-
) -> MessagePushResponse:
275+
) -> Optional[MessagePushResponse]:
272276
"""
273277
Push a message to a Queue
274278
@@ -304,7 +308,7 @@ def push(
304308
extra_query: Query | None = None,
305309
extra_body: Body | None = None,
306310
timeout: float | httpx.Timeout | None | NotGiven = not_given,
307-
) -> MessagePushResponse:
311+
) -> Optional[MessagePushResponse]:
308312
if account_id is None:
309313
account_id = self._client._get_account_id_path_param()
310314
if not account_id:
@@ -322,9 +326,13 @@ def push(
322326
message_push_params.MessagePushParams,
323327
),
324328
options=make_request_options(
325-
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
329+
extra_headers=extra_headers,
330+
extra_query=extra_query,
331+
extra_body=extra_body,
332+
timeout=timeout,
333+
post_parser=ResultWrapper[Optional[MessagePushResponse]]._unwrapper,
326334
),
327-
cast_to=MessagePushResponse,
335+
cast_to=cast(Type[Optional[MessagePushResponse]], ResultWrapper[MessagePushResponse]),
328336
)
329337

330338

@@ -416,7 +424,7 @@ async def bulk_push(
416424
extra_query: Query | None = None,
417425
extra_body: Body | None = None,
418426
timeout: float | httpx.Timeout | None | NotGiven = not_given,
419-
) -> MessageBulkPushResponse:
427+
) -> Optional[MessageBulkPushResponse]:
420428
"""
421429
Push a batch of message to a Queue
422430
@@ -451,9 +459,13 @@ async def bulk_push(
451459
message_bulk_push_params.MessageBulkPushParams,
452460
),
453461
options=make_request_options(
454-
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
462+
extra_headers=extra_headers,
463+
extra_query=extra_query,
464+
extra_body=extra_body,
465+
timeout=timeout,
466+
post_parser=ResultWrapper[Optional[MessageBulkPushResponse]]._unwrapper,
455467
),
456-
cast_to=MessageBulkPushResponse,
468+
cast_to=cast(Type[Optional[MessageBulkPushResponse]], ResultWrapper[MessageBulkPushResponse]),
457469
)
458470

459471
async def pull(
@@ -531,7 +543,7 @@ async def push(
531543
extra_query: Query | None = None,
532544
extra_body: Body | None = None,
533545
timeout: float | httpx.Timeout | None | NotGiven = not_given,
534-
) -> MessagePushResponse:
546+
) -> Optional[MessagePushResponse]:
535547
"""
536548
Push a message to a Queue
537549
@@ -568,7 +580,7 @@ async def push(
568580
extra_query: Query | None = None,
569581
extra_body: Body | None = None,
570582
timeout: float | httpx.Timeout | None | NotGiven = not_given,
571-
) -> MessagePushResponse:
583+
) -> Optional[MessagePushResponse]:
572584
"""
573585
Push a message to a Queue
574586
@@ -604,7 +616,7 @@ async def push(
604616
extra_query: Query | None = None,
605617
extra_body: Body | None = None,
606618
timeout: float | httpx.Timeout | None | NotGiven = not_given,
607-
) -> MessagePushResponse:
619+
) -> Optional[MessagePushResponse]:
608620
if account_id is None:
609621
account_id = self._client._get_account_id_path_param()
610622
if not account_id:
@@ -622,9 +634,13 @@ async def push(
622634
message_push_params.MessagePushParams,
623635
),
624636
options=make_request_options(
625-
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
637+
extra_headers=extra_headers,
638+
extra_query=extra_query,
639+
extra_body=extra_body,
640+
timeout=timeout,
641+
post_parser=ResultWrapper[Optional[MessagePushResponse]]._unwrapper,
626642
),
627-
cast_to=MessagePushResponse,
643+
cast_to=cast(Type[Optional[MessagePushResponse]], ResultWrapper[MessagePushResponse]),
628644
)
629645

630646

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,39 @@
11
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

3-
from typing import List, Optional
4-
from typing_extensions import Literal
3+
from typing import Optional
54

65
from ..._models import BaseModel
7-
from ..shared.response_info import ResponseInfo
86

9-
__all__ = ["MessageBulkPushResponse"]
7+
__all__ = ["MessageBulkPushResponse", "Metadata", "MetadataMetrics"]
108

119

12-
class MessageBulkPushResponse(BaseModel):
13-
errors: Optional[List[ResponseInfo]] = None
10+
class MetadataMetrics(BaseModel):
11+
"""Best-effort metrics for the queue.
12+
13+
Values may be approximate due to the distributed nature of queues.
14+
"""
15+
16+
backlog_bytes: float
17+
"""The size in bytes of unacknowledged messages in the queue."""
18+
19+
backlog_count: float
20+
"""The number of unacknowledged messages in the queue."""
21+
22+
oldest_message_timestamp_ms: float
23+
"""Unix timestamp in milliseconds of the oldest unacknowledged message in the
24+
queue.
1425
15-
messages: Optional[List[str]] = None
26+
Returns 0 if unknown.
27+
"""
1628

17-
success: Optional[Literal[True]] = None
18-
"""Indicates if the API call was successful or not."""
29+
30+
class Metadata(BaseModel):
31+
metrics: Optional[MetadataMetrics] = None
32+
"""Best-effort metrics for the queue.
33+
34+
Values may be approximate due to the distributed nature of queues.
35+
"""
36+
37+
38+
class MessageBulkPushResponse(BaseModel):
39+
metadata: Optional[Metadata] = None

src/cloudflare/types/queues/message_pull_response.py

Lines changed: 32 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
from ..._models import BaseModel
66

7-
__all__ = ["MessagePullResponse", "Message"]
7+
__all__ = ["MessagePullResponse", "Message", "Metadata", "MetadataMetrics"]
88

99

1010
class Message(BaseModel):
@@ -25,8 +25,38 @@ class Message(BaseModel):
2525
timestamp_ms: Optional[float] = None
2626

2727

28+
class MetadataMetrics(BaseModel):
29+
"""Best-effort metrics for the queue.
30+
31+
Values may be approximate due to the distributed nature of queues.
32+
"""
33+
34+
backlog_bytes: float
35+
"""The size in bytes of unacknowledged messages in the queue."""
36+
37+
backlog_count: float
38+
"""The number of unacknowledged messages in the queue."""
39+
40+
oldest_message_timestamp_ms: float
41+
"""Unix timestamp in milliseconds of the oldest unacknowledged message in the
42+
queue.
43+
44+
Returns 0 if unknown.
45+
"""
46+
47+
48+
class Metadata(BaseModel):
49+
metrics: Optional[MetadataMetrics] = None
50+
"""Best-effort metrics for the queue.
51+
52+
Values may be approximate due to the distributed nature of queues.
53+
"""
54+
55+
2856
class MessagePullResponse(BaseModel):
2957
message_backlog_count: Optional[float] = None
30-
"""The number of unacknowledged messages in the queue"""
58+
"""The number of unacknowledged messages in the queue."""
3159

3260
messages: Optional[List[Message]] = None
61+
62+
metadata: Optional[Metadata] = None
Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,39 @@
11
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
22

3-
from typing import List, Optional
4-
from typing_extensions import Literal
3+
from typing import Optional
54

65
from ..._models import BaseModel
7-
from ..shared.response_info import ResponseInfo
86

9-
__all__ = ["MessagePushResponse"]
7+
__all__ = ["MessagePushResponse", "Metadata", "MetadataMetrics"]
108

119

12-
class MessagePushResponse(BaseModel):
13-
errors: Optional[List[ResponseInfo]] = None
10+
class MetadataMetrics(BaseModel):
11+
"""Best-effort metrics for the queue.
12+
13+
Values may be approximate due to the distributed nature of queues.
14+
"""
15+
16+
backlog_bytes: float
17+
"""The size in bytes of unacknowledged messages in the queue."""
18+
19+
backlog_count: float
20+
"""The number of unacknowledged messages in the queue."""
21+
22+
oldest_message_timestamp_ms: float
23+
"""Unix timestamp in milliseconds of the oldest unacknowledged message in the
24+
queue.
1425
15-
messages: Optional[List[str]] = None
26+
Returns 0 if unknown.
27+
"""
1628

17-
success: Optional[Literal[True]] = None
18-
"""Indicates if the API call was successful or not."""
29+
30+
class Metadata(BaseModel):
31+
metrics: Optional[MetadataMetrics] = None
32+
"""Best-effort metrics for the queue.
33+
34+
Values may be approximate due to the distributed nature of queues.
35+
"""
36+
37+
38+
class MessagePushResponse(BaseModel):
39+
metadata: Optional[Metadata] = None

0 commit comments

Comments
 (0)