chunkify-analytics-sdk 0.9.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (179) hide show
  1. chunkify_analytics/__init__.py +102 -0
  2. chunkify_analytics/_base_client.py +2153 -0
  3. chunkify_analytics/_client.py +1262 -0
  4. chunkify_analytics/_compat.py +226 -0
  5. chunkify_analytics/_constants.py +14 -0
  6. chunkify_analytics/_exceptions.py +108 -0
  7. chunkify_analytics/_files.py +173 -0
  8. chunkify_analytics/_models.py +964 -0
  9. chunkify_analytics/_qs.py +149 -0
  10. chunkify_analytics/_resource.py +43 -0
  11. chunkify_analytics/_response.py +835 -0
  12. chunkify_analytics/_streaming.py +338 -0
  13. chunkify_analytics/_types.py +274 -0
  14. chunkify_analytics/_utils/__init__.py +64 -0
  15. chunkify_analytics/_utils/_compat.py +45 -0
  16. chunkify_analytics/_utils/_datetime_parse.py +136 -0
  17. chunkify_analytics/_utils/_json.py +35 -0
  18. chunkify_analytics/_utils/_logs.py +25 -0
  19. chunkify_analytics/_utils/_path.py +127 -0
  20. chunkify_analytics/_utils/_proxy.py +65 -0
  21. chunkify_analytics/_utils/_reflection.py +42 -0
  22. chunkify_analytics/_utils/_resources_proxy.py +24 -0
  23. chunkify_analytics/_utils/_streams.py +12 -0
  24. chunkify_analytics/_utils/_sync.py +58 -0
  25. chunkify_analytics/_utils/_transform.py +457 -0
  26. chunkify_analytics/_utils/_typing.py +156 -0
  27. chunkify_analytics/_utils/_utils.py +433 -0
  28. chunkify_analytics/_version.py +4 -0
  29. chunkify_analytics/lib/.keep +4 -0
  30. chunkify_analytics/pagination.py +221 -0
  31. chunkify_analytics/py.typed +0 -0
  32. chunkify_analytics/resources/__init__.py +243 -0
  33. chunkify_analytics/resources/admin/__init__.py +33 -0
  34. chunkify_analytics/resources/admin/admin.py +253 -0
  35. chunkify_analytics/resources/admin/keys.py +283 -0
  36. chunkify_analytics/resources/dimensions.py +436 -0
  37. chunkify_analytics/resources/engagement.py +479 -0
  38. chunkify_analytics/resources/errors.py +400 -0
  39. chunkify_analytics/resources/events.py +562 -0
  40. chunkify_analytics/resources/exports.py +584 -0
  41. chunkify_analytics/resources/health.py +159 -0
  42. chunkify_analytics/resources/playback_rates.py +391 -0
  43. chunkify_analytics/resources/project/__init__.py +33 -0
  44. chunkify_analytics/resources/project/keys.py +379 -0
  45. chunkify_analytics/resources/project/project.py +322 -0
  46. chunkify_analytics/resources/quality.py +471 -0
  47. chunkify_analytics/resources/renditions.py +391 -0
  48. chunkify_analytics/resources/retention.py +377 -0
  49. chunkify_analytics/resources/subtitles.py +389 -0
  50. chunkify_analytics/resources/summary.py +469 -0
  51. chunkify_analytics/resources/timeseries.py +399 -0
  52. chunkify_analytics/resources/videos.py +424 -0
  53. chunkify_analytics/resources/views.py +579 -0
  54. chunkify_analytics/types/__init__.py +145 -0
  55. chunkify_analytics/types/admin/__init__.py +3 -0
  56. chunkify_analytics/types/admin_create_project_params.py +25 -0
  57. chunkify_analytics/types/analytics_event.py +32 -0
  58. chunkify_analytics/types/analytics_event_param.py +30 -0
  59. chunkify_analytics/types/created_project.py +37 -0
  60. chunkify_analytics/types/created_project_key.py +34 -0
  61. chunkify_analytics/types/deleted_project.py +18 -0
  62. chunkify_analytics/types/dimension_list_values_params.py +124 -0
  63. chunkify_analytics/types/dimension_values.py +42 -0
  64. chunkify_analytics/types/engagement.py +60 -0
  65. chunkify_analytics/types/engagement_breakdown_page.py +44 -0
  66. chunkify_analytics/types/engagement_response.py +11 -0
  67. chunkify_analytics/types/engagement_retrieve_params.py +158 -0
  68. chunkify_analytics/types/engagement_timeseries.py +28 -0
  69. chunkify_analytics/types/engagement_timeseries_bucket.py +63 -0
  70. chunkify_analytics/types/error_group.py +17 -0
  71. chunkify_analytics/types/error_list_params.py +124 -0
  72. chunkify_analytics/types/error_page.py +14 -0
  73. chunkify_analytics/types/event_ingest_params.py +19 -0
  74. chunkify_analytics/types/event_ingest_response.py +11 -0
  75. chunkify_analytics/types/event_list_params.py +146 -0
  76. chunkify_analytics/types/event_page.py +18 -0
  77. chunkify_analytics/types/export.py +18 -0
  78. chunkify_analytics/types/export_columns.py +12 -0
  79. chunkify_analytics/types/export_create_params.py +40 -0
  80. chunkify_analytics/types/export_download_response.py +7 -0
  81. chunkify_analytics/types/export_list_columns_params.py +69 -0
  82. chunkify_analytics/types/export_query_param.py +141 -0
  83. chunkify_analytics/types/health.py +11 -0
  84. chunkify_analytics/types/metrics.py +13 -0
  85. chunkify_analytics/types/metrics_breakdown_page.py +40 -0
  86. chunkify_analytics/types/metrics_response.py +11 -0
  87. chunkify_analytics/types/native_created.py +13 -0
  88. chunkify_analytics/types/native_duplicate.py +13 -0
  89. chunkify_analytics/types/playback_error.py +180 -0
  90. chunkify_analytics/types/playback_error_param.py +182 -0
  91. chunkify_analytics/types/playback_rate_changed.py +150 -0
  92. chunkify_analytics/types/playback_rate_changed_param.py +152 -0
  93. chunkify_analytics/types/playback_rate_metric.py +21 -0
  94. chunkify_analytics/types/playback_rate_report.py +31 -0
  95. chunkify_analytics/types/playback_rate_retrieve_params.py +117 -0
  96. chunkify_analytics/types/playback_state_changed.py +150 -0
  97. chunkify_analytics/types/playback_state_changed_param.py +156 -0
  98. chunkify_analytics/types/project/__init__.py +6 -0
  99. chunkify_analytics/types/project/key_create_params.py +21 -0
  100. chunkify_analytics/types/project/project.py +35 -0
  101. chunkify_analytics/types/project_key.py +21 -0
  102. chunkify_analytics/types/project_keys.py +14 -0
  103. chunkify_analytics/types/project_update_params.py +25 -0
  104. chunkify_analytics/types/quality.py +117 -0
  105. chunkify_analytics/types/quality_breakdown_page.py +44 -0
  106. chunkify_analytics/types/quality_response.py +11 -0
  107. chunkify_analytics/types/quality_retrieve_params.py +158 -0
  108. chunkify_analytics/types/quality_timeseries.py +28 -0
  109. chunkify_analytics/types/quality_timeseries_bucket.py +120 -0
  110. chunkify_analytics/types/rendition_changed.py +156 -0
  111. chunkify_analytics/types/rendition_changed_param.py +158 -0
  112. chunkify_analytics/types/rendition_metric.py +40 -0
  113. chunkify_analytics/types/rendition_report.py +43 -0
  114. chunkify_analytics/types/rendition_retrieve_params.py +117 -0
  115. chunkify_analytics/types/retention_bucket.py +22 -0
  116. chunkify_analytics/types/retention_report.py +33 -0
  117. chunkify_analytics/types/retention_retrieve_params.py +110 -0
  118. chunkify_analytics/types/rotated_project_key.py +29 -0
  119. chunkify_analytics/types/seek_completed.py +166 -0
  120. chunkify_analytics/types/seek_completed_param.py +168 -0
  121. chunkify_analytics/types/shared/__init__.py +24 -0
  122. chunkify_analytics/types/shared/browser_context.py +62 -0
  123. chunkify_analytics/types/shared/custom_dimensions.py +8 -0
  124. chunkify_analytics/types/shared/event_context.py +161 -0
  125. chunkify_analytics/types/shared/event_envelope.py +152 -0
  126. chunkify_analytics/types/shared/metric_count_ratio.py +18 -0
  127. chunkify_analytics/types/shared/otlp_any_value.py +56 -0
  128. chunkify_analytics/types/shared/otlp_attribute.py +24 -0
  129. chunkify_analytics/types/shared/otlp_attribute_value.py +136 -0
  130. chunkify_analytics/types/shared/otlp_context_attribute.py +22 -0
  131. chunkify_analytics/types/shared/otlp_log_record.py +48 -0
  132. chunkify_analytics/types/shared/otlp_resource.py +20 -0
  133. chunkify_analytics/types/shared/otlp_scope.py +24 -0
  134. chunkify_analytics/types/shared/playback_rate_playing_time.py +12 -0
  135. chunkify_analytics/types/shared/playback_score.py +28 -0
  136. chunkify_analytics/types/shared/played_range.py +13 -0
  137. chunkify_analytics/types/shared/progress_reached.py +39 -0
  138. chunkify_analytics/types/shared/rendition_playing_time.py +21 -0
  139. chunkify_analytics/types/shared/startup_outcomes.py +39 -0
  140. chunkify_analytics/types/shared/stored_otlp_context.py +50 -0
  141. chunkify_analytics/types/shared/subtitle_playing_time.py +14 -0
  142. chunkify_analytics/types/shared/view_metrics.py +100 -0
  143. chunkify_analytics/types/shared/watch_time_distribution.py +41 -0
  144. chunkify_analytics/types/shared_params/__init__.py +8 -0
  145. chunkify_analytics/types/shared_params/browser_context.py +62 -0
  146. chunkify_analytics/types/shared_params/custom_dimensions.py +10 -0
  147. chunkify_analytics/types/shared_params/playback_rate_playing_time.py +14 -0
  148. chunkify_analytics/types/shared_params/played_range.py +15 -0
  149. chunkify_analytics/types/shared_params/rendition_playing_time.py +22 -0
  150. chunkify_analytics/types/shared_params/subtitle_playing_time.py +15 -0
  151. chunkify_analytics/types/stored_event.py +44 -0
  152. chunkify_analytics/types/subtitle_changed.py +150 -0
  153. chunkify_analytics/types/subtitle_changed_param.py +152 -0
  154. chunkify_analytics/types/subtitle_metric.py +26 -0
  155. chunkify_analytics/types/subtitle_report.py +31 -0
  156. chunkify_analytics/types/subtitle_retrieve_params.py +117 -0
  157. chunkify_analytics/types/summary_retrieve_params.py +158 -0
  158. chunkify_analytics/types/time_bucket.py +22 -0
  159. chunkify_analytics/types/timeseries.py +28 -0
  160. chunkify_analytics/types/timeseries_response.py +12 -0
  161. chunkify_analytics/types/timesery_retrieve_params.py +115 -0
  162. chunkify_analytics/types/video_list_params.py +140 -0
  163. chunkify_analytics/types/video_metrics.py +23 -0
  164. chunkify_analytics/types/video_page.py +14 -0
  165. chunkify_analytics/types/view.py +43 -0
  166. chunkify_analytics/types/view_detail.py +21 -0
  167. chunkify_analytics/types/view_ended.py +180 -0
  168. chunkify_analytics/types/view_ended_param.py +182 -0
  169. chunkify_analytics/types/view_list_params.py +152 -0
  170. chunkify_analytics/types/view_page.py +14 -0
  171. chunkify_analytics/types/view_retrieve_params.py +23 -0
  172. chunkify_analytics/types/view_snapshot.py +180 -0
  173. chunkify_analytics/types/view_snapshot_param.py +182 -0
  174. chunkify_analytics/types/view_started.py +192 -0
  175. chunkify_analytics/types/view_started_param.py +194 -0
  176. chunkify_analytics_sdk-0.9.0.dist-info/METADATA +487 -0
  177. chunkify_analytics_sdk-0.9.0.dist-info/RECORD +179 -0
  178. chunkify_analytics_sdk-0.9.0.dist-info/WHEEL +4 -0
  179. chunkify_analytics_sdk-0.9.0.dist-info/licenses/LICENSE +201 -0
@@ -0,0 +1,283 @@
1
+ # File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ from __future__ import annotations
4
+
5
+ import httpx
6
+
7
+ from ..._types import Body, Query, Headers, NotGiven, not_given
8
+ from ..._utils import path_template
9
+ from ..._compat import cached_property
10
+ from ..._resource import SyncAPIResource, AsyncAPIResource
11
+ from ..._response import (
12
+ to_raw_response_wrapper,
13
+ to_streamed_response_wrapper,
14
+ async_to_raw_response_wrapper,
15
+ async_to_streamed_response_wrapper,
16
+ )
17
+ from ..._base_client import make_request_options
18
+ from ...types.project_keys import ProjectKeys
19
+ from ...types.rotated_project_key import RotatedProjectKey
20
+
21
+ __all__ = ["KeysResource", "AsyncKeysResource"]
22
+
23
+
24
+ class KeysResource(SyncAPIResource):
25
+ """Project origins and keys."""
26
+
27
+ @cached_property
28
+ def with_raw_response(self) -> KeysResourceWithRawResponse:
29
+ """
30
+ This property can be used as a prefix for any HTTP method call to return
31
+ the raw response object instead of the parsed content.
32
+
33
+ For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#accessing-raw-response-data-eg-headers
34
+ """
35
+ return KeysResourceWithRawResponse(self)
36
+
37
+ @cached_property
38
+ def with_streaming_response(self) -> KeysResourceWithStreamingResponse:
39
+ """
40
+ An alternative to `.with_raw_response` that doesn't eagerly read the response body.
41
+
42
+ For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#with_streaming_response
43
+ """
44
+ return KeysResourceWithStreamingResponse(self)
45
+
46
+ def list(
47
+ self,
48
+ project_id: str,
49
+ *,
50
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
51
+ # The extra values given here take precedence over values defined on the client or passed to this method.
52
+ extra_headers: Headers | None = None,
53
+ extra_query: Query | None = None,
54
+ extra_body: Body | None = None,
55
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
56
+ ) -> ProjectKeys:
57
+ """List key IDs, names and permissions by project ID using CHUNKIFY_ADMIN_KEY.
58
+
59
+ No
60
+ project credential is required. Key values are never returned. Intended for a
61
+ trusted backend that verifies project ownership.
62
+
63
+ Args:
64
+ extra_headers: Send extra headers
65
+
66
+ extra_query: Add additional query parameters to the request
67
+
68
+ extra_body: Add additional JSON properties to the request
69
+
70
+ timeout: Override the client-level default timeout for this request, in seconds
71
+ """
72
+ if not project_id:
73
+ raise ValueError(f"Expected a non-empty value for `project_id` but received {project_id!r}")
74
+ return self._get(
75
+ path_template("/v1/projects/{project_id}/keys", project_id=project_id),
76
+ options=make_request_options(
77
+ extra_headers=extra_headers,
78
+ extra_query=extra_query,
79
+ extra_body=extra_body,
80
+ timeout=timeout,
81
+ security={"admin_key": True},
82
+ ),
83
+ cast_to=ProjectKeys,
84
+ )
85
+
86
+ def rotate(
87
+ self,
88
+ key_id: str,
89
+ *,
90
+ project_id: str,
91
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
92
+ # The extra values given here take precedence over values defined on the client or passed to this method.
93
+ extra_headers: Headers | None = None,
94
+ extra_query: Query | None = None,
95
+ extra_body: Body | None = None,
96
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
97
+ ) -> RotatedProjectKey:
98
+ """
99
+ Replace one existing public or secret key using CHUNKIFY_ADMIN_KEY, even when
100
+ the project secret was lost. The old value stops working immediately. Key ID,
101
+ type and read-only access are preserved; other keys are unchanged. Save the
102
+ returned replacement. Intended for a trusted backend that verifies project
103
+ ownership.
104
+
105
+ Args:
106
+ extra_headers: Send extra headers
107
+
108
+ extra_query: Add additional query parameters to the request
109
+
110
+ extra_body: Add additional JSON properties to the request
111
+
112
+ timeout: Override the client-level default timeout for this request, in seconds
113
+ """
114
+ if not project_id:
115
+ raise ValueError(f"Expected a non-empty value for `project_id` but received {project_id!r}")
116
+ if not key_id:
117
+ raise ValueError(f"Expected a non-empty value for `key_id` but received {key_id!r}")
118
+ return self._post(
119
+ path_template("/v1/projects/{project_id}/keys/{key_id}/rotate", project_id=project_id, key_id=key_id),
120
+ options=make_request_options(
121
+ extra_headers=extra_headers,
122
+ extra_query=extra_query,
123
+ extra_body=extra_body,
124
+ timeout=timeout,
125
+ security={"admin_key": True},
126
+ ),
127
+ cast_to=RotatedProjectKey,
128
+ )
129
+
130
+
131
+ class AsyncKeysResource(AsyncAPIResource):
132
+ """Project origins and keys."""
133
+
134
+ @cached_property
135
+ def with_raw_response(self) -> AsyncKeysResourceWithRawResponse:
136
+ """
137
+ This property can be used as a prefix for any HTTP method call to return
138
+ the raw response object instead of the parsed content.
139
+
140
+ For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#accessing-raw-response-data-eg-headers
141
+ """
142
+ return AsyncKeysResourceWithRawResponse(self)
143
+
144
+ @cached_property
145
+ def with_streaming_response(self) -> AsyncKeysResourceWithStreamingResponse:
146
+ """
147
+ An alternative to `.with_raw_response` that doesn't eagerly read the response body.
148
+
149
+ For more information, see https://www.github.com/chunkifydev/chunkify-analytics-python#with_streaming_response
150
+ """
151
+ return AsyncKeysResourceWithStreamingResponse(self)
152
+
153
+ async def list(
154
+ self,
155
+ project_id: str,
156
+ *,
157
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
158
+ # The extra values given here take precedence over values defined on the client or passed to this method.
159
+ extra_headers: Headers | None = None,
160
+ extra_query: Query | None = None,
161
+ extra_body: Body | None = None,
162
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
163
+ ) -> ProjectKeys:
164
+ """List key IDs, names and permissions by project ID using CHUNKIFY_ADMIN_KEY.
165
+
166
+ No
167
+ project credential is required. Key values are never returned. Intended for a
168
+ trusted backend that verifies project ownership.
169
+
170
+ Args:
171
+ extra_headers: Send extra headers
172
+
173
+ extra_query: Add additional query parameters to the request
174
+
175
+ extra_body: Add additional JSON properties to the request
176
+
177
+ timeout: Override the client-level default timeout for this request, in seconds
178
+ """
179
+ if not project_id:
180
+ raise ValueError(f"Expected a non-empty value for `project_id` but received {project_id!r}")
181
+ return await self._get(
182
+ path_template("/v1/projects/{project_id}/keys", project_id=project_id),
183
+ options=make_request_options(
184
+ extra_headers=extra_headers,
185
+ extra_query=extra_query,
186
+ extra_body=extra_body,
187
+ timeout=timeout,
188
+ security={"admin_key": True},
189
+ ),
190
+ cast_to=ProjectKeys,
191
+ )
192
+
193
+ async def rotate(
194
+ self,
195
+ key_id: str,
196
+ *,
197
+ project_id: str,
198
+ # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
199
+ # The extra values given here take precedence over values defined on the client or passed to this method.
200
+ extra_headers: Headers | None = None,
201
+ extra_query: Query | None = None,
202
+ extra_body: Body | None = None,
203
+ timeout: float | httpx.Timeout | None | NotGiven = not_given,
204
+ ) -> RotatedProjectKey:
205
+ """
206
+ Replace one existing public or secret key using CHUNKIFY_ADMIN_KEY, even when
207
+ the project secret was lost. The old value stops working immediately. Key ID,
208
+ type and read-only access are preserved; other keys are unchanged. Save the
209
+ returned replacement. Intended for a trusted backend that verifies project
210
+ ownership.
211
+
212
+ Args:
213
+ extra_headers: Send extra headers
214
+
215
+ extra_query: Add additional query parameters to the request
216
+
217
+ extra_body: Add additional JSON properties to the request
218
+
219
+ timeout: Override the client-level default timeout for this request, in seconds
220
+ """
221
+ if not project_id:
222
+ raise ValueError(f"Expected a non-empty value for `project_id` but received {project_id!r}")
223
+ if not key_id:
224
+ raise ValueError(f"Expected a non-empty value for `key_id` but received {key_id!r}")
225
+ return await self._post(
226
+ path_template("/v1/projects/{project_id}/keys/{key_id}/rotate", project_id=project_id, key_id=key_id),
227
+ options=make_request_options(
228
+ extra_headers=extra_headers,
229
+ extra_query=extra_query,
230
+ extra_body=extra_body,
231
+ timeout=timeout,
232
+ security={"admin_key": True},
233
+ ),
234
+ cast_to=RotatedProjectKey,
235
+ )
236
+
237
+
238
+ class KeysResourceWithRawResponse:
239
+ def __init__(self, keys: KeysResource) -> None:
240
+ self._keys = keys
241
+
242
+ self.list = to_raw_response_wrapper(
243
+ keys.list,
244
+ )
245
+ self.rotate = to_raw_response_wrapper(
246
+ keys.rotate,
247
+ )
248
+
249
+
250
+ class AsyncKeysResourceWithRawResponse:
251
+ def __init__(self, keys: AsyncKeysResource) -> None:
252
+ self._keys = keys
253
+
254
+ self.list = async_to_raw_response_wrapper(
255
+ keys.list,
256
+ )
257
+ self.rotate = async_to_raw_response_wrapper(
258
+ keys.rotate,
259
+ )
260
+
261
+
262
+ class KeysResourceWithStreamingResponse:
263
+ def __init__(self, keys: KeysResource) -> None:
264
+ self._keys = keys
265
+
266
+ self.list = to_streamed_response_wrapper(
267
+ keys.list,
268
+ )
269
+ self.rotate = to_streamed_response_wrapper(
270
+ keys.rotate,
271
+ )
272
+
273
+
274
+ class AsyncKeysResourceWithStreamingResponse:
275
+ def __init__(self, keys: AsyncKeysResource) -> None:
276
+ self._keys = keys
277
+
278
+ self.list = async_to_streamed_response_wrapper(
279
+ keys.list,
280
+ )
281
+ self.rotate = async_to_streamed_response_wrapper(
282
+ keys.rotate,
283
+ )