ghostcrawl 2.3.7 → 2.3.8
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.
- checksums.yaml +4 -4
- data/README.md +12 -4
- data/_generated/{ghostcrawl_client.rb → ghost_crawl_client.rb} +1 -1
- data/_generated/models/arrival_body.rb +1 -1
- data/_generated/models/arrival_body_profile_id_member1.rb +1 -1
- data/_generated/models/arrival_body_session_id_member1.rb +1 -1
- data/_generated/models/batch_scrape_request.rb +1 -1
- data/_generated/models/batch_scrape_request_behavior_actions_member1.rb +1 -1
- data/_generated/models/batch_scrape_request_behavior_actions_member2.rb +1 -1
- data/_generated/models/batch_scrape_request_extraction_strategy_member1.rb +1 -1
- data/_generated/models/batch_scrape_request_identity_country_member1.rb +1 -1
- data/_generated/models/batch_scrape_request_language_member1.rb +1 -1
- data/_generated/models/batch_scrape_request_profile_member1.rb +1 -1
- data/_generated/models/cdp_frame_request.rb +1 -1
- data/_generated/models/cdp_input_request.rb +650 -0
- data/_generated/models/{agent_request_task_steps_schema.rb → cdp_input_request_button_member1.rb} +5 -7
- data/_generated/models/cdp_input_request_step_type.rb +9 -0
- data/_generated/models/cdp_input_request_text_member1.rb +62 -0
- data/_generated/models/cdp_input_request_url_member1.rb +62 -0
- data/_generated/models/{profile_update_request_name_member1.rb → cdp_input_request_wait_until_member1.rb} +5 -5
- data/_generated/models/cdp_input_request_x_member1.rb +62 -0
- data/_generated/models/cdp_input_request_y_member1.rb +62 -0
- data/_generated/models/cdp_url_request.rb +1 -1
- data/_generated/models/close_popups_body.rb +1 -1
- data/_generated/models/close_popups_body_keep_host_member1.rb +1 -1
- data/_generated/models/close_popups_body_profile_id_member1.rb +1 -1
- data/_generated/models/content_request.rb +22 -1
- data/_generated/models/content_request_identity_country_member1.rb +1 -1
- data/_generated/models/content_request_identity_member1.rb +1 -1
- data/_generated/models/content_request_language_member1.rb +1 -1
- data/_generated/models/content_request_profile_member1.rb +1 -1
- data/_generated/models/content_request_proxy_member1.rb +1 -1
- data/_generated/models/cookie_dict.rb +1 -1
- data/_generated/models/cookie_dict_domain_member1.rb +1 -1
- data/_generated/models/cookie_dict_expires_member1.rb +1 -1
- data/_generated/models/cookie_dict_http_only_member1.rb +1 -1
- data/_generated/models/cookie_dict_path_member1.rb +1 -1
- data/_generated/models/cookie_dict_same_site_member1.rb +1 -1
- data/_generated/models/cookie_dict_secure_member1.rb +1 -1
- data/_generated/models/cookie_dict_url_member1.rb +1 -1
- data/_generated/models/cookies_delete_body.rb +95 -4
- data/_generated/models/cookies_delete_body_domain_member1.rb +1 -1
- data/_generated/models/cookies_delete_body_name_member1.rb +1 -1
- data/_generated/models/cookies_delete_body_path_member1.rb +1 -1
- data/_generated/models/cookies_delete_body_profile_id_member1.rb +62 -0
- data/_generated/models/cookies_set_body.rb +95 -4
- data/_generated/models/cookies_set_body_profile_id_member1.rb +62 -0
- data/_generated/models/deep_crawl_body.rb +1 -1
- data/_generated/models/deep_crawl_body_timeout_s_member1.rb +1 -1
- data/_generated/models/deep_crawl_body_wait_until_member1.rb +1 -1
- data/_generated/models/deep_crawl_body_webhook_url_member1.rb +1 -1
- data/_generated/models/dom_snapshot_body.rb +95 -4
- data/_generated/models/dom_snapshot_body_profile_id_member1.rb +62 -0
- data/_generated/models/download_body.rb +95 -4
- data/_generated/models/download_body_profile_id_member1.rb +62 -0
- data/_generated/models/error_code.rb +1 -0
- data/_generated/models/eval_body.rb +166 -4
- data/_generated/models/eval_body_profile_id_member1.rb +62 -0
- data/_generated/models/eval_body_session_id_member1.rb +62 -0
- data/_generated/models/extend_body.rb +1 -1
- data/_generated/models/extend_body_ttl_seconds_member1.rb +1 -1
- data/_generated/models/extract_request.rb +29 -8
- data/_generated/models/extract_request_behavior_actions_member1.rb +1 -1
- data/_generated/models/extract_request_behavior_actions_member2.rb +1 -1
- data/_generated/models/extract_request_identity_country_member1.rb +1 -1
- data/_generated/models/extract_request_language_member1.rb +1 -1
- data/_generated/models/extract_request_prompt_member1.rb +1 -1
- data/_generated/models/extract_request_url_member1.rb +1 -1
- data/_generated/models/extract_request_urls_member1.rb +1 -1
- data/_generated/models/filter_spec.rb +1 -1
- data/_generated/models/{profile_update_request.rb → ghostcrawl_api_routes_profiles_profile_update_request.rb} +41 -41
- data/_generated/models/ghostcrawl_api_routes_profiles_profile_update_request_name_member1.rb +62 -0
- data/_generated/models/ghostcrawl_api_routes_profiles_profile_update_request_storage_state_id_member1.rb +62 -0
- data/_generated/models/har_body.rb +1 -1
- data/_generated/models/map_body.rb +1 -1
- data/_generated/models/map_body_search_member1.rb +1 -1
- data/_generated/models/map_response.rb +1 -1
- data/_generated/models/map_response_truncated_to_server_max_member1.rb +1 -1
- data/_generated/models/models.rb +26 -13
- data/_generated/models/mouse_body.rb +1 -1
- data/_generated/models/mouse_body_ops.rb +1 -1
- data/_generated/models/mouse_body_profile_id_member1.rb +1 -1
- data/_generated/models/mouse_body_session_id_member1.rb +1 -1
- data/_generated/models/pdf_request.rb +22 -1
- data/_generated/models/pdf_request_identity_country_member1.rb +1 -1
- data/_generated/models/pdf_request_identity_member1.rb +1 -1
- data/_generated/models/pdf_request_language_member1.rb +1 -1
- data/_generated/models/pdf_request_profile_member1.rb +1 -1
- data/_generated/models/pdf_request_proxy_member1.rb +1 -1
- data/_generated/models/problem_details.rb +1 -1
- data/_generated/models/profile_create_request.rb +1 -1
- data/_generated/models/profile_create_request_storage_state_id_member1.rb +1 -1
- data/_generated/models/retry_delivery_response.rb +1 -1
- data/_generated/models/rotate_secret_response.rb +1 -1
- data/_generated/models/schedule_create_request.rb +1 -1
- data/_generated/models/schedule_create_request_job_params.rb +1 -1
- data/_generated/models/schedule_create_request_notify_webhook_member1.rb +1 -1
- data/_generated/models/scorer_spec.rb +1 -1
- data/_generated/models/scrape_page_result.rb +1 -1
- data/_generated/models/scrape_request.rb +46 -4
- data/_generated/models/scrape_request_behavior_actions_member1.rb +1 -1
- data/_generated/models/scrape_request_behavior_actions_member2.rb +1 -1
- data/_generated/models/scrape_request_device.rb +14 -0
- data/_generated/models/scrape_request_identity_country_member1.rb +1 -1
- data/_generated/models/scrape_request_identity_member1.rb +1 -1
- data/_generated/models/scrape_request_language_member1.rb +1 -1
- data/_generated/models/scrape_request_profile_member1.rb +1 -1
- data/_generated/models/scrape_request_proxy_member1.rb +1 -1
- data/_generated/models/scrape_request_screenshot_selector_member1.rb +1 -1
- data/_generated/models/scrape_request_session_member1.rb +1 -1
- data/_generated/models/scrape_request_timeout_ms_member1.rb +1 -1
- data/_generated/models/scrape_request_url_member1.rb +1 -1
- data/_generated/models/scrape_request_urls_member1.rb +1 -1
- data/_generated/models/scrape_result.rb +1 -1
- data/_generated/models/scrape_result_format_member1.rb +1 -1
- data/_generated/models/scrape_result_identity_id_member1.rb +1 -1
- data/_generated/models/scrape_result_markdown_member1.rb +1 -1
- data/_generated/models/scrape_result_status_member1.rb +1 -1
- data/_generated/models/scrape_result_token_estimate_member1.rb +1 -1
- data/_generated/models/scrape_result_warnings_member1.rb +1 -1
- data/_generated/models/screenshot_request.rb +22 -1
- data/_generated/models/screenshot_request_identity_country_member1.rb +1 -1
- data/_generated/models/screenshot_request_identity_member1.rb +1 -1
- data/_generated/models/screenshot_request_language_member1.rb +1 -1
- data/_generated/models/screenshot_request_profile_member1.rb +1 -1
- data/_generated/models/screenshot_request_proxy_member1.rb +1 -1
- data/_generated/models/screenshot_request_screenshot_selector_member1.rb +1 -1
- data/_generated/models/scroll_body.rb +258 -4
- data/_generated/models/scroll_body_distance_px_member1.rb +1 -1
- data/_generated/models/scroll_body_dy_member1.rb +62 -0
- data/_generated/models/scroll_body_profile_id_member1.rb +62 -0
- data/_generated/models/scroll_body_selector_member1.rb +1 -1
- data/_generated/models/scroll_body_session_id_member1.rb +62 -0
- data/_generated/models/search_request.rb +4 -4
- data/_generated/models/search_request_country_member1.rb +1 -1
- data/_generated/models/search_request_engine_member1.rb +1 -1
- data/_generated/models/search_request_freshness_member1.rb +1 -1
- data/_generated/models/search_request_vertical_member1.rb +1 -1
- data/_generated/models/session_create_request.rb +204 -1
- data/_generated/models/session_create_request_device.rb +15 -0
- data/_generated/models/session_create_request_device_seed_member1.rb +62 -0
- data/_generated/models/{profile_update_request_storage_state_id_member1.rb → session_create_request_identity_country_member1.rb} +5 -5
- data/_generated/models/session_create_request_profile_member1.rb +1 -1
- data/_generated/models/storage_state_attach_request.rb +1 -1
- data/_generated/models/storage_state_detach_request.rb +1 -1
- data/_generated/models/tab_visit_body.rb +1 -1
- data/_generated/models/tab_visit_body_profile_id_member1.rb +1 -1
- data/_generated/models/tab_visit_body_session_id_member1.rb +1 -1
- data/_generated/models/takeover_action_body.rb +1 -1
- data/_generated/models/touch_body.rb +1 -1
- data/_generated/models/touch_body_ops.rb +1 -1
- data/_generated/models/touch_body_profile_id_member1.rb +1 -1
- data/_generated/models/touch_body_session_id_member1.rb +1 -1
- data/_generated/models/upload_body.rb +95 -4
- data/_generated/models/upload_body_profile_id_member1.rb +62 -0
- data/_generated/models/wait_body.rb +95 -4
- data/_generated/models/wait_body_profile_id_member1.rb +62 -0
- data/_generated/models/wait_body_selector_member1.rb +1 -1
- data/_generated/models/webhook_create_request.rb +1 -1
- data/_generated/models/webhook_create_response.rb +1 -1
- data/_generated/models/webhook_delivery_list_response.rb +1 -1
- data/_generated/models/webhook_delivery_list_response_next_cursor_member1.rb +1 -1
- data/_generated/models/webhook_delivery_public.rb +1 -1
- data/_generated/models/webhook_delivery_public_delivered_at_member1.rb +1 -1
- data/_generated/models/webhook_delivery_public_error_class_member1.rb +1 -1
- data/_generated/models/webhook_delivery_public_replay_of_member1.rb +1 -1
- data/_generated/models/webhook_delivery_public_response_body_preview_member1.rb +1 -1
- data/_generated/models/webhook_delivery_public_response_status_member1.rb +1 -1
- data/_generated/models/webhook_list_response.rb +1 -1
- data/_generated/models/webhook_list_response_next_cursor_member1.rb +1 -1
- data/_generated/models/webhook_public.rb +1 -1
- data/_generated/models/webhook_public_secret_rotated_at_member1.rb +1 -1
- data/_generated/v1/cdp/cdp_request_builder.rb +7 -1
- data/_generated/v1/cdp/frame/frame_request_builder.rb +1 -1
- data/_generated/v1/cdp/input/input.rb +0 -0
- data/_generated/v1/cdp/input/input_request_builder.rb +74 -0
- data/_generated/v1/cdp/url/url_request_builder.rb +1 -1
- data/_generated/v1/content/content_request_builder.rb +1 -1
- data/_generated/v1/crawl/crawl_request_builder.rb +1 -1
- data/_generated/v1/crawl/deep/deep_request_builder.rb +1 -1
- data/_generated/v1/crawl/deep/item/with_run_item_request_builder.rb +1 -1
- data/_generated/v1/crawl_runs/crawl_runs_post_request_body.rb +1 -1
- data/_generated/v1/crawl_runs/crawl_runs_request_builder.rb +1 -1
- data/_generated/v1/crawl_runs/item/cancel/cancel_request_builder.rb +1 -1
- data/_generated/v1/crawl_runs/item/resume/resume_request_builder.rb +1 -1
- data/_generated/v1/crawl_runs/item/with_run_item_request_builder.rb +1 -1
- data/_generated/v1/datasets/datasets_post_request_body.rb +1 -1
- data/_generated/v1/datasets/datasets_request_builder.rb +1 -1
- data/_generated/v1/datasets/item/rows/append/append_post_request_body.rb +1 -1
- data/_generated/v1/datasets/item/rows/append/append_request_builder.rb +1 -1
- data/_generated/v1/datasets/item/rows/rows_request_builder.rb +1 -1
- data/_generated/v1/datasets/item/with_name_item_request_builder.rb +1 -1
- data/_generated/v1/downloads/downloads_request_builder.rb +1 -1
- data/_generated/v1/downloads/item/with_download_item_request_builder.rb +3 -3
- data/_generated/v1/extract/extract_post_response.rb +1 -1
- data/_generated/v1/extract/extract_request_builder.rb +5 -5
- data/_generated/v1/kv/item/with_key_item_request_builder.rb +1 -1
- data/_generated/v1/kv/item/with_key_put_request_body.rb +1 -1
- data/_generated/v1/kv/kv_request_builder.rb +1 -1
- data/_generated/v1/map/map_request_builder.rb +1 -1
- data/_generated/v1/page/arrival/arrival_request_builder.rb +1 -1
- data/_generated/v1/page/close_popups/close_popups_request_builder.rb +3 -3
- data/_generated/v1/page/cookies/cookies_request_builder.rb +10 -10
- data/_generated/v1/page/dom_snapshot/dom_snapshot_request_builder.rb +3 -3
- data/_generated/v1/page/download/download_request_builder.rb +3 -3
- data/_generated/v1/page/eval/eval_request_builder.rb +1 -1
- data/_generated/v1/page/har/har_request_builder.rb +1 -1
- data/_generated/v1/page/mouse/mouse_request_builder.rb +1 -1
- data/_generated/v1/page/page_request_builder.rb +1 -1
- data/_generated/v1/page/scroll/scroll_request_builder.rb +3 -3
- data/_generated/v1/page/tab_visit/tab_visit_request_builder.rb +1 -1
- data/_generated/v1/page/touch/touch_request_builder.rb +1 -1
- data/_generated/v1/page/upload/upload_request_builder.rb +3 -3
- data/_generated/v1/page/wait/wait_request_builder.rb +3 -3
- data/_generated/v1/pdf/pdf_request_builder.rb +1 -1
- data/_generated/v1/profiles/item/with_name_item_request_builder.rb +2 -2
- data/_generated/v1/profiles/profiles_request_builder.rb +1 -1
- data/_generated/v1/recordings/item/recording_item_request_builder.rb +1 -1
- data/_generated/v1/recordings/item/visual/frames/frames_request_builder.rb +4 -10
- data/_generated/v1/recordings/item/visual/start/start_request_builder.rb +4 -10
- data/_generated/v1/recordings/item/visual/stop/stop_request_builder.rb +4 -10
- data/_generated/v1/recordings/item/visual/visual_request_builder.rb +4 -10
- data/_generated/v1/recordings/recordings_request_builder.rb +1 -1
- data/_generated/v1/schedules/item/runs/runs_request_builder.rb +1 -1
- data/_generated/v1/schedules/item/with_schedule_item_request_builder.rb +1 -1
- data/_generated/v1/schedules/schedules_request_builder.rb +1 -1
- data/_generated/v1/scrape/batch/batch_request_builder.rb +1 -1
- data/_generated/v1/scrape/scrape_request_builder.rb +1 -1
- data/_generated/v1/screenshot/screenshot_request_builder.rb +1 -1
- data/_generated/v1/screenshot_blobs/item/with_ref_item_request_builder.rb +1 -1
- data/_generated/v1/screenshot_blobs/screenshot_blobs_request_builder.rb +1 -1
- data/_generated/v1/search/jobs/item/with_job_item_request_builder.rb +1 -1
- data/_generated/v1/search/jobs/jobs_request_builder.rb +1 -1
- data/_generated/v1/search/search_request_builder.rb +3 -3
- data/_generated/v1/selfhost/byo/behavior/behavior_put_request_body.rb +1 -1
- data/_generated/v1/selfhost/byo/behavior/behavior_request_builder.rb +1 -1
- data/_generated/v1/selfhost/byo/byo_request_builder.rb +1 -1
- data/_generated/v1/selfhost/byo/identity/identity_put_request_body.rb +1 -1
- data/_generated/v1/selfhost/byo/identity/identity_request_builder.rb +1 -1
- data/_generated/v1/selfhost/byo/proxy/proxy_put_request_body.rb +1 -1
- data/_generated/v1/selfhost/byo/proxy/proxy_request_builder.rb +1 -1
- data/_generated/v1/selfhost/selfhost_request_builder.rb +1 -1
- data/_generated/v1/sessions/create/create_request_builder.rb +1 -1
- data/_generated/v1/sessions/item/extend/extend_request_builder.rb +1 -1
- data/_generated/v1/sessions/item/pin/pin_request_builder.rb +1 -1
- data/_generated/v1/sessions/item/profile_item_request_builder.rb +47 -1
- data/_generated/v1/sessions/item/recording/recording_request_builder.rb +1 -1
- data/_generated/v1/sessions/item/recording/start/start_request_builder.rb +1 -1
- data/_generated/v1/sessions/item/recording/stop/stop_request_builder.rb +1 -1
- data/_generated/v1/sessions/item/release/release_request_builder.rb +1 -1
- data/_generated/v1/sessions/item/takeover/takeover_request_builder.rb +3 -3
- data/_generated/v1/sessions/item/takeover_release/takeover_release_request_builder.rb +1 -1
- data/_generated/v1/sessions/item/takeover_token/takeover_token_request_builder.rb +1 -1
- data/_generated/v1/sessions/item/terminate/terminate.rb +0 -0
- data/_generated/v1/sessions/item/terminate/terminate_request_builder.rb +71 -0
- data/_generated/v1/sessions/sessions_request_builder.rb +1 -1
- data/_generated/v1/storage_states/detach/detach_request_builder.rb +1 -1
- data/_generated/v1/storage_states/item/attach/attach_request_builder.rb +1 -1
- data/_generated/v1/storage_states/item/with_id_or_name_item_request_builder.rb +1 -1
- data/_generated/v1/storage_states/storage_states_post_request_body.rb +1 -1
- data/_generated/v1/storage_states/storage_states_request_builder.rb +3 -3
- data/_generated/v1/v1_request_builder.rb +1 -8
- data/_generated/v1/webhooks/item/deliveries/deliveries_request_builder.rb +1 -1
- data/_generated/v1/webhooks/item/deliveries/item/retry_escaped/retry_request_builder.rb +1 -1
- data/_generated/v1/webhooks/item/deliveries/item/with_delivery_item_request_builder.rb +1 -1
- data/_generated/v1/webhooks/item/rotate_secret/rotate_secret_request_builder.rb +1 -1
- data/_generated/v1/webhooks/item/with_webhook_item_request_builder.rb +1 -1
- data/_generated/v1/webhooks/webhooks_request_builder.rb +1 -1
- data/lib/ghostcrawl/client.rb +2 -2
- data/lib/ghostcrawl/version.rb +1 -1
- metadata +36 -26
- data/_generated/models/agent_request.rb +0 -203
- data/_generated/models/agent_request_mode.rb +0 -8
- data/_generated/models/agent_request_task.rb +0 -164
- data/_generated/models/agent_request_task_steps.rb +0 -122
- data/_generated/models/agent_request_task_steps_type.rb +0 -9
- data/_generated/models/auth_context.rb +0 -204
- data/_generated/models/error_envelope.rb +0 -264
- data/_generated/models/error_envelope_limits.rb +0 -162
- data/_generated/models/proxy_config.rb +0 -116
- data/_generated/v1/agent/agent.rb +0 -1
- data/_generated/v1/agent/agent404_error.rb +0 -87
- data/_generated/v1/agent/agent_request_builder.rb +0 -73
- data/_generated/v1/binary/binary.rb +0 -9
- /data/_generated/{ghostcrawl.rb → ghost_crawl.rb} +0 -0
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
require 'microsoft_kiota_abstractions'
|
|
2
|
-
require_relative '../
|
|
2
|
+
require_relative '../ghost_crawl'
|
|
3
3
|
require_relative './models'
|
|
4
4
|
|
|
5
5
|
module GhostCrawl
|
|
@@ -15,12 +15,15 @@ module GhostCrawl
|
|
|
15
15
|
# "persist" (default): same identity for all URLs in a batch. "randomize": fresh identity per URL (each counts against quota).
|
|
16
16
|
@batch_identity_mode
|
|
17
17
|
##
|
|
18
|
-
# BYO behavior: a list of trusted-input actions replayed on the loaded page instead of the built-in
|
|
18
|
+
# BYO behavior: a list of trusted-input actions replayed on the loaded page instead of the built-in browser session. Each item is {"kind":"move","x":int,"y":int} | {"kind":"wheel","x":int,"y":int,"dy":int} | {"kind":"dwell","ms":int}. Sanitized + bounded server-side (max 256 actions). Available on every tier.
|
|
19
19
|
@behavior_actions
|
|
20
20
|
##
|
|
21
21
|
# Maximum tokens per markdown chunk. Clamped server-side to [256, 32768] regardless of caller input.
|
|
22
22
|
@chunk_tokens
|
|
23
23
|
##
|
|
24
|
+
# Device class for the population identity draw. 'random' (default) = unchanged. The random_* classes restrict which real-population devices may be drawn (weights inside the class unchanged); with engine 'auto' the engine follows the drawn device (iOS -> webkit always, android -> chrome). An engine the class cannot render on -> 422 device_engine_mismatch. Not combinable with identity / profile; identity_spec's operating system must lie inside the class. For a fixed device use profile=<name>. Cloud only: where no population draw runs (self-host / direct egress) a non-random class -> 422 device_unsupported.
|
|
25
|
+
@device
|
|
26
|
+
##
|
|
24
27
|
# Engine override. 'auto' (default): the identity's browser decides the engine. 'chrome'|'firefox'|'webkit': force that engine, enforced only if coherent with the identity (e.g. iOS identities are always webkit); incoherent picks are rejected, never coerced to a hybrid.
|
|
25
28
|
@engine
|
|
26
29
|
##
|
|
@@ -30,6 +33,9 @@ module GhostCrawl
|
|
|
30
33
|
# When screenshot=true, capture the FULL document height instead of just the visible viewport. Ignored when screenshot_selector is set.
|
|
31
34
|
@full_page
|
|
32
35
|
##
|
|
36
|
+
# Override geo-coherence: use `identity_country`'s geo (timezone + geolocation) REGARDLESS of the exit IP's country. Requires a pinned `identity_country` (and the geo_select tier). Off by default, the default is IP-coherent geo (the browser identity follows the exit). Forcing may create an IP<->timezone mismatch that some sites cross-check; opt-in at your own risk.
|
|
37
|
+
@geo_force
|
|
38
|
+
##
|
|
33
39
|
# Previously-persisted identity_id from POST /v1/identity (persist=true).
|
|
34
40
|
@identity
|
|
35
41
|
##
|
|
@@ -102,14 +108,14 @@ module GhostCrawl
|
|
|
102
108
|
@batch_identity_mode = value
|
|
103
109
|
end
|
|
104
110
|
##
|
|
105
|
-
## Gets the behavior_actions property value. BYO behavior: a list of trusted-input actions replayed on the loaded page instead of the built-in
|
|
111
|
+
## Gets the behavior_actions property value. BYO behavior: a list of trusted-input actions replayed on the loaded page instead of the built-in browser session. Each item is {"kind":"move","x":int,"y":int} | {"kind":"wheel","x":int,"y":int,"dy":int} | {"kind":"dwell","ms":int}. Sanitized + bounded server-side (max 256 actions). Available on every tier.
|
|
106
112
|
## @return a scrape_request_behavior_actions
|
|
107
113
|
##
|
|
108
114
|
def behavior_actions
|
|
109
115
|
return @behavior_actions
|
|
110
116
|
end
|
|
111
117
|
##
|
|
112
|
-
## Sets the behavior_actions property value. BYO behavior: a list of trusted-input actions replayed on the loaded page instead of the built-in
|
|
118
|
+
## Sets the behavior_actions property value. BYO behavior: a list of trusted-input actions replayed on the loaded page instead of the built-in browser session. Each item is {"kind":"move","x":int,"y":int} | {"kind":"wheel","x":int,"y":int,"dy":int} | {"kind":"dwell","ms":int}. Sanitized + bounded server-side (max 256 actions). Available on every tier.
|
|
113
119
|
## @param value Value to set for the behavior_actions property.
|
|
114
120
|
## @return a void
|
|
115
121
|
##
|
|
@@ -139,9 +145,11 @@ module GhostCrawl
|
|
|
139
145
|
@additional_data = Hash.new
|
|
140
146
|
@batch_identity_mode = GhostCrawl::Models::ScrapeRequestBatchIdentityMode[:Persist]
|
|
141
147
|
@chunk_tokens = 8192
|
|
148
|
+
@device = GhostCrawl::Models::ScrapeRequestDevice[:Random]
|
|
142
149
|
@engine = GhostCrawl::Models::ScrapeRequestEngine[:Auto]
|
|
143
150
|
@format = GhostCrawl::Models::ScrapeRequestFormat[:Html]
|
|
144
151
|
@full_page = false
|
|
152
|
+
@geo_force = false
|
|
145
153
|
@include_citations = true
|
|
146
154
|
@routing_mode = GhostCrawl::Models::ScrapeRequestRoutingMode[:Auto]
|
|
147
155
|
@screenshot = false
|
|
@@ -157,6 +165,21 @@ module GhostCrawl
|
|
|
157
165
|
return ScrapeRequest.new
|
|
158
166
|
end
|
|
159
167
|
##
|
|
168
|
+
## Gets the device property value. Device class for the population identity draw. 'random' (default) = unchanged. The random_* classes restrict which real-population devices may be drawn (weights inside the class unchanged); with engine 'auto' the engine follows the drawn device (iOS -> webkit always, android -> chrome). An engine the class cannot render on -> 422 device_engine_mismatch. Not combinable with identity / profile; identity_spec's operating system must lie inside the class. For a fixed device use profile=<name>. Cloud only: where no population draw runs (self-host / direct egress) a non-random class -> 422 device_unsupported.
|
|
169
|
+
## @return a scrape_request_device
|
|
170
|
+
##
|
|
171
|
+
def device
|
|
172
|
+
return @device
|
|
173
|
+
end
|
|
174
|
+
##
|
|
175
|
+
## Sets the device property value. Device class for the population identity draw. 'random' (default) = unchanged. The random_* classes restrict which real-population devices may be drawn (weights inside the class unchanged); with engine 'auto' the engine follows the drawn device (iOS -> webkit always, android -> chrome). An engine the class cannot render on -> 422 device_engine_mismatch. Not combinable with identity / profile; identity_spec's operating system must lie inside the class. For a fixed device use profile=<name>. Cloud only: where no population draw runs (self-host / direct egress) a non-random class -> 422 device_unsupported.
|
|
176
|
+
## @param value Value to set for the device property.
|
|
177
|
+
## @return a void
|
|
178
|
+
##
|
|
179
|
+
def device=(value)
|
|
180
|
+
@device = value
|
|
181
|
+
end
|
|
182
|
+
##
|
|
160
183
|
## Gets the engine property value. Engine override. 'auto' (default): the identity's browser decides the engine. 'chrome'|'firefox'|'webkit': force that engine, enforced only if coherent with the identity (e.g. iOS identities are always webkit); incoherent picks are rejected, never coerced to a hybrid.
|
|
161
184
|
## @return a scrape_request_engine
|
|
162
185
|
##
|
|
@@ -202,6 +225,21 @@ module GhostCrawl
|
|
|
202
225
|
@full_page = value
|
|
203
226
|
end
|
|
204
227
|
##
|
|
228
|
+
## Gets the geo_force property value. Override geo-coherence: use `identity_country`'s geo (timezone + geolocation) REGARDLESS of the exit IP's country. Requires a pinned `identity_country` (and the geo_select tier). Off by default, the default is IP-coherent geo (the browser identity follows the exit). Forcing may create an IP<->timezone mismatch that some sites cross-check; opt-in at your own risk.
|
|
229
|
+
## @return a boolean
|
|
230
|
+
##
|
|
231
|
+
def geo_force
|
|
232
|
+
return @geo_force
|
|
233
|
+
end
|
|
234
|
+
##
|
|
235
|
+
## Sets the geo_force property value. Override geo-coherence: use `identity_country`'s geo (timezone + geolocation) REGARDLESS of the exit IP's country. Requires a pinned `identity_country` (and the geo_select tier). Off by default, the default is IP-coherent geo (the browser identity follows the exit). Forcing may create an IP<->timezone mismatch that some sites cross-check; opt-in at your own risk.
|
|
236
|
+
## @param value Value to set for the geo_force property.
|
|
237
|
+
## @return a void
|
|
238
|
+
##
|
|
239
|
+
def geo_force=(value)
|
|
240
|
+
@geo_force = value
|
|
241
|
+
end
|
|
242
|
+
##
|
|
205
243
|
## The deserialization information for the current model
|
|
206
244
|
## @return a i_dictionary
|
|
207
245
|
##
|
|
@@ -210,9 +248,11 @@ module GhostCrawl
|
|
|
210
248
|
"batch_identity_mode" => lambda {|n| @batch_identity_mode = n.get_enum_value(GhostCrawl::Models::ScrapeRequestBatchIdentityMode) },
|
|
211
249
|
"behavior_actions" => lambda {|n| @behavior_actions = n.get_object_value(lambda {|pn| ScrapeRequest::ScrapeRequestBehaviorActions.create_from_discriminator_value(pn) }) },
|
|
212
250
|
"chunk_tokens" => lambda {|n| @chunk_tokens = n.get_number_value() },
|
|
251
|
+
"device" => lambda {|n| @device = n.get_enum_value(GhostCrawl::Models::ScrapeRequestDevice) },
|
|
213
252
|
"engine" => lambda {|n| @engine = n.get_enum_value(GhostCrawl::Models::ScrapeRequestEngine) },
|
|
214
253
|
"format" => lambda {|n| @format = n.get_enum_value(GhostCrawl::Models::ScrapeRequestFormat) },
|
|
215
254
|
"full_page" => lambda {|n| @full_page = n.get_boolean_value() },
|
|
255
|
+
"geo_force" => lambda {|n| @geo_force = n.get_boolean_value() },
|
|
216
256
|
"identity" => lambda {|n| @identity = n.get_object_value(lambda {|pn| ScrapeRequest::ScrapeRequestIdentity.create_from_discriminator_value(pn) }) },
|
|
217
257
|
"identity_country" => lambda {|n| @identity_country = n.get_object_value(lambda {|pn| ScrapeRequest::ScrapeRequestIdentityCountry.create_from_discriminator_value(pn) }) },
|
|
218
258
|
"include_citations" => lambda {|n| @include_citations = n.get_boolean_value() },
|
|
@@ -374,9 +414,11 @@ module GhostCrawl
|
|
|
374
414
|
writer.write_enum_value("batch_identity_mode", @batch_identity_mode)
|
|
375
415
|
writer.write_object_value("behavior_actions", @behavior_actions)
|
|
376
416
|
writer.write_number_value("chunk_tokens", @chunk_tokens)
|
|
417
|
+
writer.write_enum_value("device", @device)
|
|
377
418
|
writer.write_enum_value("engine", @engine)
|
|
378
419
|
writer.write_enum_value("format", @format)
|
|
379
420
|
writer.write_boolean_value("full_page", @full_page)
|
|
421
|
+
writer.write_boolean_value("geo_force", @geo_force)
|
|
380
422
|
writer.write_object_value("identity", @identity)
|
|
381
423
|
writer.write_object_value("identity_country", @identity_country)
|
|
382
424
|
writer.write_boolean_value("include_citations", @include_citations)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
module GhostCrawl
|
|
2
|
+
module Models
|
|
3
|
+
##
|
|
4
|
+
# Device class for the population identity draw. 'random' (default) = unchanged. The random_* classes restrict which real-population devices may be drawn (weights inside the class unchanged); with engine 'auto' the engine follows the drawn device (iOS -> webkit always, android -> chrome). An engine the class cannot render on -> 422 device_engine_mismatch. Not combinable with identity / profile; identity_spec's operating system must lie inside the class. For a fixed device use profile=<name>. Cloud only: where no population draw runs (self-host / direct egress) a non-random class -> 422 device_unsupported.
|
|
5
|
+
ScrapeRequestDevice = {
|
|
6
|
+
Random: :Random,
|
|
7
|
+
Random_desktop: :Random_desktop,
|
|
8
|
+
Random_mobile: :Random_mobile,
|
|
9
|
+
Random_windows: :Random_windows,
|
|
10
|
+
Random_android: :Random_android,
|
|
11
|
+
Random_ios: :Random_ios,
|
|
12
|
+
}
|
|
13
|
+
end
|
|
14
|
+
end
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
require 'microsoft_kiota_abstractions'
|
|
2
|
-
require_relative '../
|
|
2
|
+
require_relative '../ghost_crawl'
|
|
3
3
|
require_relative './models'
|
|
4
4
|
|
|
5
5
|
module GhostCrawl
|
|
@@ -18,6 +18,9 @@ module GhostCrawl
|
|
|
18
18
|
# Capture the FULL document height instead of just the viewport.
|
|
19
19
|
@full_page
|
|
20
20
|
##
|
|
21
|
+
# Bypass geo-coherence: claim identity_country's geo (timezone + geolocation) REGARDLESS of the exit IP. Requires a pinned identity_country + geo_select tier. Default off (geo follows the exit; forcing may create an IP<->timezone mismatch).
|
|
22
|
+
@geo_force
|
|
23
|
+
##
|
|
21
24
|
# Re-use a persisted identity.
|
|
22
25
|
@identity
|
|
23
26
|
##
|
|
@@ -61,6 +64,7 @@ module GhostCrawl
|
|
|
61
64
|
@additional_data = Hash.new
|
|
62
65
|
@engine = GhostCrawl::Models::ScreenshotRequestEngine[:Auto]
|
|
63
66
|
@full_page = false
|
|
67
|
+
@geo_force = false
|
|
64
68
|
end
|
|
65
69
|
##
|
|
66
70
|
## Creates a new instance of the appropriate class based on discriminator value
|
|
@@ -102,6 +106,21 @@ module GhostCrawl
|
|
|
102
106
|
@full_page = value
|
|
103
107
|
end
|
|
104
108
|
##
|
|
109
|
+
## Gets the geo_force property value. Bypass geo-coherence: claim identity_country's geo (timezone + geolocation) REGARDLESS of the exit IP. Requires a pinned identity_country + geo_select tier. Default off (geo follows the exit; forcing may create an IP<->timezone mismatch).
|
|
110
|
+
## @return a boolean
|
|
111
|
+
##
|
|
112
|
+
def geo_force
|
|
113
|
+
return @geo_force
|
|
114
|
+
end
|
|
115
|
+
##
|
|
116
|
+
## Sets the geo_force property value. Bypass geo-coherence: claim identity_country's geo (timezone + geolocation) REGARDLESS of the exit IP. Requires a pinned identity_country + geo_select tier. Default off (geo follows the exit; forcing may create an IP<->timezone mismatch).
|
|
117
|
+
## @param value Value to set for the geo_force property.
|
|
118
|
+
## @return a void
|
|
119
|
+
##
|
|
120
|
+
def geo_force=(value)
|
|
121
|
+
@geo_force = value
|
|
122
|
+
end
|
|
123
|
+
##
|
|
105
124
|
## The deserialization information for the current model
|
|
106
125
|
## @return a i_dictionary
|
|
107
126
|
##
|
|
@@ -109,6 +128,7 @@ module GhostCrawl
|
|
|
109
128
|
return {
|
|
110
129
|
"engine" => lambda {|n| @engine = n.get_enum_value(GhostCrawl::Models::ScreenshotRequestEngine) },
|
|
111
130
|
"full_page" => lambda {|n| @full_page = n.get_boolean_value() },
|
|
131
|
+
"geo_force" => lambda {|n| @geo_force = n.get_boolean_value() },
|
|
112
132
|
"identity" => lambda {|n| @identity = n.get_object_value(lambda {|pn| ScreenshotRequest::ScreenshotRequestIdentity.create_from_discriminator_value(pn) }) },
|
|
113
133
|
"identity_country" => lambda {|n| @identity_country = n.get_object_value(lambda {|pn| ScreenshotRequest::ScreenshotRequestIdentityCountry.create_from_discriminator_value(pn) }) },
|
|
114
134
|
"language" => lambda {|n| @language = n.get_object_value(lambda {|pn| ScreenshotRequest::ScreenshotRequestLanguage.create_from_discriminator_value(pn) }) },
|
|
@@ -217,6 +237,7 @@ module GhostCrawl
|
|
|
217
237
|
raise StandardError, 'writer cannot be null' if writer.nil?
|
|
218
238
|
writer.write_enum_value("engine", @engine)
|
|
219
239
|
writer.write_boolean_value("full_page", @full_page)
|
|
240
|
+
writer.write_boolean_value("geo_force", @geo_force)
|
|
220
241
|
writer.write_object_value("identity", @identity)
|
|
221
242
|
writer.write_object_value("identity_country", @identity_country)
|
|
222
243
|
writer.write_object_value("language", @language)
|