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.
- bytekit/__init__.py +8 -0
- bytekit/api/__init__.py +1 -0
- bytekit/api/account/__init__.py +1 -0
- bytekit/api/account/get_account.py +157 -0
- bytekit/api/bulk/__init__.py +1 -0
- bytekit/api/bulk/create_bulk.py +204 -0
- bytekit/api/bulk/delete_bulk.py +177 -0
- bytekit/api/bulk/get_bulk.py +157 -0
- bytekit/api/bulk/list_bulk_screenshots.py +152 -0
- bytekit/api/fetch/__init__.py +1 -0
- bytekit/api/fetch/get_fetch.py +254 -0
- bytekit/api/fetch/post_fetch.py +178 -0
- bytekit/api/fetch_bulk/__init__.py +1 -0
- bytekit/api/fetch_bulk/create_fetch_bulk.py +180 -0
- bytekit/api/fetch_bulk/get_fetch_bulk.py +157 -0
- bytekit/api/monitors/__init__.py +1 -0
- bytekit/api/monitors/create_monitor.py +180 -0
- bytekit/api/monitors/delete_monitor.py +155 -0
- bytekit/api/monitors/get_monitor.py +157 -0
- bytekit/api/monitors/list_monitor_captures.py +188 -0
- bytekit/api/monitors/list_monitors.py +193 -0
- bytekit/api/monitors/update_monitor.py +191 -0
- bytekit/api/scrape/__init__.py +1 -0
- bytekit/api/scrape/create_scrape.py +197 -0
- bytekit/api/scrape/get_scrape.py +231 -0
- bytekit/api/scrape_bulk/__init__.py +1 -0
- bytekit/api/scrape_bulk/create_scrape_bulk.py +188 -0
- bytekit/api/scrape_bulk/get_scrape_bulk.py +157 -0
- bytekit/api/screenshots/__init__.py +1 -0
- bytekit/api/screenshots/create_screenshot.py +208 -0
- bytekit/api/screenshots/get_screenshot.py +177 -0
- bytekit/api/search/__init__.py +1 -0
- bytekit/api/search/create_search.py +225 -0
- bytekit/api/sitemap/__init__.py +1 -0
- bytekit/api/sitemap/create_sitemap.py +192 -0
- bytekit/api/sitemap/get_sitemap.py +157 -0
- bytekit/api/usage/__init__.py +1 -0
- bytekit/api/usage/get_usage.py +126 -0
- bytekit/api/usage/get_usage_by_endpoint.py +215 -0
- bytekit/api/usage/get_usage_daily.py +203 -0
- bytekit/api/webhooks/__init__.py +1 -0
- bytekit/api/webhooks/list_webhook_deliveries.py +214 -0
- bytekit/api/webhooks/retry_webhook_delivery.py +165 -0
- bytekit/client.py +418 -0
- bytekit/errors.py +18 -0
- bytekit/models/__init__.py +401 -0
- bytekit/models/account_bearer_response.py +207 -0
- bytekit/models/account_bearer_response_api_key.py +134 -0
- bytekit/models/account_bearer_response_api_key_environment.py +8 -0
- bytekit/models/account_bearer_response_auto_topup.py +83 -0
- bytekit/models/account_bearer_response_plan.py +150 -0
- bytekit/models/account_bearer_response_subscription.py +85 -0
- bytekit/models/account_bearer_response_subscription_plan.py +99 -0
- bytekit/models/account_bearer_response_subscription_status.py +10 -0
- bytekit/models/account_session_response.py +164 -0
- bytekit/models/account_session_response_notifications.py +51 -0
- bytekit/models/account_session_response_plan.py +150 -0
- bytekit/models/bandwidth_balance.py +91 -0
- bytekit/models/capture_response.py +216 -0
- bytekit/models/capture_response_outcome.py +10 -0
- bytekit/models/clip.py +83 -0
- bytekit/models/cookie.py +90 -0
- bytekit/models/create_bulk_body.py +155 -0
- bytekit/models/create_bulk_body_defaults.py +423 -0
- bytekit/models/create_bulk_body_defaults_device.py +9 -0
- bytekit/models/create_bulk_body_defaults_device_scale_factor_type_1.py +9 -0
- bytekit/models/create_bulk_body_defaults_device_scale_factor_type_2_type_1.py +9 -0
- bytekit/models/create_bulk_body_defaults_device_scale_factor_type_3_type_1.py +9 -0
- bytekit/models/create_bulk_body_defaults_formats_item.py +12 -0
- bytekit/models/create_bulk_body_defaults_type.py +9 -0
- bytekit/models/create_bulk_body_defaults_viewport_type_0.py +67 -0
- bytekit/models/create_bulk_body_defaults_wait_until.py +10 -0
- bytekit/models/create_bulk_body_items_item.py +380 -0
- bytekit/models/create_bulk_body_items_item_device.py +9 -0
- bytekit/models/create_bulk_body_items_item_formats_item.py +12 -0
- bytekit/models/create_bulk_body_items_item_scenario.py +10 -0
- bytekit/models/create_bulk_body_items_item_type.py +9 -0
- bytekit/models/create_bulk_body_items_item_viewport_type_0.py +67 -0
- bytekit/models/create_bulk_body_items_item_wait_until.py +10 -0
- bytekit/models/create_bulk_response_202.py +164 -0
- bytekit/models/create_bulk_response_202_status.py +10 -0
- bytekit/models/create_fetch_bulk_body.py +161 -0
- bytekit/models/create_fetch_bulk_body_defaults.py +91 -0
- bytekit/models/create_fetch_bulk_body_defaults_format.py +9 -0
- bytekit/models/create_fetch_bulk_body_metadata.py +44 -0
- bytekit/models/create_fetch_bulk_body_urls_item_type_1.py +102 -0
- bytekit/models/create_fetch_bulk_body_urls_item_type_1_format.py +9 -0
- bytekit/models/create_fetch_bulk_response_202.py +44 -0
- bytekit/models/create_scrape_bulk_body.py +179 -0
- bytekit/models/create_scrape_bulk_body_custom.py +52 -0
- bytekit/models/create_scrape_bulk_body_defaults.py +167 -0
- bytekit/models/create_scrape_bulk_body_defaults_formats_item.py +12 -0
- bytekit/models/create_scrape_bulk_body_defaults_headers.py +44 -0
- bytekit/models/create_scrape_bulk_body_items_item.py +226 -0
- bytekit/models/create_scrape_bulk_body_items_item_custom.py +50 -0
- bytekit/models/create_scrape_bulk_body_items_item_formats_item.py +12 -0
- bytekit/models/create_scrape_bulk_body_items_item_headers.py +44 -0
- bytekit/models/create_scrape_bulk_body_items_item_metadata.py +44 -0
- bytekit/models/create_scrape_bulk_response_202.py +166 -0
- bytekit/models/create_scrape_bulk_response_202_status.py +10 -0
- bytekit/models/create_search_body.py +140 -0
- bytekit/models/create_search_body_date_range.py +13 -0
- bytekit/models/create_search_body_type.py +10 -0
- bytekit/models/create_search_response_200.py +119 -0
- bytekit/models/create_search_response_200_results_item.py +161 -0
- bytekit/models/create_search_response_200_results_item_image.py +113 -0
- bytekit/models/create_search_response_502.py +46 -0
- bytekit/models/create_search_response_502_error.py +8 -0
- bytekit/models/credit_balance.py +91 -0
- bytekit/models/delete_bulk_response_200.py +164 -0
- bytekit/models/delete_bulk_response_200_status.py +11 -0
- bytekit/models/error.py +83 -0
- bytekit/models/error_error.py +100 -0
- bytekit/models/error_status.py +8 -0
- bytekit/models/fetch_request.py +276 -0
- bytekit/models/fetch_request_cache_ttl_type_1.py +8 -0
- bytekit/models/fetch_request_custom.py +48 -0
- bytekit/models/fetch_request_format.py +9 -0
- bytekit/models/fetch_request_markdown_images.py +11 -0
- bytekit/models/fetch_request_markdown_links.py +11 -0
- bytekit/models/fetch_request_markdown_mode.py +10 -0
- bytekit/models/get_bulk_response_200.py +164 -0
- bytekit/models/get_bulk_response_200_status.py +11 -0
- bytekit/models/get_fetch_bulk_response_200.py +44 -0
- bytekit/models/get_fetch_cache_ttl_type_1.py +8 -0
- bytekit/models/get_fetch_format.py +9 -0
- bytekit/models/get_scrape_bulk_response_200.py +164 -0
- bytekit/models/get_scrape_bulk_response_200_status.py +11 -0
- bytekit/models/get_usage_by_endpoint_response_200.py +114 -0
- bytekit/models/get_usage_by_endpoint_response_200_rows_item.py +90 -0
- bytekit/models/get_usage_by_endpoint_response_200_rows_item_endpoint.py +17 -0
- bytekit/models/get_usage_by_endpoint_response_200_totals.py +67 -0
- bytekit/models/get_usage_daily_response_200.py +97 -0
- bytekit/models/get_usage_daily_response_200_data_item.py +219 -0
- bytekit/models/get_usage_response_200.py +344 -0
- bytekit/models/get_usage_response_200_plan_type.py +10 -0
- bytekit/models/list_bulk_screenshots_response_200.py +44 -0
- bytekit/models/list_monitor_captures_response_200.py +101 -0
- bytekit/models/list_monitors_response_200.py +101 -0
- bytekit/models/list_monitors_status.py +12 -0
- bytekit/models/list_webhook_deliveries_response_200.py +101 -0
- bytekit/models/list_webhook_deliveries_status.py +11 -0
- bytekit/models/metadata.py +44 -0
- bytekit/models/monitor_create_request.py +219 -0
- bytekit/models/monitor_create_request_interval_type.py +11 -0
- bytekit/models/monitor_create_request_notify_on.py +9 -0
- bytekit/models/monitor_create_request_options.py +44 -0
- bytekit/models/monitor_create_request_scrape_options.py +44 -0
- bytekit/models/monitor_create_request_type.py +9 -0
- bytekit/models/monitor_create_request_webhook_headers.py +44 -0
- bytekit/models/monitor_create_response.py +423 -0
- bytekit/models/monitor_response.py +411 -0
- bytekit/models/monitor_response_interval_type.py +11 -0
- bytekit/models/monitor_response_metadata_type_0.py +44 -0
- bytekit/models/monitor_response_status.py +12 -0
- bytekit/models/monitor_response_type.py +9 -0
- bytekit/models/monitor_response_webhook_headers_type_0.py +44 -0
- bytekit/models/monitor_update_request.py +223 -0
- bytekit/models/monitor_update_request_interval_type.py +11 -0
- bytekit/models/monitor_update_request_notify_on.py +9 -0
- bytekit/models/monitor_update_request_options.py +44 -0
- bytekit/models/monitor_update_request_scrape_options.py +44 -0
- bytekit/models/monitor_update_request_status.py +9 -0
- bytekit/models/monitor_update_request_webhook_headers.py +44 -0
- bytekit/models/scrape_error_envelope.py +113 -0
- bytekit/models/scrape_error_envelope_error.py +93 -0
- bytekit/models/scrape_error_envelope_error_code.py +18 -0
- bytekit/models/scrape_error_envelope_schema_version.py +8 -0
- bytekit/models/scrape_error_envelope_status.py +8 -0
- bytekit/models/scrape_formats.py +183 -0
- bytekit/models/scrape_markdown_tokens.py +75 -0
- bytekit/models/scrape_metadata.py +262 -0
- bytekit/models/scrape_queued_envelope.py +124 -0
- bytekit/models/scrape_queued_envelope_schema_version.py +8 -0
- bytekit/models/scrape_queued_envelope_status.py +8 -0
- bytekit/models/scrape_request.py +485 -0
- bytekit/models/scrape_request_cache_ttl_type_1.py +8 -0
- bytekit/models/scrape_request_custom.py +48 -0
- bytekit/models/scrape_request_events_item.py +10 -0
- bytekit/models/scrape_request_formats_item.py +12 -0
- bytekit/models/scrape_request_headers.py +44 -0
- bytekit/models/scrape_request_markdown_images.py +11 -0
- bytekit/models/scrape_request_markdown_links.py +11 -0
- bytekit/models/scrape_request_markdown_mode.py +10 -0
- bytekit/models/scrape_request_token_encoding.py +9 -0
- bytekit/models/scrape_request_x_internal_scrape_path.py +8 -0
- bytekit/models/scrape_scored_image.py +128 -0
- bytekit/models/scrape_scored_link.py +94 -0
- bytekit/models/scrape_stats.py +75 -0
- bytekit/models/scrape_success_envelope.py +345 -0
- bytekit/models/scrape_success_envelope_cache.py +10 -0
- bytekit/models/scrape_success_envelope_custom.py +48 -0
- bytekit/models/scrape_success_envelope_schema_version.py +8 -0
- bytekit/models/scrape_success_envelope_status.py +8 -0
- bytekit/models/scrape_table.py +96 -0
- bytekit/models/scrape_table_kind.py +10 -0
- bytekit/models/scrape_warning.py +88 -0
- bytekit/models/scrape_warning_code.py +17 -0
- bytekit/models/screenshot_request.py +445 -0
- bytekit/models/screenshot_request_device.py +9 -0
- bytekit/models/screenshot_request_device_scale_factor_type_1.py +9 -0
- bytekit/models/screenshot_request_device_scale_factor_type_2_type_1.py +9 -0
- bytekit/models/screenshot_request_device_scale_factor_type_3_type_1.py +9 -0
- bytekit/models/screenshot_request_format.py +9 -0
- bytekit/models/screenshot_request_headers.py +44 -0
- bytekit/models/screenshot_request_wait_until.py +10 -0
- bytekit/models/screenshot_response.py +264 -0
- bytekit/models/screenshot_response_status.py +11 -0
- bytekit/models/sitemap_request.py +210 -0
- bytekit/models/sitemap_request_process_type_0.py +90 -0
- bytekit/models/sitemap_request_process_type_0_options.py +44 -0
- bytekit/models/sitemap_request_strategy.py +10 -0
- bytekit/models/sitemap_response.py +418 -0
- bytekit/models/sitemap_response_cache.py +10 -0
- bytekit/models/sitemap_response_metadata_type_0.py +44 -0
- bytekit/models/sitemap_response_process_type_0.py +44 -0
- bytekit/models/sitemap_response_sources_type_0.py +44 -0
- bytekit/models/sitemap_response_status.py +11 -0
- bytekit/models/viewport.py +67 -0
- bytekit/models/webhook_delivery_response.py +270 -0
- bytekit/models/webhook_delivery_response_event_type.py +14 -0
- bytekit/models/webhook_delivery_response_status.py +11 -0
- bytekit/py.typed +0 -0
- bytekit/types.py +54 -0
- bytekit_sdk-0.3.0.dist-info/METADATA +141 -0
- bytekit_sdk-0.3.0.dist-info/RECORD +227 -0
- 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"""
|