From 125ebe5cb023b276c01bdc8c3cafbe8841dffddb Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 26 Jun 2026 16:47:21 +0000 Subject: [PATCH 1/5] feat(api): api update --- .stats.yml | 4 +- README.md | 12 +- .../models/web_screenshot_params.rb | 225 ++++++++- .../models/web_web_crawl_md_params.rb | 227 ++++++++- .../models/web_web_scrape_html_params.rb | 225 ++++++++- .../models/web_web_scrape_md_params.rb | 225 ++++++++- lib/context_dev/resources/web.rb | 16 +- .../models/web_screenshot_params.rbi | 242 ++++++++++ .../models/web_web_crawl_md_params.rbi | 245 ++++++++++ .../models/web_web_scrape_html_params.rbi | 450 ++++++++++++++++++ .../models/web_web_scrape_md_params.rbi | 244 ++++++++++ rbi/context_dev/resources/web.rbi | 17 + .../models/web_screenshot_params.rbs | 426 +++++++++++++++++ .../models/web_web_crawl_md_params.rbs | 426 +++++++++++++++++ .../models/web_web_scrape_html_params.rbs | 426 +++++++++++++++++ .../models/web_web_scrape_md_params.rbs | 426 +++++++++++++++++ sig/context_dev/resources/web.rbs | 4 + 17 files changed, 3824 insertions(+), 16 deletions(-) diff --git a/.stats.yml b/.stats.yml index e34b116d..24c57ba3 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 25 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-4903d5902cec6a80f42b9adaa9cf0defa9805ff22d7ae96970d209a4f867e195.yml -openapi_spec_hash: 1097891c23530dfe0155f23170daf973 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-00c5b8f1ebfe212bc8fb46204f5c05507630afa55b10f77e3a43c66d21edbb77.yml +openapi_spec_hash: 8bf4489b9bce0e52a89480109ffc5257 config_hash: c7b0cdaba3b9797b77efd89e1754d803 diff --git a/README.md b/README.md index 434a4b21..be0aa53a 100644 --- a/README.md +++ b/README.md @@ -206,11 +206,11 @@ context_dev.brand.retrieve(**params) Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime: ```ruby -# :true -puts(ContextDev::WebScreenshotParams::FullScreenshot::TRUE) +# :ad +puts(ContextDev::WebScreenshotParams::Country::AD) -# Revealed type: `T.all(ContextDev::WebScreenshotParams::FullScreenshot, Symbol)` -T.reveal_type(ContextDev::WebScreenshotParams::FullScreenshot::TRUE) +# Revealed type: `T.all(ContextDev::WebScreenshotParams::Country, Symbol)` +T.reveal_type(ContextDev::WebScreenshotParams::Country::AD) ``` Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value: @@ -218,13 +218,13 @@ Enum parameters have a "relaxed" type, so you can either pass in enum constants ```ruby # Using the enum constants preserves the tagged type information: context_dev.web.screenshot( - full_screenshot: ContextDev::WebScreenshotParams::FullScreenshot::TRUE, + country: ContextDev::WebScreenshotParams::Country::AD, # … ) # Literal values are also permissible: context_dev.web.screenshot( - full_screenshot: :true, + country: :ad, # … ) ``` diff --git a/lib/context_dev/models/web_screenshot_params.rb b/lib/context_dev/models/web_screenshot_params.rb index 3f66b3c5..d9172a81 100644 --- a/lib/context_dev/models/web_screenshot_params.rb +++ b/lib/context_dev/models/web_screenshot_params.rb @@ -7,6 +7,13 @@ class WebScreenshotParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters + # @!attribute country + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + # + # @return [Symbol, ContextDev::Models::WebScreenshotParams::Country, nil] + optional :country, enum: -> { ContextDev::WebScreenshotParams::Country } + # @!attribute direct_url # A specific URL to screenshot directly, bypassing domain resolution (e.g., # 'https://example.com/pricing'). When provided, the screenshot is taken of this @@ -90,10 +97,12 @@ class WebScreenshotParams < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :wait_for_ms, Integer - # @!method initialize(direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, request_options: {}) + # @!method initialize(country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebScreenshotParams} for more details. # + # @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country] Two-letter ISO 3166-1 alpha-2 country code for the website request location. Whe + # # @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https # # @param domain [String] Domain name to take screenshot of (e.g., 'example.com', 'google.com'). The domai @@ -116,6 +125,220 @@ class WebScreenshotParams < ContextDev::Internal::Type::BaseModel # # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}] + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + module Country + extend ContextDev::Internal::Type::Enum + + AD = :ad + AE = :ae + AF = :af + AG = :ag + AI = :ai + AL = :al + AM = :am + AO = :ao + AR = :ar + AT = :at + AU = :au + AW = :aw + AZ = :az + BA = :ba + BB = :bb + BD = :bd + BE = :be + BF = :bf + BG = :bg + BH = :bh + BI = :bi + BJ = :bj + BM = :bm + BN = :bn + BO = :bo + BQ = :bq + BR = :br + BS = :bs + BW = :bw + BY = :by + BZ = :bz + CA = :ca + CD = :cd + CF = :cf + CG = :cg + CH = :ch + CI = :ci + CL = :cl + CM = :cm + CN = :cn + CO = :co + CR = :cr + CV = :cv + CW = :cw + CY = :cy + CZ = :cz + DE = :de + DJ = :dj + DK = :dk + DM = :dm + DO = :do + DZ = :dz + EC = :ec + EE = :ee + EG = :eg + ES = :es + ET = :et + FI = :fi + FJ = :fj + FR = :fr + GA = :ga + GB = :gb + GD = :gd + GE = :ge + GF = :gf + GG = :gg + GH = :gh + GM = :gm + GN = :gn + GP = :gp + GQ = :gq + GR = :gr + GT = :gt + GU = :gu + GW = :gw + GY = :gy + HK = :hk + HN = :hn + HR = :hr + HT = :ht + HU = :hu + ID = :id + IE = :ie + IL = :il + IM = :im + IN = :in + IQ = :iq + IR = :ir + IS = :is + IT = :it + JE = :je + JM = :jm + JO = :jo + JP = :jp + KE = :ke + KG = :kg + KH = :kh + KN = :kn + KR = :kr + KW = :kw + KY = :ky + KZ = :kz + LA = :la + LB = :lb + LC = :lc + LK = :lk + LR = :lr + LS = :ls + LT = :lt + LU = :lu + LV = :lv + LY = :ly + MA = :ma + MC = :mc + MD = :md + ME = :me + MF = :mf + MG = :mg + MK = :mk + ML = :ml + MM = :mm + MN = :mn + MO = :mo + MQ = :mq + MR = :mr + MT = :mt + MU = :mu + MV = :mv + MW = :mw + MX = :mx + MY = :my + MZ = :mz + NA = :na + NC = :nc + NE = :ne + NG = :ng + NI = :ni + NL = :nl + NO = :no + NP = :np + NZ = :nz + OM = :om + PA = :pa + PE = :pe + PF = :pf + PG = :pg + PH = :ph + PK = :pk + PL = :pl + PR = :pr + PS = :ps + PT = :pt + PY = :py + QA = :qa + RE = :re + RO = :ro + RS = :rs + RU = :ru + RW = :rw + SA = :sa + SC = :sc + SD = :sd + SE = :se + SG = :sg + SI = :si + SK = :sk + SL = :sl + SM = :sm + SN = :sn + SO = :so + SR = :sr + SS = :ss + ST = :st + SV = :sv + SX = :sx + SY = :sy + SZ = :sz + TC = :tc + TD = :td + TG = :tg + TH = :th + TJ = :tj + TL = :tl + TM = :tm + TN = :tn + TR = :tr + TT = :tt + TW = :tw + TZ = :tz + UA = :ua + UG = :ug + US = :us + UY = :uy + UZ = :uz + VC = :vc + VE = :ve + VG = :vg + VI = :vi + VN = :vn + YE = :ye + YT = :yt + ZA = :za + ZM = :zm + ZW = :zw + + # @!method self.values + # @return [Array] + end + # Optional parameter to determine screenshot type. If 'true', takes a full page # screenshot capturing all content. If 'false' or not provided, takes a viewport # screenshot (standard browser view). diff --git a/lib/context_dev/models/web_web_crawl_md_params.rb b/lib/context_dev/models/web_web_crawl_md_params.rb index 48d90bbf..85c47967 100644 --- a/lib/context_dev/models/web_web_crawl_md_params.rb +++ b/lib/context_dev/models/web_web_crawl_md_params.rb @@ -13,6 +13,14 @@ class WebWebCrawlMdParams < ContextDev::Internal::Type::BaseModel # @return [String] required :url, String + # @!attribute country + # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev + # residential proxy exit location. Must be one of Context.dev's supported + # countries. When provided, Context.dev fetches the target page from that country. + # + # @return [Symbol, ContextDev::Models::WebWebCrawlMdParams::Country, nil] + optional :country, enum: -> { ContextDev::WebWebCrawlMdParams::Country } + # @!attribute exclude_selectors # CSS selectors to remove before each crawled page is converted to Markdown. # Applied after includeSelectors. Exclusion takes precedence: an element matching @@ -127,12 +135,14 @@ class WebWebCrawlMdParams < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :wait_for_ms, Integer, api_name: :waitForMs - # @!method initialize(url:, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, shorten_base64_images: nil, stop_after_ms: nil, timeout_ms: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) + # @!method initialize(url:, country: nil, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, shorten_base64_images: nil, stop_after_ms: nil, timeout_ms: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebWebCrawlMdParams} for more details. # # @param url [String] The starting URL for the crawl (must include http:// or https:// protocol) # + # @param country [Symbol, ContextDev::Models::WebWebCrawlMdParams::Country] Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev r + # # @param exclude_selectors [Array] CSS selectors to remove before each crawled page is converted to Markdown. Appli # # @param follow_subdomains [Boolean] When true, follow links on subdomains of the starting URL's domain (e.g. docs.ex @@ -167,6 +177,221 @@ class WebWebCrawlMdParams < ContextDev::Internal::Type::BaseModel # # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}] + # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev + # residential proxy exit location. Must be one of Context.dev's supported + # countries. When provided, Context.dev fetches the target page from that country. + module Country + extend ContextDev::Internal::Type::Enum + + AD = :ad + AE = :ae + AF = :af + AG = :ag + AI = :ai + AL = :al + AM = :am + AO = :ao + AR = :ar + AT = :at + AU = :au + AW = :aw + AZ = :az + BA = :ba + BB = :bb + BD = :bd + BE = :be + BF = :bf + BG = :bg + BH = :bh + BI = :bi + BJ = :bj + BM = :bm + BN = :bn + BO = :bo + BQ = :bq + BR = :br + BS = :bs + BW = :bw + BY = :by + BZ = :bz + CA = :ca + CD = :cd + CF = :cf + CG = :cg + CH = :ch + CI = :ci + CL = :cl + CM = :cm + CN = :cn + CO = :co + CR = :cr + CV = :cv + CW = :cw + CY = :cy + CZ = :cz + DE = :de + DJ = :dj + DK = :dk + DM = :dm + DO = :do + DZ = :dz + EC = :ec + EE = :ee + EG = :eg + ES = :es + ET = :et + FI = :fi + FJ = :fj + FR = :fr + GA = :ga + GB = :gb + GD = :gd + GE = :ge + GF = :gf + GG = :gg + GH = :gh + GM = :gm + GN = :gn + GP = :gp + GQ = :gq + GR = :gr + GT = :gt + GU = :gu + GW = :gw + GY = :gy + HK = :hk + HN = :hn + HR = :hr + HT = :ht + HU = :hu + ID = :id + IE = :ie + IL = :il + IM = :im + IN = :in + IQ = :iq + IR = :ir + IS = :is + IT = :it + JE = :je + JM = :jm + JO = :jo + JP = :jp + KE = :ke + KG = :kg + KH = :kh + KN = :kn + KR = :kr + KW = :kw + KY = :ky + KZ = :kz + LA = :la + LB = :lb + LC = :lc + LK = :lk + LR = :lr + LS = :ls + LT = :lt + LU = :lu + LV = :lv + LY = :ly + MA = :ma + MC = :mc + MD = :md + ME = :me + MF = :mf + MG = :mg + MK = :mk + ML = :ml + MM = :mm + MN = :mn + MO = :mo + MQ = :mq + MR = :mr + MT = :mt + MU = :mu + MV = :mv + MW = :mw + MX = :mx + MY = :my + MZ = :mz + NA = :na + NC = :nc + NE = :ne + NG = :ng + NI = :ni + NL = :nl + NO = :no + NP = :np + NZ = :nz + OM = :om + PA = :pa + PE = :pe + PF = :pf + PG = :pg + PH = :ph + PK = :pk + PL = :pl + PR = :pr + PS = :ps + PT = :pt + PY = :py + QA = :qa + RE = :re + RO = :ro + RS = :rs + RU = :ru + RW = :rw + SA = :sa + SC = :sc + SD = :sd + SE = :se + SG = :sg + SI = :si + SK = :sk + SL = :sl + SM = :sm + SN = :sn + SO = :so + SR = :sr + SS = :ss + ST = :st + SV = :sv + SX = :sx + SY = :sy + SZ = :sz + TC = :tc + TD = :td + TG = :tg + TH = :th + TJ = :tj + TL = :tl + TM = :tm + TN = :tn + TR = :tr + TT = :tt + TW = :tw + TZ = :tz + UA = :ua + UG = :ug + US = :us + UY = :uy + UZ = :uz + VC = :vc + VE = :ve + VG = :vg + VI = :vi + VN = :vn + YE = :ye + YT = :yt + ZA = :za + ZM = :zm + ZW = :zw + + # @!method self.values + # @return [Array] + end + class Pdf < ContextDev::Internal::Type::BaseModel # @!attribute end_ # Last 1-based PDF page to parse. When omitted, parsing ends at the last page. diff --git a/lib/context_dev/models/web_web_scrape_html_params.rb b/lib/context_dev/models/web_web_scrape_html_params.rb index bc3ebac1..ef9b5ac0 100644 --- a/lib/context_dev/models/web_web_scrape_html_params.rb +++ b/lib/context_dev/models/web_web_scrape_html_params.rb @@ -13,6 +13,13 @@ class WebWebScrapeHTMLParams < ContextDev::Internal::Type::BaseModel # @return [String] required :url, String + # @!attribute country + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + # + # @return [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Country, nil] + optional :country, enum: -> { ContextDev::WebWebScrapeHTMLParams::Country } + # @!attribute exclude_selectors # CSS selectors to remove from the result. Applied after includeSelectors. # Exclusion takes precedence: an element matching both is removed. Examples: @@ -80,12 +87,14 @@ class WebWebScrapeHTMLParams < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :wait_for_ms, Integer - # @!method initialize(url:, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) + # @!method initialize(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebWebScrapeHTMLParams} for more details. # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # + # @param country [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Country] Two-letter ISO 3166-1 alpha-2 country code for the website request location. Whe + # # @param exclude_selectors [Array] CSS selectors to remove from the result. Applied after includeSelectors. Exclusi # # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob @@ -106,6 +115,220 @@ class WebWebScrapeHTMLParams < ContextDev::Internal::Type::BaseModel # # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}] + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + module Country + extend ContextDev::Internal::Type::Enum + + AD = :ad + AE = :ae + AF = :af + AG = :ag + AI = :ai + AL = :al + AM = :am + AO = :ao + AR = :ar + AT = :at + AU = :au + AW = :aw + AZ = :az + BA = :ba + BB = :bb + BD = :bd + BE = :be + BF = :bf + BG = :bg + BH = :bh + BI = :bi + BJ = :bj + BM = :bm + BN = :bn + BO = :bo + BQ = :bq + BR = :br + BS = :bs + BW = :bw + BY = :by + BZ = :bz + CA = :ca + CD = :cd + CF = :cf + CG = :cg + CH = :ch + CI = :ci + CL = :cl + CM = :cm + CN = :cn + CO = :co + CR = :cr + CV = :cv + CW = :cw + CY = :cy + CZ = :cz + DE = :de + DJ = :dj + DK = :dk + DM = :dm + DO = :do + DZ = :dz + EC = :ec + EE = :ee + EG = :eg + ES = :es + ET = :et + FI = :fi + FJ = :fj + FR = :fr + GA = :ga + GB = :gb + GD = :gd + GE = :ge + GF = :gf + GG = :gg + GH = :gh + GM = :gm + GN = :gn + GP = :gp + GQ = :gq + GR = :gr + GT = :gt + GU = :gu + GW = :gw + GY = :gy + HK = :hk + HN = :hn + HR = :hr + HT = :ht + HU = :hu + ID = :id + IE = :ie + IL = :il + IM = :im + IN = :in + IQ = :iq + IR = :ir + IS = :is + IT = :it + JE = :je + JM = :jm + JO = :jo + JP = :jp + KE = :ke + KG = :kg + KH = :kh + KN = :kn + KR = :kr + KW = :kw + KY = :ky + KZ = :kz + LA = :la + LB = :lb + LC = :lc + LK = :lk + LR = :lr + LS = :ls + LT = :lt + LU = :lu + LV = :lv + LY = :ly + MA = :ma + MC = :mc + MD = :md + ME = :me + MF = :mf + MG = :mg + MK = :mk + ML = :ml + MM = :mm + MN = :mn + MO = :mo + MQ = :mq + MR = :mr + MT = :mt + MU = :mu + MV = :mv + MW = :mw + MX = :mx + MY = :my + MZ = :mz + NA = :na + NC = :nc + NE = :ne + NG = :ng + NI = :ni + NL = :nl + NO = :no + NP = :np + NZ = :nz + OM = :om + PA = :pa + PE = :pe + PF = :pf + PG = :pg + PH = :ph + PK = :pk + PL = :pl + PR = :pr + PS = :ps + PT = :pt + PY = :py + QA = :qa + RE = :re + RO = :ro + RS = :rs + RU = :ru + RW = :rw + SA = :sa + SC = :sc + SD = :sd + SE = :se + SG = :sg + SI = :si + SK = :sk + SL = :sl + SM = :sm + SN = :sn + SO = :so + SR = :sr + SS = :ss + ST = :st + SV = :sv + SX = :sx + SY = :sy + SZ = :sz + TC = :tc + TD = :td + TG = :tg + TH = :th + TJ = :tj + TL = :tl + TM = :tm + TN = :tn + TR = :tr + TT = :tt + TW = :tw + TZ = :tz + UA = :ua + UG = :ug + US = :us + UY = :uy + UZ = :uz + VC = :vc + VE = :ve + VG = :vg + VI = :vi + VN = :vn + YE = :ye + YT = :yt + ZA = :za + ZM = :zm + ZW = :zw + + # @!method self.values + # @return [Array] + end + class Pdf < ContextDev::Internal::Type::BaseModel # @!attribute end_ # Last 1-based PDF page to parse. When omitted, parsing ends at the last page. diff --git a/lib/context_dev/models/web_web_scrape_md_params.rb b/lib/context_dev/models/web_web_scrape_md_params.rb index 40fe595c..e5966e52 100644 --- a/lib/context_dev/models/web_web_scrape_md_params.rb +++ b/lib/context_dev/models/web_web_scrape_md_params.rb @@ -14,6 +14,13 @@ class WebWebScrapeMdParams < ContextDev::Internal::Type::BaseModel # @return [String] required :url, String + # @!attribute country + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + # + # @return [Symbol, ContextDev::Models::WebWebScrapeMdParams::Country, nil] + optional :country, enum: -> { ContextDev::WebWebScrapeMdParams::Country } + # @!attribute exclude_selectors # CSS selectors to remove before conversion to Markdown. Applied after # includeSelectors. Exclusion takes precedence: an element matching both is @@ -99,12 +106,14 @@ class WebWebScrapeMdParams < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :wait_for_ms, Integer - # @!method initialize(url:, exclude_selectors: nil, headers: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) + # @!method initialize(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebWebScrapeMdParams} for more details. # # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr # + # @param country [Symbol, ContextDev::Models::WebWebScrapeMdParams::Country] Two-letter ISO 3166-1 alpha-2 country code for the website request location. Whe + # # @param exclude_selectors [Array] CSS selectors to remove before conversion to Markdown. Applied after includeSele # # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob @@ -131,6 +140,220 @@ class WebWebScrapeMdParams < ContextDev::Internal::Type::BaseModel # # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}] + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + module Country + extend ContextDev::Internal::Type::Enum + + AD = :ad + AE = :ae + AF = :af + AG = :ag + AI = :ai + AL = :al + AM = :am + AO = :ao + AR = :ar + AT = :at + AU = :au + AW = :aw + AZ = :az + BA = :ba + BB = :bb + BD = :bd + BE = :be + BF = :bf + BG = :bg + BH = :bh + BI = :bi + BJ = :bj + BM = :bm + BN = :bn + BO = :bo + BQ = :bq + BR = :br + BS = :bs + BW = :bw + BY = :by + BZ = :bz + CA = :ca + CD = :cd + CF = :cf + CG = :cg + CH = :ch + CI = :ci + CL = :cl + CM = :cm + CN = :cn + CO = :co + CR = :cr + CV = :cv + CW = :cw + CY = :cy + CZ = :cz + DE = :de + DJ = :dj + DK = :dk + DM = :dm + DO = :do + DZ = :dz + EC = :ec + EE = :ee + EG = :eg + ES = :es + ET = :et + FI = :fi + FJ = :fj + FR = :fr + GA = :ga + GB = :gb + GD = :gd + GE = :ge + GF = :gf + GG = :gg + GH = :gh + GM = :gm + GN = :gn + GP = :gp + GQ = :gq + GR = :gr + GT = :gt + GU = :gu + GW = :gw + GY = :gy + HK = :hk + HN = :hn + HR = :hr + HT = :ht + HU = :hu + ID = :id + IE = :ie + IL = :il + IM = :im + IN = :in + IQ = :iq + IR = :ir + IS = :is + IT = :it + JE = :je + JM = :jm + JO = :jo + JP = :jp + KE = :ke + KG = :kg + KH = :kh + KN = :kn + KR = :kr + KW = :kw + KY = :ky + KZ = :kz + LA = :la + LB = :lb + LC = :lc + LK = :lk + LR = :lr + LS = :ls + LT = :lt + LU = :lu + LV = :lv + LY = :ly + MA = :ma + MC = :mc + MD = :md + ME = :me + MF = :mf + MG = :mg + MK = :mk + ML = :ml + MM = :mm + MN = :mn + MO = :mo + MQ = :mq + MR = :mr + MT = :mt + MU = :mu + MV = :mv + MW = :mw + MX = :mx + MY = :my + MZ = :mz + NA = :na + NC = :nc + NE = :ne + NG = :ng + NI = :ni + NL = :nl + NO = :no + NP = :np + NZ = :nz + OM = :om + PA = :pa + PE = :pe + PF = :pf + PG = :pg + PH = :ph + PK = :pk + PL = :pl + PR = :pr + PS = :ps + PT = :pt + PY = :py + QA = :qa + RE = :re + RO = :ro + RS = :rs + RU = :ru + RW = :rw + SA = :sa + SC = :sc + SD = :sd + SE = :se + SG = :sg + SI = :si + SK = :sk + SL = :sl + SM = :sm + SN = :sn + SO = :so + SR = :sr + SS = :ss + ST = :st + SV = :sv + SX = :sx + SY = :sy + SZ = :sz + TC = :tc + TD = :td + TG = :tg + TH = :th + TJ = :tj + TL = :tl + TM = :tm + TN = :tn + TR = :tr + TT = :tt + TW = :tw + TZ = :tz + UA = :ua + UG = :ug + US = :us + UY = :uy + UZ = :uz + VC = :vc + VE = :ve + VG = :vg + VI = :vi + VN = :vn + YE = :ye + YT = :yt + ZA = :za + ZM = :zm + ZW = :zw + + # @!method self.values + # @return [Array] + end + class Pdf < ContextDev::Internal::Type::BaseModel # @!attribute end_ # Last 1-based PDF page to parse. When omitted, parsing ends at the last page. diff --git a/lib/context_dev/resources/web.rb b/lib/context_dev/resources/web.rb index a7122048..162e31dc 100644 --- a/lib/context_dev/resources/web.rb +++ b/lib/context_dev/resources/web.rb @@ -163,7 +163,9 @@ def extract_styleguide(params = {}) # # Capture a screenshot of a website. # - # @overload screenshot(direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, request_options: {}) + # @overload screenshot(country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, request_options: {}) + # + # @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country] Two-letter ISO 3166-1 alpha-2 country code for the website request location. Whe # # @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https # @@ -253,10 +255,12 @@ def search(params) # Performs a crawl starting from a given URL, extracts page content as Markdown, # and returns results for all crawled pages. # - # @overload web_crawl_md(url:, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, shorten_base64_images: nil, stop_after_ms: nil, timeout_ms: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) + # @overload web_crawl_md(url:, country: nil, exclude_selectors: nil, follow_subdomains: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, shorten_base64_images: nil, stop_after_ms: nil, timeout_ms: nil, url_regex: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # # @param url [String] The starting URL for the crawl (must include http:// or https:// protocol) # + # @param country [Symbol, ContextDev::Models::WebWebCrawlMdParams::Country] Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev r + # # @param exclude_selectors [Array] CSS selectors to remove before each crawled page is converted to Markdown. Appli # # @param follow_subdomains [Boolean] When true, follow links on subdomains of the starting URL's domain (e.g. docs.ex @@ -310,10 +314,12 @@ def web_crawl_md(params) # # Scrapes the given URL and returns the raw HTML content of the page. # - # @overload web_scrape_html(url:, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) + # @overload web_scrape_html(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # # @param url [String] Full URL to scrape (must include http:// or https:// protocol) # + # @param country [Symbol, ContextDev::Models::WebWebScrapeHTMLParams::Country] Two-letter ISO 3166-1 alpha-2 country code for the website request location. Whe + # # @param exclude_selectors [Array] CSS selectors to remove from the result. Applied after includeSelectors. Exclusi # # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob @@ -405,10 +411,12 @@ def web_scrape_images(params) # # Scrapes the given URL into LLM usable Markdown. # - # @overload web_scrape_md(url:, exclude_selectors: nil, headers: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) + # @overload web_scrape_md(url:, country: nil, exclude_selectors: nil, headers: nil, include_frames: nil, include_images: nil, include_links: nil, include_selectors: nil, max_age_ms: nil, pdf: nil, shorten_base64_images: nil, timeout_ms: nil, use_main_content_only: nil, wait_for_ms: nil, request_options: {}) # # @param url [String] Full URL to scrape into LLM usable Markdown (must include http:// or https:// pr # + # @param country [Symbol, ContextDev::Models::WebWebScrapeMdParams::Country] Two-letter ISO 3166-1 alpha-2 country code for the website request location. Whe + # # @param exclude_selectors [Array] CSS selectors to remove before conversion to Markdown. Applied after includeSele # # @param headers [Hash{Symbol=>String}] Optional outbound HTTP headers forwarded only to the target URL, sent as deep-ob diff --git a/rbi/context_dev/models/web_screenshot_params.rbi b/rbi/context_dev/models/web_screenshot_params.rbi index 8531a345..373f0eb1 100644 --- a/rbi/context_dev/models/web_screenshot_params.rbi +++ b/rbi/context_dev/models/web_screenshot_params.rbi @@ -11,6 +11,18 @@ module ContextDev T.any(ContextDev::WebScreenshotParams, ContextDev::Internal::AnyHash) end + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + sig do + returns(T.nilable(ContextDev::WebScreenshotParams::Country::OrSymbol)) + end + attr_reader :country + + sig do + params(country: ContextDev::WebScreenshotParams::Country::OrSymbol).void + end + attr_writer :country + # A specific URL to screenshot directly, bypassing domain resolution (e.g., # 'https://example.com/pricing'). When provided, the screenshot is taken of this # exact URL. You must provide either 'domain' or 'directUrl', but not both. @@ -130,6 +142,7 @@ module ContextDev sig do params( + country: ContextDev::WebScreenshotParams::Country::OrSymbol, direct_url: String, domain: String, full_screenshot: @@ -146,6 +159,9 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + country: nil, # A specific URL to screenshot directly, bypassing domain resolution (e.g., # 'https://example.com/pricing'). When provided, the screenshot is taken of this # exact URL. You must provide either 'domain' or 'directUrl', but not both. @@ -196,6 +212,7 @@ module ContextDev sig do override.returns( { + country: ContextDev::WebScreenshotParams::Country::OrSymbol, direct_url: String, domain: String, full_screenshot: @@ -215,6 +232,231 @@ module ContextDev def to_hash end + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + module Country + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, ContextDev::WebScreenshotParams::Country) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AD = T.let(:ad, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + AE = T.let(:ae, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + AF = T.let(:af, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + AG = T.let(:ag, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + AI = T.let(:ai, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + AL = T.let(:al, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + AM = T.let(:am, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + AO = T.let(:ao, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + AR = T.let(:ar, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + AT = T.let(:at, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + AU = T.let(:au, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + AW = T.let(:aw, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + AZ = T.let(:az, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BA = T.let(:ba, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BB = T.let(:bb, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BD = T.let(:bd, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BE = T.let(:be, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BF = T.let(:bf, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BG = T.let(:bg, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BH = T.let(:bh, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BI = T.let(:bi, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BJ = T.let(:bj, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BM = T.let(:bm, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BN = T.let(:bn, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BO = T.let(:bo, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BQ = T.let(:bq, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BR = T.let(:br, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BS = T.let(:bs, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BW = T.let(:bw, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BY = T.let(:by, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + BZ = T.let(:bz, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CA = T.let(:ca, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CD = T.let(:cd, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CF = T.let(:cf, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CG = T.let(:cg, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CH = T.let(:ch, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CI = T.let(:ci, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CL = T.let(:cl, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CM = T.let(:cm, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CN = T.let(:cn, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CO = T.let(:co, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CR = T.let(:cr, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CV = T.let(:cv, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CW = T.let(:cw, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CY = T.let(:cy, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + CZ = T.let(:cz, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + DE = T.let(:de, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + DJ = T.let(:dj, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + DK = T.let(:dk, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + DM = T.let(:dm, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + DO = T.let(:do, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + DZ = T.let(:dz, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + EC = T.let(:ec, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + EE = T.let(:ee, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + EG = T.let(:eg, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + ES = T.let(:es, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + ET = T.let(:et, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + FI = T.let(:fi, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + FJ = T.let(:fj, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + FR = T.let(:fr, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GA = T.let(:ga, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GB = T.let(:gb, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GD = T.let(:gd, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GE = T.let(:ge, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GF = T.let(:gf, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GG = T.let(:gg, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GH = T.let(:gh, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GM = T.let(:gm, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GN = T.let(:gn, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GP = T.let(:gp, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GQ = T.let(:gq, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GR = T.let(:gr, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GT = T.let(:gt, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GU = T.let(:gu, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GW = T.let(:gw, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + GY = T.let(:gy, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + HK = T.let(:hk, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + HN = T.let(:hn, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + HR = T.let(:hr, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + HT = T.let(:ht, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + HU = T.let(:hu, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + ID = T.let(:id, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + IE = T.let(:ie, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + IL = T.let(:il, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + IM = T.let(:im, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + IN = T.let(:in, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + IQ = T.let(:iq, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + IR = T.let(:ir, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + IS = T.let(:is, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + IT = T.let(:it, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + JE = T.let(:je, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + JM = T.let(:jm, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + JO = T.let(:jo, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + JP = T.let(:jp, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + KE = T.let(:ke, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + KG = T.let(:kg, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + KH = T.let(:kh, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + KN = T.let(:kn, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + KR = T.let(:kr, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + KW = T.let(:kw, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + KY = T.let(:ky, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + KZ = T.let(:kz, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + LA = T.let(:la, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + LB = T.let(:lb, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + LC = T.let(:lc, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + LK = T.let(:lk, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + LR = T.let(:lr, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + LS = T.let(:ls, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + LT = T.let(:lt, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + LU = T.let(:lu, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + LV = T.let(:lv, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + LY = T.let(:ly, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MA = T.let(:ma, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MC = T.let(:mc, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MD = T.let(:md, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + ME = T.let(:me, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MF = T.let(:mf, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MG = T.let(:mg, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MK = T.let(:mk, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + ML = T.let(:ml, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MM = T.let(:mm, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MN = T.let(:mn, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MO = T.let(:mo, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MQ = T.let(:mq, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MR = T.let(:mr, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MT = T.let(:mt, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MU = T.let(:mu, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MV = T.let(:mv, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MW = T.let(:mw, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MX = T.let(:mx, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MY = T.let(:my, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + MZ = T.let(:mz, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + NA = T.let(:na, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + NC = T.let(:nc, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + NE = T.let(:ne, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + NG = T.let(:ng, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + NI = T.let(:ni, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + NL = T.let(:nl, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + NO = T.let(:no, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + NP = T.let(:np, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + NZ = T.let(:nz, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + OM = T.let(:om, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + PA = T.let(:pa, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + PE = T.let(:pe, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + PF = T.let(:pf, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + PG = T.let(:pg, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + PH = T.let(:ph, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + PK = T.let(:pk, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + PL = T.let(:pl, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + PR = T.let(:pr, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + PS = T.let(:ps, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + PT = T.let(:pt, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + PY = T.let(:py, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + QA = T.let(:qa, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + RE = T.let(:re, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + RO = T.let(:ro, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + RS = T.let(:rs, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + RU = T.let(:ru, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + RW = T.let(:rw, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SA = T.let(:sa, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SC = T.let(:sc, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SD = T.let(:sd, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SE = T.let(:se, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SG = T.let(:sg, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SI = T.let(:si, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SK = T.let(:sk, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SL = T.let(:sl, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SM = T.let(:sm, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SN = T.let(:sn, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SO = T.let(:so, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SR = T.let(:sr, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SS = T.let(:ss, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + ST = T.let(:st, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SV = T.let(:sv, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SX = T.let(:sx, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SY = T.let(:sy, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + SZ = T.let(:sz, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + TC = T.let(:tc, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + TD = T.let(:td, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + TG = T.let(:tg, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + TH = T.let(:th, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + TJ = T.let(:tj, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + TL = T.let(:tl, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + TM = T.let(:tm, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + TN = T.let(:tn, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + TR = T.let(:tr, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + TT = T.let(:tt, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + TW = T.let(:tw, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + TZ = T.let(:tz, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + UA = T.let(:ua, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + UG = T.let(:ug, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + US = T.let(:us, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + UY = T.let(:uy, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + UZ = T.let(:uz, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + VC = T.let(:vc, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + VE = T.let(:ve, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + VG = T.let(:vg, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + VI = T.let(:vi, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + VN = T.let(:vn, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + YE = T.let(:ye, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + YT = T.let(:yt, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + ZA = T.let(:za, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + ZM = T.let(:zm, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + ZW = T.let(:zw, ContextDev::WebScreenshotParams::Country::TaggedSymbol) + + sig do + override.returns( + T::Array[ContextDev::WebScreenshotParams::Country::TaggedSymbol] + ) + end + def self.values + end + end + # Optional parameter to determine screenshot type. If 'true', takes a full page # screenshot capturing all content. If 'false' or not provided, takes a viewport # screenshot (standard browser view). diff --git a/rbi/context_dev/models/web_web_crawl_md_params.rbi b/rbi/context_dev/models/web_web_crawl_md_params.rbi index c1f08ea3..a68ae1bf 100644 --- a/rbi/context_dev/models/web_web_crawl_md_params.rbi +++ b/rbi/context_dev/models/web_web_crawl_md_params.rbi @@ -15,6 +15,19 @@ module ContextDev sig { returns(String) } attr_accessor :url + # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev + # residential proxy exit location. Must be one of Context.dev's supported + # countries. When provided, Context.dev fetches the target page from that country. + sig do + returns(T.nilable(ContextDev::WebWebCrawlMdParams::Country::OrSymbol)) + end + attr_reader :country + + sig do + params(country: ContextDev::WebWebCrawlMdParams::Country::OrSymbol).void + end + attr_writer :country + # CSS selectors to remove before each crawled page is converted to Markdown. # Applied after includeSelectors. Exclusion takes precedence: an element matching # both is removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]". @@ -148,6 +161,7 @@ module ContextDev sig do params( url: String, + country: ContextDev::WebWebCrawlMdParams::Country::OrSymbol, exclude_selectors: T::Array[String], follow_subdomains: T::Boolean, include_frames: T::Boolean, @@ -170,6 +184,10 @@ module ContextDev def self.new( # The starting URL for the crawl (must include http:// or https:// protocol) url:, + # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev + # residential proxy exit location. Must be one of Context.dev's supported + # countries. When provided, Context.dev fetches the target page from that country. + country: nil, # CSS selectors to remove before each crawled page is converted to Markdown. # Applied after includeSelectors. Exclusion takes precedence: an element matching # both is removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]". @@ -228,6 +246,7 @@ module ContextDev override.returns( { url: String, + country: ContextDev::WebWebCrawlMdParams::Country::OrSymbol, exclude_selectors: T::Array[String], follow_subdomains: T::Boolean, include_frames: T::Boolean, @@ -251,6 +270,232 @@ module ContextDev def to_hash end + # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev + # residential proxy exit location. Must be one of Context.dev's supported + # countries. When provided, Context.dev fetches the target page from that country. + module Country + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, ContextDev::WebWebCrawlMdParams::Country) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AD = T.let(:ad, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + AE = T.let(:ae, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + AF = T.let(:af, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + AG = T.let(:ag, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + AI = T.let(:ai, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + AL = T.let(:al, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + AM = T.let(:am, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + AO = T.let(:ao, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + AR = T.let(:ar, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + AT = T.let(:at, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + AU = T.let(:au, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + AW = T.let(:aw, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + AZ = T.let(:az, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BA = T.let(:ba, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BB = T.let(:bb, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BD = T.let(:bd, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BE = T.let(:be, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BF = T.let(:bf, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BG = T.let(:bg, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BH = T.let(:bh, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BI = T.let(:bi, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BJ = T.let(:bj, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BM = T.let(:bm, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BN = T.let(:bn, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BO = T.let(:bo, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BQ = T.let(:bq, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BR = T.let(:br, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BS = T.let(:bs, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BW = T.let(:bw, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BY = T.let(:by, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + BZ = T.let(:bz, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CA = T.let(:ca, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CD = T.let(:cd, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CF = T.let(:cf, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CG = T.let(:cg, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CH = T.let(:ch, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CI = T.let(:ci, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CL = T.let(:cl, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CM = T.let(:cm, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CN = T.let(:cn, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CO = T.let(:co, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CR = T.let(:cr, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CV = T.let(:cv, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CW = T.let(:cw, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CY = T.let(:cy, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + CZ = T.let(:cz, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + DE = T.let(:de, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + DJ = T.let(:dj, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + DK = T.let(:dk, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + DM = T.let(:dm, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + DO = T.let(:do, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + DZ = T.let(:dz, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + EC = T.let(:ec, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + EE = T.let(:ee, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + EG = T.let(:eg, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + ES = T.let(:es, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + ET = T.let(:et, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + FI = T.let(:fi, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + FJ = T.let(:fj, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + FR = T.let(:fr, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GA = T.let(:ga, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GB = T.let(:gb, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GD = T.let(:gd, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GE = T.let(:ge, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GF = T.let(:gf, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GG = T.let(:gg, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GH = T.let(:gh, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GM = T.let(:gm, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GN = T.let(:gn, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GP = T.let(:gp, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GQ = T.let(:gq, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GR = T.let(:gr, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GT = T.let(:gt, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GU = T.let(:gu, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GW = T.let(:gw, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + GY = T.let(:gy, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + HK = T.let(:hk, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + HN = T.let(:hn, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + HR = T.let(:hr, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + HT = T.let(:ht, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + HU = T.let(:hu, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + ID = T.let(:id, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + IE = T.let(:ie, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + IL = T.let(:il, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + IM = T.let(:im, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + IN = T.let(:in, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + IQ = T.let(:iq, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + IR = T.let(:ir, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + IS = T.let(:is, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + IT = T.let(:it, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + JE = T.let(:je, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + JM = T.let(:jm, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + JO = T.let(:jo, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + JP = T.let(:jp, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + KE = T.let(:ke, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + KG = T.let(:kg, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + KH = T.let(:kh, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + KN = T.let(:kn, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + KR = T.let(:kr, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + KW = T.let(:kw, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + KY = T.let(:ky, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + KZ = T.let(:kz, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + LA = T.let(:la, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + LB = T.let(:lb, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + LC = T.let(:lc, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + LK = T.let(:lk, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + LR = T.let(:lr, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + LS = T.let(:ls, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + LT = T.let(:lt, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + LU = T.let(:lu, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + LV = T.let(:lv, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + LY = T.let(:ly, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MA = T.let(:ma, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MC = T.let(:mc, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MD = T.let(:md, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + ME = T.let(:me, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MF = T.let(:mf, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MG = T.let(:mg, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MK = T.let(:mk, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + ML = T.let(:ml, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MM = T.let(:mm, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MN = T.let(:mn, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MO = T.let(:mo, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MQ = T.let(:mq, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MR = T.let(:mr, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MT = T.let(:mt, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MU = T.let(:mu, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MV = T.let(:mv, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MW = T.let(:mw, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MX = T.let(:mx, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MY = T.let(:my, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + MZ = T.let(:mz, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + NA = T.let(:na, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + NC = T.let(:nc, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + NE = T.let(:ne, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + NG = T.let(:ng, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + NI = T.let(:ni, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + NL = T.let(:nl, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + NO = T.let(:no, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + NP = T.let(:np, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + NZ = T.let(:nz, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + OM = T.let(:om, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + PA = T.let(:pa, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + PE = T.let(:pe, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + PF = T.let(:pf, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + PG = T.let(:pg, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + PH = T.let(:ph, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + PK = T.let(:pk, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + PL = T.let(:pl, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + PR = T.let(:pr, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + PS = T.let(:ps, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + PT = T.let(:pt, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + PY = T.let(:py, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + QA = T.let(:qa, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + RE = T.let(:re, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + RO = T.let(:ro, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + RS = T.let(:rs, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + RU = T.let(:ru, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + RW = T.let(:rw, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SA = T.let(:sa, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SC = T.let(:sc, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SD = T.let(:sd, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SE = T.let(:se, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SG = T.let(:sg, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SI = T.let(:si, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SK = T.let(:sk, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SL = T.let(:sl, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SM = T.let(:sm, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SN = T.let(:sn, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SO = T.let(:so, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SR = T.let(:sr, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SS = T.let(:ss, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + ST = T.let(:st, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SV = T.let(:sv, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SX = T.let(:sx, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SY = T.let(:sy, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + SZ = T.let(:sz, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + TC = T.let(:tc, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + TD = T.let(:td, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + TG = T.let(:tg, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + TH = T.let(:th, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + TJ = T.let(:tj, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + TL = T.let(:tl, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + TM = T.let(:tm, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + TN = T.let(:tn, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + TR = T.let(:tr, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + TT = T.let(:tt, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + TW = T.let(:tw, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + TZ = T.let(:tz, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + UA = T.let(:ua, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + UG = T.let(:ug, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + US = T.let(:us, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + UY = T.let(:uy, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + UZ = T.let(:uz, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + VC = T.let(:vc, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + VE = T.let(:ve, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + VG = T.let(:vg, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + VI = T.let(:vi, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + VN = T.let(:vn, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + YE = T.let(:ye, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + YT = T.let(:yt, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + ZA = T.let(:za, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + ZM = T.let(:zm, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + ZW = T.let(:zw, ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol) + + sig do + override.returns( + T::Array[ContextDev::WebWebCrawlMdParams::Country::TaggedSymbol] + ) + end + def self.values + end + end + class Pdf < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/web_web_scrape_html_params.rbi b/rbi/context_dev/models/web_web_scrape_html_params.rbi index 854cd7f6..eecce6e0 100644 --- a/rbi/context_dev/models/web_web_scrape_html_params.rbi +++ b/rbi/context_dev/models/web_web_scrape_html_params.rbi @@ -18,6 +18,22 @@ module ContextDev sig { returns(String) } attr_accessor :url + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + sig do + returns( + T.nilable(ContextDev::WebWebScrapeHTMLParams::Country::OrSymbol) + ) + end + attr_reader :country + + sig do + params( + country: ContextDev::WebWebScrapeHTMLParams::Country::OrSymbol + ).void + end + attr_writer :country + # CSS selectors to remove from the result. Applied after includeSelectors. # Exclusion takes precedence: an element matching both is removed. Examples: # "nav", "footer", ".ad-banner", "[aria-hidden=true]". @@ -97,6 +113,7 @@ module ContextDev sig do params( url: String, + country: ContextDev::WebWebScrapeHTMLParams::Country::OrSymbol, exclude_selectors: T::Array[String], headers: T::Hash[Symbol, String], include_frames: T::Boolean, @@ -112,6 +129,9 @@ module ContextDev def self.new( # Full URL to scrape (must include http:// or https:// protocol) url:, + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + country: nil, # CSS selectors to remove from the result. Applied after includeSelectors. # Exclusion takes precedence: an element matching both is removed. Examples: # "nav", "footer", ".ad-banner", "[aria-hidden=true]". @@ -151,6 +171,7 @@ module ContextDev override.returns( { url: String, + country: ContextDev::WebWebScrapeHTMLParams::Country::OrSymbol, exclude_selectors: T::Array[String], headers: T::Hash[Symbol, String], include_frames: T::Boolean, @@ -167,6 +188,435 @@ module ContextDev def to_hash end + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + module Country + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, ContextDev::WebWebScrapeHTMLParams::Country) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AD = + T.let(:ad, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + AE = + T.let(:ae, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + AF = + T.let(:af, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + AG = + T.let(:ag, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + AI = + T.let(:ai, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + AL = + T.let(:al, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + AM = + T.let(:am, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + AO = + T.let(:ao, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + AR = + T.let(:ar, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + AT = + T.let(:at, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + AU = + T.let(:au, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + AW = + T.let(:aw, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + AZ = + T.let(:az, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BA = + T.let(:ba, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BB = + T.let(:bb, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BD = + T.let(:bd, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BE = + T.let(:be, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BF = + T.let(:bf, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BG = + T.let(:bg, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BH = + T.let(:bh, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BI = + T.let(:bi, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BJ = + T.let(:bj, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BM = + T.let(:bm, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BN = + T.let(:bn, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BO = + T.let(:bo, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BQ = + T.let(:bq, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BR = + T.let(:br, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BS = + T.let(:bs, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BW = + T.let(:bw, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BY = + T.let(:by, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + BZ = + T.let(:bz, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CA = + T.let(:ca, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CD = + T.let(:cd, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CF = + T.let(:cf, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CG = + T.let(:cg, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CH = + T.let(:ch, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CI = + T.let(:ci, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CL = + T.let(:cl, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CM = + T.let(:cm, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CN = + T.let(:cn, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CO = + T.let(:co, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CR = + T.let(:cr, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CV = + T.let(:cv, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CW = + T.let(:cw, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CY = + T.let(:cy, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + CZ = + T.let(:cz, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + DE = + T.let(:de, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + DJ = + T.let(:dj, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + DK = + T.let(:dk, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + DM = + T.let(:dm, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + DO = + T.let(:do, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + DZ = + T.let(:dz, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + EC = + T.let(:ec, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + EE = + T.let(:ee, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + EG = + T.let(:eg, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + ES = + T.let(:es, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + ET = + T.let(:et, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + FI = + T.let(:fi, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + FJ = + T.let(:fj, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + FR = + T.let(:fr, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GA = + T.let(:ga, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GB = + T.let(:gb, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GD = + T.let(:gd, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GE = + T.let(:ge, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GF = + T.let(:gf, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GG = + T.let(:gg, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GH = + T.let(:gh, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GM = + T.let(:gm, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GN = + T.let(:gn, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GP = + T.let(:gp, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GQ = + T.let(:gq, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GR = + T.let(:gr, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GT = + T.let(:gt, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GU = + T.let(:gu, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GW = + T.let(:gw, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + GY = + T.let(:gy, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + HK = + T.let(:hk, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + HN = + T.let(:hn, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + HR = + T.let(:hr, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + HT = + T.let(:ht, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + HU = + T.let(:hu, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + ID = + T.let(:id, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + IE = + T.let(:ie, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + IL = + T.let(:il, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + IM = + T.let(:im, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + IN = + T.let(:in, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + IQ = + T.let(:iq, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + IR = + T.let(:ir, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + IS = + T.let(:is, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + IT = + T.let(:it, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + JE = + T.let(:je, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + JM = + T.let(:jm, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + JO = + T.let(:jo, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + JP = + T.let(:jp, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + KE = + T.let(:ke, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + KG = + T.let(:kg, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + KH = + T.let(:kh, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + KN = + T.let(:kn, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + KR = + T.let(:kr, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + KW = + T.let(:kw, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + KY = + T.let(:ky, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + KZ = + T.let(:kz, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + LA = + T.let(:la, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + LB = + T.let(:lb, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + LC = + T.let(:lc, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + LK = + T.let(:lk, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + LR = + T.let(:lr, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + LS = + T.let(:ls, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + LT = + T.let(:lt, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + LU = + T.let(:lu, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + LV = + T.let(:lv, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + LY = + T.let(:ly, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MA = + T.let(:ma, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MC = + T.let(:mc, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MD = + T.let(:md, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + ME = + T.let(:me, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MF = + T.let(:mf, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MG = + T.let(:mg, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MK = + T.let(:mk, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + ML = + T.let(:ml, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MM = + T.let(:mm, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MN = + T.let(:mn, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MO = + T.let(:mo, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MQ = + T.let(:mq, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MR = + T.let(:mr, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MT = + T.let(:mt, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MU = + T.let(:mu, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MV = + T.let(:mv, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MW = + T.let(:mw, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MX = + T.let(:mx, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MY = + T.let(:my, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + MZ = + T.let(:mz, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + NA = + T.let(:na, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + NC = + T.let(:nc, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + NE = + T.let(:ne, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + NG = + T.let(:ng, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + NI = + T.let(:ni, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + NL = + T.let(:nl, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + NO = + T.let(:no, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + NP = + T.let(:np, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + NZ = + T.let(:nz, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + OM = + T.let(:om, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + PA = + T.let(:pa, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + PE = + T.let(:pe, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + PF = + T.let(:pf, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + PG = + T.let(:pg, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + PH = + T.let(:ph, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + PK = + T.let(:pk, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + PL = + T.let(:pl, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + PR = + T.let(:pr, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + PS = + T.let(:ps, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + PT = + T.let(:pt, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + PY = + T.let(:py, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + QA = + T.let(:qa, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + RE = + T.let(:re, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + RO = + T.let(:ro, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + RS = + T.let(:rs, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + RU = + T.let(:ru, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + RW = + T.let(:rw, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SA = + T.let(:sa, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SC = + T.let(:sc, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SD = + T.let(:sd, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SE = + T.let(:se, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SG = + T.let(:sg, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SI = + T.let(:si, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SK = + T.let(:sk, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SL = + T.let(:sl, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SM = + T.let(:sm, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SN = + T.let(:sn, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SO = + T.let(:so, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SR = + T.let(:sr, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SS = + T.let(:ss, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + ST = + T.let(:st, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SV = + T.let(:sv, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SX = + T.let(:sx, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SY = + T.let(:sy, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + SZ = + T.let(:sz, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + TC = + T.let(:tc, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + TD = + T.let(:td, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + TG = + T.let(:tg, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + TH = + T.let(:th, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + TJ = + T.let(:tj, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + TL = + T.let(:tl, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + TM = + T.let(:tm, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + TN = + T.let(:tn, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + TR = + T.let(:tr, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + TT = + T.let(:tt, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + TW = + T.let(:tw, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + TZ = + T.let(:tz, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + UA = + T.let(:ua, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + UG = + T.let(:ug, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + US = + T.let(:us, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + UY = + T.let(:uy, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + UZ = + T.let(:uz, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + VC = + T.let(:vc, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + VE = + T.let(:ve, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + VG = + T.let(:vg, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + VI = + T.let(:vi, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + VN = + T.let(:vn, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + YE = + T.let(:ye, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + YT = + T.let(:yt, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + ZA = + T.let(:za, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + ZM = + T.let(:zm, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + ZW = + T.let(:zw, ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol) + + sig do + override.returns( + T::Array[ContextDev::WebWebScrapeHTMLParams::Country::TaggedSymbol] + ) + end + def self.values + end + end + class Pdf < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/web_web_scrape_md_params.rbi b/rbi/context_dev/models/web_web_scrape_md_params.rbi index 4e4d47dd..b42be75a 100644 --- a/rbi/context_dev/models/web_web_scrape_md_params.rbi +++ b/rbi/context_dev/models/web_web_scrape_md_params.rbi @@ -16,6 +16,20 @@ module ContextDev sig { returns(String) } attr_accessor :url + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + sig do + returns(T.nilable(ContextDev::WebWebScrapeMdParams::Country::OrSymbol)) + end + attr_reader :country + + sig do + params( + country: ContextDev::WebWebScrapeMdParams::Country::OrSymbol + ).void + end + attr_writer :country + # CSS selectors to remove before conversion to Markdown. Applied after # includeSelectors. Exclusion takes precedence: an element matching both is # removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]". @@ -116,6 +130,7 @@ module ContextDev sig do params( url: String, + country: ContextDev::WebWebScrapeMdParams::Country::OrSymbol, exclude_selectors: T::Array[String], headers: T::Hash[Symbol, String], include_frames: T::Boolean, @@ -135,6 +150,9 @@ module ContextDev # Full URL to scrape into LLM usable Markdown (must include http:// or https:// # protocol) url:, + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + country: nil, # CSS selectors to remove before conversion to Markdown. Applied after # includeSelectors. Exclusion takes precedence: an element matching both is # removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]". @@ -180,6 +198,7 @@ module ContextDev override.returns( { url: String, + country: ContextDev::WebWebScrapeMdParams::Country::OrSymbol, exclude_selectors: T::Array[String], headers: T::Hash[Symbol, String], include_frames: T::Boolean, @@ -199,6 +218,231 @@ module ContextDev def to_hash end + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + module Country + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, ContextDev::WebWebScrapeMdParams::Country) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AD = T.let(:ad, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + AE = T.let(:ae, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + AF = T.let(:af, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + AG = T.let(:ag, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + AI = T.let(:ai, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + AL = T.let(:al, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + AM = T.let(:am, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + AO = T.let(:ao, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + AR = T.let(:ar, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + AT = T.let(:at, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + AU = T.let(:au, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + AW = T.let(:aw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + AZ = T.let(:az, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BA = T.let(:ba, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BB = T.let(:bb, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BD = T.let(:bd, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BE = T.let(:be, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BF = T.let(:bf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BG = T.let(:bg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BH = T.let(:bh, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BI = T.let(:bi, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BJ = T.let(:bj, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BM = T.let(:bm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BN = T.let(:bn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BO = T.let(:bo, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BQ = T.let(:bq, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BR = T.let(:br, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BS = T.let(:bs, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BW = T.let(:bw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BY = T.let(:by, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + BZ = T.let(:bz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CA = T.let(:ca, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CD = T.let(:cd, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CF = T.let(:cf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CG = T.let(:cg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CH = T.let(:ch, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CI = T.let(:ci, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CL = T.let(:cl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CM = T.let(:cm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CN = T.let(:cn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CO = T.let(:co, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CR = T.let(:cr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CV = T.let(:cv, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CW = T.let(:cw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CY = T.let(:cy, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + CZ = T.let(:cz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + DE = T.let(:de, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + DJ = T.let(:dj, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + DK = T.let(:dk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + DM = T.let(:dm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + DO = T.let(:do, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + DZ = T.let(:dz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + EC = T.let(:ec, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + EE = T.let(:ee, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + EG = T.let(:eg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + ES = T.let(:es, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + ET = T.let(:et, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + FI = T.let(:fi, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + FJ = T.let(:fj, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + FR = T.let(:fr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GA = T.let(:ga, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GB = T.let(:gb, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GD = T.let(:gd, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GE = T.let(:ge, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GF = T.let(:gf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GG = T.let(:gg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GH = T.let(:gh, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GM = T.let(:gm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GN = T.let(:gn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GP = T.let(:gp, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GQ = T.let(:gq, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GR = T.let(:gr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GT = T.let(:gt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GU = T.let(:gu, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GW = T.let(:gw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + GY = T.let(:gy, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + HK = T.let(:hk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + HN = T.let(:hn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + HR = T.let(:hr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + HT = T.let(:ht, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + HU = T.let(:hu, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + ID = T.let(:id, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + IE = T.let(:ie, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + IL = T.let(:il, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + IM = T.let(:im, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + IN = T.let(:in, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + IQ = T.let(:iq, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + IR = T.let(:ir, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + IS = T.let(:is, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + IT = T.let(:it, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + JE = T.let(:je, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + JM = T.let(:jm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + JO = T.let(:jo, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + JP = T.let(:jp, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + KE = T.let(:ke, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + KG = T.let(:kg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + KH = T.let(:kh, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + KN = T.let(:kn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + KR = T.let(:kr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + KW = T.let(:kw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + KY = T.let(:ky, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + KZ = T.let(:kz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + LA = T.let(:la, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + LB = T.let(:lb, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + LC = T.let(:lc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + LK = T.let(:lk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + LR = T.let(:lr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + LS = T.let(:ls, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + LT = T.let(:lt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + LU = T.let(:lu, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + LV = T.let(:lv, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + LY = T.let(:ly, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MA = T.let(:ma, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MC = T.let(:mc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MD = T.let(:md, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + ME = T.let(:me, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MF = T.let(:mf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MG = T.let(:mg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MK = T.let(:mk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + ML = T.let(:ml, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MM = T.let(:mm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MN = T.let(:mn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MO = T.let(:mo, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MQ = T.let(:mq, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MR = T.let(:mr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MT = T.let(:mt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MU = T.let(:mu, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MV = T.let(:mv, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MW = T.let(:mw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MX = T.let(:mx, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MY = T.let(:my, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + MZ = T.let(:mz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + NA = T.let(:na, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + NC = T.let(:nc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + NE = T.let(:ne, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + NG = T.let(:ng, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + NI = T.let(:ni, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + NL = T.let(:nl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + NO = T.let(:no, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + NP = T.let(:np, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + NZ = T.let(:nz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + OM = T.let(:om, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + PA = T.let(:pa, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + PE = T.let(:pe, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + PF = T.let(:pf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + PG = T.let(:pg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + PH = T.let(:ph, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + PK = T.let(:pk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + PL = T.let(:pl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + PR = T.let(:pr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + PS = T.let(:ps, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + PT = T.let(:pt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + PY = T.let(:py, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + QA = T.let(:qa, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + RE = T.let(:re, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + RO = T.let(:ro, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + RS = T.let(:rs, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + RU = T.let(:ru, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + RW = T.let(:rw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SA = T.let(:sa, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SC = T.let(:sc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SD = T.let(:sd, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SE = T.let(:se, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SG = T.let(:sg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SI = T.let(:si, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SK = T.let(:sk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SL = T.let(:sl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SM = T.let(:sm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SN = T.let(:sn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SO = T.let(:so, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SR = T.let(:sr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SS = T.let(:ss, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + ST = T.let(:st, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SV = T.let(:sv, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SX = T.let(:sx, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SY = T.let(:sy, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + SZ = T.let(:sz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + TC = T.let(:tc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + TD = T.let(:td, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + TG = T.let(:tg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + TH = T.let(:th, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + TJ = T.let(:tj, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + TL = T.let(:tl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + TM = T.let(:tm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + TN = T.let(:tn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + TR = T.let(:tr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + TT = T.let(:tt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + TW = T.let(:tw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + TZ = T.let(:tz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + UA = T.let(:ua, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + UG = T.let(:ug, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + US = T.let(:us, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + UY = T.let(:uy, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + UZ = T.let(:uz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + VC = T.let(:vc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + VE = T.let(:ve, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + VG = T.let(:vg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + VI = T.let(:vi, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + VN = T.let(:vn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + YE = T.let(:ye, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + YT = T.let(:yt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + ZA = T.let(:za, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + ZM = T.let(:zm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + ZW = T.let(:zw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol) + + sig do + override.returns( + T::Array[ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol] + ) + end + def self.values + end + end + class Pdf < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/resources/web.rbi b/rbi/context_dev/resources/web.rbi index 56dfa06e..f40513b4 100644 --- a/rbi/context_dev/resources/web.rbi +++ b/rbi/context_dev/resources/web.rbi @@ -162,6 +162,7 @@ module ContextDev # Capture a screenshot of a website. sig do params( + country: ContextDev::WebScreenshotParams::Country::OrSymbol, direct_url: String, domain: String, full_screenshot: @@ -178,6 +179,9 @@ module ContextDev ).returns(ContextDev::Models::WebScreenshotResponse) end def screenshot( + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + country: nil, # A specific URL to screenshot directly, bypassing domain resolution (e.g., # 'https://example.com/pricing'). When provided, the screenshot is taken of this # exact URL. You must provide either 'domain' or 'directUrl', but not both. @@ -267,6 +271,7 @@ module ContextDev sig do params( url: String, + country: ContextDev::WebWebCrawlMdParams::Country::OrSymbol, exclude_selectors: T::Array[String], follow_subdomains: T::Boolean, include_frames: T::Boolean, @@ -289,6 +294,10 @@ module ContextDev def web_crawl_md( # The starting URL for the crawl (must include http:// or https:// protocol) url:, + # Two-letter ISO 3166-1 alpha-2 country code identifying a supported Context.dev + # residential proxy exit location. Must be one of Context.dev's supported + # countries. When provided, Context.dev fetches the target page from that country. + country: nil, # CSS selectors to remove before each crawled page is converted to Markdown. # Applied after includeSelectors. Exclusion takes precedence: an element matching # both is removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]". @@ -347,6 +356,7 @@ module ContextDev sig do params( url: String, + country: ContextDev::WebWebScrapeHTMLParams::Country::OrSymbol, exclude_selectors: T::Array[String], headers: T::Hash[Symbol, String], include_frames: T::Boolean, @@ -362,6 +372,9 @@ module ContextDev def web_scrape_html( # Full URL to scrape (must include http:// or https:// protocol) url:, + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + country: nil, # CSS selectors to remove from the result. Applied after includeSelectors. # Exclusion takes precedence: an element matching both is removed. Examples: # "nav", "footer", ".ad-banner", "[aria-hidden=true]". @@ -440,6 +453,7 @@ module ContextDev sig do params( url: String, + country: ContextDev::WebWebScrapeMdParams::Country::OrSymbol, exclude_selectors: T::Array[String], headers: T::Hash[Symbol, String], include_frames: T::Boolean, @@ -459,6 +473,9 @@ module ContextDev # Full URL to scrape into LLM usable Markdown (must include http:// or https:// # protocol) url:, + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. + # When provided, Context.dev fetches the target page from that country. + country: nil, # CSS selectors to remove before conversion to Markdown. Applied after # includeSelectors. Exclusion takes precedence: an element matching both is # removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]". diff --git a/sig/context_dev/models/web_screenshot_params.rbs b/sig/context_dev/models/web_screenshot_params.rbs index 0d418e35..8a3200a2 100644 --- a/sig/context_dev/models/web_screenshot_params.rbs +++ b/sig/context_dev/models/web_screenshot_params.rbs @@ -2,6 +2,7 @@ module ContextDev module Models type web_screenshot_params = { + country: ContextDev::Models::WebScreenshotParams::country, direct_url: String, domain: String, full_screenshot: ContextDev::Models::WebScreenshotParams::full_screenshot, @@ -19,6 +20,12 @@ module ContextDev extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters + attr_reader country: ContextDev::Models::WebScreenshotParams::country? + + def country=: ( + ContextDev::Models::WebScreenshotParams::country + ) -> ContextDev::Models::WebScreenshotParams::country + attr_reader direct_url: String? def direct_url=: (String) -> String @@ -68,6 +75,7 @@ module ContextDev def wait_for_ms=: (Integer) -> Integer def initialize: ( + ?country: ContextDev::Models::WebScreenshotParams::country, ?direct_url: String, ?domain: String, ?full_screenshot: ContextDev::Models::WebScreenshotParams::full_screenshot, @@ -82,6 +90,7 @@ module ContextDev ) -> void def to_hash: -> { + country: ContextDev::Models::WebScreenshotParams::country, direct_url: String, domain: String, full_screenshot: ContextDev::Models::WebScreenshotParams::full_screenshot, @@ -95,6 +104,423 @@ module ContextDev request_options: ContextDev::RequestOptions } + type country = + :ad + | :ae + | :af + | :ag + | :ai + | :al + | :am + | :ao + | :ar + | :at + | :au + | :aw + | :az + | :ba + | :bb + | :bd + | :be + | :bf + | :bg + | :bh + | :bi + | :bj + | :bm + | :bn + | :bo + | :bq + | :br + | :bs + | :bw + | :by + | :bz + | :ca + | :cd + | :cf + | :cg + | :ch + | :ci + | :cl + | :cm + | :cn + | :co + | :cr + | :cv + | :cw + | :cy + | :cz + | :de + | :dj + | :dk + | :dm + | :do + | :dz + | :ec + | :ee + | :eg + | :es + | :et + | :fi + | :fj + | :fr + | :ga + | :gb + | :gd + | :ge + | :gf + | :gg + | :gh + | :gm + | :gn + | :gp + | :gq + | :gr + | :gt + | :gu + | :gw + | :gy + | :hk + | :hn + | :hr + | :ht + | :hu + | :id + | :ie + | :il + | :im + | :in + | :iq + | :ir + | :is + | :it + | :je + | :jm + | :jo + | :jp + | :ke + | :kg + | :kh + | :kn + | :kr + | :kw + | :ky + | :kz + | :la + | :lb + | :lc + | :lk + | :lr + | :ls + | :lt + | :lu + | :lv + | :ly + | :ma + | :mc + | :md + | :me + | :mf + | :mg + | :mk + | :ml + | :mm + | :mn + | :mo + | :mq + | :mr + | :mt + | :mu + | :mv + | :mw + | :mx + | :my + | :mz + | :na + | :nc + | :ne + | :ng + | :ni + | :nl + | :no + | :np + | :nz + | :om + | :pa + | :pe + | :pf + | :pg + | :ph + | :pk + | :pl + | :pr + | :ps + | :pt + | :py + | :qa + | :re + | :ro + | :rs + | :ru + | :rw + | :sa + | :sc + | :sd + | :se + | :sg + | :si + | :sk + | :sl + | :sm + | :sn + | :so + | :sr + | :ss + | :st + | :sv + | :sx + | :sy + | :sz + | :tc + | :td + | :tg + | :th + | :tj + | :tl + | :tm + | :tn + | :tr + | :tt + | :tw + | :tz + | :ua + | :ug + | :us + | :uy + | :uz + | :vc + | :ve + | :vg + | :vi + | :vn + | :ye + | :yt + | :za + | :zm + | :zw + + module Country + extend ContextDev::Internal::Type::Enum + + AD: :ad + AE: :ae + AF: :af + AG: :ag + AI: :ai + AL: :al + AM: :am + AO: :ao + AR: :ar + AT: :at + AU: :au + AW: :aw + AZ: :az + BA: :ba + BB: :bb + BD: :bd + BE: :be + BF: :bf + BG: :bg + BH: :bh + BI: :bi + BJ: :bj + BM: :bm + BN: :bn + BO: :bo + BQ: :bq + BR: :br + BS: :bs + BW: :bw + BY: :by + BZ: :bz + CA: :ca + CD: :cd + CF: :cf + CG: :cg + CH: :ch + CI: :ci + CL: :cl + CM: :cm + CN: :cn + CO: :co + CR: :cr + CV: :cv + CW: :cw + CY: :cy + CZ: :cz + DE: :de + DJ: :dj + DK: :dk + DM: :dm + DO: :do + DZ: :dz + EC: :ec + EE: :ee + EG: :eg + ES: :es + ET: :et + FI: :fi + FJ: :fj + FR: :fr + GA: :ga + GB: :gb + GD: :gd + GE: :ge + GF: :gf + GG: :gg + GH: :gh + GM: :gm + GN: :gn + GP: :gp + GQ: :gq + GR: :gr + GT: :gt + GU: :gu + GW: :gw + GY: :gy + HK: :hk + HN: :hn + HR: :hr + HT: :ht + HU: :hu + ID: :id + IE: :ie + IL: :il + IM: :im + IN: :in + IQ: :iq + IR: :ir + IS: :is + IT: :it + JE: :je + JM: :jm + JO: :jo + JP: :jp + KE: :ke + KG: :kg + KH: :kh + KN: :kn + KR: :kr + KW: :kw + KY: :ky + KZ: :kz + LA: :la + LB: :lb + LC: :lc + LK: :lk + LR: :lr + LS: :ls + LT: :lt + LU: :lu + LV: :lv + LY: :ly + MA: :ma + MC: :mc + MD: :md + ME: :me + MF: :mf + MG: :mg + MK: :mk + ML: :ml + MM: :mm + MN: :mn + MO: :mo + MQ: :mq + MR: :mr + MT: :mt + MU: :mu + MV: :mv + MW: :mw + MX: :mx + MY: :my + MZ: :mz + NA: :na + NC: :nc + NE: :ne + NG: :ng + NI: :ni + NL: :nl + NO: :no + NP: :np + NZ: :nz + OM: :om + PA: :pa + PE: :pe + PF: :pf + PG: :pg + PH: :ph + PK: :pk + PL: :pl + PR: :pr + PS: :ps + PT: :pt + PY: :py + QA: :qa + RE: :re + RO: :ro + RS: :rs + RU: :ru + RW: :rw + SA: :sa + SC: :sc + SD: :sd + SE: :se + SG: :sg + SI: :si + SK: :sk + SL: :sl + SM: :sm + SN: :sn + SO: :so + SR: :sr + SS: :ss + ST: :st + SV: :sv + SX: :sx + SY: :sy + SZ: :sz + TC: :tc + TD: :td + TG: :tg + TH: :th + TJ: :tj + TL: :tl + TM: :tm + TN: :tn + TR: :tr + TT: :tt + TW: :tw + TZ: :tz + UA: :ua + UG: :ug + US: :us + UY: :uy + UZ: :uz + VC: :vc + VE: :ve + VG: :vg + VI: :vi + VN: :vn + YE: :ye + YT: :yt + ZA: :za + ZM: :zm + ZW: :zw + + def self?.values: -> ::Array[ContextDev::Models::WebScreenshotParams::country] + end + type full_screenshot = :true | :false module FullScreenshot diff --git a/sig/context_dev/models/web_web_crawl_md_params.rbs b/sig/context_dev/models/web_web_crawl_md_params.rbs index 7f443035..9d9e217a 100644 --- a/sig/context_dev/models/web_web_crawl_md_params.rbs +++ b/sig/context_dev/models/web_web_crawl_md_params.rbs @@ -3,6 +3,7 @@ module ContextDev type web_web_crawl_md_params = { url: String, + country: ContextDev::Models::WebWebCrawlMdParams::country, exclude_selectors: ::Array[String], follow_subdomains: bool, include_frames: bool, @@ -28,6 +29,12 @@ module ContextDev attr_accessor url: String + attr_reader country: ContextDev::Models::WebWebCrawlMdParams::country? + + def country=: ( + ContextDev::Models::WebWebCrawlMdParams::country + ) -> ContextDev::Models::WebWebCrawlMdParams::country + attr_reader exclude_selectors: ::Array[String]? def exclude_selectors=: (::Array[String]) -> ::Array[String] @@ -96,6 +103,7 @@ module ContextDev def initialize: ( url: String, + ?country: ContextDev::Models::WebWebCrawlMdParams::country, ?exclude_selectors: ::Array[String], ?follow_subdomains: bool, ?include_frames: bool, @@ -117,6 +125,7 @@ module ContextDev def to_hash: -> { url: String, + country: ContextDev::Models::WebWebCrawlMdParams::country, exclude_selectors: ::Array[String], follow_subdomains: bool, include_frames: bool, @@ -136,6 +145,423 @@ module ContextDev request_options: ContextDev::RequestOptions } + type country = + :ad + | :ae + | :af + | :ag + | :ai + | :al + | :am + | :ao + | :ar + | :at + | :au + | :aw + | :az + | :ba + | :bb + | :bd + | :be + | :bf + | :bg + | :bh + | :bi + | :bj + | :bm + | :bn + | :bo + | :bq + | :br + | :bs + | :bw + | :by + | :bz + | :ca + | :cd + | :cf + | :cg + | :ch + | :ci + | :cl + | :cm + | :cn + | :co + | :cr + | :cv + | :cw + | :cy + | :cz + | :de + | :dj + | :dk + | :dm + | :do + | :dz + | :ec + | :ee + | :eg + | :es + | :et + | :fi + | :fj + | :fr + | :ga + | :gb + | :gd + | :ge + | :gf + | :gg + | :gh + | :gm + | :gn + | :gp + | :gq + | :gr + | :gt + | :gu + | :gw + | :gy + | :hk + | :hn + | :hr + | :ht + | :hu + | :id + | :ie + | :il + | :im + | :in + | :iq + | :ir + | :is + | :it + | :je + | :jm + | :jo + | :jp + | :ke + | :kg + | :kh + | :kn + | :kr + | :kw + | :ky + | :kz + | :la + | :lb + | :lc + | :lk + | :lr + | :ls + | :lt + | :lu + | :lv + | :ly + | :ma + | :mc + | :md + | :me + | :mf + | :mg + | :mk + | :ml + | :mm + | :mn + | :mo + | :mq + | :mr + | :mt + | :mu + | :mv + | :mw + | :mx + | :my + | :mz + | :na + | :nc + | :ne + | :ng + | :ni + | :nl + | :no + | :np + | :nz + | :om + | :pa + | :pe + | :pf + | :pg + | :ph + | :pk + | :pl + | :pr + | :ps + | :pt + | :py + | :qa + | :re + | :ro + | :rs + | :ru + | :rw + | :sa + | :sc + | :sd + | :se + | :sg + | :si + | :sk + | :sl + | :sm + | :sn + | :so + | :sr + | :ss + | :st + | :sv + | :sx + | :sy + | :sz + | :tc + | :td + | :tg + | :th + | :tj + | :tl + | :tm + | :tn + | :tr + | :tt + | :tw + | :tz + | :ua + | :ug + | :us + | :uy + | :uz + | :vc + | :ve + | :vg + | :vi + | :vn + | :ye + | :yt + | :za + | :zm + | :zw + + module Country + extend ContextDev::Internal::Type::Enum + + AD: :ad + AE: :ae + AF: :af + AG: :ag + AI: :ai + AL: :al + AM: :am + AO: :ao + AR: :ar + AT: :at + AU: :au + AW: :aw + AZ: :az + BA: :ba + BB: :bb + BD: :bd + BE: :be + BF: :bf + BG: :bg + BH: :bh + BI: :bi + BJ: :bj + BM: :bm + BN: :bn + BO: :bo + BQ: :bq + BR: :br + BS: :bs + BW: :bw + BY: :by + BZ: :bz + CA: :ca + CD: :cd + CF: :cf + CG: :cg + CH: :ch + CI: :ci + CL: :cl + CM: :cm + CN: :cn + CO: :co + CR: :cr + CV: :cv + CW: :cw + CY: :cy + CZ: :cz + DE: :de + DJ: :dj + DK: :dk + DM: :dm + DO: :do + DZ: :dz + EC: :ec + EE: :ee + EG: :eg + ES: :es + ET: :et + FI: :fi + FJ: :fj + FR: :fr + GA: :ga + GB: :gb + GD: :gd + GE: :ge + GF: :gf + GG: :gg + GH: :gh + GM: :gm + GN: :gn + GP: :gp + GQ: :gq + GR: :gr + GT: :gt + GU: :gu + GW: :gw + GY: :gy + HK: :hk + HN: :hn + HR: :hr + HT: :ht + HU: :hu + ID: :id + IE: :ie + IL: :il + IM: :im + IN: :in + IQ: :iq + IR: :ir + IS: :is + IT: :it + JE: :je + JM: :jm + JO: :jo + JP: :jp + KE: :ke + KG: :kg + KH: :kh + KN: :kn + KR: :kr + KW: :kw + KY: :ky + KZ: :kz + LA: :la + LB: :lb + LC: :lc + LK: :lk + LR: :lr + LS: :ls + LT: :lt + LU: :lu + LV: :lv + LY: :ly + MA: :ma + MC: :mc + MD: :md + ME: :me + MF: :mf + MG: :mg + MK: :mk + ML: :ml + MM: :mm + MN: :mn + MO: :mo + MQ: :mq + MR: :mr + MT: :mt + MU: :mu + MV: :mv + MW: :mw + MX: :mx + MY: :my + MZ: :mz + NA: :na + NC: :nc + NE: :ne + NG: :ng + NI: :ni + NL: :nl + NO: :no + NP: :np + NZ: :nz + OM: :om + PA: :pa + PE: :pe + PF: :pf + PG: :pg + PH: :ph + PK: :pk + PL: :pl + PR: :pr + PS: :ps + PT: :pt + PY: :py + QA: :qa + RE: :re + RO: :ro + RS: :rs + RU: :ru + RW: :rw + SA: :sa + SC: :sc + SD: :sd + SE: :se + SG: :sg + SI: :si + SK: :sk + SL: :sl + SM: :sm + SN: :sn + SO: :so + SR: :sr + SS: :ss + ST: :st + SV: :sv + SX: :sx + SY: :sy + SZ: :sz + TC: :tc + TD: :td + TG: :tg + TH: :th + TJ: :tj + TL: :tl + TM: :tm + TN: :tn + TR: :tr + TT: :tt + TW: :tw + TZ: :tz + UA: :ua + UG: :ug + US: :us + UY: :uy + UZ: :uz + VC: :vc + VE: :ve + VG: :vg + VI: :vi + VN: :vn + YE: :ye + YT: :yt + ZA: :za + ZM: :zm + ZW: :zw + + def self?.values: -> ::Array[ContextDev::Models::WebWebCrawlMdParams::country] + end + type pdf = { end_: Integer, should_parse: bool, start: Integer } class Pdf < ContextDev::Internal::Type::BaseModel diff --git a/sig/context_dev/models/web_web_scrape_html_params.rbs b/sig/context_dev/models/web_web_scrape_html_params.rbs index 25b8bb30..c176c854 100644 --- a/sig/context_dev/models/web_web_scrape_html_params.rbs +++ b/sig/context_dev/models/web_web_scrape_html_params.rbs @@ -3,6 +3,7 @@ module ContextDev type web_web_scrape_html_params = { url: String, + country: ContextDev::Models::WebWebScrapeHTMLParams::country, exclude_selectors: ::Array[String], headers: ::Hash[Symbol, String], include_frames: bool, @@ -21,6 +22,12 @@ module ContextDev attr_accessor url: String + attr_reader country: ContextDev::Models::WebWebScrapeHTMLParams::country? + + def country=: ( + ContextDev::Models::WebWebScrapeHTMLParams::country + ) -> ContextDev::Models::WebWebScrapeHTMLParams::country + attr_reader exclude_selectors: ::Array[String]? def exclude_selectors=: (::Array[String]) -> ::Array[String] @@ -61,6 +68,7 @@ module ContextDev def initialize: ( url: String, + ?country: ContextDev::Models::WebWebScrapeHTMLParams::country, ?exclude_selectors: ::Array[String], ?headers: ::Hash[Symbol, String], ?include_frames: bool, @@ -75,6 +83,7 @@ module ContextDev def to_hash: -> { url: String, + country: ContextDev::Models::WebWebScrapeHTMLParams::country, exclude_selectors: ::Array[String], headers: ::Hash[Symbol, String], include_frames: bool, @@ -87,6 +96,423 @@ module ContextDev request_options: ContextDev::RequestOptions } + type country = + :ad + | :ae + | :af + | :ag + | :ai + | :al + | :am + | :ao + | :ar + | :at + | :au + | :aw + | :az + | :ba + | :bb + | :bd + | :be + | :bf + | :bg + | :bh + | :bi + | :bj + | :bm + | :bn + | :bo + | :bq + | :br + | :bs + | :bw + | :by + | :bz + | :ca + | :cd + | :cf + | :cg + | :ch + | :ci + | :cl + | :cm + | :cn + | :co + | :cr + | :cv + | :cw + | :cy + | :cz + | :de + | :dj + | :dk + | :dm + | :do + | :dz + | :ec + | :ee + | :eg + | :es + | :et + | :fi + | :fj + | :fr + | :ga + | :gb + | :gd + | :ge + | :gf + | :gg + | :gh + | :gm + | :gn + | :gp + | :gq + | :gr + | :gt + | :gu + | :gw + | :gy + | :hk + | :hn + | :hr + | :ht + | :hu + | :id + | :ie + | :il + | :im + | :in + | :iq + | :ir + | :is + | :it + | :je + | :jm + | :jo + | :jp + | :ke + | :kg + | :kh + | :kn + | :kr + | :kw + | :ky + | :kz + | :la + | :lb + | :lc + | :lk + | :lr + | :ls + | :lt + | :lu + | :lv + | :ly + | :ma + | :mc + | :md + | :me + | :mf + | :mg + | :mk + | :ml + | :mm + | :mn + | :mo + | :mq + | :mr + | :mt + | :mu + | :mv + | :mw + | :mx + | :my + | :mz + | :na + | :nc + | :ne + | :ng + | :ni + | :nl + | :no + | :np + | :nz + | :om + | :pa + | :pe + | :pf + | :pg + | :ph + | :pk + | :pl + | :pr + | :ps + | :pt + | :py + | :qa + | :re + | :ro + | :rs + | :ru + | :rw + | :sa + | :sc + | :sd + | :se + | :sg + | :si + | :sk + | :sl + | :sm + | :sn + | :so + | :sr + | :ss + | :st + | :sv + | :sx + | :sy + | :sz + | :tc + | :td + | :tg + | :th + | :tj + | :tl + | :tm + | :tn + | :tr + | :tt + | :tw + | :tz + | :ua + | :ug + | :us + | :uy + | :uz + | :vc + | :ve + | :vg + | :vi + | :vn + | :ye + | :yt + | :za + | :zm + | :zw + + module Country + extend ContextDev::Internal::Type::Enum + + AD: :ad + AE: :ae + AF: :af + AG: :ag + AI: :ai + AL: :al + AM: :am + AO: :ao + AR: :ar + AT: :at + AU: :au + AW: :aw + AZ: :az + BA: :ba + BB: :bb + BD: :bd + BE: :be + BF: :bf + BG: :bg + BH: :bh + BI: :bi + BJ: :bj + BM: :bm + BN: :bn + BO: :bo + BQ: :bq + BR: :br + BS: :bs + BW: :bw + BY: :by + BZ: :bz + CA: :ca + CD: :cd + CF: :cf + CG: :cg + CH: :ch + CI: :ci + CL: :cl + CM: :cm + CN: :cn + CO: :co + CR: :cr + CV: :cv + CW: :cw + CY: :cy + CZ: :cz + DE: :de + DJ: :dj + DK: :dk + DM: :dm + DO: :do + DZ: :dz + EC: :ec + EE: :ee + EG: :eg + ES: :es + ET: :et + FI: :fi + FJ: :fj + FR: :fr + GA: :ga + GB: :gb + GD: :gd + GE: :ge + GF: :gf + GG: :gg + GH: :gh + GM: :gm + GN: :gn + GP: :gp + GQ: :gq + GR: :gr + GT: :gt + GU: :gu + GW: :gw + GY: :gy + HK: :hk + HN: :hn + HR: :hr + HT: :ht + HU: :hu + ID: :id + IE: :ie + IL: :il + IM: :im + IN: :in + IQ: :iq + IR: :ir + IS: :is + IT: :it + JE: :je + JM: :jm + JO: :jo + JP: :jp + KE: :ke + KG: :kg + KH: :kh + KN: :kn + KR: :kr + KW: :kw + KY: :ky + KZ: :kz + LA: :la + LB: :lb + LC: :lc + LK: :lk + LR: :lr + LS: :ls + LT: :lt + LU: :lu + LV: :lv + LY: :ly + MA: :ma + MC: :mc + MD: :md + ME: :me + MF: :mf + MG: :mg + MK: :mk + ML: :ml + MM: :mm + MN: :mn + MO: :mo + MQ: :mq + MR: :mr + MT: :mt + MU: :mu + MV: :mv + MW: :mw + MX: :mx + MY: :my + MZ: :mz + NA: :na + NC: :nc + NE: :ne + NG: :ng + NI: :ni + NL: :nl + NO: :no + NP: :np + NZ: :nz + OM: :om + PA: :pa + PE: :pe + PF: :pf + PG: :pg + PH: :ph + PK: :pk + PL: :pl + PR: :pr + PS: :ps + PT: :pt + PY: :py + QA: :qa + RE: :re + RO: :ro + RS: :rs + RU: :ru + RW: :rw + SA: :sa + SC: :sc + SD: :sd + SE: :se + SG: :sg + SI: :si + SK: :sk + SL: :sl + SM: :sm + SN: :sn + SO: :so + SR: :sr + SS: :ss + ST: :st + SV: :sv + SX: :sx + SY: :sy + SZ: :sz + TC: :tc + TD: :td + TG: :tg + TH: :th + TJ: :tj + TL: :tl + TM: :tm + TN: :tn + TR: :tr + TT: :tt + TW: :tw + TZ: :tz + UA: :ua + UG: :ug + US: :us + UY: :uy + UZ: :uz + VC: :vc + VE: :ve + VG: :vg + VI: :vi + VN: :vn + YE: :ye + YT: :yt + ZA: :za + ZM: :zm + ZW: :zw + + def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeHTMLParams::country] + end + type pdf = { end_: Integer, should_parse: bool, start: Integer } class Pdf < ContextDev::Internal::Type::BaseModel diff --git a/sig/context_dev/models/web_web_scrape_md_params.rbs b/sig/context_dev/models/web_web_scrape_md_params.rbs index 36975fb9..a76f36ae 100644 --- a/sig/context_dev/models/web_web_scrape_md_params.rbs +++ b/sig/context_dev/models/web_web_scrape_md_params.rbs @@ -3,6 +3,7 @@ module ContextDev type web_web_scrape_md_params = { url: String, + country: ContextDev::Models::WebWebScrapeMdParams::country, exclude_selectors: ::Array[String], headers: ::Hash[Symbol, String], include_frames: bool, @@ -24,6 +25,12 @@ module ContextDev attr_accessor url: String + attr_reader country: ContextDev::Models::WebWebScrapeMdParams::country? + + def country=: ( + ContextDev::Models::WebWebScrapeMdParams::country + ) -> ContextDev::Models::WebWebScrapeMdParams::country + attr_reader exclude_selectors: ::Array[String]? def exclude_selectors=: (::Array[String]) -> ::Array[String] @@ -76,6 +83,7 @@ module ContextDev def initialize: ( url: String, + ?country: ContextDev::Models::WebWebScrapeMdParams::country, ?exclude_selectors: ::Array[String], ?headers: ::Hash[Symbol, String], ?include_frames: bool, @@ -93,6 +101,7 @@ module ContextDev def to_hash: -> { url: String, + country: ContextDev::Models::WebWebScrapeMdParams::country, exclude_selectors: ::Array[String], headers: ::Hash[Symbol, String], include_frames: bool, @@ -108,6 +117,423 @@ module ContextDev request_options: ContextDev::RequestOptions } + type country = + :ad + | :ae + | :af + | :ag + | :ai + | :al + | :am + | :ao + | :ar + | :at + | :au + | :aw + | :az + | :ba + | :bb + | :bd + | :be + | :bf + | :bg + | :bh + | :bi + | :bj + | :bm + | :bn + | :bo + | :bq + | :br + | :bs + | :bw + | :by + | :bz + | :ca + | :cd + | :cf + | :cg + | :ch + | :ci + | :cl + | :cm + | :cn + | :co + | :cr + | :cv + | :cw + | :cy + | :cz + | :de + | :dj + | :dk + | :dm + | :do + | :dz + | :ec + | :ee + | :eg + | :es + | :et + | :fi + | :fj + | :fr + | :ga + | :gb + | :gd + | :ge + | :gf + | :gg + | :gh + | :gm + | :gn + | :gp + | :gq + | :gr + | :gt + | :gu + | :gw + | :gy + | :hk + | :hn + | :hr + | :ht + | :hu + | :id + | :ie + | :il + | :im + | :in + | :iq + | :ir + | :is + | :it + | :je + | :jm + | :jo + | :jp + | :ke + | :kg + | :kh + | :kn + | :kr + | :kw + | :ky + | :kz + | :la + | :lb + | :lc + | :lk + | :lr + | :ls + | :lt + | :lu + | :lv + | :ly + | :ma + | :mc + | :md + | :me + | :mf + | :mg + | :mk + | :ml + | :mm + | :mn + | :mo + | :mq + | :mr + | :mt + | :mu + | :mv + | :mw + | :mx + | :my + | :mz + | :na + | :nc + | :ne + | :ng + | :ni + | :nl + | :no + | :np + | :nz + | :om + | :pa + | :pe + | :pf + | :pg + | :ph + | :pk + | :pl + | :pr + | :ps + | :pt + | :py + | :qa + | :re + | :ro + | :rs + | :ru + | :rw + | :sa + | :sc + | :sd + | :se + | :sg + | :si + | :sk + | :sl + | :sm + | :sn + | :so + | :sr + | :ss + | :st + | :sv + | :sx + | :sy + | :sz + | :tc + | :td + | :tg + | :th + | :tj + | :tl + | :tm + | :tn + | :tr + | :tt + | :tw + | :tz + | :ua + | :ug + | :us + | :uy + | :uz + | :vc + | :ve + | :vg + | :vi + | :vn + | :ye + | :yt + | :za + | :zm + | :zw + + module Country + extend ContextDev::Internal::Type::Enum + + AD: :ad + AE: :ae + AF: :af + AG: :ag + AI: :ai + AL: :al + AM: :am + AO: :ao + AR: :ar + AT: :at + AU: :au + AW: :aw + AZ: :az + BA: :ba + BB: :bb + BD: :bd + BE: :be + BF: :bf + BG: :bg + BH: :bh + BI: :bi + BJ: :bj + BM: :bm + BN: :bn + BO: :bo + BQ: :bq + BR: :br + BS: :bs + BW: :bw + BY: :by + BZ: :bz + CA: :ca + CD: :cd + CF: :cf + CG: :cg + CH: :ch + CI: :ci + CL: :cl + CM: :cm + CN: :cn + CO: :co + CR: :cr + CV: :cv + CW: :cw + CY: :cy + CZ: :cz + DE: :de + DJ: :dj + DK: :dk + DM: :dm + DO: :do + DZ: :dz + EC: :ec + EE: :ee + EG: :eg + ES: :es + ET: :et + FI: :fi + FJ: :fj + FR: :fr + GA: :ga + GB: :gb + GD: :gd + GE: :ge + GF: :gf + GG: :gg + GH: :gh + GM: :gm + GN: :gn + GP: :gp + GQ: :gq + GR: :gr + GT: :gt + GU: :gu + GW: :gw + GY: :gy + HK: :hk + HN: :hn + HR: :hr + HT: :ht + HU: :hu + ID: :id + IE: :ie + IL: :il + IM: :im + IN: :in + IQ: :iq + IR: :ir + IS: :is + IT: :it + JE: :je + JM: :jm + JO: :jo + JP: :jp + KE: :ke + KG: :kg + KH: :kh + KN: :kn + KR: :kr + KW: :kw + KY: :ky + KZ: :kz + LA: :la + LB: :lb + LC: :lc + LK: :lk + LR: :lr + LS: :ls + LT: :lt + LU: :lu + LV: :lv + LY: :ly + MA: :ma + MC: :mc + MD: :md + ME: :me + MF: :mf + MG: :mg + MK: :mk + ML: :ml + MM: :mm + MN: :mn + MO: :mo + MQ: :mq + MR: :mr + MT: :mt + MU: :mu + MV: :mv + MW: :mw + MX: :mx + MY: :my + MZ: :mz + NA: :na + NC: :nc + NE: :ne + NG: :ng + NI: :ni + NL: :nl + NO: :no + NP: :np + NZ: :nz + OM: :om + PA: :pa + PE: :pe + PF: :pf + PG: :pg + PH: :ph + PK: :pk + PL: :pl + PR: :pr + PS: :ps + PT: :pt + PY: :py + QA: :qa + RE: :re + RO: :ro + RS: :rs + RU: :ru + RW: :rw + SA: :sa + SC: :sc + SD: :sd + SE: :se + SG: :sg + SI: :si + SK: :sk + SL: :sl + SM: :sm + SN: :sn + SO: :so + SR: :sr + SS: :ss + ST: :st + SV: :sv + SX: :sx + SY: :sy + SZ: :sz + TC: :tc + TD: :td + TG: :tg + TH: :th + TJ: :tj + TL: :tl + TM: :tm + TN: :tn + TR: :tr + TT: :tt + TW: :tw + TZ: :tz + UA: :ua + UG: :ug + US: :us + UY: :uy + UZ: :uz + VC: :vc + VE: :ve + VG: :vg + VI: :vi + VN: :vn + YE: :ye + YT: :yt + ZA: :za + ZM: :zm + ZW: :zw + + def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeMdParams::country] + end + type pdf = { end_: Integer, should_parse: bool, start: Integer } class Pdf < ContextDev::Internal::Type::BaseModel diff --git a/sig/context_dev/resources/web.rbs b/sig/context_dev/resources/web.rbs index d833f86a..c874f1dc 100644 --- a/sig/context_dev/resources/web.rbs +++ b/sig/context_dev/resources/web.rbs @@ -42,6 +42,7 @@ module ContextDev ) -> ContextDev::Models::WebExtractStyleguideResponse def screenshot: ( + ?country: ContextDev::Models::WebScreenshotParams::country, ?direct_url: String, ?domain: String, ?full_screenshot: ContextDev::Models::WebScreenshotParams::full_screenshot, @@ -68,6 +69,7 @@ module ContextDev def web_crawl_md: ( url: String, + ?country: ContextDev::Models::WebWebCrawlMdParams::country, ?exclude_selectors: ::Array[String], ?follow_subdomains: bool, ?include_frames: bool, @@ -89,6 +91,7 @@ module ContextDev def web_scrape_html: ( url: String, + ?country: ContextDev::Models::WebWebScrapeHTMLParams::country, ?exclude_selectors: ::Array[String], ?headers: ::Hash[Symbol, String], ?include_frames: bool, @@ -113,6 +116,7 @@ module ContextDev def web_scrape_md: ( url: String, + ?country: ContextDev::Models::WebWebScrapeMdParams::country, ?exclude_selectors: ::Array[String], ?headers: ::Hash[Symbol, String], ?include_frames: bool, From 59319b0421154c96a444f5e2d45b83e8f4bc9074 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Fri, 26 Jun 2026 21:27:00 +0000 Subject: [PATCH 2/5] feat(api): api update --- .stats.yml | 4 +- lib/context_dev/models/web_search_params.rb | 273 +++++++++- lib/context_dev/resources/web.rb | 8 +- rbi/context_dev/models/web_search_params.rbi | 290 ++++++++++- rbi/context_dev/resources/web.rbi | 10 +- sig/context_dev/models/web_search_params.rbs | 503 +++++++++++++++++++ sig/context_dev/resources/web.rbs | 2 + 7 files changed, 1080 insertions(+), 10 deletions(-) diff --git a/.stats.yml b/.stats.yml index 24c57ba3..9dc6067a 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 25 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-00c5b8f1ebfe212bc8fb46204f5c05507630afa55b10f77e3a43c66d21edbb77.yml -openapi_spec_hash: 8bf4489b9bce0e52a89480109ffc5257 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-d3da262409c68576e457536f6c0e7ecc538219e0af19df415111c18f8fe92cfd.yml +openapi_spec_hash: 25009575202702d24bc6672472eb8506 config_hash: c7b0cdaba3b9797b77efd89e1754d803 diff --git a/lib/context_dev/models/web_search_params.rb b/lib/context_dev/models/web_search_params.rb index 6421a06f..32960ea1 100644 --- a/lib/context_dev/models/web_search_params.rb +++ b/lib/context_dev/models/web_search_params.rb @@ -8,11 +8,19 @@ class WebSearchParams < ContextDev::Internal::Type::BaseModel include ContextDev::Internal::Type::RequestParameters # @!attribute query - # Natural-language search query. + # Search query. Accepts natural language as well as Google-style search operators + # such as `site:`, `-site:`, `inurl:`, `intitle:`, quoted phrases, and `OR`. # # @return [String] required :query, String + # @!attribute country + # Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific + # country (maps to Google's `gl` parameter). Example: "us", "gb", "de". + # + # @return [Symbol, ContextDev::Models::WebSearchParams::Country, nil] + optional :country, enum: -> { ContextDev::WebSearchParams::Country } + # @!attribute exclude_domains # Blocklist — drop results from these domains. Example: ["pinterest.com", # "reddit.com"]. @@ -41,6 +49,12 @@ class WebSearchParams < ContextDev::Internal::Type::BaseModel -> { ContextDev::WebSearchParams::MarkdownOptions }, api_name: :markdownOptions + # @!attribute num_results + # Number of results to request and return (10–100). Defaults to 10. + # + # @return [Integer, nil] + optional :num_results, Integer, api_name: :numResults + # @!attribute query_fanout # Expand the query into multiple parallel variants for broader recall. # @@ -55,11 +69,13 @@ class WebSearchParams < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :timeout_ms, Integer, api_name: :timeoutMS - # @!method initialize(query:, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, query_fanout: nil, timeout_ms: nil, request_options: {}) + # @!method initialize(query:, country: nil, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, num_results: nil, query_fanout: nil, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebSearchParams} for more details. # - # @param query [String] Natural-language search query. + # @param query [String] Search query. Accepts natural language as well as Google-style search operators + # + # @param country [Symbol, ContextDev::Models::WebSearchParams::Country] Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific cou # # @param exclude_domains [Array] Blocklist — drop results from these domains. Example: ["pinterest.com", "reddit. # @@ -69,12 +85,263 @@ class WebSearchParams < ContextDev::Internal::Type::BaseModel # # @param markdown_options [ContextDev::Models::WebSearchParams::MarkdownOptions] Inline Markdown scraping for each result. Set `enabled: true` to activate. # + # @param num_results [Integer] Number of results to request and return (10–100). Defaults to 10. + # # @param query_fanout [Boolean] Expand the query into multiple parallel variants for broader recall. # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}] + # Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific + # country (maps to Google's `gl` parameter). Example: "us", "gb", "de". + module Country + extend ContextDev::Internal::Type::Enum + + AF = :af + AL = :al + DZ = :dz + AS = :as + AD = :ad + AO = :ao + AI = :ai + AQ = :aq + AG = :ag + AR = :ar + AM = :am + AW = :aw + AU = :au + AT = :at + AZ = :az + BS = :bs + BH = :bh + BD = :bd + BB = :bb + BY = :by + BE = :be + BZ = :bz + BJ = :bj + BM = :bm + BT = :bt + BO = :bo + BA = :ba + BW = :bw + BV = :bv + BR = :br + IO = :io + BN = :bn + BG = :bg + BF = :bf + BI = :bi + KH = :kh + CM = :cm + CA = :ca + CV = :cv + KY = :ky + CF = :cf + TD = :td + CL = :cl + CN = :cn + CX = :cx + CC = :cc + CO = :co + KM = :km + CG = :cg + CD = :cd + CK = :ck + CR = :cr + CI = :ci + HR = :hr + CU = :cu + CY = :cy + CZ = :cz + DK = :dk + DJ = :dj + DM = :dm + DO = :do + EC = :ec + EG = :eg + SV = :sv + GQ = :gq + ER = :er + EE = :ee + ET = :et + FK = :fk + FO = :fo + FJ = :fj + FI = :fi + FR = :fr + GF = :gf + PF = :pf + TF = :tf + GA = :ga + GM = :gm + GE = :ge + DE = :de + GH = :gh + GI = :gi + GR = :gr + GL = :gl + GD = :gd + GP = :gp + GU = :gu + GT = :gt + GN = :gn + GW = :gw + GY = :gy + HT = :ht + HM = :hm + VA = :va + HN = :hn + HK = :hk + HU = :hu + IS = :is + IN = :in + ID = :id + IR = :ir + IQ = :iq + IE = :ie + IL = :il + IT = :it + JM = :jm + JP = :jp + JO = :jo + KZ = :kz + KE = :ke + KI = :ki + KP = :kp + KR = :kr + KW = :kw + KG = :kg + LA = :la + LV = :lv + LB = :lb + LS = :ls + LR = :lr + LY = :ly + LI = :li + LT = :lt + LU = :lu + MO = :mo + MK = :mk + MG = :mg + MW = :mw + MY = :my + MV = :mv + ML = :ml + MT = :mt + MH = :mh + MQ = :mq + MR = :mr + MU = :mu + YT = :yt + MX = :mx + FM = :fm + MD = :md + MC = :mc + MN = :mn + MS = :ms + MA = :ma + MZ = :mz + MM = :mm + NA = :na + NR = :nr + NP = :np + NL = :nl + AN = :an + NC = :nc + NZ = :nz + NI = :ni + NE = :ne + NG = :ng + NU = :nu + NF = :nf + MP = :mp + NO = :no + OM = :om + PK = :pk + PW = :pw + PS = :ps + PA = :pa + PG = :pg + PY = :py + PE = :pe + PH = :ph + PN = :pn + PL = :pl + PT = :pt + PR = :pr + QA = :qa + RE = :re + RO = :ro + RU = :ru + RW = :rw + SH = :sh + KN = :kn + LC = :lc + PM = :pm + VC = :vc + WS = :ws + SM = :sm + ST = :st + SA = :sa + SN = :sn + RS = :rs + SC = :sc + SL = :sl + SG = :sg + SK = :sk + SI = :si + SB = :sb + SO = :so + ZA = :za + GS = :gs + ES = :es + LK = :lk + SD = :sd + SR = :sr + SJ = :sj + SZ = :sz + SE = :se + CH = :ch + SY = :sy + TW = :tw + TJ = :tj + TZ = :tz + TH = :th + TL = :tl + TG = :tg + TK = :tk + TO = :to + TT = :tt + TN = :tn + TR = :tr + TM = :tm + TC = :tc + TV = :tv + UG = :ug + UA = :ua + AE = :ae + GB = :gb + US = :us + UM = :um + UY = :uy + UZ = :uz + VU = :vu + VE = :ve + VN = :vn + VG = :vg + VI = :vi + WF = :wf + EH = :eh + YE = :ye + ZM = :zm + ZW = :zw + + # @!method self.values + # @return [Array] + end + # Restrict results to content published within this window. module Freshness extend ContextDev::Internal::Type::Enum diff --git a/lib/context_dev/resources/web.rb b/lib/context_dev/resources/web.rb index 162e31dc..e9e64db5 100644 --- a/lib/context_dev/resources/web.rb +++ b/lib/context_dev/resources/web.rb @@ -217,9 +217,11 @@ def screenshot(params = {}) # # Search the web and optionally scrape each result to Markdown in one round-trip. # - # @overload search(query:, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, query_fanout: nil, timeout_ms: nil, request_options: {}) + # @overload search(query:, country: nil, exclude_domains: nil, freshness: nil, include_domains: nil, markdown_options: nil, num_results: nil, query_fanout: nil, timeout_ms: nil, request_options: {}) # - # @param query [String] Natural-language search query. + # @param query [String] Search query. Accepts natural language as well as Google-style search operators + # + # @param country [Symbol, ContextDev::Models::WebSearchParams::Country] Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific cou # # @param exclude_domains [Array] Blocklist — drop results from these domains. Example: ["pinterest.com", "reddit. # @@ -229,6 +231,8 @@ def screenshot(params = {}) # # @param markdown_options [ContextDev::Models::WebSearchParams::MarkdownOptions] Inline Markdown scraping for each result. Set `enabled: true` to activate. # + # @param num_results [Integer] Number of results to request and return (10–100). Defaults to 10. + # # @param query_fanout [Boolean] Expand the query into multiple parallel variants for broader recall. # # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th diff --git a/rbi/context_dev/models/web_search_params.rbi b/rbi/context_dev/models/web_search_params.rbi index 4a7ed54b..91089100 100644 --- a/rbi/context_dev/models/web_search_params.rbi +++ b/rbi/context_dev/models/web_search_params.rbi @@ -11,10 +11,21 @@ module ContextDev T.any(ContextDev::WebSearchParams, ContextDev::Internal::AnyHash) end - # Natural-language search query. + # Search query. Accepts natural language as well as Google-style search operators + # such as `site:`, `-site:`, `inurl:`, `intitle:`, quoted phrases, and `OR`. sig { returns(String) } attr_accessor :query + # Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific + # country (maps to Google's `gl` parameter). Example: "us", "gb", "de". + sig { returns(T.nilable(ContextDev::WebSearchParams::Country::OrSymbol)) } + attr_reader :country + + sig do + params(country: ContextDev::WebSearchParams::Country::OrSymbol).void + end + attr_writer :country + # Blocklist — drop results from these domains. Example: ["pinterest.com", # "reddit.com"]. sig { returns(T.nilable(T::Array[String])) } @@ -53,6 +64,13 @@ module ContextDev end attr_writer :markdown_options + # Number of results to request and return (10–100). Defaults to 10. + sig { returns(T.nilable(Integer)) } + attr_reader :num_results + + sig { params(num_results: Integer).void } + attr_writer :num_results + # Expand the query into multiple parallel variants for broader recall. sig { returns(T.nilable(T::Boolean)) } attr_reader :query_fanout @@ -72,19 +90,25 @@ module ContextDev sig do params( query: String, + country: ContextDev::WebSearchParams::Country::OrSymbol, exclude_domains: T::Array[String], freshness: ContextDev::WebSearchParams::Freshness::OrSymbol, include_domains: T::Array[String], markdown_options: ContextDev::WebSearchParams::MarkdownOptions::OrHash, + num_results: Integer, query_fanout: T::Boolean, timeout_ms: Integer, request_options: ContextDev::RequestOptions::OrHash ).returns(T.attached_class) end def self.new( - # Natural-language search query. + # Search query. Accepts natural language as well as Google-style search operators + # such as `site:`, `-site:`, `inurl:`, `intitle:`, quoted phrases, and `OR`. query:, + # Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific + # country (maps to Google's `gl` parameter). Example: "us", "gb", "de". + country: nil, # Blocklist — drop results from these domains. Example: ["pinterest.com", # "reddit.com"]. exclude_domains: nil, @@ -95,6 +119,8 @@ module ContextDev include_domains: nil, # Inline Markdown scraping for each result. Set `enabled: true` to activate. markdown_options: nil, + # Number of results to request and return (10–100). Defaults to 10. + num_results: nil, # Expand the query into multiple parallel variants for broader recall. query_fanout: nil, # Optional timeout in milliseconds for the request. If the request takes longer @@ -109,10 +135,12 @@ module ContextDev override.returns( { query: String, + country: ContextDev::WebSearchParams::Country::OrSymbol, exclude_domains: T::Array[String], freshness: ContextDev::WebSearchParams::Freshness::OrSymbol, include_domains: T::Array[String], markdown_options: ContextDev::WebSearchParams::MarkdownOptions, + num_results: Integer, query_fanout: T::Boolean, timeout_ms: Integer, request_options: ContextDev::RequestOptions @@ -122,6 +150,264 @@ module ContextDev def to_hash end + # Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific + # country (maps to Google's `gl` parameter). Example: "us", "gb", "de". + module Country + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, ContextDev::WebSearchParams::Country) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + AF = T.let(:af, ContextDev::WebSearchParams::Country::TaggedSymbol) + AL = T.let(:al, ContextDev::WebSearchParams::Country::TaggedSymbol) + DZ = T.let(:dz, ContextDev::WebSearchParams::Country::TaggedSymbol) + AS = T.let(:as, ContextDev::WebSearchParams::Country::TaggedSymbol) + AD = T.let(:ad, ContextDev::WebSearchParams::Country::TaggedSymbol) + AO = T.let(:ao, ContextDev::WebSearchParams::Country::TaggedSymbol) + AI = T.let(:ai, ContextDev::WebSearchParams::Country::TaggedSymbol) + AQ = T.let(:aq, ContextDev::WebSearchParams::Country::TaggedSymbol) + AG = T.let(:ag, ContextDev::WebSearchParams::Country::TaggedSymbol) + AR = T.let(:ar, ContextDev::WebSearchParams::Country::TaggedSymbol) + AM = T.let(:am, ContextDev::WebSearchParams::Country::TaggedSymbol) + AW = T.let(:aw, ContextDev::WebSearchParams::Country::TaggedSymbol) + AU = T.let(:au, ContextDev::WebSearchParams::Country::TaggedSymbol) + AT = T.let(:at, ContextDev::WebSearchParams::Country::TaggedSymbol) + AZ = T.let(:az, ContextDev::WebSearchParams::Country::TaggedSymbol) + BS = T.let(:bs, ContextDev::WebSearchParams::Country::TaggedSymbol) + BH = T.let(:bh, ContextDev::WebSearchParams::Country::TaggedSymbol) + BD = T.let(:bd, ContextDev::WebSearchParams::Country::TaggedSymbol) + BB = T.let(:bb, ContextDev::WebSearchParams::Country::TaggedSymbol) + BY = T.let(:by, ContextDev::WebSearchParams::Country::TaggedSymbol) + BE = T.let(:be, ContextDev::WebSearchParams::Country::TaggedSymbol) + BZ = T.let(:bz, ContextDev::WebSearchParams::Country::TaggedSymbol) + BJ = T.let(:bj, ContextDev::WebSearchParams::Country::TaggedSymbol) + BM = T.let(:bm, ContextDev::WebSearchParams::Country::TaggedSymbol) + BT = T.let(:bt, ContextDev::WebSearchParams::Country::TaggedSymbol) + BO = T.let(:bo, ContextDev::WebSearchParams::Country::TaggedSymbol) + BA = T.let(:ba, ContextDev::WebSearchParams::Country::TaggedSymbol) + BW = T.let(:bw, ContextDev::WebSearchParams::Country::TaggedSymbol) + BV = T.let(:bv, ContextDev::WebSearchParams::Country::TaggedSymbol) + BR = T.let(:br, ContextDev::WebSearchParams::Country::TaggedSymbol) + IO = T.let(:io, ContextDev::WebSearchParams::Country::TaggedSymbol) + BN = T.let(:bn, ContextDev::WebSearchParams::Country::TaggedSymbol) + BG = T.let(:bg, ContextDev::WebSearchParams::Country::TaggedSymbol) + BF = T.let(:bf, ContextDev::WebSearchParams::Country::TaggedSymbol) + BI = T.let(:bi, ContextDev::WebSearchParams::Country::TaggedSymbol) + KH = T.let(:kh, ContextDev::WebSearchParams::Country::TaggedSymbol) + CM = T.let(:cm, ContextDev::WebSearchParams::Country::TaggedSymbol) + CA = T.let(:ca, ContextDev::WebSearchParams::Country::TaggedSymbol) + CV = T.let(:cv, ContextDev::WebSearchParams::Country::TaggedSymbol) + KY = T.let(:ky, ContextDev::WebSearchParams::Country::TaggedSymbol) + CF = T.let(:cf, ContextDev::WebSearchParams::Country::TaggedSymbol) + TD = T.let(:td, ContextDev::WebSearchParams::Country::TaggedSymbol) + CL = T.let(:cl, ContextDev::WebSearchParams::Country::TaggedSymbol) + CN = T.let(:cn, ContextDev::WebSearchParams::Country::TaggedSymbol) + CX = T.let(:cx, ContextDev::WebSearchParams::Country::TaggedSymbol) + CC = T.let(:cc, ContextDev::WebSearchParams::Country::TaggedSymbol) + CO = T.let(:co, ContextDev::WebSearchParams::Country::TaggedSymbol) + KM = T.let(:km, ContextDev::WebSearchParams::Country::TaggedSymbol) + CG = T.let(:cg, ContextDev::WebSearchParams::Country::TaggedSymbol) + CD = T.let(:cd, ContextDev::WebSearchParams::Country::TaggedSymbol) + CK = T.let(:ck, ContextDev::WebSearchParams::Country::TaggedSymbol) + CR = T.let(:cr, ContextDev::WebSearchParams::Country::TaggedSymbol) + CI = T.let(:ci, ContextDev::WebSearchParams::Country::TaggedSymbol) + HR = T.let(:hr, ContextDev::WebSearchParams::Country::TaggedSymbol) + CU = T.let(:cu, ContextDev::WebSearchParams::Country::TaggedSymbol) + CY = T.let(:cy, ContextDev::WebSearchParams::Country::TaggedSymbol) + CZ = T.let(:cz, ContextDev::WebSearchParams::Country::TaggedSymbol) + DK = T.let(:dk, ContextDev::WebSearchParams::Country::TaggedSymbol) + DJ = T.let(:dj, ContextDev::WebSearchParams::Country::TaggedSymbol) + DM = T.let(:dm, ContextDev::WebSearchParams::Country::TaggedSymbol) + DO = T.let(:do, ContextDev::WebSearchParams::Country::TaggedSymbol) + EC = T.let(:ec, ContextDev::WebSearchParams::Country::TaggedSymbol) + EG = T.let(:eg, ContextDev::WebSearchParams::Country::TaggedSymbol) + SV = T.let(:sv, ContextDev::WebSearchParams::Country::TaggedSymbol) + GQ = T.let(:gq, ContextDev::WebSearchParams::Country::TaggedSymbol) + ER = T.let(:er, ContextDev::WebSearchParams::Country::TaggedSymbol) + EE = T.let(:ee, ContextDev::WebSearchParams::Country::TaggedSymbol) + ET = T.let(:et, ContextDev::WebSearchParams::Country::TaggedSymbol) + FK = T.let(:fk, ContextDev::WebSearchParams::Country::TaggedSymbol) + FO = T.let(:fo, ContextDev::WebSearchParams::Country::TaggedSymbol) + FJ = T.let(:fj, ContextDev::WebSearchParams::Country::TaggedSymbol) + FI = T.let(:fi, ContextDev::WebSearchParams::Country::TaggedSymbol) + FR = T.let(:fr, ContextDev::WebSearchParams::Country::TaggedSymbol) + GF = T.let(:gf, ContextDev::WebSearchParams::Country::TaggedSymbol) + PF = T.let(:pf, ContextDev::WebSearchParams::Country::TaggedSymbol) + TF = T.let(:tf, ContextDev::WebSearchParams::Country::TaggedSymbol) + GA = T.let(:ga, ContextDev::WebSearchParams::Country::TaggedSymbol) + GM = T.let(:gm, ContextDev::WebSearchParams::Country::TaggedSymbol) + GE = T.let(:ge, ContextDev::WebSearchParams::Country::TaggedSymbol) + DE = T.let(:de, ContextDev::WebSearchParams::Country::TaggedSymbol) + GH = T.let(:gh, ContextDev::WebSearchParams::Country::TaggedSymbol) + GI = T.let(:gi, ContextDev::WebSearchParams::Country::TaggedSymbol) + GR = T.let(:gr, ContextDev::WebSearchParams::Country::TaggedSymbol) + GL = T.let(:gl, ContextDev::WebSearchParams::Country::TaggedSymbol) + GD = T.let(:gd, ContextDev::WebSearchParams::Country::TaggedSymbol) + GP = T.let(:gp, ContextDev::WebSearchParams::Country::TaggedSymbol) + GU = T.let(:gu, ContextDev::WebSearchParams::Country::TaggedSymbol) + GT = T.let(:gt, ContextDev::WebSearchParams::Country::TaggedSymbol) + GN = T.let(:gn, ContextDev::WebSearchParams::Country::TaggedSymbol) + GW = T.let(:gw, ContextDev::WebSearchParams::Country::TaggedSymbol) + GY = T.let(:gy, ContextDev::WebSearchParams::Country::TaggedSymbol) + HT = T.let(:ht, ContextDev::WebSearchParams::Country::TaggedSymbol) + HM = T.let(:hm, ContextDev::WebSearchParams::Country::TaggedSymbol) + VA = T.let(:va, ContextDev::WebSearchParams::Country::TaggedSymbol) + HN = T.let(:hn, ContextDev::WebSearchParams::Country::TaggedSymbol) + HK = T.let(:hk, ContextDev::WebSearchParams::Country::TaggedSymbol) + HU = T.let(:hu, ContextDev::WebSearchParams::Country::TaggedSymbol) + IS = T.let(:is, ContextDev::WebSearchParams::Country::TaggedSymbol) + IN = T.let(:in, ContextDev::WebSearchParams::Country::TaggedSymbol) + ID = T.let(:id, ContextDev::WebSearchParams::Country::TaggedSymbol) + IR = T.let(:ir, ContextDev::WebSearchParams::Country::TaggedSymbol) + IQ = T.let(:iq, ContextDev::WebSearchParams::Country::TaggedSymbol) + IE = T.let(:ie, ContextDev::WebSearchParams::Country::TaggedSymbol) + IL = T.let(:il, ContextDev::WebSearchParams::Country::TaggedSymbol) + IT = T.let(:it, ContextDev::WebSearchParams::Country::TaggedSymbol) + JM = T.let(:jm, ContextDev::WebSearchParams::Country::TaggedSymbol) + JP = T.let(:jp, ContextDev::WebSearchParams::Country::TaggedSymbol) + JO = T.let(:jo, ContextDev::WebSearchParams::Country::TaggedSymbol) + KZ = T.let(:kz, ContextDev::WebSearchParams::Country::TaggedSymbol) + KE = T.let(:ke, ContextDev::WebSearchParams::Country::TaggedSymbol) + KI = T.let(:ki, ContextDev::WebSearchParams::Country::TaggedSymbol) + KP = T.let(:kp, ContextDev::WebSearchParams::Country::TaggedSymbol) + KR = T.let(:kr, ContextDev::WebSearchParams::Country::TaggedSymbol) + KW = T.let(:kw, ContextDev::WebSearchParams::Country::TaggedSymbol) + KG = T.let(:kg, ContextDev::WebSearchParams::Country::TaggedSymbol) + LA = T.let(:la, ContextDev::WebSearchParams::Country::TaggedSymbol) + LV = T.let(:lv, ContextDev::WebSearchParams::Country::TaggedSymbol) + LB = T.let(:lb, ContextDev::WebSearchParams::Country::TaggedSymbol) + LS = T.let(:ls, ContextDev::WebSearchParams::Country::TaggedSymbol) + LR = T.let(:lr, ContextDev::WebSearchParams::Country::TaggedSymbol) + LY = T.let(:ly, ContextDev::WebSearchParams::Country::TaggedSymbol) + LI = T.let(:li, ContextDev::WebSearchParams::Country::TaggedSymbol) + LT = T.let(:lt, ContextDev::WebSearchParams::Country::TaggedSymbol) + LU = T.let(:lu, ContextDev::WebSearchParams::Country::TaggedSymbol) + MO = T.let(:mo, ContextDev::WebSearchParams::Country::TaggedSymbol) + MK = T.let(:mk, ContextDev::WebSearchParams::Country::TaggedSymbol) + MG = T.let(:mg, ContextDev::WebSearchParams::Country::TaggedSymbol) + MW = T.let(:mw, ContextDev::WebSearchParams::Country::TaggedSymbol) + MY = T.let(:my, ContextDev::WebSearchParams::Country::TaggedSymbol) + MV = T.let(:mv, ContextDev::WebSearchParams::Country::TaggedSymbol) + ML = T.let(:ml, ContextDev::WebSearchParams::Country::TaggedSymbol) + MT = T.let(:mt, ContextDev::WebSearchParams::Country::TaggedSymbol) + MH = T.let(:mh, ContextDev::WebSearchParams::Country::TaggedSymbol) + MQ = T.let(:mq, ContextDev::WebSearchParams::Country::TaggedSymbol) + MR = T.let(:mr, ContextDev::WebSearchParams::Country::TaggedSymbol) + MU = T.let(:mu, ContextDev::WebSearchParams::Country::TaggedSymbol) + YT = T.let(:yt, ContextDev::WebSearchParams::Country::TaggedSymbol) + MX = T.let(:mx, ContextDev::WebSearchParams::Country::TaggedSymbol) + FM = T.let(:fm, ContextDev::WebSearchParams::Country::TaggedSymbol) + MD = T.let(:md, ContextDev::WebSearchParams::Country::TaggedSymbol) + MC = T.let(:mc, ContextDev::WebSearchParams::Country::TaggedSymbol) + MN = T.let(:mn, ContextDev::WebSearchParams::Country::TaggedSymbol) + MS = T.let(:ms, ContextDev::WebSearchParams::Country::TaggedSymbol) + MA = T.let(:ma, ContextDev::WebSearchParams::Country::TaggedSymbol) + MZ = T.let(:mz, ContextDev::WebSearchParams::Country::TaggedSymbol) + MM = T.let(:mm, ContextDev::WebSearchParams::Country::TaggedSymbol) + NA = T.let(:na, ContextDev::WebSearchParams::Country::TaggedSymbol) + NR = T.let(:nr, ContextDev::WebSearchParams::Country::TaggedSymbol) + NP = T.let(:np, ContextDev::WebSearchParams::Country::TaggedSymbol) + NL = T.let(:nl, ContextDev::WebSearchParams::Country::TaggedSymbol) + AN = T.let(:an, ContextDev::WebSearchParams::Country::TaggedSymbol) + NC = T.let(:nc, ContextDev::WebSearchParams::Country::TaggedSymbol) + NZ = T.let(:nz, ContextDev::WebSearchParams::Country::TaggedSymbol) + NI = T.let(:ni, ContextDev::WebSearchParams::Country::TaggedSymbol) + NE = T.let(:ne, ContextDev::WebSearchParams::Country::TaggedSymbol) + NG = T.let(:ng, ContextDev::WebSearchParams::Country::TaggedSymbol) + NU = T.let(:nu, ContextDev::WebSearchParams::Country::TaggedSymbol) + NF = T.let(:nf, ContextDev::WebSearchParams::Country::TaggedSymbol) + MP = T.let(:mp, ContextDev::WebSearchParams::Country::TaggedSymbol) + NO = T.let(:no, ContextDev::WebSearchParams::Country::TaggedSymbol) + OM = T.let(:om, ContextDev::WebSearchParams::Country::TaggedSymbol) + PK = T.let(:pk, ContextDev::WebSearchParams::Country::TaggedSymbol) + PW = T.let(:pw, ContextDev::WebSearchParams::Country::TaggedSymbol) + PS = T.let(:ps, ContextDev::WebSearchParams::Country::TaggedSymbol) + PA = T.let(:pa, ContextDev::WebSearchParams::Country::TaggedSymbol) + PG = T.let(:pg, ContextDev::WebSearchParams::Country::TaggedSymbol) + PY = T.let(:py, ContextDev::WebSearchParams::Country::TaggedSymbol) + PE = T.let(:pe, ContextDev::WebSearchParams::Country::TaggedSymbol) + PH = T.let(:ph, ContextDev::WebSearchParams::Country::TaggedSymbol) + PN = T.let(:pn, ContextDev::WebSearchParams::Country::TaggedSymbol) + PL = T.let(:pl, ContextDev::WebSearchParams::Country::TaggedSymbol) + PT = T.let(:pt, ContextDev::WebSearchParams::Country::TaggedSymbol) + PR = T.let(:pr, ContextDev::WebSearchParams::Country::TaggedSymbol) + QA = T.let(:qa, ContextDev::WebSearchParams::Country::TaggedSymbol) + RE = T.let(:re, ContextDev::WebSearchParams::Country::TaggedSymbol) + RO = T.let(:ro, ContextDev::WebSearchParams::Country::TaggedSymbol) + RU = T.let(:ru, ContextDev::WebSearchParams::Country::TaggedSymbol) + RW = T.let(:rw, ContextDev::WebSearchParams::Country::TaggedSymbol) + SH = T.let(:sh, ContextDev::WebSearchParams::Country::TaggedSymbol) + KN = T.let(:kn, ContextDev::WebSearchParams::Country::TaggedSymbol) + LC = T.let(:lc, ContextDev::WebSearchParams::Country::TaggedSymbol) + PM = T.let(:pm, ContextDev::WebSearchParams::Country::TaggedSymbol) + VC = T.let(:vc, ContextDev::WebSearchParams::Country::TaggedSymbol) + WS = T.let(:ws, ContextDev::WebSearchParams::Country::TaggedSymbol) + SM = T.let(:sm, ContextDev::WebSearchParams::Country::TaggedSymbol) + ST = T.let(:st, ContextDev::WebSearchParams::Country::TaggedSymbol) + SA = T.let(:sa, ContextDev::WebSearchParams::Country::TaggedSymbol) + SN = T.let(:sn, ContextDev::WebSearchParams::Country::TaggedSymbol) + RS = T.let(:rs, ContextDev::WebSearchParams::Country::TaggedSymbol) + SC = T.let(:sc, ContextDev::WebSearchParams::Country::TaggedSymbol) + SL = T.let(:sl, ContextDev::WebSearchParams::Country::TaggedSymbol) + SG = T.let(:sg, ContextDev::WebSearchParams::Country::TaggedSymbol) + SK = T.let(:sk, ContextDev::WebSearchParams::Country::TaggedSymbol) + SI = T.let(:si, ContextDev::WebSearchParams::Country::TaggedSymbol) + SB = T.let(:sb, ContextDev::WebSearchParams::Country::TaggedSymbol) + SO = T.let(:so, ContextDev::WebSearchParams::Country::TaggedSymbol) + ZA = T.let(:za, ContextDev::WebSearchParams::Country::TaggedSymbol) + GS = T.let(:gs, ContextDev::WebSearchParams::Country::TaggedSymbol) + ES = T.let(:es, ContextDev::WebSearchParams::Country::TaggedSymbol) + LK = T.let(:lk, ContextDev::WebSearchParams::Country::TaggedSymbol) + SD = T.let(:sd, ContextDev::WebSearchParams::Country::TaggedSymbol) + SR = T.let(:sr, ContextDev::WebSearchParams::Country::TaggedSymbol) + SJ = T.let(:sj, ContextDev::WebSearchParams::Country::TaggedSymbol) + SZ = T.let(:sz, ContextDev::WebSearchParams::Country::TaggedSymbol) + SE = T.let(:se, ContextDev::WebSearchParams::Country::TaggedSymbol) + CH = T.let(:ch, ContextDev::WebSearchParams::Country::TaggedSymbol) + SY = T.let(:sy, ContextDev::WebSearchParams::Country::TaggedSymbol) + TW = T.let(:tw, ContextDev::WebSearchParams::Country::TaggedSymbol) + TJ = T.let(:tj, ContextDev::WebSearchParams::Country::TaggedSymbol) + TZ = T.let(:tz, ContextDev::WebSearchParams::Country::TaggedSymbol) + TH = T.let(:th, ContextDev::WebSearchParams::Country::TaggedSymbol) + TL = T.let(:tl, ContextDev::WebSearchParams::Country::TaggedSymbol) + TG = T.let(:tg, ContextDev::WebSearchParams::Country::TaggedSymbol) + TK = T.let(:tk, ContextDev::WebSearchParams::Country::TaggedSymbol) + TO = T.let(:to, ContextDev::WebSearchParams::Country::TaggedSymbol) + TT = T.let(:tt, ContextDev::WebSearchParams::Country::TaggedSymbol) + TN = T.let(:tn, ContextDev::WebSearchParams::Country::TaggedSymbol) + TR = T.let(:tr, ContextDev::WebSearchParams::Country::TaggedSymbol) + TM = T.let(:tm, ContextDev::WebSearchParams::Country::TaggedSymbol) + TC = T.let(:tc, ContextDev::WebSearchParams::Country::TaggedSymbol) + TV = T.let(:tv, ContextDev::WebSearchParams::Country::TaggedSymbol) + UG = T.let(:ug, ContextDev::WebSearchParams::Country::TaggedSymbol) + UA = T.let(:ua, ContextDev::WebSearchParams::Country::TaggedSymbol) + AE = T.let(:ae, ContextDev::WebSearchParams::Country::TaggedSymbol) + GB = T.let(:gb, ContextDev::WebSearchParams::Country::TaggedSymbol) + US = T.let(:us, ContextDev::WebSearchParams::Country::TaggedSymbol) + UM = T.let(:um, ContextDev::WebSearchParams::Country::TaggedSymbol) + UY = T.let(:uy, ContextDev::WebSearchParams::Country::TaggedSymbol) + UZ = T.let(:uz, ContextDev::WebSearchParams::Country::TaggedSymbol) + VU = T.let(:vu, ContextDev::WebSearchParams::Country::TaggedSymbol) + VE = T.let(:ve, ContextDev::WebSearchParams::Country::TaggedSymbol) + VN = T.let(:vn, ContextDev::WebSearchParams::Country::TaggedSymbol) + VG = T.let(:vg, ContextDev::WebSearchParams::Country::TaggedSymbol) + VI = T.let(:vi, ContextDev::WebSearchParams::Country::TaggedSymbol) + WF = T.let(:wf, ContextDev::WebSearchParams::Country::TaggedSymbol) + EH = T.let(:eh, ContextDev::WebSearchParams::Country::TaggedSymbol) + YE = T.let(:ye, ContextDev::WebSearchParams::Country::TaggedSymbol) + ZM = T.let(:zm, ContextDev::WebSearchParams::Country::TaggedSymbol) + ZW = T.let(:zw, ContextDev::WebSearchParams::Country::TaggedSymbol) + + sig do + override.returns( + T::Array[ContextDev::WebSearchParams::Country::TaggedSymbol] + ) + end + def self.values + end + end + # Restrict results to content published within this window. module Freshness extend ContextDev::Internal::Type::Enum diff --git a/rbi/context_dev/resources/web.rbi b/rbi/context_dev/resources/web.rbi index f40513b4..c71538b1 100644 --- a/rbi/context_dev/resources/web.rbi +++ b/rbi/context_dev/resources/web.rbi @@ -233,19 +233,25 @@ module ContextDev sig do params( query: String, + country: ContextDev::WebSearchParams::Country::OrSymbol, exclude_domains: T::Array[String], freshness: ContextDev::WebSearchParams::Freshness::OrSymbol, include_domains: T::Array[String], markdown_options: ContextDev::WebSearchParams::MarkdownOptions::OrHash, + num_results: Integer, query_fanout: T::Boolean, timeout_ms: Integer, request_options: ContextDev::RequestOptions::OrHash ).returns(ContextDev::Models::WebSearchResponse) end def search( - # Natural-language search query. + # Search query. Accepts natural language as well as Google-style search operators + # such as `site:`, `-site:`, `inurl:`, `intitle:`, quoted phrases, and `OR`. query:, + # Two-letter ISO 3166-1 alpha-2 country code to localize results to a specific + # country (maps to Google's `gl` parameter). Example: "us", "gb", "de". + country: nil, # Blocklist — drop results from these domains. Example: ["pinterest.com", # "reddit.com"]. exclude_domains: nil, @@ -256,6 +262,8 @@ module ContextDev include_domains: nil, # Inline Markdown scraping for each result. Set `enabled: true` to activate. markdown_options: nil, + # Number of results to request and return (10–100). Defaults to 10. + num_results: nil, # Expand the query into multiple parallel variants for broader recall. query_fanout: nil, # Optional timeout in milliseconds for the request. If the request takes longer diff --git a/sig/context_dev/models/web_search_params.rbs b/sig/context_dev/models/web_search_params.rbs index fc0b75ab..43da2e65 100644 --- a/sig/context_dev/models/web_search_params.rbs +++ b/sig/context_dev/models/web_search_params.rbs @@ -3,10 +3,12 @@ module ContextDev type web_search_params = { query: String, + country: ContextDev::Models::WebSearchParams::country, exclude_domains: ::Array[String], freshness: ContextDev::Models::WebSearchParams::freshness, include_domains: ::Array[String], markdown_options: ContextDev::WebSearchParams::MarkdownOptions, + num_results: Integer, query_fanout: bool, timeout_ms: Integer } @@ -18,6 +20,12 @@ module ContextDev attr_accessor query: String + attr_reader country: ContextDev::Models::WebSearchParams::country? + + def country=: ( + ContextDev::Models::WebSearchParams::country + ) -> ContextDev::Models::WebSearchParams::country + attr_reader exclude_domains: ::Array[String]? def exclude_domains=: (::Array[String]) -> ::Array[String] @@ -38,6 +46,10 @@ module ContextDev ContextDev::WebSearchParams::MarkdownOptions ) -> ContextDev::WebSearchParams::MarkdownOptions + attr_reader num_results: Integer? + + def num_results=: (Integer) -> Integer + attr_reader query_fanout: bool? def query_fanout=: (bool) -> bool @@ -48,10 +60,12 @@ module ContextDev def initialize: ( query: String, + ?country: ContextDev::Models::WebSearchParams::country, ?exclude_domains: ::Array[String], ?freshness: ContextDev::Models::WebSearchParams::freshness, ?include_domains: ::Array[String], ?markdown_options: ContextDev::WebSearchParams::MarkdownOptions, + ?num_results: Integer, ?query_fanout: bool, ?timeout_ms: Integer, ?request_options: ContextDev::request_opts @@ -59,15 +73,504 @@ module ContextDev def to_hash: -> { query: String, + country: ContextDev::Models::WebSearchParams::country, exclude_domains: ::Array[String], freshness: ContextDev::Models::WebSearchParams::freshness, include_domains: ::Array[String], markdown_options: ContextDev::WebSearchParams::MarkdownOptions, + num_results: Integer, query_fanout: bool, timeout_ms: Integer, request_options: ContextDev::RequestOptions } + type country = + :af + | :al + | :dz + | :as + | :ad + | :ao + | :ai + | :aq + | :ag + | :ar + | :am + | :aw + | :au + | :at + | :az + | :bs + | :bh + | :bd + | :bb + | :by + | :be + | :bz + | :bj + | :bm + | :bt + | :bo + | :ba + | :bw + | :bv + | :br + | :io + | :bn + | :bg + | :bf + | :bi + | :kh + | :cm + | :ca + | :cv + | :ky + | :cf + | :td + | :cl + | :cn + | :cx + | :cc + | :co + | :km + | :cg + | :cd + | :ck + | :cr + | :ci + | :hr + | :cu + | :cy + | :cz + | :dk + | :dj + | :dm + | :do + | :ec + | :eg + | :sv + | :gq + | :er + | :ee + | :et + | :fk + | :fo + | :fj + | :fi + | :fr + | :gf + | :pf + | :tf + | :ga + | :gm + | :ge + | :de + | :gh + | :gi + | :gr + | :gl + | :gd + | :gp + | :gu + | :gt + | :gn + | :gw + | :gy + | :ht + | :hm + | :va + | :hn + | :hk + | :hu + | :is + | :in + | :id + | :ir + | :iq + | :ie + | :il + | :it + | :jm + | :jp + | :jo + | :kz + | :ke + | :ki + | :kp + | :kr + | :kw + | :kg + | :la + | :lv + | :lb + | :ls + | :lr + | :ly + | :li + | :lt + | :lu + | :mo + | :mk + | :mg + | :mw + | :my + | :mv + | :ml + | :mt + | :mh + | :mq + | :mr + | :mu + | :yt + | :mx + | :fm + | :md + | :mc + | :mn + | :ms + | :ma + | :mz + | :mm + | :na + | :nr + | :np + | :nl + | :an + | :nc + | :nz + | :ni + | :ne + | :ng + | :nu + | :nf + | :mp + | :no + | :om + | :pk + | :pw + | :ps + | :pa + | :pg + | :py + | :pe + | :ph + | :pn + | :pl + | :pt + | :pr + | :qa + | :re + | :ro + | :ru + | :rw + | :sh + | :kn + | :lc + | :pm + | :vc + | :ws + | :sm + | :st + | :sa + | :sn + | :rs + | :sc + | :sl + | :sg + | :sk + | :si + | :sb + | :so + | :za + | :gs + | :es + | :lk + | :sd + | :sr + | :sj + | :sz + | :se + | :ch + | :sy + | :tw + | :tj + | :tz + | :th + | :tl + | :tg + | :tk + | :to + | :tt + | :tn + | :tr + | :tm + | :tc + | :tv + | :ug + | :ua + | :ae + | :gb + | :us + | :um + | :uy + | :uz + | :vu + | :ve + | :vn + | :vg + | :vi + | :wf + | :eh + | :ye + | :zm + | :zw + + module Country + extend ContextDev::Internal::Type::Enum + + AF: :af + AL: :al + DZ: :dz + AS: :as + AD: :ad + AO: :ao + AI: :ai + AQ: :aq + AG: :ag + AR: :ar + AM: :am + AW: :aw + AU: :au + AT: :at + AZ: :az + BS: :bs + BH: :bh + BD: :bd + BB: :bb + BY: :by + BE: :be + BZ: :bz + BJ: :bj + BM: :bm + BT: :bt + BO: :bo + BA: :ba + BW: :bw + BV: :bv + BR: :br + IO: :io + BN: :bn + BG: :bg + BF: :bf + BI: :bi + KH: :kh + CM: :cm + CA: :ca + CV: :cv + KY: :ky + CF: :cf + TD: :td + CL: :cl + CN: :cn + CX: :cx + CC: :cc + CO: :co + KM: :km + CG: :cg + CD: :cd + CK: :ck + CR: :cr + CI: :ci + HR: :hr + CU: :cu + CY: :cy + CZ: :cz + DK: :dk + DJ: :dj + DM: :dm + DO: :do + EC: :ec + EG: :eg + SV: :sv + GQ: :gq + ER: :er + EE: :ee + ET: :et + FK: :fk + FO: :fo + FJ: :fj + FI: :fi + FR: :fr + GF: :gf + PF: :pf + TF: :tf + GA: :ga + GM: :gm + GE: :ge + DE: :de + GH: :gh + GI: :gi + GR: :gr + GL: :gl + GD: :gd + GP: :gp + GU: :gu + GT: :gt + GN: :gn + GW: :gw + GY: :gy + HT: :ht + HM: :hm + VA: :va + HN: :hn + HK: :hk + HU: :hu + IS: :is + IN: :in + ID: :id + IR: :ir + IQ: :iq + IE: :ie + IL: :il + IT: :it + JM: :jm + JP: :jp + JO: :jo + KZ: :kz + KE: :ke + KI: :ki + KP: :kp + KR: :kr + KW: :kw + KG: :kg + LA: :la + LV: :lv + LB: :lb + LS: :ls + LR: :lr + LY: :ly + LI: :li + LT: :lt + LU: :lu + MO: :mo + MK: :mk + MG: :mg + MW: :mw + MY: :my + MV: :mv + ML: :ml + MT: :mt + MH: :mh + MQ: :mq + MR: :mr + MU: :mu + YT: :yt + MX: :mx + FM: :fm + MD: :md + MC: :mc + MN: :mn + MS: :ms + MA: :ma + MZ: :mz + MM: :mm + NA: :na + NR: :nr + NP: :np + NL: :nl + AN: :an + NC: :nc + NZ: :nz + NI: :ni + NE: :ne + NG: :ng + NU: :nu + NF: :nf + MP: :mp + NO: :no + OM: :om + PK: :pk + PW: :pw + PS: :ps + PA: :pa + PG: :pg + PY: :py + PE: :pe + PH: :ph + PN: :pn + PL: :pl + PT: :pt + PR: :pr + QA: :qa + RE: :re + RO: :ro + RU: :ru + RW: :rw + SH: :sh + KN: :kn + LC: :lc + PM: :pm + VC: :vc + WS: :ws + SM: :sm + ST: :st + SA: :sa + SN: :sn + RS: :rs + SC: :sc + SL: :sl + SG: :sg + SK: :sk + SI: :si + SB: :sb + SO: :so + ZA: :za + GS: :gs + ES: :es + LK: :lk + SD: :sd + SR: :sr + SJ: :sj + SZ: :sz + SE: :se + CH: :ch + SY: :sy + TW: :tw + TJ: :tj + TZ: :tz + TH: :th + TL: :tl + TG: :tg + TK: :tk + TO: :to + TT: :tt + TN: :tn + TR: :tr + TM: :tm + TC: :tc + TV: :tv + UG: :ug + UA: :ua + AE: :ae + GB: :gb + US: :us + UM: :um + UY: :uy + UZ: :uz + VU: :vu + VE: :ve + VN: :vn + VG: :vg + VI: :vi + WF: :wf + EH: :eh + YE: :ye + ZM: :zm + ZW: :zw + + def self?.values: -> ::Array[ContextDev::Models::WebSearchParams::country] + end + type freshness = :last_24_hours | :last_week | :last_month | :last_year module Freshness diff --git a/sig/context_dev/resources/web.rbs b/sig/context_dev/resources/web.rbs index c874f1dc..44689db7 100644 --- a/sig/context_dev/resources/web.rbs +++ b/sig/context_dev/resources/web.rbs @@ -58,10 +58,12 @@ module ContextDev def search: ( query: String, + ?country: ContextDev::Models::WebSearchParams::country, ?exclude_domains: ::Array[String], ?freshness: ContextDev::Models::WebSearchParams::freshness, ?include_domains: ::Array[String], ?markdown_options: ContextDev::WebSearchParams::MarkdownOptions, + ?num_results: Integer, ?query_fanout: bool, ?timeout_ms: Integer, ?request_options: ContextDev::request_opts From 893f11d2746ccb636e971e12c24553043046cb11 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 27 Jun 2026 20:25:32 +0000 Subject: [PATCH 3/5] feat(api): api update --- .stats.yml | 4 +- README.md | 12 ++--- .../models/web_screenshot_params.rb | 23 +++++++- lib/context_dev/resources/web.rb | 5 +- .../models/web_screenshot_params.rbi | 53 +++++++++++++++++++ rbi/context_dev/resources/web.rbi | 4 ++ .../models/web_screenshot_params.rbs | 20 +++++++ sig/context_dev/resources/web.rbs | 1 + 8 files changed, 112 insertions(+), 10 deletions(-) diff --git a/.stats.yml b/.stats.yml index 9dc6067a..0e801d62 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 25 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-d3da262409c68576e457536f6c0e7ecc538219e0af19df415111c18f8fe92cfd.yml -openapi_spec_hash: 25009575202702d24bc6672472eb8506 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-a4f78808dc23a76896b451576b3b44b0d663977f2032eaed0271dd386b20c43c.yml +openapi_spec_hash: 01f9e1ae0d635f8b874f48e3ba461476 config_hash: c7b0cdaba3b9797b77efd89e1754d803 diff --git a/README.md b/README.md index be0aa53a..ee5a3985 100644 --- a/README.md +++ b/README.md @@ -206,11 +206,11 @@ context_dev.brand.retrieve(**params) Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime: ```ruby -# :ad -puts(ContextDev::WebScreenshotParams::Country::AD) +# :light +puts(ContextDev::WebScreenshotParams::ColorScheme::LIGHT) -# Revealed type: `T.all(ContextDev::WebScreenshotParams::Country, Symbol)` -T.reveal_type(ContextDev::WebScreenshotParams::Country::AD) +# Revealed type: `T.all(ContextDev::WebScreenshotParams::ColorScheme, Symbol)` +T.reveal_type(ContextDev::WebScreenshotParams::ColorScheme::LIGHT) ``` Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value: @@ -218,13 +218,13 @@ Enum parameters have a "relaxed" type, so you can either pass in enum constants ```ruby # Using the enum constants preserves the tagged type information: context_dev.web.screenshot( - country: ContextDev::WebScreenshotParams::Country::AD, + color_scheme: ContextDev::WebScreenshotParams::ColorScheme::LIGHT, # … ) # Literal values are also permissible: context_dev.web.screenshot( - country: :ad, + color_scheme: :light, # … ) ``` diff --git a/lib/context_dev/models/web_screenshot_params.rb b/lib/context_dev/models/web_screenshot_params.rb index d9172a81..f62c7569 100644 --- a/lib/context_dev/models/web_screenshot_params.rb +++ b/lib/context_dev/models/web_screenshot_params.rb @@ -7,6 +7,13 @@ class WebScreenshotParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters + # @!attribute color_scheme + # Optional parameter to choose the site's visual theme in the screenshot. Use + # 'light' or 'dark' when the site offers both appearances. + # + # @return [Symbol, ContextDev::Models::WebScreenshotParams::ColorScheme, nil] + optional :color_scheme, enum: -> { ContextDev::WebScreenshotParams::ColorScheme } + # @!attribute country # Two-letter ISO 3166-1 alpha-2 country code for the website request location. # When provided, Context.dev fetches the target page from that country. @@ -97,10 +104,12 @@ class WebScreenshotParams < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :wait_for_ms, Integer - # @!method initialize(country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, request_options: {}) + # @!method initialize(color_scheme: nil, country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebScreenshotParams} for more details. # + # @param color_scheme [Symbol, ContextDev::Models::WebScreenshotParams::ColorScheme] Optional parameter to choose the site's visual theme in the screenshot. Use 'lig + # # @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country] Two-letter ISO 3166-1 alpha-2 country code for the website request location. Whe # # @param direct_url [String] A specific URL to screenshot directly, bypassing domain resolution (e.g., 'https @@ -125,6 +134,18 @@ class WebScreenshotParams < ContextDev::Internal::Type::BaseModel # # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}] + # Optional parameter to choose the site's visual theme in the screenshot. Use + # 'light' or 'dark' when the site offers both appearances. + module ColorScheme + extend ContextDev::Internal::Type::Enum + + LIGHT = :light + DARK = :dark + + # @!method self.values + # @return [Array] + end + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. # When provided, Context.dev fetches the target page from that country. module Country diff --git a/lib/context_dev/resources/web.rb b/lib/context_dev/resources/web.rb index e9e64db5..6d07e44b 100644 --- a/lib/context_dev/resources/web.rb +++ b/lib/context_dev/resources/web.rb @@ -163,7 +163,9 @@ def extract_styleguide(params = {}) # # Capture a screenshot of a website. # - # @overload screenshot(country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, request_options: {}) + # @overload screenshot(color_scheme: nil, country: nil, direct_url: nil, domain: nil, full_screenshot: nil, handle_cookie_popup: nil, max_age_ms: nil, page: nil, scroll_offset: nil, timeout_ms: nil, viewport: nil, wait_for_ms: nil, request_options: {}) + # + # @param color_scheme [Symbol, ContextDev::Models::WebScreenshotParams::ColorScheme] Optional parameter to choose the site's visual theme in the screenshot. Use 'lig # # @param country [Symbol, ContextDev::Models::WebScreenshotParams::Country] Two-letter ISO 3166-1 alpha-2 country code for the website request location. Whe # @@ -199,6 +201,7 @@ def screenshot(params = {}) method: :get, path: "web/screenshot", query: query.transform_keys( + color_scheme: "colorScheme", direct_url: "directUrl", full_screenshot: "fullScreenshot", handle_cookie_popup: "handleCookiePopup", diff --git a/rbi/context_dev/models/web_screenshot_params.rbi b/rbi/context_dev/models/web_screenshot_params.rbi index 373f0eb1..8e58b4d7 100644 --- a/rbi/context_dev/models/web_screenshot_params.rbi +++ b/rbi/context_dev/models/web_screenshot_params.rbi @@ -11,6 +11,22 @@ module ContextDev T.any(ContextDev::WebScreenshotParams, ContextDev::Internal::AnyHash) end + # Optional parameter to choose the site's visual theme in the screenshot. Use + # 'light' or 'dark' when the site offers both appearances. + sig do + returns( + T.nilable(ContextDev::WebScreenshotParams::ColorScheme::OrSymbol) + ) + end + attr_reader :color_scheme + + sig do + params( + color_scheme: ContextDev::WebScreenshotParams::ColorScheme::OrSymbol + ).void + end + attr_writer :color_scheme + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. # When provided, Context.dev fetches the target page from that country. sig do @@ -142,6 +158,7 @@ module ContextDev sig do params( + color_scheme: ContextDev::WebScreenshotParams::ColorScheme::OrSymbol, country: ContextDev::WebScreenshotParams::Country::OrSymbol, direct_url: String, domain: String, @@ -159,6 +176,9 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # Optional parameter to choose the site's visual theme in the screenshot. Use + # 'light' or 'dark' when the site offers both appearances. + color_scheme: nil, # Two-letter ISO 3166-1 alpha-2 country code for the website request location. # When provided, Context.dev fetches the target page from that country. country: nil, @@ -212,6 +232,8 @@ module ContextDev sig do override.returns( { + color_scheme: + ContextDev::WebScreenshotParams::ColorScheme::OrSymbol, country: ContextDev::WebScreenshotParams::Country::OrSymbol, direct_url: String, domain: String, @@ -232,6 +254,37 @@ module ContextDev def to_hash end + # Optional parameter to choose the site's visual theme in the screenshot. Use + # 'light' or 'dark' when the site offers both appearances. + module ColorScheme + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, ContextDev::WebScreenshotParams::ColorScheme) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + LIGHT = + T.let( + :light, + ContextDev::WebScreenshotParams::ColorScheme::TaggedSymbol + ) + DARK = + T.let( + :dark, + ContextDev::WebScreenshotParams::ColorScheme::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ContextDev::WebScreenshotParams::ColorScheme::TaggedSymbol] + ) + end + def self.values + end + end + # Two-letter ISO 3166-1 alpha-2 country code for the website request location. # When provided, Context.dev fetches the target page from that country. module Country diff --git a/rbi/context_dev/resources/web.rbi b/rbi/context_dev/resources/web.rbi index c71538b1..dd0a8993 100644 --- a/rbi/context_dev/resources/web.rbi +++ b/rbi/context_dev/resources/web.rbi @@ -162,6 +162,7 @@ module ContextDev # Capture a screenshot of a website. sig do params( + color_scheme: ContextDev::WebScreenshotParams::ColorScheme::OrSymbol, country: ContextDev::WebScreenshotParams::Country::OrSymbol, direct_url: String, domain: String, @@ -179,6 +180,9 @@ module ContextDev ).returns(ContextDev::Models::WebScreenshotResponse) end def screenshot( + # Optional parameter to choose the site's visual theme in the screenshot. Use + # 'light' or 'dark' when the site offers both appearances. + color_scheme: nil, # Two-letter ISO 3166-1 alpha-2 country code for the website request location. # When provided, Context.dev fetches the target page from that country. country: nil, diff --git a/sig/context_dev/models/web_screenshot_params.rbs b/sig/context_dev/models/web_screenshot_params.rbs index 8a3200a2..8df117a5 100644 --- a/sig/context_dev/models/web_screenshot_params.rbs +++ b/sig/context_dev/models/web_screenshot_params.rbs @@ -2,6 +2,7 @@ module ContextDev module Models type web_screenshot_params = { + color_scheme: ContextDev::Models::WebScreenshotParams::color_scheme, country: ContextDev::Models::WebScreenshotParams::country, direct_url: String, domain: String, @@ -20,6 +21,12 @@ module ContextDev extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters + attr_reader color_scheme: ContextDev::Models::WebScreenshotParams::color_scheme? + + def color_scheme=: ( + ContextDev::Models::WebScreenshotParams::color_scheme + ) -> ContextDev::Models::WebScreenshotParams::color_scheme + attr_reader country: ContextDev::Models::WebScreenshotParams::country? def country=: ( @@ -75,6 +82,7 @@ module ContextDev def wait_for_ms=: (Integer) -> Integer def initialize: ( + ?color_scheme: ContextDev::Models::WebScreenshotParams::color_scheme, ?country: ContextDev::Models::WebScreenshotParams::country, ?direct_url: String, ?domain: String, @@ -90,6 +98,7 @@ module ContextDev ) -> void def to_hash: -> { + color_scheme: ContextDev::Models::WebScreenshotParams::color_scheme, country: ContextDev::Models::WebScreenshotParams::country, direct_url: String, domain: String, @@ -104,6 +113,17 @@ module ContextDev request_options: ContextDev::RequestOptions } + type color_scheme = :light | :dark + + module ColorScheme + extend ContextDev::Internal::Type::Enum + + LIGHT: :light + DARK: :dark + + def self?.values: -> ::Array[ContextDev::Models::WebScreenshotParams::color_scheme] + end + type country = :ad | :ae diff --git a/sig/context_dev/resources/web.rbs b/sig/context_dev/resources/web.rbs index 44689db7..33ab127d 100644 --- a/sig/context_dev/resources/web.rbs +++ b/sig/context_dev/resources/web.rbs @@ -42,6 +42,7 @@ module ContextDev ) -> ContextDev::Models::WebExtractStyleguideResponse def screenshot: ( + ?color_scheme: ContextDev::Models::WebScreenshotParams::color_scheme, ?country: ContextDev::Models::WebScreenshotParams::country, ?direct_url: String, ?domain: String, From edf39d75e9ca0a7b96ddac6467f9b50ceca0acf1 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 27 Jun 2026 21:20:41 +0000 Subject: [PATCH 4/5] feat(api): api update --- .stats.yml | 4 +- README.md | 12 ++-- .../models/web_extract_styleguide_params.rb | 23 +++++++- lib/context_dev/resources/web.rb | 5 +- .../models/web_extract_styleguide_params.rbi | 59 +++++++++++++++++++ rbi/context_dev/resources/web.rbi | 5 ++ .../models/web_extract_styleguide_params.rbs | 20 +++++++ sig/context_dev/resources/web.rbs | 1 + 8 files changed, 119 insertions(+), 10 deletions(-) diff --git a/.stats.yml b/.stats.yml index 0e801d62..5bb2078a 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 25 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-a4f78808dc23a76896b451576b3b44b0d663977f2032eaed0271dd386b20c43c.yml -openapi_spec_hash: 01f9e1ae0d635f8b874f48e3ba461476 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-021b48afe1d6e3f54c4ebe3d0da4beb3fb8b69a6d384a4aeadbc5bab7f967603.yml +openapi_spec_hash: 2aa5b59d78c708b094acf29cc0d9a68a config_hash: c7b0cdaba3b9797b77efd89e1754d803 diff --git a/README.md b/README.md index ee5a3985..a8b0639a 100644 --- a/README.md +++ b/README.md @@ -207,23 +207,23 @@ Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::E ```ruby # :light -puts(ContextDev::WebScreenshotParams::ColorScheme::LIGHT) +puts(ContextDev::WebExtractStyleguideParams::ColorScheme::LIGHT) -# Revealed type: `T.all(ContextDev::WebScreenshotParams::ColorScheme, Symbol)` -T.reveal_type(ContextDev::WebScreenshotParams::ColorScheme::LIGHT) +# Revealed type: `T.all(ContextDev::WebExtractStyleguideParams::ColorScheme, Symbol)` +T.reveal_type(ContextDev::WebExtractStyleguideParams::ColorScheme::LIGHT) ``` Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value: ```ruby # Using the enum constants preserves the tagged type information: -context_dev.web.screenshot( - color_scheme: ContextDev::WebScreenshotParams::ColorScheme::LIGHT, +context_dev.web.extract_styleguide( + color_scheme: ContextDev::WebExtractStyleguideParams::ColorScheme::LIGHT, # … ) # Literal values are also permissible: -context_dev.web.screenshot( +context_dev.web.extract_styleguide( color_scheme: :light, # … ) diff --git a/lib/context_dev/models/web_extract_styleguide_params.rb b/lib/context_dev/models/web_extract_styleguide_params.rb index cd561c45..42019b60 100644 --- a/lib/context_dev/models/web_extract_styleguide_params.rb +++ b/lib/context_dev/models/web_extract_styleguide_params.rb @@ -7,6 +7,13 @@ class WebExtractStyleguideParams < ContextDev::Internal::Type::BaseModel extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters + # @!attribute color_scheme + # Optional browser color scheme to emulate for websites that respond to + # prefers-color-scheme. This value is part of the styleguide cache key. + # + # @return [Symbol, ContextDev::Models::WebExtractStyleguideParams::ColorScheme, nil] + optional :color_scheme, enum: -> { ContextDev::WebExtractStyleguideParams::ColorScheme } + # @!attribute direct_url # A specific URL to fetch the styleguide from directly, bypassing domain # resolution (e.g., 'https://example.com/design-system'). When provided, the @@ -41,10 +48,12 @@ class WebExtractStyleguideParams < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :timeout_ms, Integer - # @!method initialize(direct_url: nil, domain: nil, max_age_ms: nil, timeout_ms: nil, request_options: {}) + # @!method initialize(color_scheme: nil, direct_url: nil, domain: nil, max_age_ms: nil, timeout_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebExtractStyleguideParams} for more details. # + # @param color_scheme [Symbol, ContextDev::Models::WebExtractStyleguideParams::ColorScheme] Optional browser color scheme to emulate for websites that respond to prefers-co + # # @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio # # @param domain [String] Domain name to extract styleguide from (e.g., 'example.com', 'google.com'). The @@ -54,6 +63,18 @@ class WebExtractStyleguideParams < ContextDev::Internal::Type::BaseModel # @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th # # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}] + + # Optional browser color scheme to emulate for websites that respond to + # prefers-color-scheme. This value is part of the styleguide cache key. + module ColorScheme + extend ContextDev::Internal::Type::Enum + + LIGHT = :light + DARK = :dark + + # @!method self.values + # @return [Array] + end end end end diff --git a/lib/context_dev/resources/web.rb b/lib/context_dev/resources/web.rb index 6d07e44b..cc74c37d 100644 --- a/lib/context_dev/resources/web.rb +++ b/lib/context_dev/resources/web.rb @@ -127,7 +127,9 @@ def extract_fonts(params = {}) # Extract a comprehensive design system from a website including colors, # typography, spacing, shadows, and UI components. # - # @overload extract_styleguide(direct_url: nil, domain: nil, max_age_ms: nil, timeout_ms: nil, request_options: {}) + # @overload extract_styleguide(color_scheme: nil, direct_url: nil, domain: nil, max_age_ms: nil, timeout_ms: nil, request_options: {}) + # + # @param color_scheme [Symbol, ContextDev::Models::WebExtractStyleguideParams::ColorScheme] Optional browser color scheme to emulate for websites that respond to prefers-co # # @param direct_url [String] A specific URL to fetch the styleguide from directly, bypassing domain resolutio # @@ -149,6 +151,7 @@ def extract_styleguide(params = {}) method: :get, path: "web/styleguide", query: query.transform_keys( + color_scheme: "colorScheme", direct_url: "directUrl", max_age_ms: "maxAgeMs", timeout_ms: "timeoutMS" diff --git a/rbi/context_dev/models/web_extract_styleguide_params.rbi b/rbi/context_dev/models/web_extract_styleguide_params.rbi index 7e9c3bf4..5279ad06 100644 --- a/rbi/context_dev/models/web_extract_styleguide_params.rbi +++ b/rbi/context_dev/models/web_extract_styleguide_params.rbi @@ -14,6 +14,25 @@ module ContextDev ) end + # Optional browser color scheme to emulate for websites that respond to + # prefers-color-scheme. This value is part of the styleguide cache key. + sig do + returns( + T.nilable( + ContextDev::WebExtractStyleguideParams::ColorScheme::OrSymbol + ) + ) + end + attr_reader :color_scheme + + sig do + params( + color_scheme: + ContextDev::WebExtractStyleguideParams::ColorScheme::OrSymbol + ).void + end + attr_writer :color_scheme + # A specific URL to fetch the styleguide from directly, bypassing domain # resolution (e.g., 'https://example.com/design-system'). When provided, the # styleguide is extracted from this exact URL. You must provide either 'domain' or @@ -54,6 +73,8 @@ module ContextDev sig do params( + color_scheme: + ContextDev::WebExtractStyleguideParams::ColorScheme::OrSymbol, direct_url: String, domain: String, max_age_ms: Integer, @@ -62,6 +83,9 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # Optional browser color scheme to emulate for websites that respond to + # prefers-color-scheme. This value is part of the styleguide cache key. + color_scheme: nil, # A specific URL to fetch the styleguide from directly, bypassing domain # resolution (e.g., 'https://example.com/design-system'). When provided, the # styleguide is extracted from this exact URL. You must provide either 'domain' or @@ -87,6 +111,8 @@ module ContextDev sig do override.returns( { + color_scheme: + ContextDev::WebExtractStyleguideParams::ColorScheme::OrSymbol, direct_url: String, domain: String, max_age_ms: Integer, @@ -97,6 +123,39 @@ module ContextDev end def to_hash end + + # Optional browser color scheme to emulate for websites that respond to + # prefers-color-scheme. This value is part of the styleguide cache key. + module ColorScheme + extend ContextDev::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, ContextDev::WebExtractStyleguideParams::ColorScheme) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + LIGHT = + T.let( + :light, + ContextDev::WebExtractStyleguideParams::ColorScheme::TaggedSymbol + ) + DARK = + T.let( + :dark, + ContextDev::WebExtractStyleguideParams::ColorScheme::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + ContextDev::WebExtractStyleguideParams::ColorScheme::TaggedSymbol + ] + ) + end + def self.values + end + end end end end diff --git a/rbi/context_dev/resources/web.rbi b/rbi/context_dev/resources/web.rbi index dd0a8993..082aa353 100644 --- a/rbi/context_dev/resources/web.rbi +++ b/rbi/context_dev/resources/web.rbi @@ -129,6 +129,8 @@ module ContextDev # typography, spacing, shadows, and UI components. sig do params( + color_scheme: + ContextDev::WebExtractStyleguideParams::ColorScheme::OrSymbol, direct_url: String, domain: String, max_age_ms: Integer, @@ -137,6 +139,9 @@ module ContextDev ).returns(ContextDev::Models::WebExtractStyleguideResponse) end def extract_styleguide( + # Optional browser color scheme to emulate for websites that respond to + # prefers-color-scheme. This value is part of the styleguide cache key. + color_scheme: nil, # A specific URL to fetch the styleguide from directly, bypassing domain # resolution (e.g., 'https://example.com/design-system'). When provided, the # styleguide is extracted from this exact URL. You must provide either 'domain' or diff --git a/sig/context_dev/models/web_extract_styleguide_params.rbs b/sig/context_dev/models/web_extract_styleguide_params.rbs index fe7ed993..9b0b86ac 100644 --- a/sig/context_dev/models/web_extract_styleguide_params.rbs +++ b/sig/context_dev/models/web_extract_styleguide_params.rbs @@ -2,6 +2,7 @@ module ContextDev module Models type web_extract_styleguide_params = { + color_scheme: ContextDev::Models::WebExtractStyleguideParams::color_scheme, direct_url: String, domain: String, max_age_ms: Integer, @@ -13,6 +14,12 @@ module ContextDev extend ContextDev::Internal::Type::RequestParameters::Converter include ContextDev::Internal::Type::RequestParameters + attr_reader color_scheme: ContextDev::Models::WebExtractStyleguideParams::color_scheme? + + def color_scheme=: ( + ContextDev::Models::WebExtractStyleguideParams::color_scheme + ) -> ContextDev::Models::WebExtractStyleguideParams::color_scheme + attr_reader direct_url: String? def direct_url=: (String) -> String @@ -30,6 +37,7 @@ module ContextDev def timeout_ms=: (Integer) -> Integer def initialize: ( + ?color_scheme: ContextDev::Models::WebExtractStyleguideParams::color_scheme, ?direct_url: String, ?domain: String, ?max_age_ms: Integer, @@ -38,12 +46,24 @@ module ContextDev ) -> void def to_hash: -> { + color_scheme: ContextDev::Models::WebExtractStyleguideParams::color_scheme, direct_url: String, domain: String, max_age_ms: Integer, timeout_ms: Integer, request_options: ContextDev::RequestOptions } + + type color_scheme = :light | :dark + + module ColorScheme + extend ContextDev::Internal::Type::Enum + + LIGHT: :light + DARK: :dark + + def self?.values: -> ::Array[ContextDev::Models::WebExtractStyleguideParams::color_scheme] + end end end end diff --git a/sig/context_dev/resources/web.rbs b/sig/context_dev/resources/web.rbs index 33ab127d..0346d2cc 100644 --- a/sig/context_dev/resources/web.rbs +++ b/sig/context_dev/resources/web.rbs @@ -34,6 +34,7 @@ module ContextDev ) -> ContextDev::Models::WebExtractFontsResponse def extract_styleguide: ( + ?color_scheme: ContextDev::Models::WebExtractStyleguideParams::color_scheme, ?direct_url: String, ?domain: String, ?max_age_ms: Integer, From 78d95d4324237a41f371cee812683018cd0f9426 Mon Sep 17 00:00:00 2001 From: "stainless-app[bot]" <142633134+stainless-app[bot]@users.noreply.github.com> Date: Sat, 27 Jun 2026 21:21:04 +0000 Subject: [PATCH 5/5] release: 1.36.0 --- .release-please-manifest.json | 2 +- CHANGELOG.md | 11 +++++++++++ Gemfile.lock | 2 +- README.md | 2 +- lib/context_dev/version.rb | 2 +- 5 files changed, 15 insertions(+), 4 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 44959ac4..f29e96b8 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "1.35.0" + ".": "1.36.0" } \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 5bb2b785..d938655a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,16 @@ # Changelog +## 1.36.0 (2026-06-27) + +Full Changelog: [v1.35.0...v1.36.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.35.0...v1.36.0) + +### Features + +* **api:** api update ([edf39d7](https://github.com/context-dot-dev/context-ruby-sdk/commit/edf39d75e9ca0a7b96ddac6467f9b50ceca0acf1)) +* **api:** api update ([893f11d](https://github.com/context-dot-dev/context-ruby-sdk/commit/893f11d2746ccb636e971e12c24553043046cb11)) +* **api:** api update ([59319b0](https://github.com/context-dot-dev/context-ruby-sdk/commit/59319b0421154c96a444f5e2d45b83e8f4bc9074)) +* **api:** api update ([125ebe5](https://github.com/context-dot-dev/context-ruby-sdk/commit/125ebe5cb023b276c01bdc8c3cafbe8841dffddb)) + ## 1.35.0 (2026-06-25) Full Changelog: [v1.34.0...v1.35.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.34.0...v1.35.0) diff --git a/Gemfile.lock b/Gemfile.lock index b4208d01..a8178504 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - context.dev (1.35.0) + context.dev (1.36.0) cgi connection_pool diff --git a/README.md b/README.md index a8b0639a..23de0417 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "context.dev", "~> 1.35.0" +gem "context.dev", "~> 1.36.0" ``` diff --git a/lib/context_dev/version.rb b/lib/context_dev/version.rb index ea086d1c..b18b9948 100644 --- a/lib/context_dev/version.rb +++ b/lib/context_dev/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module ContextDev - VERSION = "1.35.0" + VERSION = "1.36.0" end