bytekit-sdk 0.3.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 (227) hide show
  1. bytekit/__init__.py +8 -0
  2. bytekit/api/__init__.py +1 -0
  3. bytekit/api/account/__init__.py +1 -0
  4. bytekit/api/account/get_account.py +157 -0
  5. bytekit/api/bulk/__init__.py +1 -0
  6. bytekit/api/bulk/create_bulk.py +204 -0
  7. bytekit/api/bulk/delete_bulk.py +177 -0
  8. bytekit/api/bulk/get_bulk.py +157 -0
  9. bytekit/api/bulk/list_bulk_screenshots.py +152 -0
  10. bytekit/api/fetch/__init__.py +1 -0
  11. bytekit/api/fetch/get_fetch.py +254 -0
  12. bytekit/api/fetch/post_fetch.py +178 -0
  13. bytekit/api/fetch_bulk/__init__.py +1 -0
  14. bytekit/api/fetch_bulk/create_fetch_bulk.py +180 -0
  15. bytekit/api/fetch_bulk/get_fetch_bulk.py +157 -0
  16. bytekit/api/monitors/__init__.py +1 -0
  17. bytekit/api/monitors/create_monitor.py +180 -0
  18. bytekit/api/monitors/delete_monitor.py +155 -0
  19. bytekit/api/monitors/get_monitor.py +157 -0
  20. bytekit/api/monitors/list_monitor_captures.py +188 -0
  21. bytekit/api/monitors/list_monitors.py +193 -0
  22. bytekit/api/monitors/update_monitor.py +191 -0
  23. bytekit/api/scrape/__init__.py +1 -0
  24. bytekit/api/scrape/create_scrape.py +197 -0
  25. bytekit/api/scrape/get_scrape.py +231 -0
  26. bytekit/api/scrape_bulk/__init__.py +1 -0
  27. bytekit/api/scrape_bulk/create_scrape_bulk.py +188 -0
  28. bytekit/api/scrape_bulk/get_scrape_bulk.py +157 -0
  29. bytekit/api/screenshots/__init__.py +1 -0
  30. bytekit/api/screenshots/create_screenshot.py +208 -0
  31. bytekit/api/screenshots/get_screenshot.py +177 -0
  32. bytekit/api/search/__init__.py +1 -0
  33. bytekit/api/search/create_search.py +225 -0
  34. bytekit/api/sitemap/__init__.py +1 -0
  35. bytekit/api/sitemap/create_sitemap.py +192 -0
  36. bytekit/api/sitemap/get_sitemap.py +157 -0
  37. bytekit/api/usage/__init__.py +1 -0
  38. bytekit/api/usage/get_usage.py +126 -0
  39. bytekit/api/usage/get_usage_by_endpoint.py +215 -0
  40. bytekit/api/usage/get_usage_daily.py +203 -0
  41. bytekit/api/webhooks/__init__.py +1 -0
  42. bytekit/api/webhooks/list_webhook_deliveries.py +214 -0
  43. bytekit/api/webhooks/retry_webhook_delivery.py +165 -0
  44. bytekit/client.py +418 -0
  45. bytekit/errors.py +18 -0
  46. bytekit/models/__init__.py +401 -0
  47. bytekit/models/account_bearer_response.py +207 -0
  48. bytekit/models/account_bearer_response_api_key.py +134 -0
  49. bytekit/models/account_bearer_response_api_key_environment.py +8 -0
  50. bytekit/models/account_bearer_response_auto_topup.py +83 -0
  51. bytekit/models/account_bearer_response_plan.py +150 -0
  52. bytekit/models/account_bearer_response_subscription.py +85 -0
  53. bytekit/models/account_bearer_response_subscription_plan.py +99 -0
  54. bytekit/models/account_bearer_response_subscription_status.py +10 -0
  55. bytekit/models/account_session_response.py +164 -0
  56. bytekit/models/account_session_response_notifications.py +51 -0
  57. bytekit/models/account_session_response_plan.py +150 -0
  58. bytekit/models/bandwidth_balance.py +91 -0
  59. bytekit/models/capture_response.py +216 -0
  60. bytekit/models/capture_response_outcome.py +10 -0
  61. bytekit/models/clip.py +83 -0
  62. bytekit/models/cookie.py +90 -0
  63. bytekit/models/create_bulk_body.py +155 -0
  64. bytekit/models/create_bulk_body_defaults.py +423 -0
  65. bytekit/models/create_bulk_body_defaults_device.py +9 -0
  66. bytekit/models/create_bulk_body_defaults_device_scale_factor_type_1.py +9 -0
  67. bytekit/models/create_bulk_body_defaults_device_scale_factor_type_2_type_1.py +9 -0
  68. bytekit/models/create_bulk_body_defaults_device_scale_factor_type_3_type_1.py +9 -0
  69. bytekit/models/create_bulk_body_defaults_formats_item.py +12 -0
  70. bytekit/models/create_bulk_body_defaults_type.py +9 -0
  71. bytekit/models/create_bulk_body_defaults_viewport_type_0.py +67 -0
  72. bytekit/models/create_bulk_body_defaults_wait_until.py +10 -0
  73. bytekit/models/create_bulk_body_items_item.py +380 -0
  74. bytekit/models/create_bulk_body_items_item_device.py +9 -0
  75. bytekit/models/create_bulk_body_items_item_formats_item.py +12 -0
  76. bytekit/models/create_bulk_body_items_item_scenario.py +10 -0
  77. bytekit/models/create_bulk_body_items_item_type.py +9 -0
  78. bytekit/models/create_bulk_body_items_item_viewport_type_0.py +67 -0
  79. bytekit/models/create_bulk_body_items_item_wait_until.py +10 -0
  80. bytekit/models/create_bulk_response_202.py +164 -0
  81. bytekit/models/create_bulk_response_202_status.py +10 -0
  82. bytekit/models/create_fetch_bulk_body.py +161 -0
  83. bytekit/models/create_fetch_bulk_body_defaults.py +91 -0
  84. bytekit/models/create_fetch_bulk_body_defaults_format.py +9 -0
  85. bytekit/models/create_fetch_bulk_body_metadata.py +44 -0
  86. bytekit/models/create_fetch_bulk_body_urls_item_type_1.py +102 -0
  87. bytekit/models/create_fetch_bulk_body_urls_item_type_1_format.py +9 -0
  88. bytekit/models/create_fetch_bulk_response_202.py +44 -0
  89. bytekit/models/create_scrape_bulk_body.py +179 -0
  90. bytekit/models/create_scrape_bulk_body_custom.py +52 -0
  91. bytekit/models/create_scrape_bulk_body_defaults.py +167 -0
  92. bytekit/models/create_scrape_bulk_body_defaults_formats_item.py +12 -0
  93. bytekit/models/create_scrape_bulk_body_defaults_headers.py +44 -0
  94. bytekit/models/create_scrape_bulk_body_items_item.py +226 -0
  95. bytekit/models/create_scrape_bulk_body_items_item_custom.py +50 -0
  96. bytekit/models/create_scrape_bulk_body_items_item_formats_item.py +12 -0
  97. bytekit/models/create_scrape_bulk_body_items_item_headers.py +44 -0
  98. bytekit/models/create_scrape_bulk_body_items_item_metadata.py +44 -0
  99. bytekit/models/create_scrape_bulk_response_202.py +166 -0
  100. bytekit/models/create_scrape_bulk_response_202_status.py +10 -0
  101. bytekit/models/create_search_body.py +140 -0
  102. bytekit/models/create_search_body_date_range.py +13 -0
  103. bytekit/models/create_search_body_type.py +10 -0
  104. bytekit/models/create_search_response_200.py +119 -0
  105. bytekit/models/create_search_response_200_results_item.py +161 -0
  106. bytekit/models/create_search_response_200_results_item_image.py +113 -0
  107. bytekit/models/create_search_response_502.py +46 -0
  108. bytekit/models/create_search_response_502_error.py +8 -0
  109. bytekit/models/credit_balance.py +91 -0
  110. bytekit/models/delete_bulk_response_200.py +164 -0
  111. bytekit/models/delete_bulk_response_200_status.py +11 -0
  112. bytekit/models/error.py +83 -0
  113. bytekit/models/error_error.py +100 -0
  114. bytekit/models/error_status.py +8 -0
  115. bytekit/models/fetch_request.py +276 -0
  116. bytekit/models/fetch_request_cache_ttl_type_1.py +8 -0
  117. bytekit/models/fetch_request_custom.py +48 -0
  118. bytekit/models/fetch_request_format.py +9 -0
  119. bytekit/models/fetch_request_markdown_images.py +11 -0
  120. bytekit/models/fetch_request_markdown_links.py +11 -0
  121. bytekit/models/fetch_request_markdown_mode.py +10 -0
  122. bytekit/models/get_bulk_response_200.py +164 -0
  123. bytekit/models/get_bulk_response_200_status.py +11 -0
  124. bytekit/models/get_fetch_bulk_response_200.py +44 -0
  125. bytekit/models/get_fetch_cache_ttl_type_1.py +8 -0
  126. bytekit/models/get_fetch_format.py +9 -0
  127. bytekit/models/get_scrape_bulk_response_200.py +164 -0
  128. bytekit/models/get_scrape_bulk_response_200_status.py +11 -0
  129. bytekit/models/get_usage_by_endpoint_response_200.py +114 -0
  130. bytekit/models/get_usage_by_endpoint_response_200_rows_item.py +90 -0
  131. bytekit/models/get_usage_by_endpoint_response_200_rows_item_endpoint.py +17 -0
  132. bytekit/models/get_usage_by_endpoint_response_200_totals.py +67 -0
  133. bytekit/models/get_usage_daily_response_200.py +97 -0
  134. bytekit/models/get_usage_daily_response_200_data_item.py +219 -0
  135. bytekit/models/get_usage_response_200.py +344 -0
  136. bytekit/models/get_usage_response_200_plan_type.py +10 -0
  137. bytekit/models/list_bulk_screenshots_response_200.py +44 -0
  138. bytekit/models/list_monitor_captures_response_200.py +101 -0
  139. bytekit/models/list_monitors_response_200.py +101 -0
  140. bytekit/models/list_monitors_status.py +12 -0
  141. bytekit/models/list_webhook_deliveries_response_200.py +101 -0
  142. bytekit/models/list_webhook_deliveries_status.py +11 -0
  143. bytekit/models/metadata.py +44 -0
  144. bytekit/models/monitor_create_request.py +219 -0
  145. bytekit/models/monitor_create_request_interval_type.py +11 -0
  146. bytekit/models/monitor_create_request_notify_on.py +9 -0
  147. bytekit/models/monitor_create_request_options.py +44 -0
  148. bytekit/models/monitor_create_request_scrape_options.py +44 -0
  149. bytekit/models/monitor_create_request_type.py +9 -0
  150. bytekit/models/monitor_create_request_webhook_headers.py +44 -0
  151. bytekit/models/monitor_create_response.py +423 -0
  152. bytekit/models/monitor_response.py +411 -0
  153. bytekit/models/monitor_response_interval_type.py +11 -0
  154. bytekit/models/monitor_response_metadata_type_0.py +44 -0
  155. bytekit/models/monitor_response_status.py +12 -0
  156. bytekit/models/monitor_response_type.py +9 -0
  157. bytekit/models/monitor_response_webhook_headers_type_0.py +44 -0
  158. bytekit/models/monitor_update_request.py +223 -0
  159. bytekit/models/monitor_update_request_interval_type.py +11 -0
  160. bytekit/models/monitor_update_request_notify_on.py +9 -0
  161. bytekit/models/monitor_update_request_options.py +44 -0
  162. bytekit/models/monitor_update_request_scrape_options.py +44 -0
  163. bytekit/models/monitor_update_request_status.py +9 -0
  164. bytekit/models/monitor_update_request_webhook_headers.py +44 -0
  165. bytekit/models/scrape_error_envelope.py +113 -0
  166. bytekit/models/scrape_error_envelope_error.py +93 -0
  167. bytekit/models/scrape_error_envelope_error_code.py +18 -0
  168. bytekit/models/scrape_error_envelope_schema_version.py +8 -0
  169. bytekit/models/scrape_error_envelope_status.py +8 -0
  170. bytekit/models/scrape_formats.py +183 -0
  171. bytekit/models/scrape_markdown_tokens.py +75 -0
  172. bytekit/models/scrape_metadata.py +262 -0
  173. bytekit/models/scrape_queued_envelope.py +124 -0
  174. bytekit/models/scrape_queued_envelope_schema_version.py +8 -0
  175. bytekit/models/scrape_queued_envelope_status.py +8 -0
  176. bytekit/models/scrape_request.py +485 -0
  177. bytekit/models/scrape_request_cache_ttl_type_1.py +8 -0
  178. bytekit/models/scrape_request_custom.py +48 -0
  179. bytekit/models/scrape_request_events_item.py +10 -0
  180. bytekit/models/scrape_request_formats_item.py +12 -0
  181. bytekit/models/scrape_request_headers.py +44 -0
  182. bytekit/models/scrape_request_markdown_images.py +11 -0
  183. bytekit/models/scrape_request_markdown_links.py +11 -0
  184. bytekit/models/scrape_request_markdown_mode.py +10 -0
  185. bytekit/models/scrape_request_token_encoding.py +9 -0
  186. bytekit/models/scrape_request_x_internal_scrape_path.py +8 -0
  187. bytekit/models/scrape_scored_image.py +128 -0
  188. bytekit/models/scrape_scored_link.py +94 -0
  189. bytekit/models/scrape_stats.py +75 -0
  190. bytekit/models/scrape_success_envelope.py +345 -0
  191. bytekit/models/scrape_success_envelope_cache.py +10 -0
  192. bytekit/models/scrape_success_envelope_custom.py +48 -0
  193. bytekit/models/scrape_success_envelope_schema_version.py +8 -0
  194. bytekit/models/scrape_success_envelope_status.py +8 -0
  195. bytekit/models/scrape_table.py +96 -0
  196. bytekit/models/scrape_table_kind.py +10 -0
  197. bytekit/models/scrape_warning.py +88 -0
  198. bytekit/models/scrape_warning_code.py +17 -0
  199. bytekit/models/screenshot_request.py +445 -0
  200. bytekit/models/screenshot_request_device.py +9 -0
  201. bytekit/models/screenshot_request_device_scale_factor_type_1.py +9 -0
  202. bytekit/models/screenshot_request_device_scale_factor_type_2_type_1.py +9 -0
  203. bytekit/models/screenshot_request_device_scale_factor_type_3_type_1.py +9 -0
  204. bytekit/models/screenshot_request_format.py +9 -0
  205. bytekit/models/screenshot_request_headers.py +44 -0
  206. bytekit/models/screenshot_request_wait_until.py +10 -0
  207. bytekit/models/screenshot_response.py +264 -0
  208. bytekit/models/screenshot_response_status.py +11 -0
  209. bytekit/models/sitemap_request.py +210 -0
  210. bytekit/models/sitemap_request_process_type_0.py +90 -0
  211. bytekit/models/sitemap_request_process_type_0_options.py +44 -0
  212. bytekit/models/sitemap_request_strategy.py +10 -0
  213. bytekit/models/sitemap_response.py +418 -0
  214. bytekit/models/sitemap_response_cache.py +10 -0
  215. bytekit/models/sitemap_response_metadata_type_0.py +44 -0
  216. bytekit/models/sitemap_response_process_type_0.py +44 -0
  217. bytekit/models/sitemap_response_sources_type_0.py +44 -0
  218. bytekit/models/sitemap_response_status.py +11 -0
  219. bytekit/models/viewport.py +67 -0
  220. bytekit/models/webhook_delivery_response.py +270 -0
  221. bytekit/models/webhook_delivery_response_event_type.py +14 -0
  222. bytekit/models/webhook_delivery_response_status.py +11 -0
  223. bytekit/py.typed +0 -0
  224. bytekit/types.py +54 -0
  225. bytekit_sdk-0.3.0.dist-info/METADATA +141 -0
  226. bytekit_sdk-0.3.0.dist-info/RECORD +227 -0
  227. bytekit_sdk-0.3.0.dist-info/WHEEL +4 -0
@@ -0,0 +1,191 @@
1
+ from http import HTTPStatus
2
+ from typing import Any, Optional, Union
3
+
4
+ import httpx
5
+
6
+ from ... import errors
7
+ from ...client import AuthenticatedClient, Client
8
+ from ...models.error import Error
9
+ from ...models.monitor_response import MonitorResponse
10
+ from ...models.monitor_update_request import MonitorUpdateRequest
11
+ from ...types import Response
12
+
13
+
14
+ def _get_kwargs(
15
+ id: str,
16
+ *,
17
+ body: MonitorUpdateRequest,
18
+ ) -> dict[str, Any]:
19
+ headers: dict[str, Any] = {}
20
+
21
+ _kwargs: dict[str, Any] = {
22
+ "method": "patch",
23
+ "url": "/v1/monitors/{id}".format(
24
+ id=id,
25
+ ),
26
+ }
27
+
28
+ _kwargs["json"] = body.to_dict()
29
+
30
+ headers["Content-Type"] = "application/json"
31
+
32
+ _kwargs["headers"] = headers
33
+ return _kwargs
34
+
35
+
36
+ def _parse_response(
37
+ *, client: Union[AuthenticatedClient, Client], response: httpx.Response
38
+ ) -> Optional[Union[Error, MonitorResponse]]:
39
+ if response.status_code == 200:
40
+ response_200 = MonitorResponse.from_dict(response.json())
41
+
42
+ return response_200
43
+ if response.status_code == 400:
44
+ response_400 = Error.from_dict(response.json())
45
+
46
+ return response_400
47
+ if response.status_code == 404:
48
+ response_404 = Error.from_dict(response.json())
49
+
50
+ return response_404
51
+ if response.status_code == 409:
52
+ response_409 = Error.from_dict(response.json())
53
+
54
+ return response_409
55
+ if response.status_code == 422:
56
+ response_422 = Error.from_dict(response.json())
57
+
58
+ return response_422
59
+ if client.raise_on_unexpected_status:
60
+ raise errors.UnexpectedStatus(response.status_code, response.content)
61
+ else:
62
+ return None
63
+
64
+
65
+ def _build_response(
66
+ *, client: Union[AuthenticatedClient, Client], response: httpx.Response
67
+ ) -> Response[Union[Error, MonitorResponse]]:
68
+ return Response(
69
+ status_code=HTTPStatus(response.status_code),
70
+ content=response.content,
71
+ headers=response.headers,
72
+ parsed=_parse_response(client=client, response=response),
73
+ )
74
+
75
+
76
+ def sync_detailed(
77
+ id: str,
78
+ *,
79
+ client: Union[AuthenticatedClient, Client],
80
+ body: MonitorUpdateRequest,
81
+ ) -> Response[Union[Error, MonitorResponse]]:
82
+ """Update monitor
83
+
84
+ Args:
85
+ id (str):
86
+ body (MonitorUpdateRequest):
87
+
88
+ Raises:
89
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
90
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
91
+
92
+ Returns:
93
+ Response[Union[Error, MonitorResponse]]
94
+ """
95
+
96
+ kwargs = _get_kwargs(
97
+ id=id,
98
+ body=body,
99
+ )
100
+
101
+ response = client.get_httpx_client().request(
102
+ **kwargs,
103
+ )
104
+
105
+ return _build_response(client=client, response=response)
106
+
107
+
108
+ def sync(
109
+ id: str,
110
+ *,
111
+ client: Union[AuthenticatedClient, Client],
112
+ body: MonitorUpdateRequest,
113
+ ) -> Optional[Union[Error, MonitorResponse]]:
114
+ """Update monitor
115
+
116
+ Args:
117
+ id (str):
118
+ body (MonitorUpdateRequest):
119
+
120
+ Raises:
121
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
122
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
123
+
124
+ Returns:
125
+ Union[Error, MonitorResponse]
126
+ """
127
+
128
+ return sync_detailed(
129
+ id=id,
130
+ client=client,
131
+ body=body,
132
+ ).parsed
133
+
134
+
135
+ async def asyncio_detailed(
136
+ id: str,
137
+ *,
138
+ client: Union[AuthenticatedClient, Client],
139
+ body: MonitorUpdateRequest,
140
+ ) -> Response[Union[Error, MonitorResponse]]:
141
+ """Update monitor
142
+
143
+ Args:
144
+ id (str):
145
+ body (MonitorUpdateRequest):
146
+
147
+ Raises:
148
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
149
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
150
+
151
+ Returns:
152
+ Response[Union[Error, MonitorResponse]]
153
+ """
154
+
155
+ kwargs = _get_kwargs(
156
+ id=id,
157
+ body=body,
158
+ )
159
+
160
+ response = await client.get_async_httpx_client().request(**kwargs)
161
+
162
+ return _build_response(client=client, response=response)
163
+
164
+
165
+ async def asyncio(
166
+ id: str,
167
+ *,
168
+ client: Union[AuthenticatedClient, Client],
169
+ body: MonitorUpdateRequest,
170
+ ) -> Optional[Union[Error, MonitorResponse]]:
171
+ """Update monitor
172
+
173
+ Args:
174
+ id (str):
175
+ body (MonitorUpdateRequest):
176
+
177
+ Raises:
178
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
179
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
180
+
181
+ Returns:
182
+ Union[Error, MonitorResponse]
183
+ """
184
+
185
+ return (
186
+ await asyncio_detailed(
187
+ id=id,
188
+ client=client,
189
+ body=body,
190
+ )
191
+ ).parsed
@@ -0,0 +1 @@
1
+ """Contains endpoint functions for accessing the API"""
@@ -0,0 +1,197 @@
1
+ from http import HTTPStatus
2
+ from typing import Any, Optional, Union
3
+
4
+ import httpx
5
+
6
+ from ... import errors
7
+ from ...client import AuthenticatedClient, Client
8
+ from ...models.error import Error
9
+ from ...models.scrape_queued_envelope import ScrapeQueuedEnvelope
10
+ from ...models.scrape_request import ScrapeRequest
11
+ from ...models.scrape_success_envelope import ScrapeSuccessEnvelope
12
+ from ...types import Response
13
+
14
+
15
+ def _get_kwargs(
16
+ *,
17
+ body: ScrapeRequest,
18
+ ) -> dict[str, Any]:
19
+ headers: dict[str, Any] = {}
20
+
21
+ _kwargs: dict[str, Any] = {
22
+ "method": "post",
23
+ "url": "/v1/scrape",
24
+ }
25
+
26
+ _kwargs["json"] = body.to_dict()
27
+
28
+ headers["Content-Type"] = "application/json"
29
+
30
+ _kwargs["headers"] = headers
31
+ return _kwargs
32
+
33
+
34
+ def _parse_response(
35
+ *, client: Union[AuthenticatedClient, Client], response: httpx.Response
36
+ ) -> Optional[Union[Error, ScrapeQueuedEnvelope, ScrapeSuccessEnvelope]]:
37
+ if response.status_code == 200:
38
+ response_200 = ScrapeSuccessEnvelope.from_dict(response.json())
39
+
40
+ return response_200
41
+ if response.status_code == 202:
42
+ response_202 = ScrapeQueuedEnvelope.from_dict(response.json())
43
+
44
+ return response_202
45
+ if response.status_code == 400:
46
+ response_400 = Error.from_dict(response.json())
47
+
48
+ return response_400
49
+ if response.status_code == 422:
50
+ response_422 = Error.from_dict(response.json())
51
+
52
+ return response_422
53
+ if response.status_code == 429:
54
+ response_429 = Error.from_dict(response.json())
55
+
56
+ return response_429
57
+ if response.status_code == 500:
58
+ response_500 = Error.from_dict(response.json())
59
+
60
+ return response_500
61
+ if client.raise_on_unexpected_status:
62
+ raise errors.UnexpectedStatus(response.status_code, response.content)
63
+ else:
64
+ return None
65
+
66
+
67
+ def _build_response(
68
+ *, client: Union[AuthenticatedClient, Client], response: httpx.Response
69
+ ) -> Response[Union[Error, ScrapeQueuedEnvelope, ScrapeSuccessEnvelope]]:
70
+ return Response(
71
+ status_code=HTTPStatus(response.status_code),
72
+ content=response.content,
73
+ headers=response.headers,
74
+ parsed=_parse_response(client=client, response=response),
75
+ )
76
+
77
+
78
+ def sync_detailed(
79
+ *,
80
+ client: Union[AuthenticatedClient, Client],
81
+ body: ScrapeRequest,
82
+ ) -> Response[Union[Error, ScrapeQueuedEnvelope, ScrapeSuccessEnvelope]]:
83
+ """Scrape a URL
84
+
85
+ Fetches and processes a URL, returning content in one or more formats wrapped in a ScrapeEnvelope.
86
+ Most requests return synchronously in under a second; requests needing a full page render return
87
+ HTTP 202 and complete asynchronously.
88
+
89
+ Args:
90
+ body (ScrapeRequest):
91
+
92
+ Raises:
93
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
94
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
95
+
96
+ Returns:
97
+ Response[Union[Error, ScrapeQueuedEnvelope, ScrapeSuccessEnvelope]]
98
+ """
99
+
100
+ kwargs = _get_kwargs(
101
+ body=body,
102
+ )
103
+
104
+ response = client.get_httpx_client().request(
105
+ **kwargs,
106
+ )
107
+
108
+ return _build_response(client=client, response=response)
109
+
110
+
111
+ def sync(
112
+ *,
113
+ client: Union[AuthenticatedClient, Client],
114
+ body: ScrapeRequest,
115
+ ) -> Optional[Union[Error, ScrapeQueuedEnvelope, ScrapeSuccessEnvelope]]:
116
+ """Scrape a URL
117
+
118
+ Fetches and processes a URL, returning content in one or more formats wrapped in a ScrapeEnvelope.
119
+ Most requests return synchronously in under a second; requests needing a full page render return
120
+ HTTP 202 and complete asynchronously.
121
+
122
+ Args:
123
+ body (ScrapeRequest):
124
+
125
+ Raises:
126
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
127
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
128
+
129
+ Returns:
130
+ Union[Error, ScrapeQueuedEnvelope, ScrapeSuccessEnvelope]
131
+ """
132
+
133
+ return sync_detailed(
134
+ client=client,
135
+ body=body,
136
+ ).parsed
137
+
138
+
139
+ async def asyncio_detailed(
140
+ *,
141
+ client: Union[AuthenticatedClient, Client],
142
+ body: ScrapeRequest,
143
+ ) -> Response[Union[Error, ScrapeQueuedEnvelope, ScrapeSuccessEnvelope]]:
144
+ """Scrape a URL
145
+
146
+ Fetches and processes a URL, returning content in one or more formats wrapped in a ScrapeEnvelope.
147
+ Most requests return synchronously in under a second; requests needing a full page render return
148
+ HTTP 202 and complete asynchronously.
149
+
150
+ Args:
151
+ body (ScrapeRequest):
152
+
153
+ Raises:
154
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
155
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
156
+
157
+ Returns:
158
+ Response[Union[Error, ScrapeQueuedEnvelope, ScrapeSuccessEnvelope]]
159
+ """
160
+
161
+ kwargs = _get_kwargs(
162
+ body=body,
163
+ )
164
+
165
+ response = await client.get_async_httpx_client().request(**kwargs)
166
+
167
+ return _build_response(client=client, response=response)
168
+
169
+
170
+ async def asyncio(
171
+ *,
172
+ client: Union[AuthenticatedClient, Client],
173
+ body: ScrapeRequest,
174
+ ) -> Optional[Union[Error, ScrapeQueuedEnvelope, ScrapeSuccessEnvelope]]:
175
+ """Scrape a URL
176
+
177
+ Fetches and processes a URL, returning content in one or more formats wrapped in a ScrapeEnvelope.
178
+ Most requests return synchronously in under a second; requests needing a full page render return
179
+ HTTP 202 and complete asynchronously.
180
+
181
+ Args:
182
+ body (ScrapeRequest):
183
+
184
+ Raises:
185
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
186
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
187
+
188
+ Returns:
189
+ Union[Error, ScrapeQueuedEnvelope, ScrapeSuccessEnvelope]
190
+ """
191
+
192
+ return (
193
+ await asyncio_detailed(
194
+ client=client,
195
+ body=body,
196
+ )
197
+ ).parsed
@@ -0,0 +1,231 @@
1
+ from http import HTTPStatus
2
+ from typing import Any, Optional, Union
3
+
4
+ import httpx
5
+
6
+ from ... import errors
7
+ from ...client import AuthenticatedClient, Client
8
+ from ...models.error import Error
9
+ from ...models.scrape_error_envelope import ScrapeErrorEnvelope
10
+ from ...models.scrape_queued_envelope import ScrapeQueuedEnvelope
11
+ from ...models.scrape_success_envelope import ScrapeSuccessEnvelope
12
+ from ...types import Response
13
+
14
+
15
+ def _get_kwargs(
16
+ id: str,
17
+ ) -> dict[str, Any]:
18
+ _kwargs: dict[str, Any] = {
19
+ "method": "get",
20
+ "url": "/v1/scrape/{id}".format(
21
+ id=id,
22
+ ),
23
+ }
24
+
25
+ return _kwargs
26
+
27
+
28
+ def _parse_response(
29
+ *, client: Union[AuthenticatedClient, Client], response: httpx.Response
30
+ ) -> Optional[
31
+ Union[
32
+ Error,
33
+ Union["ScrapeErrorEnvelope", "ScrapeQueuedEnvelope", "ScrapeSuccessEnvelope"],
34
+ ]
35
+ ]:
36
+ if response.status_code == 200:
37
+
38
+ def _parse_response_200(
39
+ data: object,
40
+ ) -> Union[
41
+ "ScrapeErrorEnvelope", "ScrapeQueuedEnvelope", "ScrapeSuccessEnvelope"
42
+ ]:
43
+ try:
44
+ if not isinstance(data, dict):
45
+ raise TypeError()
46
+ componentsschemas_scrape_envelope_type_0 = (
47
+ ScrapeSuccessEnvelope.from_dict(data)
48
+ )
49
+
50
+ return componentsschemas_scrape_envelope_type_0
51
+ except: # noqa: E722
52
+ pass
53
+ try:
54
+ if not isinstance(data, dict):
55
+ raise TypeError()
56
+ componentsschemas_scrape_envelope_type_1 = (
57
+ ScrapeErrorEnvelope.from_dict(data)
58
+ )
59
+
60
+ return componentsschemas_scrape_envelope_type_1
61
+ except: # noqa: E722
62
+ pass
63
+ if not isinstance(data, dict):
64
+ raise TypeError()
65
+ componentsschemas_scrape_envelope_type_2 = ScrapeQueuedEnvelope.from_dict(
66
+ data
67
+ )
68
+
69
+ return componentsschemas_scrape_envelope_type_2
70
+
71
+ response_200 = _parse_response_200(response.json())
72
+
73
+ return response_200
74
+ if response.status_code == 404:
75
+ response_404 = Error.from_dict(response.json())
76
+
77
+ return response_404
78
+ if client.raise_on_unexpected_status:
79
+ raise errors.UnexpectedStatus(response.status_code, response.content)
80
+ else:
81
+ return None
82
+
83
+
84
+ def _build_response(
85
+ *, client: Union[AuthenticatedClient, Client], response: httpx.Response
86
+ ) -> Response[
87
+ Union[
88
+ Error,
89
+ Union["ScrapeErrorEnvelope", "ScrapeQueuedEnvelope", "ScrapeSuccessEnvelope"],
90
+ ]
91
+ ]:
92
+ return Response(
93
+ status_code=HTTPStatus(response.status_code),
94
+ content=response.content,
95
+ headers=response.headers,
96
+ parsed=_parse_response(client=client, response=response),
97
+ )
98
+
99
+
100
+ def sync_detailed(
101
+ id: str,
102
+ *,
103
+ client: Union[AuthenticatedClient, Client],
104
+ ) -> Response[
105
+ Union[
106
+ Error,
107
+ Union["ScrapeErrorEnvelope", "ScrapeQueuedEnvelope", "ScrapeSuccessEnvelope"],
108
+ ]
109
+ ]:
110
+ """Get scrape result
111
+
112
+ Always returns 200. Check the `status` discriminator for the scrape state.
113
+
114
+ Args:
115
+ id (str):
116
+
117
+ Raises:
118
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
119
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
120
+
121
+ Returns:
122
+ Response[Union[Error, Union['ScrapeErrorEnvelope', 'ScrapeQueuedEnvelope', 'ScrapeSuccessEnvelope']]]
123
+ """
124
+
125
+ kwargs = _get_kwargs(
126
+ id=id,
127
+ )
128
+
129
+ response = client.get_httpx_client().request(
130
+ **kwargs,
131
+ )
132
+
133
+ return _build_response(client=client, response=response)
134
+
135
+
136
+ def sync(
137
+ id: str,
138
+ *,
139
+ client: Union[AuthenticatedClient, Client],
140
+ ) -> Optional[
141
+ Union[
142
+ Error,
143
+ Union["ScrapeErrorEnvelope", "ScrapeQueuedEnvelope", "ScrapeSuccessEnvelope"],
144
+ ]
145
+ ]:
146
+ """Get scrape result
147
+
148
+ Always returns 200. Check the `status` discriminator for the scrape state.
149
+
150
+ Args:
151
+ id (str):
152
+
153
+ Raises:
154
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
155
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
156
+
157
+ Returns:
158
+ Union[Error, Union['ScrapeErrorEnvelope', 'ScrapeQueuedEnvelope', 'ScrapeSuccessEnvelope']]
159
+ """
160
+
161
+ return sync_detailed(
162
+ id=id,
163
+ client=client,
164
+ ).parsed
165
+
166
+
167
+ async def asyncio_detailed(
168
+ id: str,
169
+ *,
170
+ client: Union[AuthenticatedClient, Client],
171
+ ) -> Response[
172
+ Union[
173
+ Error,
174
+ Union["ScrapeErrorEnvelope", "ScrapeQueuedEnvelope", "ScrapeSuccessEnvelope"],
175
+ ]
176
+ ]:
177
+ """Get scrape result
178
+
179
+ Always returns 200. Check the `status` discriminator for the scrape state.
180
+
181
+ Args:
182
+ id (str):
183
+
184
+ Raises:
185
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
186
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
187
+
188
+ Returns:
189
+ Response[Union[Error, Union['ScrapeErrorEnvelope', 'ScrapeQueuedEnvelope', 'ScrapeSuccessEnvelope']]]
190
+ """
191
+
192
+ kwargs = _get_kwargs(
193
+ id=id,
194
+ )
195
+
196
+ response = await client.get_async_httpx_client().request(**kwargs)
197
+
198
+ return _build_response(client=client, response=response)
199
+
200
+
201
+ async def asyncio(
202
+ id: str,
203
+ *,
204
+ client: Union[AuthenticatedClient, Client],
205
+ ) -> Optional[
206
+ Union[
207
+ Error,
208
+ Union["ScrapeErrorEnvelope", "ScrapeQueuedEnvelope", "ScrapeSuccessEnvelope"],
209
+ ]
210
+ ]:
211
+ """Get scrape result
212
+
213
+ Always returns 200. Check the `status` discriminator for the scrape state.
214
+
215
+ Args:
216
+ id (str):
217
+
218
+ Raises:
219
+ errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
220
+ httpx.TimeoutException: If the request takes longer than Client.timeout.
221
+
222
+ Returns:
223
+ Union[Error, Union['ScrapeErrorEnvelope', 'ScrapeQueuedEnvelope', 'ScrapeSuccessEnvelope']]
224
+ """
225
+
226
+ return (
227
+ await asyncio_detailed(
228
+ id=id,
229
+ client=client,
230
+ )
231
+ ).parsed
@@ -0,0 +1 @@
1
+ """Contains endpoint functions for accessing the API"""