|
| 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 | + |
| 8 | +import httpx |
| 9 | + |
| 10 | +from ..._types import Body, Query, Headers, NotGiven, not_given |
| 11 | +from ..._utils import maybe_transform, async_maybe_transform |
| 12 | +from ..._compat import cached_property |
| 13 | +from ..._resource import SyncAPIResource, AsyncAPIResource |
| 14 | +from ..._response import ( |
| 15 | + to_raw_response_wrapper, |
| 16 | + to_streamed_response_wrapper, |
| 17 | + async_to_raw_response_wrapper, |
| 18 | + async_to_streamed_response_wrapper, |
| 19 | +) |
| 20 | +from ..._base_client import make_request_options |
| 21 | +from ...types.accounts import usage_analytics_get_params |
| 22 | +from ...types.accounts.usage_analytics_response import UsageAnalyticsResponse |
| 23 | + |
| 24 | +__all__ = ["UsageAnalyticsResource", "AsyncUsageAnalyticsResource"] |
| 25 | + |
| 26 | + |
| 27 | +class UsageAnalyticsResource(SyncAPIResource): |
| 28 | + @cached_property |
| 29 | + def with_raw_response(self) -> UsageAnalyticsResourceWithRawResponse: |
| 30 | + """ |
| 31 | + This property can be used as a prefix for any HTTP method call to return |
| 32 | + the raw response object instead of the parsed content. |
| 33 | +
|
| 34 | + For more information, see https://www.github.com/imagekit-developer/imagekit-python#accessing-raw-response-data-eg-headers |
| 35 | + """ |
| 36 | + return UsageAnalyticsResourceWithRawResponse(self) |
| 37 | + |
| 38 | + @cached_property |
| 39 | + def with_streaming_response(self) -> UsageAnalyticsResourceWithStreamingResponse: |
| 40 | + """ |
| 41 | + An alternative to `.with_raw_response` that doesn't eagerly read the response body. |
| 42 | +
|
| 43 | + For more information, see https://www.github.com/imagekit-developer/imagekit-python#with_streaming_response |
| 44 | + """ |
| 45 | + return UsageAnalyticsResourceWithStreamingResponse(self) |
| 46 | + |
| 47 | + def get( |
| 48 | + self, |
| 49 | + *, |
| 50 | + end_date: Union[str, date], |
| 51 | + start_date: Union[str, date], |
| 52 | + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. |
| 53 | + # The extra values given here take precedence over values defined on the client or passed to this method. |
| 54 | + extra_headers: Headers | None = None, |
| 55 | + extra_query: Query | None = None, |
| 56 | + extra_body: Body | None = None, |
| 57 | + timeout: float | httpx.Timeout | None | NotGiven = not_given, |
| 58 | + ) -> UsageAnalyticsResponse: |
| 59 | + """ |
| 60 | + **Note:** This API is currently in beta. |
| 61 | +
|
| 62 | + Get the account analytics data between two dates. The response covers the period |
| 63 | + from the start date to the end date, both dates inclusive. Both dates are |
| 64 | + interpreted as UTC calendar days. |
| 65 | +
|
| 66 | + The returned data is scoped to the requesting account only. Unlike |
| 67 | + `/v1/accounts/usage`, an agency account's analytics are not aggregated across |
| 68 | + its child accounts. |
| 69 | +
|
| 70 | + The response is cached for 5 minutes per account and date range. Use |
| 71 | + `generatedAt` to check how fresh the returned data is. |
| 72 | +
|
| 73 | + Args: |
| 74 | + end_date: Specify an `endDate` in `YYYY-MM-DD` format, interpreted as a UTC calendar day. |
| 75 | + It should be after the `startDate`. The difference between `startDate` and |
| 76 | + `endDate` should be less than 90 days. |
| 77 | +
|
| 78 | + start_date: Specify a `startDate` in `YYYY-MM-DD` format, interpreted as a UTC calendar day. |
| 79 | + It should be before the `endDate`. The difference between `startDate` and |
| 80 | + `endDate` should be less than 90 days. |
| 81 | +
|
| 82 | + extra_headers: Send extra headers |
| 83 | +
|
| 84 | + extra_query: Add additional query parameters to the request |
| 85 | +
|
| 86 | + extra_body: Add additional JSON properties to the request |
| 87 | +
|
| 88 | + timeout: Override the client-level default timeout for this request, in seconds |
| 89 | + """ |
| 90 | + return self._get( |
| 91 | + "/v1/accounts/usage-analytics", |
| 92 | + options=make_request_options( |
| 93 | + extra_headers=extra_headers, |
| 94 | + extra_query=extra_query, |
| 95 | + extra_body=extra_body, |
| 96 | + timeout=timeout, |
| 97 | + query=maybe_transform( |
| 98 | + { |
| 99 | + "end_date": end_date, |
| 100 | + "start_date": start_date, |
| 101 | + }, |
| 102 | + usage_analytics_get_params.UsageAnalyticsGetParams, |
| 103 | + ), |
| 104 | + ), |
| 105 | + cast_to=UsageAnalyticsResponse, |
| 106 | + ) |
| 107 | + |
| 108 | + |
| 109 | +class AsyncUsageAnalyticsResource(AsyncAPIResource): |
| 110 | + @cached_property |
| 111 | + def with_raw_response(self) -> AsyncUsageAnalyticsResourceWithRawResponse: |
| 112 | + """ |
| 113 | + This property can be used as a prefix for any HTTP method call to return |
| 114 | + the raw response object instead of the parsed content. |
| 115 | +
|
| 116 | + For more information, see https://www.github.com/imagekit-developer/imagekit-python#accessing-raw-response-data-eg-headers |
| 117 | + """ |
| 118 | + return AsyncUsageAnalyticsResourceWithRawResponse(self) |
| 119 | + |
| 120 | + @cached_property |
| 121 | + def with_streaming_response(self) -> AsyncUsageAnalyticsResourceWithStreamingResponse: |
| 122 | + """ |
| 123 | + An alternative to `.with_raw_response` that doesn't eagerly read the response body. |
| 124 | +
|
| 125 | + For more information, see https://www.github.com/imagekit-developer/imagekit-python#with_streaming_response |
| 126 | + """ |
| 127 | + return AsyncUsageAnalyticsResourceWithStreamingResponse(self) |
| 128 | + |
| 129 | + async def get( |
| 130 | + self, |
| 131 | + *, |
| 132 | + end_date: Union[str, date], |
| 133 | + start_date: Union[str, date], |
| 134 | + # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. |
| 135 | + # The extra values given here take precedence over values defined on the client or passed to this method. |
| 136 | + extra_headers: Headers | None = None, |
| 137 | + extra_query: Query | None = None, |
| 138 | + extra_body: Body | None = None, |
| 139 | + timeout: float | httpx.Timeout | None | NotGiven = not_given, |
| 140 | + ) -> UsageAnalyticsResponse: |
| 141 | + """ |
| 142 | + **Note:** This API is currently in beta. |
| 143 | +
|
| 144 | + Get the account analytics data between two dates. The response covers the period |
| 145 | + from the start date to the end date, both dates inclusive. Both dates are |
| 146 | + interpreted as UTC calendar days. |
| 147 | +
|
| 148 | + The returned data is scoped to the requesting account only. Unlike |
| 149 | + `/v1/accounts/usage`, an agency account's analytics are not aggregated across |
| 150 | + its child accounts. |
| 151 | +
|
| 152 | + The response is cached for 5 minutes per account and date range. Use |
| 153 | + `generatedAt` to check how fresh the returned data is. |
| 154 | +
|
| 155 | + Args: |
| 156 | + end_date: Specify an `endDate` in `YYYY-MM-DD` format, interpreted as a UTC calendar day. |
| 157 | + It should be after the `startDate`. The difference between `startDate` and |
| 158 | + `endDate` should be less than 90 days. |
| 159 | +
|
| 160 | + start_date: Specify a `startDate` in `YYYY-MM-DD` format, interpreted as a UTC calendar day. |
| 161 | + It should be before the `endDate`. The difference between `startDate` and |
| 162 | + `endDate` should be less than 90 days. |
| 163 | +
|
| 164 | + extra_headers: Send extra headers |
| 165 | +
|
| 166 | + extra_query: Add additional query parameters to the request |
| 167 | +
|
| 168 | + extra_body: Add additional JSON properties to the request |
| 169 | +
|
| 170 | + timeout: Override the client-level default timeout for this request, in seconds |
| 171 | + """ |
| 172 | + return await self._get( |
| 173 | + "/v1/accounts/usage-analytics", |
| 174 | + options=make_request_options( |
| 175 | + extra_headers=extra_headers, |
| 176 | + extra_query=extra_query, |
| 177 | + extra_body=extra_body, |
| 178 | + timeout=timeout, |
| 179 | + query=await async_maybe_transform( |
| 180 | + { |
| 181 | + "end_date": end_date, |
| 182 | + "start_date": start_date, |
| 183 | + }, |
| 184 | + usage_analytics_get_params.UsageAnalyticsGetParams, |
| 185 | + ), |
| 186 | + ), |
| 187 | + cast_to=UsageAnalyticsResponse, |
| 188 | + ) |
| 189 | + |
| 190 | + |
| 191 | +class UsageAnalyticsResourceWithRawResponse: |
| 192 | + def __init__(self, usage_analytics: UsageAnalyticsResource) -> None: |
| 193 | + self._usage_analytics = usage_analytics |
| 194 | + |
| 195 | + self.get = to_raw_response_wrapper( |
| 196 | + usage_analytics.get, |
| 197 | + ) |
| 198 | + |
| 199 | + |
| 200 | +class AsyncUsageAnalyticsResourceWithRawResponse: |
| 201 | + def __init__(self, usage_analytics: AsyncUsageAnalyticsResource) -> None: |
| 202 | + self._usage_analytics = usage_analytics |
| 203 | + |
| 204 | + self.get = async_to_raw_response_wrapper( |
| 205 | + usage_analytics.get, |
| 206 | + ) |
| 207 | + |
| 208 | + |
| 209 | +class UsageAnalyticsResourceWithStreamingResponse: |
| 210 | + def __init__(self, usage_analytics: UsageAnalyticsResource) -> None: |
| 211 | + self._usage_analytics = usage_analytics |
| 212 | + |
| 213 | + self.get = to_streamed_response_wrapper( |
| 214 | + usage_analytics.get, |
| 215 | + ) |
| 216 | + |
| 217 | + |
| 218 | +class AsyncUsageAnalyticsResourceWithStreamingResponse: |
| 219 | + def __init__(self, usage_analytics: AsyncUsageAnalyticsResource) -> None: |
| 220 | + self._usage_analytics = usage_analytics |
| 221 | + |
| 222 | + self.get = async_to_streamed_response_wrapper( |
| 223 | + usage_analytics.get, |
| 224 | + ) |
0 commit comments