FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

feat(billing): update codegen output · cloudflare/cloudflare-python@7e3d4f7 · GitHub

/ cloudflare-python Public

Commit 7e3d4f7

Browse files
rotem-cloud
committed
feat(billing): update codegen output
1 parent 1ed70ec commit 7e3d4f7

8 files changed

Lines changed: 492 additions & 18 deletions

File tree

‎src/cloudflare/resources/billing/api.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@ Methods:
1717
Types:
1818

1919
```python
20-
from cloudflare.types.billing import UsagePaygoResponse
20+
from cloudflare.types.billing import UsageGetResponse, UsagePaygoResponse
2121
```
2222

2323
Methods:
2424

25-
- <code title="get /accounts/{account_id}/billing/usage/paygo">client.billing.usage.<a href="./src/cloudflare/resources/billing/usage.py">paygo</a>(\*, account_id, \*\*<a href="src/cloudflare/types/billing/usage_paygo_params.py">params</a>) -> <a href="./src/cloudflare/types/billing/usage_paygo_response.py">UsagePaygoResponse</a></code>
25+
- <code title="get /accounts/{account_id}/billable/usage">client.billing.usage.<a href="./src/cloudflare/resources/billing/usage.py">get</a>(\*, account_id, \*\*<a href="src/cloudflare/types/billing/usage_get_params.py">params</a>) -> <a href="./src/cloudflare/types/billing/usage_get_response.py">UsageGetResponse</a></code>
26+
- <code title="get /accounts/{account_id}/paygo-usage">client.billing.usage.<a href="./src/cloudflare/resources/billing/usage.py">paygo</a>(\*, account_id, \*\*<a href="src/cloudflare/types/billing/usage_paygo_params.py">params</a>) -> <a href="./src/cloudflare/types/billing/usage_paygo_response.py">UsagePaygoResponse</a></code>

‎src/cloudflare/resources/billing/usage.py‎

Lines changed: 166 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,8 @@
1919
)
2020
from ..._wrappers import ResultWrapper
2121
from ..._base_client import make_request_options
22-
from ...types.billing import usage_paygo_params
22+
from ...types.billing import usage_get_params, usage_paygo_params
23+
from ...types.billing.usage_get_response import UsageGetResponse
2324
from ...types.billing.usage_paygo_response import UsagePaygoResponse
2425

2526
__all__ = ["UsageResource", "AsyncUsageResource"]
@@ -45,6 +46,79 @@ def with_streaming_response(self) -> UsageResourceWithStreamingResponse:
4546
"""
4647
return UsageResourceWithStreamingResponse(self)
4748

49+
def get(
50+
self,
51+
*,
52+
account_id: str,
53+
from_: Union[str, date] | Omit = omit,
54+
metric: str | Omit = omit,
55+
to: Union[str, date] | Omit = omit,
56+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
57+
# The extra values given here take precedence over values defined on the client or passed to this method.
58+
extra_headers: Headers | None = None,
59+
extra_query: Query | None = None,
60+
extra_body: Body | None = None,
61+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
62+
) -> UsageGetResponse:
63+
"""
64+
Returns cost and usage data for a single Cloudflare account, aligned with the
65+
[FinOps FOCUS v1.3](https://focus.finops.org/focus-specification/v1-3/) Cost and
66+
Usage dataset specification.
67+
68+
Each record represents one billable metric for one account on one day. This
69+
includes all metered usage, including usage that falls within free-tier
70+
allowances and may result in zero cost.
71+
72+
**Note:** Cost and pricing fields are not yet populated and will be absent from
73+
responses until billing integration is complete.
74+
75+
When `from` and `to` are omitted, defaults to the start of the current month
76+
through today. The maximum date range is 31 days.
77+
78+
Args:
79+
account_id: Represents a Cloudflare resource identifier tag.
80+
81+
from_: Start date for the usage query (ISO 8601). Required if `to` is set. When omitted
82+
along with `to`, defaults to the start of the current month. Filters by charge
83+
period (when consumption happened), not billing period. The maximum date range
84+
is 31 days.
85+
86+
metric: Filter results by billable metric id (e.g., workers_standard_requests).
87+
88+
to: End date for the usage query (ISO 8601). Required if `from` is set. When omitted
89+
along with `from`, defaults to today. Filters by charge period (when consumption
90+
happened), not billing period. The maximum date range is 31 days.
91+
92+
extra_headers: Send extra headers
93+
94+
extra_query: Add additional query parameters to the request
95+
96+
extra_body: Add additional JSON properties to the request
97+
98+
timeout: Override the client-level default timeout for this request, in seconds
99+
"""
100+
if not account_id:
101+
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
102+
return self._get(
103+
path_template("/accounts/{account_id}/billable/usage", account_id=account_id),
104+
options=make_request_options(
105+
extra_headers=extra_headers,
106+
extra_query=extra_query,
107+
extra_body=extra_body,
108+
timeout=timeout,
109+
query=maybe_transform(
110+
{
111+
"from_": from_,
112+
"metric": metric,
113+
"to": to,
114+
},
115+
usage_get_params.UsageGetParams,
116+
),
117+
post_parser=ResultWrapper[UsageGetResponse]._unwrapper,
118+
),
119+
cast_to=cast(Type[UsageGetResponse], ResultWrapper[UsageGetResponse]),
120+
)
121+
48122
def paygo(
49123
self,
50124
*,
@@ -68,9 +142,9 @@ def paygo(
68142
Args:
69143
account_id: Represents a Cloudflare resource identifier tag.
70144
71-
from_: Defines the start date for the usage query (e.g., 2025-02-01).
145+
from_: Start date for the usage query (ISO 8601).
72146
73-
to: Defines the end date for the usage query (e.g., 2025-03-01).
147+
to: End date for the usage query (ISO 8601).
74148
75149
extra_headers: Send extra headers
76150
@@ -83,7 +157,7 @@ def paygo(
83157
if not account_id:
84158
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
85159
return self._get(
86-
path_template("/accounts/{account_id}/billing/usage/paygo", account_id=account_id),
160+
path_template("/accounts/{account_id}/paygo-usage", account_id=account_id),
87161
options=make_request_options(
88162
extra_headers=extra_headers,
89163
extra_query=extra_query,
@@ -122,6 +196,79 @@ def with_streaming_response(self) -> AsyncUsageResourceWithStreamingResponse:
122196
"""
123197
return AsyncUsageResourceWithStreamingResponse(self)
124198

199+
async def get(
200+
self,
201+
*,
202+
account_id: str,
203+
from_: Union[str, date] | Omit = omit,
204+
metric: str | Omit = omit,
205+
to: Union[str, date] | Omit = omit,
206+
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
207+
# The extra values given here take precedence over values defined on the client or passed to this method.
208+
extra_headers: Headers | None = None,
209+
extra_query: Query | None = None,
210+
extra_body: Body | None = None,
211+
timeout: float | httpx.Timeout | None | NotGiven = not_given,
212+
) -> UsageGetResponse:
213+
"""
214+
Returns cost and usage data for a single Cloudflare account, aligned with the
215+
[FinOps FOCUS v1.3](https://focus.finops.org/focus-specification/v1-3/) Cost and
216+
Usage dataset specification.
217+
218+
Each record represents one billable metric for one account on one day. This
219+
includes all metered usage, including usage that falls within free-tier
220+
allowances and may result in zero cost.
221+
222+
**Note:** Cost and pricing fields are not yet populated and will be absent from
223+
responses until billing integration is complete.
224+
225+
When `from` and `to` are omitted, defaults to the start of the current month
226+
through today. The maximum date range is 31 days.
227+
228+
Args:
229+
account_id: Represents a Cloudflare resource identifier tag.
230+
231+
from_: Start date for the usage query (ISO 8601). Required if `to` is set. When omitted
232+
along with `to`, defaults to the start of the current month. Filters by charge
233+
period (when consumption happened), not billing period. The maximum date range
234+
is 31 days.
235+
236+
metric: Filter results by billable metric id (e.g., workers_standard_requests).
237+
238+
to: End date for the usage query (ISO 8601). Required if `from` is set. When omitted
239+
along with `from`, defaults to today. Filters by charge period (when consumption
240+
happened), not billing period. The maximum date range is 31 days.
241+
242+
extra_headers: Send extra headers
243+
244+
extra_query: Add additional query parameters to the request
245+
246+
extra_body: Add additional JSON properties to the request
247+
248+
timeout: Override the client-level default timeout for this request, in seconds
249+
"""
250+
if not account_id:
251+
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
252+
return await self._get(
253+
path_template("/accounts/{account_id}/billable/usage", account_id=account_id),
254+
options=make_request_options(
255+
extra_headers=extra_headers,
256+
extra_query=extra_query,
257+
extra_body=extra_body,
258+
timeout=timeout,
259+
query=await async_maybe_transform(
260+
{
261+
"from_": from_,
262+
"metric": metric,
263+
"to": to,
264+
},
265+
usage_get_params.UsageGetParams,
266+
),
267+
post_parser=ResultWrapper[UsageGetResponse]._unwrapper,
268+
),
269+
cast_to=cast(Type[UsageGetResponse], ResultWrapper[UsageGetResponse]),
270+
)
271+
125272
async def paygo(
126273
self,
127274
*,
@@ -145,9 +292,9 @@ async def paygo(
145292
Args:
146293
account_id: Represents a Cloudflare resource identifier tag.
147294
148-
from_: Defines the start date for the usage query (e.g., 2025-02-01).
295+
from_: Start date for the usage query (ISO 8601).
149296
150-
to: Defines the end date for the usage query (e.g., 2025-03-01).
297+
to: End date for the usage query (ISO 8601).
151298
152299
extra_headers: Send extra headers
153300
@@ -160,7 +307,7 @@ async def paygo(
160307
if not account_id:
161308
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
162309
return await self._get(
163-
path_template("/accounts/{account_id}/billing/usage/paygo", account_id=account_id),
310+
path_template("/accounts/{account_id}/paygo-usage", account_id=account_id),
164311
options=make_request_options(
165312
extra_headers=extra_headers,
166313
extra_query=extra_query,
@@ -183,6 +330,9 @@ class UsageResourceWithRawResponse:
183330
def __init__(self, usage: UsageResource) -> None:
184331
self._usage = usage
185332

333+
self.get = to_raw_response_wrapper(
334+
usage.get,
335+
)
186336
self.paygo = to_raw_response_wrapper(
187337
usage.paygo,
188338
)
@@ -192,6 +342,9 @@ class AsyncUsageResourceWithRawResponse:
192342
def __init__(self, usage: AsyncUsageResource) -> None:
193343
self._usage = usage
194344

345+
self.get = async_to_raw_response_wrapper(
346+
usage.get,
347+
)
195348
self.paygo = async_to_raw_response_wrapper(
196349
usage.paygo,
197350
)
@@ -201,6 +354,9 @@ class UsageResourceWithStreamingResponse:
201354
def __init__(self, usage: UsageResource) -> None:
202355
self._usage = usage
203356

357+
self.get = to_streamed_response_wrapper(
358+
usage.get,
359+
)
204360
self.paygo = to_streamed_response_wrapper(
205361
usage.paygo,
206362
)
@@ -210,6 +366,9 @@ class AsyncUsageResourceWithStreamingResponse:
210366
def __init__(self, usage: AsyncUsageResource) -> None:
211367
self._usage = usage
212368

369+
self.get = async_to_streamed_response_wrapper(
370+
usage.get,
371+
)
213372
self.paygo = async_to_streamed_response_wrapper(
214373
usage.paygo,
215374
)

‎src/cloudflare/types/billing/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
from __future__ import annotations
44

5+
from .usage_get_params import UsageGetParams as UsageGetParams
6+
from .usage_get_response import UsageGetResponse as UsageGetResponse
57
from .usage_paygo_params import UsagePaygoParams as UsagePaygoParams
68
from .profile_get_response import ProfileGetResponse as ProfileGetResponse
79
from .usage_paygo_response import UsagePaygoResponse as UsagePaygoResponse

‎src/cloudflare/types/billing/usage_get_params.py‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2+
3+
from __future__ import annotations
4+
5+
from typing import Union
6+
from datetime import date
7+
from typing_extensions import Required, Annotated, TypedDict
8+
9+
from ..._utils import PropertyInfo
10+
11+
__all__ = ["UsageGetParams"]
12+
13+
14+
class UsageGetParams(TypedDict, total=False):
15+
account_id: Required[str]
16+
"""Represents a Cloudflare resource identifier tag."""
17+
18+
from_: Annotated[Union[str, date], PropertyInfo(alias="from", format="iso8601")]
19+
"""Start date for the usage query (ISO 8601).
20+
21+
Required if `to` is set. When omitted along with `to`, defaults to the start of
22+
the current month. Filters by charge period (when consumption happened), not
23+
billing period. The maximum date range is 31 days.
24+
"""
25+
26+
metric: str
27+
"""Filter results by billable metric id (e.g., workers_standard_requests)."""
28+
29+
to: Annotated[Union[str, date], PropertyInfo(format="iso8601")]
30+
"""End date for the usage query (ISO 8601).
31+
32+
Required if `from` is set. When omitted along with `from`, defaults to today.
33+
Filters by charge period (when consumption happened), not billing period. The
34+
maximum date range is 31 days.
35+
"""

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL