@getanyapi/sdk 0.34.4 → 0.35.0

package/dist/index.d.cts

@@ -1086,7 +1086,7 @@ interface AmazonAsinsData {
  */
 interface AmazonBestsellersInput {
     /**
-     * Maximum number of results to return (1-20, default 20). You are billed per result returned, so a lower limit costs less.
+     * Maximum number of results to return (1-20, default 20).
      * Range: minimum 1, maximum 20.
      * Default: 20.
      */
@@ -1262,7 +1262,7 @@ interface AmazonReviewsInput {
      */
     keyword?: string;
     /**
-     * Maximum number of results to return (1-50, default 50). You are billed per result returned, so a lower limit costs less.
+     * Maximum number of results to return (1-50, default 50).
      * Range: minimum 1, maximum 50.
      * Default: 50.
      */
@@ -1349,7 +1349,7 @@ interface AmazonReviewsData {
  */
 interface AmazonSearchInput {
     /**
-     * Maximum number of results to return (1-20, default 20). You are billed per result returned, so a lower limit costs less.
+     * Maximum number of results to return (1-20, default 20).
      * Range: minimum 1, maximum 20.
      * Default: 20.
      */
@@ -9001,7 +9001,7 @@ interface EbaySearchInput {
      */
     condition?: ("new" | "open_box" | "refurbished" | "used" | "for_parts")[];
     /**
-     * Maximum number of results to return (1 to 25, default 25). You are billed per result returned, so a lower limit costs less.
+     * Maximum number of results to return (1 to 25, default 25).
      * Range: minimum 1, maximum 25.
      */
     limit?: number;
@@ -9351,17 +9351,20 @@ interface EmailVerifyItem {
      * Free email provider.
      */
     free?: boolean;
+    /**
+     * Why the verdict was reached. Published by only one of the two sources, so it is absent on most calls; never treat it as required.
+     */
     reason?: string;
     /**
      * Role-based address (e.g. info@).
      */
     role?: boolean;
     /**
-     * Confidence score (0-100).
+     * Confidence in the verdict, 0-100. Coarse rather than graded on most calls: it tracks the status rather than ranking addresses within one.
      */
     score?: number;
     /**
-     * Deliverability verdict (e.g. valid, risky, invalid). Populated whenever the provider has data for the entity.
+     * Deliverability verdict: good (the mailbox accepted), bad (it was refused), or risky (no source could settle it - usually a catch-all domain that accepts every address, sometimes a receiving server that declined to answer at all). Populated whenever the provider has data for the entity.
      */
     status: string;
     [extra: string]: unknown;
@@ -9396,9 +9399,9 @@ declare class EmailNamespace {
     /**
      * Email Verifier
      *
-     * Verify an email address for deliverability: a status verdict (valid, risky, or invalid) with domain, mailbox, catch-all, disposable, and role signals plus a confidence score. Malformed addresses are rejected by the input schema with no charge; every syntactically valid address returns a billed verdict, including undeliverable ones.
+     * Verify an email address for deliverability: a status verdict (good, risky, or bad) with domain, mailbox, catch-all, disposable, and role signals plus a confidence score. Malformed addresses are rejected by the input schema with no charge; every syntactically valid address returns a billed verdict, including undeliverable ones.
      *
-     * Price: $0 per request plus $0.00088 per result (maximum $0.00088).
+     * Price: $0.0066 per request.
      *
      * @example
      * const res = await client.email.verify({ email: "patrick@stripe.com" });
@@ -15584,7 +15587,7 @@ interface GoogleShoppingSearchInput {
      */
     language?: string;
     /**
-     * Maximum number of results to return (1-10, default 10). You are billed per result returned, so a lower limit costs less.
+     * Maximum number of results to return (1-10, default 10).
      * Range: minimum 1, maximum 10.
      */
     limit?: number;
@@ -17131,7 +17134,7 @@ interface InstagramReelsSearchData {
  */
 interface InstagramSearchInput {
     /**
-     * Maximum number of results to return (1-20, default 20). You are billed per result returned, so a lower limit costs less.
+     * Maximum number of results to return (1-20, default 20).
      * Range: minimum 1, maximum 20.
      */
     limit?: number;
@@ -18086,7 +18089,7 @@ declare class InstagramNamespace {
      *
      * Search Instagram for users, hashtags, or places by keyword and get matching results with names, counts, and links.
      *
-     * Price: $0.0015 per request.
+     * Price: $0.0036 per request.
      *
      * @example
      * const res = await client.instagram.search({ query: "nasa" });
@@ -20236,7 +20239,7 @@ interface LinkedinPostData {
  */
 interface LinkedinPostCommentsInput {
     /**
-     * Maximum number of comments to return. You are billed per comment returned, so a lower limit costs less.
+     * Maximum number of comments to return.
      * Range: minimum 1, maximum 100.
      * Default: 100.
      */
@@ -20341,7 +20344,7 @@ interface LinkedinPostCommentsData {
  */
 interface LinkedinPostReactionsInput {
     /**
-     * Maximum number of reactions to return (1-100, default 100). You are billed per reaction returned, so a lower limit costs less.
+     * Maximum number of reactions to return (1-100, default 100).
      * Range: minimum 1, maximum 100.
      */
     limit?: number;
@@ -20710,7 +20713,7 @@ interface LinkedinProfilePostsFullInput {
      */
     includeReposts?: boolean;
     /**
-     * Maximum number of posts to return (1-100, default 10). You are billed per post returned, so a lower limit costs less.
+     * Maximum number of posts to return (1-100, default 10).
      * Range: minimum 1, maximum 100.
      * Default: 10.
      */
@@ -21047,8 +21050,7 @@ interface LinkedinProfilePostsFullItem {
      */
     text: string;
     /**
-     * LinkedIn record type reported for the post. Populated whenever the provider has data for the entity.
-     * Present whenever the upstream returns this record.
+     * LinkedIn record type reported for the post.
      */
     type?: string;
     /**
@@ -21191,7 +21193,7 @@ interface LinkedinProfilePostsFullData {
  */
 interface LinkedinProfilePostsThinInput {
     /**
-     * Maximum number of posts to return (10-100, default 10). You are billed per post returned, so a lower limit costs less.
+     * Maximum number of posts to return (10-100, default 10).
      * Range: minimum 10, maximum 100.
      * Default: 10.
      */
@@ -21492,8 +21494,9 @@ interface LinkedinProfileThinData {
  */
 interface LinkedinSearchCompaniesInput {
     /**
-     * Maximum number of results to return (1-20, default 20). You are billed per result returned, so a lower limit costs less.
+     * Maximum number of results to return (1-20, default 20).
      * Range: minimum 1, maximum 20.
+     * Default: 20.
      */
     limit?: number;
     /**
@@ -21678,7 +21681,7 @@ interface LinkedinSearchPostsFullInput {
      */
     datePosted?: "last-hour" | "last-day" | "last-week" | "last-month" | "last-three-months" | "last-six-months" | "last-year";
     /**
-     * Maximum number of posts to return (1-100, default 10). The upper bound is one LinkedIn search page. You are billed per post returned.
+     * Maximum number of posts to return (1-100, default 10). The upper bound is one LinkedIn search page.
      * Range: minimum 1, maximum 100.
      * Default: 10.
      */
@@ -22434,7 +22437,7 @@ declare class LinkedinNamespace {
      *
      * List a LinkedIn company page's recent posts by URL: full text, canonical link, publish date, author, engagement counts with a per-reaction breakdown, and attached media.
      *
-     * Price: $0.00116 per request plus $0.00193 per result (maximum $0.0975).
+     * Price: $0.005 per request.
      *
      * @example
      * const res = await client.linkedin.companyPosts({ url: "https://www.linkedin.com/company/stripe", limit: 10 });
@@ -22489,7 +22492,7 @@ declare class LinkedinNamespace {
      *
      * Cheap job index: title, company, location, posted date, URL. No description, salary, applicant counts, or seniority - for those use linkedin.jobs.
      *
-     * Price: $0.0009 per request.
+     * Price: $0.00066 per request.
      *
      * @example
      * const res = await client.linkedin.jobsThin({ query: "software engineer", limit: 3, location: "United States", workplaceType: "remote" });
@@ -22511,7 +22514,7 @@ declare class LinkedinNamespace {
      *
      * List comments on a LinkedIn post - full text, commenter name/URL/job title, timestamps, and engagement.
      *
-     * Price: $0 per request plus $0.00143 per result (maximum $0.143).
+     * Price: $0.005 per request.
      *
      * @example
      * const res = await client.linkedin.postComments({ url: "https://www.linkedin.com/posts/stripe_philip-kl%C3%B6ckner-in-conversation-with-conor-activity-7477791740645564416-tIbZ", limit: 10 });
@@ -22522,7 +22525,7 @@ declare class LinkedinNamespace {
      *
      * List who reacted to a LinkedIn post - reactor name, profile URL, job title, and reaction type. Lead-gen grade.
      *
-     * Price: $0 per request plus $0.0022 per result (maximum $0.22).
+     * Price: $0.005 per request.
      *
      * @example
      * const res = await client.linkedin.postReactions({ url: "https://www.linkedin.com/posts/satyanadella_today-were-bringing-skills-to-copilot-for-activity-7475945433668694017--kvG", limit: 5 });
@@ -22544,10 +22547,10 @@ declare class LinkedinNamespace {
      *
      * Fetch a rich LinkedIn member profile by URL: name, headline, avatar, location, connections and followers, current position, and full work experience with job titles, descriptions, dates, employment/workplace type, and per-role skills, plus education, skills, certifications, honors and awards, languages, projects, publications, and verified/premium/open-to-work flags.
      *
-     * Price: $0.0044 per request plus $0 per result (maximum $0.0044).
+     * Price: $0.004 per request.
      *
      * @example
-     * const res = await client.linkedin.profile({ url: "https://www.linkedin.com/in/williamhgates" });
+     * const res = await client.linkedin.profile({ url: "https://www.linkedin.com/in/patrickcollison" });
      */
     profile(input: LinkedinProfileInput, options?: RequestOptions): Promise<RunResult<LinkedinProfileData>>;
     /**
@@ -22555,7 +22558,7 @@ declare class LinkedinNamespace {
      *
      * Fetch recent public LinkedIn profile posts with enriched author, engagement, article, newsletter, media, annotation, repost, and social activity details.
      *
-     * Price: $0.00116 per request plus $0.00193 per result (maximum $0.194).
+     * Price: $0.005 per request.
      *
      * @example
      * const res = await client.linkedin.profilePostsFull({ url: "https://www.linkedin.com/in/williamhgates/", limit: 10 });
@@ -22566,7 +22569,7 @@ declare class LinkedinNamespace {
      *
      * Fetch recent public LinkedIn profile posts with portable identity, author, engagement, article, image, video, and repost fields.
      *
-     * Price: $0 per request plus $0.00143 per result (maximum $0.143).
+     * Price: $0.005 per request.
      *
      * @example
      * const res = await client.linkedin.profilePostsThin({ url: "https://www.linkedin.com/in/williamhgates/", limit: 10 });
@@ -22588,7 +22591,7 @@ declare class LinkedinNamespace {
      *
      * Search LinkedIn companies by keyword with optional location filtering, returning normalized company records.
      *
-     * Price: $0.0011 per request plus $0.0044 per result (maximum $0.0891).
+     * Price: $0.005 per request.
      *
      * @example
      * const res = await client.linkedin.searchCompanies({ query: "fintech", limit: 3 });
@@ -22617,7 +22620,7 @@ declare class LinkedinNamespace {
      *
      * Search public LinkedIn posts with rich author, engagement, attachment, and poll details.
      *
-     * Price: $0 per request plus $0.00143 per result (maximum $0.143).
+     * Price: $0.005 per request.
      *
      * @example
      * const res = await client.linkedin.searchPostsFull({ query: "artificial intelligence", datePosted: "last-week", limit: 10, sort: "relevance" });
@@ -22817,7 +22820,7 @@ interface MapsContactsData {
  */
 interface MapsPlaceInput {
     /**
-     * Optional list of Google Maps place-category names to keep; the match is limited to a place whose category is one of these. Use lowercase category names as shown on Google Maps (e.g. ["coffee shop"]). Omit to allow any category.
+     * Optional list of Google Maps place-category names to keep; the match is limited to a place whose category is one of these. Use lowercase category names as shown on Google Maps (e.g. ["coffee shop"]). Omit to allow any category and stay on the cheapest price; a category filter routes to a dearer source.
      */
     categoryFilterWords?: string[];
     /**
@@ -22830,7 +22833,7 @@ interface MapsPlaceInput {
      */
     location?: string;
     /**
-     * Only match a place with at least this average rating: two (2+), twoAndHalf (2.5+), three (3+), threeAndHalf (3.5+), four (4+), or fourAndHalf (4.5+). Places with no reviews are excluded. Omit for no rating filter.
+     * Only match a place with at least this average rating: two (2+), twoAndHalf (2.5+), three (3+), threeAndHalf (3.5+), four (4+), or fourAndHalf (4.5+). Places with no reviews are excluded. Omit this field to stay on the cheapest price; a rating floor routes to a dearer source.
      * One of: two, twoAndHalf, three, threeAndHalf, four, fourAndHalf.
      */
     placeMinimumStars?: "two" | "twoAndHalf" | "three" | "threeAndHalf" | "four" | "fourAndHalf";
@@ -22844,7 +22847,7 @@ interface MapsPlaceInput {
      */
     query: string;
     /**
-     * Filter by whether the place lists a website: allPlaces (default), withWebsite (only if it has a website), or withoutWebsite (only if it has none).
+     * Filter by whether the place lists a website: allPlaces (default), withWebsite (only if it has a website), or withoutWebsite (only if it has none). Omit this field, or send allPlaces, to stay on the cheapest price; withWebsite and withoutWebsite route to a dearer source.
      * One of: allPlaces, withWebsite, withoutWebsite.
      */
     website?: "allPlaces" | "withWebsite" | "withoutWebsite";
@@ -23068,7 +23071,7 @@ interface MapsReviewsData {
  */
 interface MapsSearchInput {
     /**
-     * Optional list of Google Maps place-category names to keep; results are limited to places whose category matches one of these. Use lowercase category names as shown on Google Maps (e.g. ["coffee shop", "restaurant"]). Omit to include all categories.
+     * Optional list of Google Maps place-category names to keep; results are limited to places whose category matches one of these. Use lowercase category names as shown on Google Maps (e.g. ["coffee shop", "restaurant"]). Omit to include all categories and stay on the cheapest price; a category filter routes to a dearer source.
      */
     categoryFilterWords?: string[];
     /**
@@ -23086,7 +23089,7 @@ interface MapsSearchInput {
      */
     location: string;
     /**
-     * Only return places with at least this average rating: two (2+), twoAndHalf (2.5+), three (3+), threeAndHalf (3.5+), four (4+), or fourAndHalf (4.5+). Places with no reviews are excluded. Omit for no rating filter.
+     * Only return places with at least this average rating: two (2+), twoAndHalf (2.5+), three (3+), threeAndHalf (3.5+), four (4+), or fourAndHalf (4.5+). Places with no reviews are excluded. Omit this field to stay on the cheapest price; a rating floor routes to a dearer source.
      * One of: two, twoAndHalf, three, threeAndHalf, four, fourAndHalf.
      */
     placeMinimumStars?: "two" | "twoAndHalf" | "three" | "threeAndHalf" | "four" | "fourAndHalf";
@@ -23100,7 +23103,7 @@ interface MapsSearchInput {
      */
     query: string;
     /**
-     * Filter places by whether they list a website: allPlaces (default), withWebsite (only places that have a website), or withoutWebsite (only places without one).
+     * Filter places by whether they list a website: allPlaces (default), withWebsite (only places that have a website), or withoutWebsite (only places without one). Omit this field, or send allPlaces, to stay on the cheapest price; withWebsite and withoutWebsite route to a dearer source.
      * One of: allPlaces, withWebsite, withoutWebsite.
      */
     website?: "allPlaces" | "withWebsite" | "withoutWebsite";
@@ -23223,7 +23226,7 @@ declare class MapsNamespace {
      * Price: $0.00175 per request.
      *
      * @example
-     * const res = await client.maps.place({ query: "Blue Bottle Coffee", location: "San Francisco, CA", website: "withWebsite" });
+     * const res = await client.maps.place({ query: "Blue Bottle Coffee", location: "San Francisco, CA" });
      */
     place(input: MapsPlaceInput, options?: RequestOptions): Promise<RunResult<MapsPlaceData>>;
     /**
@@ -23245,7 +23248,7 @@ declare class MapsNamespace {
      * Price: $0.00175 per request.
      *
      * @example
-     * const res = await client.maps.search({ location: "Austin, TX", query: "coffee", limit: 3, placeMinimumStars: "four", website: "withWebsite" });
+     * const res = await client.maps.search({ location: "Austin, TX", query: "coffee", limit: 3 });
      */
     search(input: MapsSearchInput, options?: RequestOptions): Promise<RunResult<MapsSearchData>>;
 }
@@ -31017,7 +31020,7 @@ declare class PersonEnrichmentNamespace {
  */
 interface PinterestSearchInput {
     /**
-     * Maximum number of results to return (1-20, default 20). You are billed per result returned, so a lower limit costs less.
+     * Maximum number of results to return (1-20, default 20).
      * Range: minimum 1, maximum 20.
      */
     limit?: number;
@@ -36906,7 +36909,7 @@ interface TiktokHashtagVideosInput {
      */
     hashtag: string;
     /**
-     * Maximum number of results to return (1-20, default 20). You are billed per result returned, so a lower limit costs less.
+     * Maximum number of results to return (1-20, default 20).
      * Range: minimum 1, maximum 20.
      */
     limit?: number;
@@ -38372,7 +38375,7 @@ declare class TiktokNamespace {
      *
      * List recent TikTok videos for a hashtag (creator, caption, views, likes, shares).
      *
-     * Price: $0.00144 per request.
+     * Price: $0.0036 per request.
      *
      * @example
      * const res = await client.tiktok.hashtagVideos({ hashtag: "cooking", limit: 3 });
@@ -39273,7 +39276,7 @@ interface TiktokShopSearchInput {
      */
     country?: "US" | "VN" | "TH" | "PH" | "MY" | "ID" | "GB" | "SG" | "ES" | "MX" | "DE" | "IT" | "FR" | "BR" | "JP";
     /**
-     * Maximum number of results to return (1-10, default 10). You are billed per result returned, so a lower limit costs less.
+     * Maximum number of results to return (1-10, default 10).
      * Range: minimum 1, maximum 10.
      */
     limit?: number;
@@ -39654,7 +39657,7 @@ interface TripadvisorReviewsInput {
      */
     languages?: string[];
     /**
-     * Maximum number of results to return (1-20, default 20). You are billed per result returned, so a lower limit costs less.
+     * Maximum number of results to return (1-20, default 20).
      * Range: minimum 1, maximum 20.
      */
     limit?: number;
@@ -39736,7 +39739,7 @@ interface TripadvisorSearchInput {
      */
     includeRestaurants?: boolean;
     /**
-     * Maximum number of results to return (1-20, default 20). You are billed per result returned, so a lower limit costs less.
+     * Maximum number of results to return (1-20, default 20).
      * Range: minimum 1, maximum 20.
      */
     limit?: number;
@@ -39894,8 +39897,9 @@ interface TrustpilotReviewsInput {
      */
     languages?: string[];
     /**
-     * Maximum number of results to return (1-200, default 200). Trustpilot serves at most 200 reviews per company. You are billed per result returned, so a lower limit costs less.
+     * Maximum number of results to return (1-200, default 200). Trustpilot serves at most 200 reviews per company.
      * Range: minimum 1, maximum 200.
+     * Default: 200.
      */
     limit?: number;
     /**
@@ -39977,7 +39981,7 @@ declare class TrustpilotNamespace {
      *
      * Pull Trustpilot reviews for any company by brand name: star ratings, review text, dates, and reviewer details as clean JSON.
      *
-     * Price: $0.00006 per request plus $0.00005 per result (maximum $0.00886).
+     * Price: $0.00225 per request.
      *
      * @example
      * const res = await client.trustpilot.reviews({ company: "stripe.com", limit: 3 });
@@ -42088,7 +42092,7 @@ interface WebScrapeInput {
      */
     excludeTags?: string[];
     /**
-     * Which representations of the page to return. Any combination of: markdown (page content as Markdown), html (cleaned HTML), rawHtml (verbatim page HTML). Each requested format is returned under the matching output field. Defaults to Markdown and raw HTML.
+     * Which representations of the page to return. Any combination of: markdown (page content as Markdown), html (the page HTML exactly as the browser received it, including head and script tags). Each requested format is returned under the matching output field. Defaults to both. rawHtml is a deprecated alias of html, returned under a rawHtml field for callers that predate the rename; send html instead.
      */
     formats?: ("markdown" | "html" | "rawHtml")[];
     /**
@@ -42109,11 +42113,6 @@ interface WebScrapeInput {
      * Range: minimum 1.
      */
     preferLatencyUnderMs?: number;
-    /**
-     * When true, fetch through a stealth proxy that gets past bot protection which refuses an ordinary request. This costs materially more per request (see the pricing ceiling), so leave it off unless a normal scrape of the site comes back blocked or empty.
-     * Default: false.
-     */
-    stealth?: boolean;
     /**
      * The URL of the page to scrape.
      * Format: uri.
@@ -42134,7 +42133,7 @@ interface WebScrapeData {
      */
     description: string;
     /**
-     * The cleaned page HTML. Present only when 'html' is among the requested formats.
+     * The page HTML exactly as the browser received it, head and script tags included. Present when 'html' is among the requested formats (the default).
      */
     html?: string;
     /**
@@ -42143,7 +42142,7 @@ interface WebScrapeData {
      */
     markdown?: string;
     /**
-     * The verbatim page HTML before cleaning. Present only when 'rawHtml' is among the requested formats.
+     * The same bytes as 'html'. Deprecated alias returned only when 'rawHtml' is among the requested formats; use 'html'.
      */
     rawHtml?: string;
     /**
@@ -42233,7 +42232,7 @@ declare class WebNamespace {
      * Price: $0.0007 per request.
      *
      * @example
-     * const res = await client.web.scrape({ url: "https://example.com", formats: ["markdown", "rawHtml"], onlyMainContent: false });
+     * const res = await client.web.scrape({ url: "https://example.com", formats: ["markdown", "html"], onlyMainContent: false });
      */
     scrape(input: WebScrapeInput, options?: RequestOptions): Promise<RunResult<WebScrapeData>>;
     /**
@@ -44984,7 +44983,7 @@ interface ZillowSearchInput {
      */
     includeRoomForRent?: boolean;
     /**
-     * Maximum number of results to return (1-25, default 25). You are billed per result returned, so a lower limit costs less.
+     * Maximum number of results to return (1-25, default 25).
      * Range: minimum 1, maximum 25.
      * Default: 25.
      */