dataforseo-client 2.1.2 → 2.1.3

package/dist/cjs/models/OnPageWaterfallResultInfo.d.ts

@@ -1,24 +1,24 @@
 import { CrawlStatusInfo } from "./CrawlStatusInfo";
 import { OnPageWaterfallItem } from "./OnPageWaterfallItem";
 export interface IOnPageWaterfallResultInfo {
-    /** status of the crawling session possible values: in_progress, finished */
+    /** *status of the crawling session* possible values: `in_progress`, `finished` */
     crawl_progress?: string | undefined;
-    /** details of the crawling session */
+    /** *details of the crawling session* */
     crawl_status?: CrawlStatusInfo | undefined;
-    /** number of items in the results array */
+    /** *number of items in the results array* */
     items_count?: number | undefined;
-    /** items array */
+    /** *items array* */
     items?: OnPageWaterfallItem[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageWaterfallResultInfo implements IOnPageWaterfallResultInfo {
-    /** status of the crawling session possible values: in_progress, finished */
+    /** *status of the crawling session* possible values: `in_progress`, `finished` */
     crawl_progress?: string | undefined;
-    /** details of the crawling session */
+    /** *details of the crawling session* */
     crawl_status?: CrawlStatusInfo | undefined;
-    /** number of items in the results array */
+    /** *number of items in the results array* */
     items_count?: number | undefined;
-    /** items array */
+    /** *items array* */
     items?: OnPageWaterfallItem[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageWaterfallResultInfo);

package/dist/cjs/models/OnPageWaterfallTaskInfo.d.ts

@@ -1,12 +1,12 @@
 import { OnPageWaterfallResultInfo } from "./OnPageWaterfallResultInfo";
 import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
 export interface IOnPageWaterfallTaskInfo extends IBaseResponseTaskInfo {
-    /** array of results */
+    /** *array of results* */
     result?: OnPageWaterfallResultInfo[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageWaterfallTaskInfo extends BaseResponseTaskInfo implements IOnPageWaterfallTaskInfo {
-    /** array of results */
+    /** *array of results* */
     result?: OnPageWaterfallResultInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageWaterfallTaskInfo);

package/dist/cjs/models/PageMetaInfo.d.ts

@@ -2,65 +2,65 @@ import { HtmlContentInfo } from "./HtmlContentInfo";
 import { HunspellInfo } from "./HunspellInfo";
 import { OnPageResourceIssueInfo } from "./OnPageResourceIssueInfo";
 export interface IPageMetaInfo {
-    /** page title */
+    /** *page title* */
     title?: string | undefined;
-    /** code page example: 65001 */
+    /** *[code page](https://en.wikipedia.org/wiki/Code_page)* example: `65001` */
     charset?: number | undefined;
-    /** indicates whether a page’s ‘meta robots’ allows crawlers to follow the links on the page if false, the page’s ‘meta robots’ tag contains “nofollow” parameter instructing crawlers not to follow the links on the page */
+    /** *indicates whether a page's 'meta robots' allows crawlers to follow the links on the page* if `false`, the page's 'meta robots' tag contains 'nofollow' parameter instructing crawlers not to follow the links on the page */
     follow?: boolean | undefined;
-    /** meta tag generator */
+    /** *meta tag generator* */
     generator?: string | undefined;
-    /** HTML header tags */
+    /** *HTML header tags* */
     htags?: {
         [key: string]: string[];
     } | undefined;
-    /** content of the meta description tag */
+    /** *content of the meta description tag* */
     description?: string | undefined;
-    /** favicon of the page */
+    /** *favicon of the page* */
     favicon?: string | undefined;
-    /** content of the keywords meta tag */
+    /** *content of the `keywords` meta tag* */
     meta_keywords?: string | undefined;
-    /** canonical page */
+    /** *canonical page* */
     canonical?: string | undefined;
-    /** number of internal links on the page */
+    /** *number of internal links on the page* */
     internal_links_count?: number | undefined;
-    /** number of external links on the page */
+    /** *number of external links on the page* */
     external_links_count?: number | undefined;
-    /** number of internal links pointing at the page */
+    /** *number of internal links pointing at the page* */
     inbound_links_count?: number | undefined;
-    /** number of images on the page */
+    /** *number of images on the page* */
     images_count?: number | undefined;
-    /** total size of images on the page measured in bytes */
+    /** *total size of images on the page measured in bytes* */
     images_size?: number | undefined;
-    /** number of scripts on the page */
+    /** *number of scripts on the page* */
     scripts_count?: number | undefined;
-    /** total size of scripts on the page measured in bytes */
+    /** *total size of scripts on the page measured in bytes* */
     scripts_size?: number | undefined;
-    /** number of stylesheets on the page */
+    /** *number of stylesheets on the page* */
     stylesheets_count?: number | undefined;
-    /** total size of stylesheets on the page measured in bytes */
+    /** *total size of stylesheets on the page measured in bytes* */
     stylesheets_size?: number | undefined;
-    /** length of the title tag in characters */
+    /** *length of the `title` tag in characters* */
     title_length?: number | undefined;
-    /** length of the description tag in characters */
+    /** *length of the `description` tag in characters* */
     description_length?: number | undefined;
-    /** number of scripts on the page that block page rendering */
+    /** *number of scripts on the page that block page rendering* */
     render_blocking_scripts_count?: number | undefined;
-    /** number of CSS styles on the page that block page rendering */
+    /** *number of CSS styles on the page that block page rendering* */
     render_blocking_stylesheets_count?: number | undefined;
-    /** Core Web Vitals metric measuring the layout stability of the page measures the sum total of all individual layout shift scores for every unexpected layout shift that occurs during the entire lifespan of the page. Learn more. */
+    /** *Core Web Vitals metric measuring the layout stability of the page* measures the sum total of all individual layout shift scores for every unexpected layout shift that occurs during the entire lifespan of the page. [Learn more.](https://web.dev/cls/) */
     cumulative_layout_shift?: number | undefined;
-    /** meta title of the page meta tag in the head section of an HTML document that defines the title of a page */
+    /** *meta title of the page* meta tag in the head section of an HTML document that defines the title of a page */
     meta_title?: string | undefined;
-    /** overall information about content of the page */
+    /** *overall information about content of the page* */
     content?: HtmlContentInfo | undefined;
-    /** deprecated tags on the page */
+    /** *deprecated tags on the page* */
     deprecated_tags?: string[] | undefined;
-    /** duplicate meta tags on the page */
+    /** *duplicate meta tags on the page* */
     duplicate_meta_tags?: string[] | undefined;
-    /** spellcheck hunspell spellcheck errors */
+    /** *spellcheck* [hunspell](http://hunspell.github.io/) spellcheck errors */
     spell?: HunspellInfo | undefined;
-    /** object of social media tags found on the page contains social media tags and their content supported tags include but are not limited to Open Graph and Twitter card */
+    /** *object of social media tags found on the page* contains social media tags and their content supported tags include but are not limited to [Open Graph](https://ogp.me/) and [Twitter card](https://developer.twitter.com/en/docs/twitter-for-websites/cards/guides/getting-started) */
     social_media_tags?: {
         [key: string]: string;
     } | undefined;
@@ -69,65 +69,65 @@ export interface IPageMetaInfo {
     [key: string]: any;
 }
 export declare class PageMetaInfo implements IPageMetaInfo {
-    /** page title */
+    /** *page title* */
     title?: string | undefined;
-    /** code page example: 65001 */
+    /** *[code page](https://en.wikipedia.org/wiki/Code_page)* example: `65001` */
     charset?: number | undefined;
-    /** indicates whether a page’s ‘meta robots’ allows crawlers to follow the links on the page if false, the page’s ‘meta robots’ tag contains “nofollow” parameter instructing crawlers not to follow the links on the page */
+    /** *indicates whether a page's 'meta robots' allows crawlers to follow the links on the page* if `false`, the page's 'meta robots' tag contains 'nofollow' parameter instructing crawlers not to follow the links on the page */
     follow?: boolean | undefined;
-    /** meta tag generator */
+    /** *meta tag generator* */
     generator?: string | undefined;
-    /** HTML header tags */
+    /** *HTML header tags* */
     htags?: {
         [key: string]: string[];
     } | undefined;
-    /** content of the meta description tag */
+    /** *content of the meta description tag* */
     description?: string | undefined;
-    /** favicon of the page */
+    /** *favicon of the page* */
     favicon?: string | undefined;
-    /** content of the keywords meta tag */
+    /** *content of the `keywords` meta tag* */
     meta_keywords?: string | undefined;
-    /** canonical page */
+    /** *canonical page* */
     canonical?: string | undefined;
-    /** number of internal links on the page */
+    /** *number of internal links on the page* */
     internal_links_count?: number | undefined;
-    /** number of external links on the page */
+    /** *number of external links on the page* */
     external_links_count?: number | undefined;
-    /** number of internal links pointing at the page */
+    /** *number of internal links pointing at the page* */
     inbound_links_count?: number | undefined;
-    /** number of images on the page */
+    /** *number of images on the page* */
     images_count?: number | undefined;
-    /** total size of images on the page measured in bytes */
+    /** *total size of images on the page measured in bytes* */
     images_size?: number | undefined;
-    /** number of scripts on the page */
+    /** *number of scripts on the page* */
     scripts_count?: number | undefined;
-    /** total size of scripts on the page measured in bytes */
+    /** *total size of scripts on the page measured in bytes* */
     scripts_size?: number | undefined;
-    /** number of stylesheets on the page */
+    /** *number of stylesheets on the page* */
     stylesheets_count?: number | undefined;
-    /** total size of stylesheets on the page measured in bytes */
+    /** *total size of stylesheets on the page measured in bytes* */
     stylesheets_size?: number | undefined;
-    /** length of the title tag in characters */
+    /** *length of the `title` tag in characters* */
     title_length?: number | undefined;
-    /** length of the description tag in characters */
+    /** *length of the `description` tag in characters* */
     description_length?: number | undefined;
-    /** number of scripts on the page that block page rendering */
+    /** *number of scripts on the page that block page rendering* */
     render_blocking_scripts_count?: number | undefined;
-    /** number of CSS styles on the page that block page rendering */
+    /** *number of CSS styles on the page that block page rendering* */
     render_blocking_stylesheets_count?: number | undefined;
-    /** Core Web Vitals metric measuring the layout stability of the page measures the sum total of all individual layout shift scores for every unexpected layout shift that occurs during the entire lifespan of the page. Learn more. */
+    /** *Core Web Vitals metric measuring the layout stability of the page* measures the sum total of all individual layout shift scores for every unexpected layout shift that occurs during the entire lifespan of the page. [Learn more.](https://web.dev/cls/) */
     cumulative_layout_shift?: number | undefined;
-    /** meta title of the page meta tag in the head section of an HTML document that defines the title of a page */
+    /** *meta title of the page* meta tag in the head section of an HTML document that defines the title of a page */
     meta_title?: string | undefined;
-    /** overall information about content of the page */
+    /** *overall information about content of the page* */
     content?: HtmlContentInfo | undefined;
-    /** deprecated tags on the page */
+    /** *deprecated tags on the page* */
     deprecated_tags?: string[] | undefined;
-    /** duplicate meta tags on the page */
+    /** *duplicate meta tags on the page* */
     duplicate_meta_tags?: string[] | undefined;
-    /** spellcheck hunspell spellcheck errors */
+    /** *spellcheck* [hunspell](http://hunspell.github.io/) spellcheck errors */
     spell?: HunspellInfo | undefined;
-    /** object of social media tags found on the page contains social media tags and their content supported tags include but are not limited to Open Graph and Twitter card */
+    /** *object of social media tags found on the page* contains social media tags and their content supported tags include but are not limited to [Open Graph](https://ogp.me/) and [Twitter card](https://developer.twitter.com/en/docs/twitter-for-websites/cards/guides/getting-started) */
     social_media_tags?: {
         [key: string]: string;
     } | undefined;

package/dist/cjs/models/PageMetrics.d.ts

@@ -1,56 +1,56 @@
 export interface IPageMetrics {
-    /** number of external links the number of links pointing to other websites */
+    /** *number of external links* the number of links pointing to other websites */
     links_external?: number | undefined;
-    /** number of internal links the number of links pointing to other pages within the target website */
+    /** *number of internal links* the number of links pointing to other pages within the target website */
     links_internal?: number | undefined;
-    /** number of pages with duplicate titles */
+    /** *number of pages with duplicate titles* */
     duplicate_title?: number | undefined;
-    /** number of pages with duplicate descriptions */
+    /** *number of pages with duplicate descriptions* */
     duplicate_description?: number | undefined;
-    /** number of pages with duplicate content */
+    /** *number of pages with duplicate content* */
     duplicate_content?: number | undefined;
-    /** number of broken links number of broken links across all crawled pages on a target website */
+    /** *number of broken links* number of broken links across all crawled pages on a target website */
     broken_links?: number | undefined;
-    /** number of broken resources the number of images and other resources with broken links */
+    /** *number of broken resources* the number of images and other resources with broken links */
     broken_resources?: number | undefined;
-    /** number of links present on the target website that may have a conflict for example, if 'links_relation_conflict': 2, the target website is referring to the same source by at least one internal link with the rel='nofollow' attribute and by at least one dofollow link */
+    /** *number of links present on the target website that may have a conflict* for example, if `'links_relation_conflict': 2`, the target website is referring to the same source by at least one internal link with the `rel='nofollow'` attribute **and** by at least one dofollow link */
     links_relation_conflict?: number | undefined;
-    /** number of redirect chains that start and end at the same URL number of redirect chains where the destination URL redirects back to the original URL */
+    /** *number of redirect chains that start and end at the same URL* number of redirect chains where the destination URL redirects back to the original URL */
     redirect_loop?: number | undefined;
-    /** shows how website is optimized on a 100-point scale this field shows how website is optimized considering critical on-page issues and warnings detected; 100 is the highest possible score that means website does not have any critical on-page issues and important warnings; note that this value depends on the number of crawled pages; learn more about how the metric is calculated in this help center article */
+    /** *shows how website is optimized on a 100-point scale* this field shows how website is optimized considering critical on-page issues and warnings detected; `100` is the highest possible score that means website does not have any critical on-page issues and important warnings; **note** that this value depends on the number of crawled pages; learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-onpage-score-of-a-domain-calculated) */
     onpage_score?: number | undefined;
-    /** number of non-indexable pages number of pages that are blocked from being indexed by Google and other search engines by robots.txt, HTTP headers, or meta tags settings; you can receive a list of non-indexable URLs using this endpoint */
+    /** *number of non-indexable pages* number of pages that are blocked from being indexed by Google and other search engines by robots.txt, HTTP headers, or meta tags settings; you can receive a list of non-indexable URLs using [this endpoint](https://docs.dataforseo.com/v3/on_page/non_indexable/?bash) */
     non_indexable?: number | undefined;
-    /** page-specific on-page check-ups */
+    /** *page-specific on-page check-ups* */
     checks?: {
         [key: string]: number;
     } | undefined;
     [key: string]: any;
 }
 export declare class PageMetrics implements IPageMetrics {
-    /** number of external links the number of links pointing to other websites */
+    /** *number of external links* the number of links pointing to other websites */
     links_external?: number | undefined;
-    /** number of internal links the number of links pointing to other pages within the target website */
+    /** *number of internal links* the number of links pointing to other pages within the target website */
     links_internal?: number | undefined;
-    /** number of pages with duplicate titles */
+    /** *number of pages with duplicate titles* */
     duplicate_title?: number | undefined;
-    /** number of pages with duplicate descriptions */
+    /** *number of pages with duplicate descriptions* */
     duplicate_description?: number | undefined;
-    /** number of pages with duplicate content */
+    /** *number of pages with duplicate content* */
     duplicate_content?: number | undefined;
-    /** number of broken links number of broken links across all crawled pages on a target website */
+    /** *number of broken links* number of broken links across all crawled pages on a target website */
     broken_links?: number | undefined;
-    /** number of broken resources the number of images and other resources with broken links */
+    /** *number of broken resources* the number of images and other resources with broken links */
     broken_resources?: number | undefined;
-    /** number of links present on the target website that may have a conflict for example, if 'links_relation_conflict': 2, the target website is referring to the same source by at least one internal link with the rel='nofollow' attribute and by at least one dofollow link */
+    /** *number of links present on the target website that may have a conflict* for example, if `'links_relation_conflict': 2`, the target website is referring to the same source by at least one internal link with the `rel='nofollow'` attribute **and** by at least one dofollow link */
     links_relation_conflict?: number | undefined;
-    /** number of redirect chains that start and end at the same URL number of redirect chains where the destination URL redirects back to the original URL */
+    /** *number of redirect chains that start and end at the same URL* number of redirect chains where the destination URL redirects back to the original URL */
     redirect_loop?: number | undefined;
-    /** shows how website is optimized on a 100-point scale this field shows how website is optimized considering critical on-page issues and warnings detected; 100 is the highest possible score that means website does not have any critical on-page issues and important warnings; note that this value depends on the number of crawled pages; learn more about how the metric is calculated in this help center article */
+    /** *shows how website is optimized on a 100-point scale* this field shows how website is optimized considering critical on-page issues and warnings detected; `100` is the highest possible score that means website does not have any critical on-page issues and important warnings; **note** that this value depends on the number of crawled pages; learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-onpage-score-of-a-domain-calculated) */
     onpage_score?: number | undefined;
-    /** number of non-indexable pages number of pages that are blocked from being indexed by Google and other search engines by robots.txt, HTTP headers, or meta tags settings; you can receive a list of non-indexable URLs using this endpoint */
+    /** *number of non-indexable pages* number of pages that are blocked from being indexed by Google and other search engines by robots.txt, HTTP headers, or meta tags settings; you can receive a list of non-indexable URLs using [this endpoint](https://docs.dataforseo.com/v3/on_page/non_indexable/?bash) */
     non_indexable?: number | undefined;
-    /** page-specific on-page check-ups */
+    /** *page-specific on-page check-ups* */
     checks?: {
         [key: string]: number;
     } | undefined;

package/dist/cjs/models/PageTiming.d.ts

@@ -1,54 +1,54 @@
 export interface IPageTiming {
-    /** Time To Interactive (TTI) metric the time it takes until the user can interact with a page (in milliseconds) */
+    /** *[Time To Interactive (TTI)](https://web.dev/interactive/) metric* the time it takes until the user can interact with a page (in milliseconds) */
     time_to_interactive?: number | undefined;
-    /** time to load resources the time it takes until the page and all of its subresources are downloaded (in milliseconds) */
+    /** *time to load resources* the time it takes until the page and all of its subresources are downloaded (in milliseconds) */
     dom_complete?: number | undefined;
-    /** Core Web Vitals metric measuring how fast the largest above-the-fold content element is displayed The amount of time (in milliseconds) to render the largest content element visible in the viewport, from when the user requests the URL. Learn more. */
+    /** *Core Web Vitals metric measuring how fast the largest above-the-fold content element is displayed* The amount of time (in milliseconds) to render the largest content element visible in the viewport, from when the user requests the URL. [Learn more](https://web.dev/lcp/). */
     largest_contentful_paint?: number | undefined;
-    /** Core Web Vitals metric indicating the responsiveness of a page The time (in milliseconds) from when a user first interacts with your page to the time when the browser responds to that interaction. Learn more. */
+    /** *Core Web Vitals metric indicating the responsiveness of a page* The time (in milliseconds) from when a user first interacts with your page to the time when the browser responds to that interaction. [Learn more](https://web.dev/fid/). */
     first_input_delay?: number | undefined;
-    /** time to connect to a server the time it takes until the connection with a server is established (in milliseconds) */
+    /** *time to connect to a server* the time it takes until the connection with a server is established (in milliseconds) */
     connection_time?: number | undefined;
-    /** time to establish a secure connection the time it takes until the secure connection with a server is established (in milliseconds) */
+    /** *time to establish a secure connection* the time it takes until the secure connection with a server is established (in milliseconds) */
     time_to_secure_connection?: number | undefined;
-    /** time to send a request to a server the time it takes until the request to a server is sent (in milliseconds) */
+    /** *time to send a request to a server* the time it takes until the request to a server is sent (in milliseconds) */
     request_sent_time?: number | undefined;
-    /** time to first byte (TTFB) in milliseconds */
+    /** *time to first byte [(TTFB)](https://en.wikipedia.org/wiki/Time_to_first_byte) in milliseconds* */
     waiting_time?: number | undefined;
-    /** time it takes for a browser to receive a response (in milliseconds) */
+    /** *time it takes for a browser to receive a response (in milliseconds)* */
     download_time?: number | undefined;
-    /** total time it takes until a browser receives a complete response from a server (in milliseconds) */
+    /** *total time it takes until a browser receives a complete response from a server (in milliseconds)* */
     duration_time?: number | undefined;
-    /** time to start downloading the HTML resource the amount of time the browser needs to start downloading a page */
+    /** *time to start downloading the HTML resource* the amount of time the browser needs to start downloading a page */
     fetch_start?: number | undefined;
-    /** time to complete downloading the HTML resource the amount of time the browser needs to complete downloading a page */
+    /** *time to complete downloading the HTML resource* the amount of time the browser needs to complete downloading a page */
     fetch_end?: number | undefined;
     [key: string]: any;
 }
 export declare class PageTiming implements IPageTiming {
-    /** Time To Interactive (TTI) metric the time it takes until the user can interact with a page (in milliseconds) */
+    /** *[Time To Interactive (TTI)](https://web.dev/interactive/) metric* the time it takes until the user can interact with a page (in milliseconds) */
     time_to_interactive?: number | undefined;
-    /** time to load resources the time it takes until the page and all of its subresources are downloaded (in milliseconds) */
+    /** *time to load resources* the time it takes until the page and all of its subresources are downloaded (in milliseconds) */
     dom_complete?: number | undefined;
-    /** Core Web Vitals metric measuring how fast the largest above-the-fold content element is displayed The amount of time (in milliseconds) to render the largest content element visible in the viewport, from when the user requests the URL. Learn more. */
+    /** *Core Web Vitals metric measuring how fast the largest above-the-fold content element is displayed* The amount of time (in milliseconds) to render the largest content element visible in the viewport, from when the user requests the URL. [Learn more](https://web.dev/lcp/). */
     largest_contentful_paint?: number | undefined;
-    /** Core Web Vitals metric indicating the responsiveness of a page The time (in milliseconds) from when a user first interacts with your page to the time when the browser responds to that interaction. Learn more. */
+    /** *Core Web Vitals metric indicating the responsiveness of a page* The time (in milliseconds) from when a user first interacts with your page to the time when the browser responds to that interaction. [Learn more](https://web.dev/fid/). */
     first_input_delay?: number | undefined;
-    /** time to connect to a server the time it takes until the connection with a server is established (in milliseconds) */
+    /** *time to connect to a server* the time it takes until the connection with a server is established (in milliseconds) */
     connection_time?: number | undefined;
-    /** time to establish a secure connection the time it takes until the secure connection with a server is established (in milliseconds) */
+    /** *time to establish a secure connection* the time it takes until the secure connection with a server is established (in milliseconds) */
     time_to_secure_connection?: number | undefined;
-    /** time to send a request to a server the time it takes until the request to a server is sent (in milliseconds) */
+    /** *time to send a request to a server* the time it takes until the request to a server is sent (in milliseconds) */
     request_sent_time?: number | undefined;
-    /** time to first byte (TTFB) in milliseconds */
+    /** *time to first byte [(TTFB)](https://en.wikipedia.org/wiki/Time_to_first_byte) in milliseconds* */
     waiting_time?: number | undefined;
-    /** time it takes for a browser to receive a response (in milliseconds) */
+    /** *time it takes for a browser to receive a response (in milliseconds)* */
     download_time?: number | undefined;
-    /** total time it takes until a browser receives a complete response from a server (in milliseconds) */
+    /** *total time it takes until a browser receives a complete response from a server (in milliseconds)* */
     duration_time?: number | undefined;
-    /** time to start downloading the HTML resource the amount of time the browser needs to start downloading a page */
+    /** *time to start downloading the HTML resource* the amount of time the browser needs to start downloading a page */
     fetch_start?: number | undefined;
-    /** time to complete downloading the HTML resource the amount of time the browser needs to complete downloading a page */
+    /** *time to complete downloading the HTML resource* the amount of time the browser needs to complete downloading a page */
     fetch_end?: number | undefined;
     [key: string]: any;
     constructor(data?: IPageTiming);

package/dist/cjs/models/PeopleAlsoAskElement.d.ts

@@ -2,26 +2,26 @@ import { BaseSerpApiPeopleAlsoAskExpandedElementItem } from "./BaseSerpApiPeople
 export interface IPeopleAlsoAskElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** question that triggered additional expanded elements */
+    /** *question that triggered additional expanded elements* */
     seed_question?: string | undefined;
-    /** the XPath of the element */
+    /** *the [XPath](https://en.wikipedia.org/wiki/XPath) of the element* */
     xpath?: string | undefined;
-    /** expanded element */
+    /** *expanded element* */
     expanded_element?: BaseSerpApiPeopleAlsoAskExpandedElementItem[] | undefined;
     [key: string]: any;
 }
 export declare class PeopleAlsoAskElement implements IPeopleAlsoAskElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** question that triggered additional expanded elements */
+    /** *question that triggered additional expanded elements* */
     seed_question?: string | undefined;
-    /** the XPath of the element */
+    /** *the [XPath](https://en.wikipedia.org/wiki/XPath) of the element* */
     xpath?: string | undefined;
-    /** expanded element */
+    /** *expanded element* */
     expanded_element?: BaseSerpApiPeopleAlsoAskExpandedElementItem[] | undefined;
     [key: string]: any;
     constructor(data?: IPeopleAlsoAskElement);

package/dist/cjs/models/PerspectivesElement.d.ts

@@ -1,38 +1,38 @@
 export interface IPerspectivesElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** link description */
+    /** *link description* */
     description?: string | undefined;
-    /** source URL */
+    /** *source URL* */
     url?: string | undefined;
-    /** domain where a link points */
+    /** *domain where a link points* */
     domain?: string | undefined;
-    /** the date when the page source of the element was published */
+    /** *the date when the page source of the element was published* */
     date?: string | undefined;
-    /** reference source name or title */
+    /** *reference source name or title* */
     source?: string | undefined;
-    /** date and time when the result was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when the result was published* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
     timestamp?: string | undefined;
     [key: string]: any;
 }
 export declare class PerspectivesElement implements IPerspectivesElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** link description */
+    /** *link description* */
     description?: string | undefined;
-    /** source URL */
+    /** *source URL* */
     url?: string | undefined;
-    /** domain where a link points */
+    /** *domain where a link points* */
     domain?: string | undefined;
-    /** the date when the page source of the element was published */
+    /** *the date when the page source of the element was published* */
     date?: string | undefined;
-    /** reference source name or title */
+    /** *reference source name or title* */
     source?: string | undefined;
-    /** date and time when the result was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when the result was published* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
     timestamp?: string | undefined;
     [key: string]: any;
     constructor(data?: IPerspectivesElement);

package/dist/cjs/models/PopularProductsElement.d.ts

@@ -1,41 +1,54 @@
 import { PriceInfo } from "./PriceInfo";
 import { RatingInfo } from "./RatingInfo";
+import { ProductIdentifiers } from "./ProductIdentifiers";
 export interface IPopularProductsElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** link description */
+    /** *source URL* */
+    url?: string | undefined;
+    /** *domain where a link points* */
+    domain?: string | undefined;
+    /** *link description* */
     description?: string | undefined;
-    /** indicates whether the product is sold by multiple sellers */
+    /** *indicates whether the product is sold by multiple sellers* */
     more_sellers?: boolean | undefined;
-    /** seller of the product */
+    /** *seller of the product* */
     seller?: string | undefined;
-    /** URL of the image the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available) */
+    /** *URL of the image* the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available) */
     image_url?: string | undefined;
-    /** price indicated in the element */
+    /** *price indicated in the element* */
     price?: PriceInfo | undefined;
-    /** the item’s rating  the popularity rate based on reviews and displayed in SERP; if there is none, equals null */
+    /** *the item's rating* the popularity rate based on reviews and displayed in SERP; if there is none, equals `null` */
     rating?: RatingInfo | undefined;
+    /** *identifiers of the product* can include the following identifiers: `product_id`, `data_docid`, `gid` */
+    product_identifiers?: ProductIdentifiers | undefined;
     [key: string]: any;
 }
 export declare class PopularProductsElement implements IPopularProductsElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** link description */
+    /** *source URL* */
+    url?: string | undefined;
+    /** *domain where a link points* */
+    domain?: string | undefined;
+    /** *link description* */
     description?: string | undefined;
-    /** indicates whether the product is sold by multiple sellers */
+    /** *indicates whether the product is sold by multiple sellers* */
     more_sellers?: boolean | undefined;
-    /** seller of the product */
+    /** *seller of the product* */
     seller?: string | undefined;
-    /** URL of the image the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available) */
+    /** *URL of the image* the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available) */
     image_url?: string | undefined;
-    /** price indicated in the element */
+    /** *price indicated in the element* */
     price?: PriceInfo | undefined;
-    /** the item’s rating  the popularity rate based on reviews and displayed in SERP; if there is none, equals null */
+    /** *the item's rating* the popularity rate based on reviews and displayed in SERP; if there is none, equals `null` */
     rating?: RatingInfo | undefined;
+    /** *identifiers of the product* can include the following identifiers: `product_id`, `data_docid`, `gid` */
+    product_identifiers?: ProductIdentifiers | undefined;
     [key: string]: any;
     constructor(data?: IPopularProductsElement);
     init(data?: any): void;

package/dist/cjs/models/PopularProductsElement.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PopularProductsElement = void 0;
 const PriceInfo_1 = require("./PriceInfo");
 const RatingInfo_1 = require("./RatingInfo");
+const ProductIdentifiers_1 = require("./ProductIdentifiers");
 class PopularProductsElement {
     constructor(data) {
         if (data) {
@@ -20,12 +21,15 @@ class PopularProductsElement {
             }
             this.type = data["type"];
             this.title = data["title"];
+            this.url = data["url"];
+            this.domain = data["domain"];
             this.description = data["description"];
             this.more_sellers = data["more_sellers"];
             this.seller = data["seller"];
             this.image_url = data["image_url"];
             this.price = data["price"] ? PriceInfo_1.PriceInfo.fromJS(data["price"]) : undefined;
             this.rating = data["rating"] ? RatingInfo_1.RatingInfo.fromJS(data["rating"]) : undefined;
+            this.product_identifiers = data["product_identifiers"] ? ProductIdentifiers_1.ProductIdentifiers.fromJS(data["product_identifiers"]) : undefined;
         }
     }
     static fromJS(data) {
@@ -35,16 +39,19 @@ class PopularProductsElement {
         return result;
     }
     toJSON(data) {
-        var _a, _b;
+        var _a, _b, _c;
         data = typeof data === 'object' ? data : {};
         data["type"] = this.type;
         data["title"] = this.title;
+        data["url"] = this.url;
+        data["domain"] = this.domain;
         data["description"] = this.description;
         data["more_sellers"] = this.more_sellers;
         data["seller"] = this.seller;
         data["image_url"] = this.image_url;
         data["price"] = this.price ? (_a = PriceInfo_1.PriceInfo.fromJS(this.price)) === null || _a === void 0 ? void 0 : _a.toJSON() : undefined;
         data["rating"] = this.rating ? (_b = RatingInfo_1.RatingInfo.fromJS(this.rating)) === null || _b === void 0 ? void 0 : _b.toJSON() : undefined;
+        data["product_identifiers"] = this.product_identifiers ? (_c = ProductIdentifiers_1.ProductIdentifiers.fromJS(this.product_identifiers)) === null || _c === void 0 ? void 0 : _c.toJSON() : undefined;
         return data;
     }
 }