PyPI - nimble_python - Versions diffs - 0.1.0__py3-none-any.whl - Mend

nimble_python 0.1.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 (50) hide show

nimble_python/__init__.py +104 -0
nimble_python/_base_client.py +2127 -0
nimble_python/_client.py +4783 -0
nimble_python/_compat.py +219 -0
nimble_python/_constants.py +14 -0
nimble_python/_exceptions.py +108 -0
nimble_python/_files.py +123 -0
nimble_python/_models.py +872 -0
nimble_python/_qs.py +150 -0
nimble_python/_resource.py +43 -0
nimble_python/_response.py +832 -0
nimble_python/_streaming.py +333 -0
nimble_python/_types.py +270 -0
nimble_python/_utils/__init__.py +64 -0
nimble_python/_utils/_compat.py +45 -0
nimble_python/_utils/_datetime_parse.py +136 -0
nimble_python/_utils/_json.py +35 -0
nimble_python/_utils/_logs.py +25 -0
nimble_python/_utils/_proxy.py +65 -0
nimble_python/_utils/_reflection.py +42 -0
nimble_python/_utils/_resources_proxy.py +24 -0
nimble_python/_utils/_streams.py +12 -0
nimble_python/_utils/_sync.py +58 -0
nimble_python/_utils/_transform.py +457 -0
nimble_python/_utils/_typing.py +156 -0
nimble_python/_utils/_utils.py +421 -0
nimble_python/_version.py +4 -0
nimble_python/lib/.keep +4 -0
nimble_python/py.typed +0 -0
nimble_python/resources/__init__.py +19 -0
nimble_python/resources/crawl.py +553 -0
nimble_python/types/__init__.py +18 -0
nimble_python/types/client_extract_params.py +1366 -0
nimble_python/types/client_extract_template_params.py +14 -0
nimble_python/types/client_map_params.py +812 -0
nimble_python/types/client_search_params.py +75 -0
nimble_python/types/crawl_list_params.py +19 -0
nimble_python/types/crawl_list_response.py +1390 -0
nimble_python/types/crawl_root_params.py +1429 -0
nimble_python/types/crawl_root_response.py +11 -0
nimble_python/types/crawl_status_response.py +33 -0
nimble_python/types/crawl_terminate_response.py +11 -0
nimble_python/types/extract_response.py +11 -0
nimble_python/types/extract_template_response.py +11 -0
nimble_python/types/map_response.py +28 -0
nimble_python/types/search_response.py +70 -0
nimble_python-0.1.0.dist-info/METADATA +452 -0
nimble_python-0.1.0.dist-info/RECORD +50 -0
nimble_python-0.1.0.dist-info/WHEEL +4 -0
nimble_python-0.1.0.dist-info/licenses/LICENSE +201 -0

nimble_python/types/client_extract_params.py ADDED Viewed

@@ -0,0 +1,1366 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+from __future__ import annotations
+from typing import Dict, List, Union, Iterable, Optional
+from typing_extensions import Literal, Required, Annotated, TypeAlias, TypedDict
+from .._types import SequenceNotStr
+from .._utils import PropertyInfo
+__all__ = [
+    "ClientExtractParams",
+    "DebugOptions",
+    "Browser",
+    "BrowserUnionMember1",
+    "CookiesUnionMember0",
+    "Metadata",
+    "NetworkCapture",
+    "NetworkCaptureURL",
+    "ParseOptions",
+    "QueryTemplate",
+    "QueryTemplatePagination",
+    "QueryTemplatePaginationNextPageParams",
+    "QueryTemplatePaginationUnionMember1",
+    "RenderOptions",
+    "RenderOptionsHackiumConfiguration",
+    "Session",
+    "Template",
+    "UserbrowserCreationTemplateRendered",
+]
+class ClientExtractParams(TypedDict, total=False):
+    debug_options: Required[DebugOptions]
+    """Debug and troubleshooting options for the request"""
+    url: Required[str]
+    """Target URL to scrape"""
+    browser: Browser
+    """Browser type to emulate"""
+    city: str
+    """City for geolocation"""
+    client_timeout: float
+    """Client-side timeout in milliseconds"""
+    consent_header: bool
+    """Whether to automatically handle cookie consent headers"""
+    cookies: Union[Iterable[CookiesUnionMember0], str]
+    """Browser cookies as array of cookie objects"""
+    country: Literal[
+        "AD",
+        "AE",
+        "AF",
+        "AG",
+        "AI",
+        "AL",
+        "AM",
+        "AO",
+        "AQ",
+        "AR",
+        "AS",
+        "AT",
+        "AU",
+        "AW",
+        "AX",
+        "AZ",
+        "BA",
+        "BB",
+        "BD",
+        "BE",
+        "BF",
+        "BG",
+        "BH",
+        "BI",
+        "BJ",
+        "BL",
+        "BM",
+        "BN",
+        "BO",
+        "BQ",
+        "BR",
+        "BS",
+        "BT",
+        "BV",
+        "BW",
+        "BY",
+        "BZ",
+        "CA",
+        "CC",
+        "CD",
+        "CF",
+        "CG",
+        "CH",
+        "CI",
+        "CK",
+        "CL",
+        "CM",
+        "CN",
+        "CO",
+        "CR",
+        "CU",
+        "CV",
+        "CW",
+        "CX",
+        "CY",
+        "CZ",
+        "DE",
+        "DJ",
+        "DK",
+        "DM",
+        "DO",
+        "DZ",
+        "EC",
+        "EE",
+        "EG",
+        "EH",
+        "ER",
+        "ES",
+        "ET",
+        "FI",
+        "FJ",
+        "FK",
+        "FM",
+        "FO",
+        "FR",
+        "GA",
+        "GB",
+        "GD",
+        "GE",
+        "GF",
+        "GG",
+        "GH",
+        "GI",
+        "GL",
+        "GM",
+        "GN",
+        "GP",
+        "GQ",
+        "GR",
+        "GS",
+        "GT",
+        "GU",
+        "GW",
+        "GY",
+        "HK",
+        "HM",
+        "HN",
+        "HR",
+        "HT",
+        "HU",
+        "ID",
+        "IE",
+        "IL",
+        "IM",
+        "IN",
+        "IO",
+        "IQ",
+        "IR",
+        "IS",
+        "IT",
+        "JE",
+        "JM",
+        "JO",
+        "JP",
+        "KE",
+        "KG",
+        "KH",
+        "KI",
+        "KM",
+        "KN",
+        "KP",
+        "KR",
+        "KW",
+        "KY",
+        "KZ",
+        "LA",
+        "LB",
+        "LC",
+        "LI",
+        "LK",
+        "LR",
+        "LS",
+        "LT",
+        "LU",
+        "LV",
+        "LY",
+        "MA",
+        "MC",
+        "MD",
+        "ME",
+        "MF",
+        "MG",
+        "MH",
+        "MK",
+        "ML",
+        "MM",
+        "MN",
+        "MO",
+        "MP",
+        "MQ",
+        "MR",
+        "MS",
+        "MT",
+        "MU",
+        "MV",
+        "MW",
+        "MX",
+        "MY",
+        "MZ",
+        "NA",
+        "NC",
+        "NE",
+        "NF",
+        "NG",
+        "NI",
+        "NL",
+        "NO",
+        "NP",
+        "NR",
+        "NU",
+        "NZ",
+        "OM",
+        "PA",
+        "PE",
+        "PF",
+        "PG",
+        "PH",
+        "PK",
+        "PL",
+        "PM",
+        "PN",
+        "PR",
+        "PS",
+        "PT",
+        "PW",
+        "PY",
+        "QA",
+        "RE",
+        "RO",
+        "RS",
+        "RU",
+        "RW",
+        "SA",
+        "SB",
+        "SC",
+        "SD",
+        "SE",
+        "SG",
+        "SH",
+        "SI",
+        "SJ",
+        "SK",
+        "SL",
+        "SM",
+        "SN",
+        "SO",
+        "SR",
+        "SS",
+        "ST",
+        "SV",
+        "SX",
+        "SY",
+        "SZ",
+        "TC",
+        "TD",
+        "TF",
+        "TG",
+        "TH",
+        "TJ",
+        "TK",
+        "TL",
+        "TM",
+        "TN",
+        "TO",
+        "TR",
+        "TT",
+        "TV",
+        "TW",
+        "TZ",
+        "UA",
+        "UG",
+        "UM",
+        "US",
+        "UY",
+        "UZ",
+        "VA",
+        "VC",
+        "VE",
+        "VG",
+        "VI",
+        "VN",
+        "VU",
+        "WF",
+        "WS",
+        "XK",
+        "YE",
+        "YT",
+        "ZA",
+        "ZM",
+        "ZW",
+        "ALL",
+    ]
+    """Country code for geolocation and proxy selection"""
+    device: Literal["desktop", "mobile", "tablet"]
+    """Device type for browser emulation"""
+    disable_ip_check: bool
+    """Whether to disable IP address validation"""
+    driver: Literal["vx6", "vx8", "vx8-pro", "vx10", "vx10-pro", "vx12", "vx12-pro"]
+    """Browser driver to use"""
+    dynamic_parser: Dict[str, object]
+    """Custom parser configuration as a key-value map"""
+    expected_status_codes: Iterable[int]
+    """Expected HTTP status codes for successful requests"""
+    export_userbrowser: bool
+    """Whether to export the userbrowser session"""
+    format: Literal["json", "html", "csv", "raw", "json-lines", "markdown"]
+    """Response format"""
+    headers: Dict[str, Union[str, SequenceNotStr[str], None]]
+    """Custom HTTP headers to include in the request"""
+    http2: bool
+    """Whether to use HTTP/2 protocol"""
+    ip6: bool
+    """Whether to use IPv6 for the request"""
+    is_xhr: bool
+    """Whether to emulate XMLHttpRequest behavior"""
+    locale: Literal[
+        "aa-DJ",
+        "aa-ER",
+        "aa-ET",
+        "af",
+        "af-NA",
+        "af-ZA",
+        "ak",
+        "ak-GH",
+        "am",
+        "am-ET",
+        "an-ES",
+        "ar",
+        "ar-AE",
+        "ar-BH",
+        "ar-DZ",
+        "ar-EG",
+        "ar-IN",
+        "ar-IQ",
+        "ar-JO",
+        "ar-KW",
+        "ar-LB",
+        "ar-LY",
+        "ar-MA",
+        "ar-OM",
+        "ar-QA",
+        "ar-SA",
+        "ar-SD",
+        "ar-SY",
+        "ar-TN",
+        "ar-YE",
+        "as",
+        "as-IN",
+        "asa",
+        "asa-TZ",
+        "ast-ES",
+        "az",
+        "az-AZ",
+        "az-Cyrl",
+        "az-Cyrl-AZ",
+        "az-Latn",
+        "az-Latn-AZ",
+        "be",
+        "be-BY",
+        "bem",
+        "bem-ZM",
+        "ber-DZ",
+        "ber-MA",
+        "bez",
+        "bez-TZ",
+        "bg",
+        "bg-BG",
+        "bho-IN",
+        "bm",
+        "bm-ML",
+        "bn",
+        "bn-BD",
+        "bn-IN",
+        "bo",
+        "bo-CN",
+        "bo-IN",
+        "br-FR",
+        "brx-IN",
+        "bs",
+        "bs-BA",
+        "byn-ER",
+        "ca",
+        "ca-AD",
+        "ca-ES",
+        "ca-FR",
+        "ca-IT",
+        "cgg",
+        "cgg-UG",
+        "chr",
+        "chr-US",
+        "crh-UA",
+        "cs",
+        "cs-CZ",
+        "csb-PL",
+        "cv-RU",
+        "cy",
+        "cy-GB",
+        "da",
+        "da-DK",
+        "dav",
+        "dav-KE",
+        "de",
+        "de-AT",
+        "de-BE",
+        "de-CH",
+        "de-DE",
+        "de-LI",
+        "de-LU",
+        "dv-MV",
+        "dz-BT",
+        "ebu",
+        "ebu-KE",
+        "ee",
+        "ee-GH",
+        "ee-TG",
+        "el",
+        "el-CY",
+        "el-GR",
+        "en",
+        "en-AG",
+        "en-AS",
+        "en-AU",
+        "en-BE",
+        "en-BW",
+        "en-BZ",
+        "en-CA",
+        "en-DK",
+        "en-GB",
+        "en-GU",
+        "en-HK",
+        "en-IE",
+        "en-IN",
+        "en-JM",
+        "en-MH",
+        "en-MP",
+        "en-MT",
+        "en-MU",
+        "en-NA",
+        "en-NG",
+        "en-NZ",
+        "en-PH",
+        "en-PK",
+        "en-SG",
+        "en-TT",
+        "en-UM",
+        "en-US",
+        "en-VI",
+        "en-ZA",
+        "en-ZM",
+        "en-ZW",
+        "eo",
+        "es",
+        "es-419",
+        "es-AR",
+        "es-BO",
+        "es-CL",
+        "es-CO",
+        "es-CR",
+        "es-CU",
+        "es-DO",
+        "es-EC",
+        "es-ES",
+        "es-GQ",
+        "es-GT",
+        "es-HN",
+        "es-MX",
+        "es-NI",
+        "es-PA",
+        "es-PE",
+        "es-PR",
+        "es-PY",
+        "es-SV",
+        "es-US",
+        "es-UY",
+        "es-VE",
+        "et",
+        "et-EE",
+        "eu",
+        "eu-ES",
+        "fa",
+        "fa-AF",
+        "fa-IR",
+        "ff",
+        "ff-SN",
+        "fi",
+        "fi-FI",
+        "fil",
+        "fil-PH",
+        "fo",
+        "fo-FO",
+        "fr",
+        "fr-BE",
+        "fr-BF",
+        "fr-BI",
+        "fr-BJ",
+        "fr-BL",
+        "fr-CA",
+        "fr-CD",
+        "fr-CF",
+        "fr-CG",
+        "fr-CH",
+        "fr-CI",
+        "fr-CM",
+        "fr-DJ",
+        "fr-FR",
+        "fr-GA",
+        "fr-GN",
+        "fr-GP",
+        "fr-GQ",
+        "fr-KM",
+        "fr-LU",
+        "fr-MC",
+        "fr-MF",
+        "fr-MG",
+        "fr-ML",
+        "fr-MQ",
+        "fr-NE",
+        "fr-RE",
+        "fr-RW",
+        "fr-SN",
+        "fr-TD",
+        "fr-TG",
+        "fur-IT",
+        "fy-DE",
+        "fy-NL",
+        "ga",
+        "ga-IE",
+        "gd-GB",
+        "gez-ER",
+        "gez-ET",
+        "gl",
+        "gl-ES",
+        "gsw",
+        "gsw-CH",
+        "gu",
+        "gu-IN",
+        "guz",
+        "guz-KE",
+        "gv",
+        "gv-GB",
+        "ha",
+        "ha-Latn",
+        "ha-Latn-GH",
+        "ha-Latn-NE",
+        "ha-Latn-NG",
+        "ha-NG",
+        "haw",
+        "haw-US",
+        "he",
+        "he-IL",
+        "hi",
+        "hi-IN",
+        "hne-IN",
+        "hr",
+        "hr-HR",
+        "hsb-DE",
+        "ht-HT",
+        "hu",
+        "hu-HU",
+        "hy",
+        "hy-AM",
+        "id",
+        "id-ID",
+        "ig",
+        "ig-NG",
+        "ii",
+        "ii-CN",
+        "ik-CA",
+        "is",
+        "is-IS",
+        "it",
+        "it-CH",
+        "it-IT",
+        "iu-CA",
+        "iw-IL",
+        "ja",
+        "ja-JP",
+        "jmc",
+        "jmc-TZ",
+        "ka",
+        "ka-GE",
+        "kab",
+        "kab-DZ",
+        "kam",
+        "kam-KE",
+        "kde",
+        "kde-TZ",
+        "kea",
+        "kea-CV",
+        "khq",
+        "khq-ML",
+        "ki",
+        "ki-KE",
+        "kk",
+        "kk-Cyrl",
+        "kk-Cyrl-KZ",
+        "kk-KZ",
+        "kl",
+        "kl-GL",
+        "kln",
+        "kln-KE",
+        "km",
+        "km-KH",
+        "kn",
+        "kn-IN",
+        "ko",
+        "ko-KR",
+        "kok",
+        "kok-IN",
+        "ks-IN",
+        "ku-TR",
+        "kw",
+        "kw-GB",
+        "ky-KG",
+        "lag",
+        "lag-TZ",
+        "lb-LU",
+        "lg",
+        "lg-UG",
+        "li-BE",
+        "li-NL",
+        "lij-IT",
+        "lo-LA",
+        "lt",
+        "lt-LT",
+        "luo",
+        "luo-KE",
+        "luy",
+        "luy-KE",
+        "lv",
+        "lv-LV",
+        "mag-IN",
+        "mai-IN",
+        "mas",
+        "mas-KE",
+        "mas-TZ",
+        "mer",
+        "mer-KE",
+        "mfe",
+        "mfe-MU",
+        "mg",
+        "mg-MG",
+        "mhr-RU",
+        "mi-NZ",
+        "mk",
+        "mk-MK",
+        "ml",
+        "ml-IN",
+        "mn-MN",
+        "mr",
+        "mr-IN",
+        "ms",
+        "ms-BN",
+        "ms-MY",
+        "mt",
+        "mt-MT",
+        "my",
+        "my-MM",
+        "nan-TW",
+        "naq",
+        "naq-NA",
+        "nb",
+        "nb-NO",
+        "nd",
+        "nd-ZW",
+        "nds-DE",
+        "nds-NL",
+        "ne",
+        "ne-IN",
+        "ne-NP",
+        "nl",
+        "nl-AW",
+        "nl-BE",
+        "nl-NL",
+        "nn",
+        "nn-NO",
+        "nr-ZA",
+        "nso-ZA",
+        "nyn",
+        "nyn-UG",
+        "oc-FR",
+        "om",
+        "om-ET",
+        "om-KE",
+        "or",
+        "or-IN",
+        "os-RU",
+        "pa",
+        "pa-Arab",
+        "pa-Arab-PK",
+        "pa-Guru",
+        "pa-Guru-IN",
+        "pa-IN",
+        "pa-PK",
+        "pap-AN",
+        "pl",
+        "pl-PL",
+        "ps",
+        "ps-AF",
+        "pt",
+        "pt-BR",
+        "pt-GW",
+        "pt-MZ",
+        "pt-PT",
+        "rm",
+        "rm-CH",
+        "ro",
+        "ro-MD",
+        "ro-RO",
+        "rof",
+        "rof-TZ",
+        "ru",
+        "ru-MD",
+        "ru-RU",
+        "ru-UA",
+        "rw",
+        "rw-RW",
+        "rwk",
+        "rwk-TZ",
+        "sa-IN",
+        "saq",
+        "saq-KE",
+        "sc-IT",
+        "sd-IN",
+        "se-NO",
+        "seh",
+        "seh-MZ",
+        "ses",
+        "ses-ML",
+        "sg",
+        "sg-CF",
+        "shi",
+        "shi-Latn",
+        "shi-Latn-MA",
+        "shi-Tfng",
+        "shi-Tfng-MA",
+        "shs-CA",
+        "si",
+        "si-LK",
+        "sid-ET",
+        "sk",
+        "sk-SK",
+        "sl",
+        "sl-SI",
+        "sn",
+        "sn-ZW",
+        "so",
+        "so-DJ",
+        "so-ET",
+        "so-KE",
+        "so-SO",
+        "sq",
+        "sq-AL",
+        "sq-MK",
+        "sr",
+        "sr-Cyrl",
+        "sr-Cyrl-BA",
+        "sr-Cyrl-ME",
+        "sr-Cyrl-RS",
+        "sr-Latn",
+        "sr-Latn-BA",
+        "sr-Latn-ME",
+        "sr-Latn-RS",
+        "sr-ME",
+        "sr-RS",
+        "ss-ZA",
+        "st-ZA",
+        "sv",
+        "sv-FI",
+        "sv-SE",
+        "sw",
+        "sw-KE",
+        "sw-TZ",
+        "ta",
+        "ta-IN",
+        "ta-LK",
+        "te",
+        "te-IN",
+        "teo",
+        "teo-KE",
+        "teo-UG",
+        "tg-TJ",
+        "th",
+        "th-TH",
+        "ti",
+        "ti-ER",
+        "ti-ET",
+        "tig-ER",
+        "tk-TM",
+        "tl-PH",
+        "tn-ZA",
+        "to",
+        "to-TO",
+        "tr",
+        "tr-CY",
+        "tr-TR",
+        "ts-ZA",
+        "tt-RU",
+        "tzm",
+        "tzm-Latn",
+        "tzm-Latn-MA",
+        "ug-CN",
+        "uk",
+        "uk-UA",
+        "unm-US",
+        "ur",
+        "ur-IN",
+        "ur-PK",
+        "uz",
+        "uz-Arab",
+        "uz-Arab-AF",
+        "uz-Cyrl",
+        "uz-Cyrl-UZ",
+        "uz-Latn",
+        "uz-Latn-UZ",
+        "uz-UZ",
+        "ve-ZA",
+        "vi",
+        "vi-VN",
+        "vun",
+        "vun-TZ",
+        "wa-BE",
+        "wae-CH",
+        "wal-ET",
+        "wo-SN",
+        "xh-ZA",
+        "xog",
+        "xog-UG",
+        "yi-US",
+        "yo",
+        "yo-NG",
+        "yue-HK",
+        "zh",
+        "zh-CN",
+        "zh-HK",
+        "zh-Hans",
+        "zh-Hans-CN",
+        "zh-Hans-HK",
+        "zh-Hans-MO",
+        "zh-Hans-SG",
+        "zh-Hant",
+        "zh-Hant-HK",
+        "zh-Hant-MO",
+        "zh-Hant-TW",
+        "zh-SG",
+        "zh-TW",
+        "zu",
+        "zu-ZA",
+        "auto",
+    ]
+    """Locale for browser language and region settings"""
+    markdown: bool
+    """Whether to return response in Markdown format"""
+    metadata: Metadata
+    """Structured metadata about the request execution context"""
+    method: Literal["GET", "POST", "PUT", "PATCH", "DELETE"]
+    """HTTP method for the request"""
+    native_mode: Literal["requester", "apm", "direct"]
+    """Native execution mode"""
+    network_capture: Iterable[NetworkCapture]
+    """Filters for capturing network traffic"""
+    no_html: bool
+    """Whether to exclude HTML from the response"""
+    no_userbrowser: bool
+    """Whether to disable browser-based rendering"""
+    os: Literal["windows", "mac os", "linux", "android", "ios"]
+    """Operating system to emulate"""
+    parse: bool
+    """Whether to parse the response content"""
+    parse_options: ParseOptions
+    """Configuration options for parsing behavior"""
+    parser: Union[Dict[str, object], str]
+    """Custom parser configuration as a key-value map"""
+    proxy_provider: Literal[
+        "brightdata",
+        "oxylabs",
+        "smartproxy",
+        "proxit",
+        "proxit_preprod",
+        "local",
+        "rayobyte",
+        "always",
+        "oculusproxies",
+        "froxy",
+        "packetstream",
+        "911proxy",
+        "direct911proxy",
+        "thesocialproxy",
+        "thesocialproxy2",
+        "nimble-isp",
+        "nimble-isp-mobile",
+        "proxit-linux",
+        "proxit-macos",
+        "proxit-windows",
+        "proxit-rental",
+        "ipfoxy",
+        "brightup",
+        "research",
+    ]
+    """Proxy provider to use for the request"""
+    proxy_providers: Dict[str, float]
+    """Weighted distribution of proxy providers"""
+    query_template: QueryTemplate
+    """Query template configuration for structured data extraction"""
+    raw_headers: bool
+    """Whether to return raw HTTP headers in response"""
+    referrer_type: Literal["random", "no-referer", "same-origin", "google", "bing", "facebook", "twitter", "instagram"]
+    """Referrer policy for the request"""
+    render: bool
+    """Whether to render JavaScript content using a browser"""
+    render_flow: Iterable[Dict[str, object]]
+    """Array of actions to perform during browser rendering"""
+    render_options: RenderOptions
+    request_timeout: float
+    """Request timeout in milliseconds"""
+    return_response_headers_as_header: bool
+    """Whether to return response headers in HTTP headers"""
+    save_userbrowser: bool
+    """Whether to save the userbrowser session for reuse"""
+    session: Session
+    skill: Union[str, SequenceNotStr[str]]
+    """Skills or capabilities required for the request"""
+    skip_ubct: bool
+    """Whether to skip userbrowser creation template processing"""
+    state: Literal[
+        "AL",
+        "AK",
+        "AS",
+        "AZ",
+        "AR",
+        "CA",
+        "CO",
+        "CT",
+        "DE",
+        "DC",
+        "FL",
+        "GA",
+        "GU",
+        "HI",
+        "ID",
+        "IL",
+        "IN",
+        "IA",
+        "KS",
+        "KY",
+        "LA",
+        "ME",
+        "MD",
+        "MA",
+        "MI",
+        "MN",
+        "MS",
+        "MO",
+        "MT",
+        "NE",
+        "NV",
+        "NH",
+        "NJ",
+        "NM",
+        "NY",
+        "NC",
+        "ND",
+        "MP",
+        "OH",
+        "OK",
+        "OR",
+        "PA",
+        "PR",
+        "RI",
+        "SC",
+        "SD",
+        "TN",
+        "TX",
+        "UT",
+        "VT",
+        "VA",
+        "VI",
+        "WA",
+        "WV",
+        "WI",
+        "WY",
+    ]
+    """US state for geolocation (only valid when country is US)"""
+    tag: str
+    """User-defined tag for request identification"""
+    template: Template
+    """Userbrowser creation template configuration"""
+    type: str
+    """Type of query or scraping template"""
+    userbrowser_creation_template_rendered: UserbrowserCreationTemplateRendered
+    """Pre-rendered userbrowser creation template configuration"""
+class DebugOptions(TypedDict, total=False):
+    """Debug and troubleshooting options for the request"""
+    collect_har: Union[bool, Literal["never", "on-error", "always"]]
+    no_retry_mode: Union[bool, Literal["never", "always"]]
+    record_screen: Union[bool, Literal["never", "on-error", "always"]]
+    redact: Union[bool, Literal["never", "always"]]
+    show_cursor: Union[bool, Literal["never", "always"]]
+    solve_captcha: Union[bool, Literal["never", "always"]]
+    trace: Union[bool, Literal["never", "on-error", "always"]]
+    upload_engine_logs: Union[bool, Literal["never", "on-error", "always"]]
+    verbose: Union[bool, Literal["never", "always"]]
+    with_proxy_usage: Union[bool, Literal["never", "always"]]
+class BrowserUnionMember1(TypedDict, total=False):
+    name: Required[Literal["chrome", "firefox"]]
+    version: str
+    """Specific browser version to emulate"""
+Browser: TypeAlias = Union[Literal["chrome", "firefox"], BrowserUnionMember1]
+class CookiesUnionMember0Typed(TypedDict, total=False):
+    creation: Optional[str]
+    domain: Optional[str]
+    expires: str
+    extensions: Optional[SequenceNotStr[str]]
+    host_only: Annotated[Optional[bool], PropertyInfo(alias="hostOnly")]
+    http_only: Annotated[Optional[bool], PropertyInfo(alias="httpOnly")]
+    last_accessed: Annotated[Optional[str], PropertyInfo(alias="lastAccessed")]
+    max_age: Annotated[Union[Literal["Infinity", "-Infinity"], float, None], PropertyInfo(alias="maxAge")]
+    name: str
+    path: Optional[str]
+    path_is_default: Annotated[Optional[bool], PropertyInfo(alias="pathIsDefault")]
+    same_site: Annotated[Literal["strict", "lax", "none"], PropertyInfo(alias="sameSite")]
+    secure: bool
+    value: str
+CookiesUnionMember0: TypeAlias = Union[CookiesUnionMember0Typed, Dict[str, object]]
+class Metadata(TypedDict, total=False):
+    """Structured metadata about the request execution context"""
+    account_name: str
+    """Account name associated with the request"""
+    definition_id: int
+    """Definition identifier"""
+    definition_name: str
+    """Name of the definition"""
+    endpoint: str
+    """API endpoint being called"""
+    execution_id: str
+    """Unique identifier for this execution"""
+    flowit_task_id: str
+    """FlowIt task identifier"""
+    input_id: str
+    """Input data identifier"""
+    pipeline_execution_id: int
+    """Identifier for the pipeline execution"""
+    query_template_id: str
+    """Query template identifier"""
+    source: str
+    """Source system or application making the request"""
+    template_id: int
+    """Template identifier"""
+    template_name: str
+    """Name of the template"""
+class NetworkCaptureURL(TypedDict, total=False):
+    value: Required[str]
+    type: Literal["exact", "contains"]
+class NetworkCapture(TypedDict, total=False):
+    method: Literal["GET", "HEAD", "POST", "PUT", "DELETE", "CONNECT", "OPTIONS", "TRACE", "PATCH"]
+    resource_type: Union[str, SequenceNotStr[str]]
+    """Resource type for network capture filtering"""
+    status_code: Union[float, Iterable[float]]
+    url: NetworkCaptureURL
+    validation: bool
+    wait_for_requests_count: float
+    wait_for_requests_count_timeout: float
+class ParseOptionsTyped(TypedDict, total=False):
+    """Configuration options for parsing behavior"""
+    merge_dynamic: bool
+    """Whether to merge dynamic parsing results with static results"""
+ParseOptions: TypeAlias = Union[ParseOptionsTyped, Dict[str, object]]
+class QueryTemplatePaginationNextPageParams(TypedDict, total=False):
+    next_page_params: Required[Dict[str, object]]
+class QueryTemplatePaginationUnionMember1(TypedDict, total=False):
+    next_page_params: Required[Dict[str, object]]
+QueryTemplatePagination: TypeAlias = Union[
+    QueryTemplatePaginationNextPageParams, Iterable[QueryTemplatePaginationUnionMember1]
+]
+class QueryTemplateTyped(TypedDict, total=False):
+    """Query template configuration for structured data extraction"""
+    id: Required[str]
+    api_type: Literal["WEB", "SERP", "SOCIAL"]
+    pagination: QueryTemplatePagination
+    params: Dict[str, object]
+QueryTemplate: TypeAlias = Union[QueryTemplateTyped, Dict[str, object]]
+class RenderOptionsHackiumConfiguration(TypedDict, total=False):
+    """Configuration for Hackium browser modifications"""
+    collect_logs: bool
+    do_not_fix_math_salt: bool
+    enable_document_element_spoof: bool
+    enable_document_has_focus: bool
+    enable_fake_navigation_history: bool
+    enable_key_ordering: bool
+    enable_sniffer: bool
+    enable_verbose_logs: bool
+class RenderOptions(TypedDict, total=False):
+    adblock: bool
+    """Whether to enable ad blocking"""
+    blocked_domains: SequenceNotStr[str]
+    """Domains to block from loading"""
+    browser_engine: Union[Literal["chrome", "hackium", "firefox", "hackfox"], Dict[str, float]]
+    """Browser engine to use, or weighted distribution of engines"""
+    cache: bool
+    """Whether to enable browser caching"""
+    connector_type: Literal["puppeteer", "puppeteer-cdp", "puppeteer-bidi", "webit-cdp", "playwright"]
+    """Type of browser connector to use"""
+    disabled_resources: List[
+        Literal[
+            "other",
+            "document",
+            "stylesheet",
+            "image",
+            "media",
+            "font",
+            "script",
+            "texttrack",
+            "xhr",
+            "fetch",
+            "eventsource",
+            "websocket",
+            "manifest",
+            "signedexchange",
+            "ping",
+            "cspviolationreport",
+            "prefetch",
+            "preflight",
+            "fedcm",
+        ]
+    ]
+    """Types of resources to block from loading"""
+    enable_2captcha: bool
+    """Whether to use 2Captcha service for solving captchas"""
+    extensions: SequenceNotStr[str]
+    """Browser extensions to load"""
+    fingerprint_id: str
+    """Fingerprint identifier for browser customization"""
+    hackium_configuration: RenderOptionsHackiumConfiguration
+    """Configuration for Hackium browser modifications"""
+    headless: bool
+    """Whether to run browser in headless mode"""
+    include_iframes: bool
+    """Whether to include iframe content in the result"""
+    load_local_storage: bool
+    """Whether to load previously stored localStorage data"""
+    local_storage_keys_to_load: SequenceNotStr[str]
+    """Specific localStorage keys to load"""
+    mouse_strategy: Literal["linear", "ghost-cursor", "windmouse"]
+    """Strategy for simulating mouse movements"""
+    no_accept_encoding: bool
+    """Disable content encoding to avoid cached responses"""
+    override_permissions: bool
+    """Whether to override default browser permissions"""
+    random_header_order: bool
+    """Whether to randomize HTTP header order"""
+    render_type: Literal["domcontentloaded", "load", "idle0", "networkidle0", "idle2", "networkidle2", "navigate"]
+    """Type of render completion to wait for"""
+    store_local_storage: bool
+    """Whether to store localStorage data for future sessions"""
+    timeout: float
+    """Maximum time in milliseconds to wait for page render"""
+    typing_interval: float
+    """Interval in milliseconds between key presses"""
+    typing_strategy: Literal["simple", "distribution"]
+    """Strategy for simulating keyboard typing"""
+    userbrowser: bool
+    """Whether to use a persistent browser session"""
+    wait_until: Literal["load", "domcontentloaded", "idle0", "idle2", "networkidle0", "networkidle2", "navigate"]
+    """Browser event to wait for before considering page loaded"""
+    with_performance_metrics: bool
+    """Whether to collect performance metrics during rendering"""
+class Session(TypedDict, total=False):
+    id: str
+    prefetch_userbrowser: bool
+    retry: bool
+    timeout: float
+class Template(TypedDict, total=False):
+    """Userbrowser creation template configuration"""
+    name: Required[str]
+    params: Dict[str, object]
+class UserbrowserCreationTemplateRendered(TypedDict, total=False):
+    """Pre-rendered userbrowser creation template configuration"""
+    id: Required[str]
+    allowed_parameter_names: Required[SequenceNotStr[str]]
+    render_flow_rendered: Required[Iterable[Dict[str, object]]]