feat(scrape): add Yelp search parser

Merge pull request #2306 from context-dot-dev/feat/yelp-search-parser

Stainless-Generated-From: 18edb4fa782172de4560dbf83e032d0f79abc97d

Author: stlc-bot

lib/context_dev/models/batch_get_results_response.rb

@@ -190,10 +190,11 @@ class Result < ContextDev::Internal::Type::BaseModel
             #   data, instagram-feed returns data.posts, tiktok-profile and tiktok-video return
             #   one record as data, tiktok-feed returns data.videos, tiktok-comments returns
             #   data.comments, tiktok-followers, tiktok-following, and tiktok-user-search return
-            #   data.users, emails, phone-numbers, and links return data.emails,
-            #   data.phone_numbers, and data.links from the rendered page; the store, Maps, G2,
-            #   Instagram, and TikTok parsers read their data directly, independently of DOM
-            #   filters and other outputs.
+            #   data.users, yelp-search returns up to 20 ranked organic businesses in
+            #   data.businesses, plus total and pagination, from a Yelp search URL; emails,
+            #   phone-numbers, and links return data.emails, data.phone_numbers, and data.links
+            #   from the rendered page; the store, Maps, G2, Instagram, and TikTok parsers read
+            #   their data directly, independently of DOM filters and other outputs.
             #
             #   @return [ContextDev::Models::BatchGetResultsResponse::Data::Ok::Result::Parsed]
             required :parsed, -> { ContextDev::Models::BatchGetResultsResponse::Data::Ok::Result::Parsed }
@@ -1027,10 +1028,11 @@ class Parsed < ContextDev::Internal::Type::BaseModel
               #   data, instagram-feed returns data.posts, tiktok-profile and tiktok-video return
               #   one record as data, tiktok-feed returns data.videos, tiktok-comments returns
               #   data.comments, tiktok-followers, tiktok-following, and tiktok-user-search return
-              #   data.users, emails, phone-numbers, and links return data.emails,
-              #   data.phone_numbers, and data.links from the rendered page; the store, Maps, G2,
-              #   Instagram, and TikTok parsers read their data directly, independently of DOM
-              #   filters and other outputs.
+              #   data.users, yelp-search returns up to 20 ranked organic businesses in
+              #   data.businesses, plus total and pagination, from a Yelp search URL; emails,
+              #   phone-numbers, and links return data.emails, data.phone_numbers, and data.links
+              #   from the rendered page; the store, Maps, G2, Instagram, and TikTok parsers read
+              #   their data directly, independently of DOM filters and other outputs.
               #
               #   @param data [Hash{Symbol=>Object}, nil]
               #
@@ -1069,6 +1071,7 @@ module Type
                 TIKTOK_FOLLOWERS = :"tiktok-followers"
                 TIKTOK_FOLLOWING = :"tiktok-following"
                 TIKTOK_USER_SEARCH = :"tiktok-user-search"
+                YELP_SEARCH = :"yelp-search"
                 EMAILS = :emails
                 PHONE_NUMBERS = :"phone-numbers"
                 LINKS = :links
@@ -1592,10 +1595,11 @@ class Result < ContextDev::Internal::Type::BaseModel
             #   data, instagram-feed returns data.posts, tiktok-profile and tiktok-video return
             #   one record as data, tiktok-feed returns data.videos, tiktok-comments returns
             #   data.comments, tiktok-followers, tiktok-following, and tiktok-user-search return
-            #   data.users, emails, phone-numbers, and links return data.emails,
-            #   data.phone_numbers, and data.links from the rendered page; the store, Maps, G2,
-            #   Instagram, and TikTok parsers read their data directly, independently of DOM
-            #   filters and other outputs.
+            #   data.users, yelp-search returns up to 20 ranked organic businesses in
+            #   data.businesses, plus total and pagination, from a Yelp search URL; emails,
+            #   phone-numbers, and links return data.emails, data.phone_numbers, and data.links
+            #   from the rendered page; the store, Maps, G2, Instagram, and TikTok parsers read
+            #   their data directly, independently of DOM filters and other outputs.
             #
             #   @return [ContextDev::Models::BatchGetResultsResponse::Data::Error::Result::Parsed]
             required :parsed, -> { ContextDev::Models::BatchGetResultsResponse::Data::Error::Result::Parsed }
@@ -2431,10 +2435,11 @@ class Parsed < ContextDev::Internal::Type::BaseModel
               #   data, instagram-feed returns data.posts, tiktok-profile and tiktok-video return
               #   one record as data, tiktok-feed returns data.videos, tiktok-comments returns
               #   data.comments, tiktok-followers, tiktok-following, and tiktok-user-search return
-              #   data.users, emails, phone-numbers, and links return data.emails,
-              #   data.phone_numbers, and data.links from the rendered page; the store, Maps, G2,
-              #   Instagram, and TikTok parsers read their data directly, independently of DOM
-              #   filters and other outputs.
+              #   data.users, yelp-search returns up to 20 ranked organic businesses in
+              #   data.businesses, plus total and pagination, from a Yelp search URL; emails,
+              #   phone-numbers, and links return data.emails, data.phone_numbers, and data.links
+              #   from the rendered page; the store, Maps, G2, Instagram, and TikTok parsers read
+              #   their data directly, independently of DOM filters and other outputs.
               #
               #   @param data [Hash{Symbol=>Object}, nil]
               #
@@ -2473,6 +2478,7 @@ module Type
                 TIKTOK_FOLLOWERS = :"tiktok-followers"
                 TIKTOK_FOLLOWING = :"tiktok-following"
                 TIKTOK_USER_SEARCH = :"tiktok-user-search"
+                YELP_SEARCH = :"yelp-search"
                 EMAILS = :emails
                 PHONE_NUMBERS = :"phone-numbers"
                 LINKS = :links

lib/context_dev/models/batch_submit_params.rb

@@ -1667,17 +1667,19 @@ class PrebuiltParser < ContextDev::Internal::Type::BaseModel
                   #   (/search/user?q={query}) as data.users: id, username, nickname, biography,
                   #   avatar_url, sec_uid, follower_count, like_count, and is_verified. The TikTok
                   #   parsers accept tiktok.com, www.tiktok.com, and m.tiktok.com URLs but not short
-                  #   links (vm.tiktok.com, vt.tiktok.com, tiktok.com/t/…). emails accepts any page
-                  #   and returns its email addresses as data.emails ([{ email }]), read from mailto
-                  #   links, Cloudflare-protected addresses, and visible text. phone-numbers accepts
-                  #   any page and returns its valid phone numbers in E.164 as data.phone_numbers ([{
-                  #   phone }]), read from tel links and visible text; numbers without a country code
-                  #   are read for the country of the site TLD, defaulting to US. links accepts any
-                  #   page and returns its unique http(s) links as data.links ([{ url, text }]), with
-                  #   absolute URLs; text falls back to aria-label or image alt and is null when a
-                  #   link has none. The emails parser reads the rendered page and respects content
-                  #   filters; the other prebuilt parsers read their data independently of DOM
-                  #   filters.
+                  #   links (vm.tiktok.com, vt.tiktok.com, tiktok.com/t/…). yelp-search accepts Yelp
+                  #   search URLs with find_desc and find_loc, reads start as the result offset, and
+                  #   returns up to 20 ranked organic businesses in data.businesses with total and
+                  #   pagination. emails accepts any page and returns its email addresses as
+                  #   data.emails ([{ email }]), read from mailto links, Cloudflare-protected
+                  #   addresses, and visible text. phone-numbers accepts any page and returns its
+                  #   valid phone numbers in E.164 as data.phone_numbers ([{ phone }]), read from tel
+                  #   links and visible text; numbers without a country code are read for the country
+                  #   of the site TLD, defaulting to US. links accepts any page and returns its unique
+                  #   http(s) links as data.links ([{ url, text }]), with absolute URLs; text falls
+                  #   back to aria-label or image alt and is null when a link has none. The emails
+                  #   parser reads the rendered page and respects content filters; the other prebuilt
+                  #   parsers read their data independently of DOM filters.
                   #
                   #   @return [Symbol, ContextDev::Models::BatchSubmitParams::Input::Scrape::Data::BatchUnifiedScrapeData::ParseParams::PrebuiltParser::Parser]
                   required :parser,
@@ -1776,17 +1778,19 @@ class PrebuiltParser < ContextDev::Internal::Type::BaseModel
                   # (/search/user?q={query}) as data.users: id, username, nickname, biography,
                   # avatar_url, sec_uid, follower_count, like_count, and is_verified. The TikTok
                   # parsers accept tiktok.com, www.tiktok.com, and m.tiktok.com URLs but not short
-                  # links (vm.tiktok.com, vt.tiktok.com, tiktok.com/t/…). emails accepts any page
-                  # and returns its email addresses as data.emails ([{ email }]), read from mailto
-                  # links, Cloudflare-protected addresses, and visible text. phone-numbers accepts
-                  # any page and returns its valid phone numbers in E.164 as data.phone_numbers ([{
-                  # phone }]), read from tel links and visible text; numbers without a country code
-                  # are read for the country of the site TLD, defaulting to US. links accepts any
-                  # page and returns its unique http(s) links as data.links ([{ url, text }]), with
-                  # absolute URLs; text falls back to aria-label or image alt and is null when a
-                  # link has none. The emails parser reads the rendered page and respects content
-                  # filters; the other prebuilt parsers read their data independently of DOM
-                  # filters.
+                  # links (vm.tiktok.com, vt.tiktok.com, tiktok.com/t/…). yelp-search accepts Yelp
+                  # search URLs with find_desc and find_loc, reads start as the result offset, and
+                  # returns up to 20 ranked organic businesses in data.businesses with total and
+                  # pagination. emails accepts any page and returns its email addresses as
+                  # data.emails ([{ email }]), read from mailto links, Cloudflare-protected
+                  # addresses, and visible text. phone-numbers accepts any page and returns its
+                  # valid phone numbers in E.164 as data.phone_numbers ([{ phone }]), read from tel
+                  # links and visible text; numbers without a country code are read for the country
+                  # of the site TLD, defaulting to US. links accepts any page and returns its unique
+                  # http(s) links as data.links ([{ url, text }]), with absolute URLs; text falls
+                  # back to aria-label or image alt and is null when a link has none. The emails
+                  # parser reads the rendered page and respects content filters; the other prebuilt
+                  # parsers read their data independently of DOM filters.
                   #
                   # @see ContextDev::Models::BatchSubmitParams::Input::Scrape::Data::BatchUnifiedScrapeData::ParseParams::PrebuiltParser#parser
                   module Parser
@@ -1809,6 +1813,7 @@ module Parser
                     TIKTOK_FOLLOWERS = :"tiktok-followers"
                     TIKTOK_FOLLOWING = :"tiktok-following"
                     TIKTOK_USER_SEARCH = :"tiktok-user-search"
+                    YELP_SEARCH = :"yelp-search"
                     EMAILS = :emails
                     PHONE_NUMBERS = :"phone-numbers"
                     LINKS = :links
@@ -4969,17 +4974,19 @@ class PrebuiltParser < ContextDev::Internal::Type::BaseModel
                   #   (/search/user?q={query}) as data.users: id, username, nickname, biography,
                   #   avatar_url, sec_uid, follower_count, like_count, and is_verified. The TikTok
                   #   parsers accept tiktok.com, www.tiktok.com, and m.tiktok.com URLs but not short
-                  #   links (vm.tiktok.com, vt.tiktok.com, tiktok.com/t/…). emails accepts any page
-                  #   and returns its email addresses as data.emails ([{ email }]), read from mailto
-                  #   links, Cloudflare-protected addresses, and visible text. phone-numbers accepts
-                  #   any page and returns its valid phone numbers in E.164 as data.phone_numbers ([{
-                  #   phone }]), read from tel links and visible text; numbers without a country code
-                  #   are read for the country of the site TLD, defaulting to US. links accepts any
-                  #   page and returns its unique http(s) links as data.links ([{ url, text }]), with
-                  #   absolute URLs; text falls back to aria-label or image alt and is null when a
-                  #   link has none. The emails parser reads the rendered page and respects content
-                  #   filters; the other prebuilt parsers read their data independently of DOM
-                  #   filters.
+                  #   links (vm.tiktok.com, vt.tiktok.com, tiktok.com/t/…). yelp-search accepts Yelp
+                  #   search URLs with find_desc and find_loc, reads start as the result offset, and
+                  #   returns up to 20 ranked organic businesses in data.businesses with total and
+                  #   pagination. emails accepts any page and returns its email addresses as
+                  #   data.emails ([{ email }]), read from mailto links, Cloudflare-protected
+                  #   addresses, and visible text. phone-numbers accepts any page and returns its
+                  #   valid phone numbers in E.164 as data.phone_numbers ([{ phone }]), read from tel
+                  #   links and visible text; numbers without a country code are read for the country
+                  #   of the site TLD, defaulting to US. links accepts any page and returns its unique
+                  #   http(s) links as data.links ([{ url, text }]), with absolute URLs; text falls
+                  #   back to aria-label or image alt and is null when a link has none. The emails
+                  #   parser reads the rendered page and respects content filters; the other prebuilt
+                  #   parsers read their data independently of DOM filters.
                   #
                   #   @return [Symbol, ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::BatchUnifiedCrawlData::ParseParams::PrebuiltParser::Parser]
                   required :parser,
@@ -5078,17 +5085,19 @@ class PrebuiltParser < ContextDev::Internal::Type::BaseModel
                   # (/search/user?q={query}) as data.users: id, username, nickname, biography,
                   # avatar_url, sec_uid, follower_count, like_count, and is_verified. The TikTok
                   # parsers accept tiktok.com, www.tiktok.com, and m.tiktok.com URLs but not short
-                  # links (vm.tiktok.com, vt.tiktok.com, tiktok.com/t/…). emails accepts any page
-                  # and returns its email addresses as data.emails ([{ email }]), read from mailto
-                  # links, Cloudflare-protected addresses, and visible text. phone-numbers accepts
-                  # any page and returns its valid phone numbers in E.164 as data.phone_numbers ([{
-                  # phone }]), read from tel links and visible text; numbers without a country code
-                  # are read for the country of the site TLD, defaulting to US. links accepts any
-                  # page and returns its unique http(s) links as data.links ([{ url, text }]), with
-                  # absolute URLs; text falls back to aria-label or image alt and is null when a
-                  # link has none. The emails parser reads the rendered page and respects content
-                  # filters; the other prebuilt parsers read their data independently of DOM
-                  # filters.
+                  # links (vm.tiktok.com, vt.tiktok.com, tiktok.com/t/…). yelp-search accepts Yelp
+                  # search URLs with find_desc and find_loc, reads start as the result offset, and
+                  # returns up to 20 ranked organic businesses in data.businesses with total and
+                  # pagination. emails accepts any page and returns its email addresses as
+                  # data.emails ([{ email }]), read from mailto links, Cloudflare-protected
+                  # addresses, and visible text. phone-numbers accepts any page and returns its
+                  # valid phone numbers in E.164 as data.phone_numbers ([{ phone }]), read from tel
+                  # links and visible text; numbers without a country code are read for the country
+                  # of the site TLD, defaulting to US. links accepts any page and returns its unique
+                  # http(s) links as data.links ([{ url, text }]), with absolute URLs; text falls
+                  # back to aria-label or image alt and is null when a link has none. The emails
+                  # parser reads the rendered page and respects content filters; the other prebuilt
+                  # parsers read their data independently of DOM filters.
                   #
                   # @see ContextDev::Models::BatchSubmitParams::Input::Crawl::Data::BatchUnifiedCrawlData::ParseParams::PrebuiltParser#parser
                   module Parser
@@ -5111,6 +5120,7 @@ module Parser
                     TIKTOK_FOLLOWERS = :"tiktok-followers"
                     TIKTOK_FOLLOWING = :"tiktok-following"
                     TIKTOK_USER_SEARCH = :"tiktok-user-search"
+                    YELP_SEARCH = :"yelp-search"
                     EMAILS = :emails
                     PHONE_NUMBERS = :"phone-numbers"
                     LINKS = :links