dataforseo-client 2.1.2 → 2.1.5

package/dist/esm/models/OnPageContentParsingLiveRequestInfo.d.ts

@@ -1,66 +1,66 @@
 export interface IOnPageContentParsingLiveRequestInfo {
-    /** URL of the content to parse required field URL of the page to parse example: https://www.fujielectric.com/ */
+    /** *URL of the content to parse* **required field** URL of the page to parse example: `https://www.fujielectric.com/` */
     url?: string | undefined;
-    /** custom user agent optional field custom user agent for crawling a website example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36 default value: Mozilla/5.0 (compatible; RSiteAuditor) */
+    /** *custom user agent* optional field custom user agent for crawling a website example: `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36` default value: `Mozilla/5.0 (compatible; RSiteAuditor)` */
     custom_user_agent?: string | undefined;
-    /** preset for browser screen parameters optional field if you use this field, you don’t need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factor possible values: desktop, mobile, tablet desktop preset will apply the following values: browser_screen_width: 1920 browser_screen_height: 1080 browser_screen_scale_factor: 1 mobile preset will apply the following values: browser_screen_width: 390 browser_screen_height: 844 browser_screen_scale_factor: 3 tablet preset will apply the following values: browser_screen_width: 1024 browser_screen_height: 1366 browser_screen_scale_factor: 2 Note: to use this parameter, set enable_javascript or enable_browser_rendering to true */
+    /** *preset for browser screen parameters* optional field if you use this field, you don't need to indicate `browser_screen_width`, `browser_screen_height`, `browser_screen_scale_factor`             possible values: `desktop`, `mobile`, `tablet`             `desktop` preset will apply the following values:             `browser_screen_width: 1920` `browser_screen_height: 1080` `browser_screen_scale_factor: 1`             `mobile` preset will apply the following values:             `browser_screen_width: 390` `browser_screen_height: 844` `browser_screen_scale_factor: 3`             `tablet` preset will apply the following values:             `browser_screen_width: 1024` `browser_screen_height: 1366` `browser_screen_scale_factor: 2`             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true` */
     browser_preset?: string | undefined;
-    /** browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value, in pixels: 240 maximum value, in pixels: 9999 */
+    /** *browser screen width* optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored;             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`             minimum value, in pixels: `240` maximum value, in pixels: `9999` */
     browser_screen_width?: number | undefined;
-    /** browser screen height optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value, in pixels: 240 maximum value, in pixels: 9999 */
+    /** *browser screen height* optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored;             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`             minimum value, in pixels: `240` maximum value, in pixels: `9999` */
     browser_screen_height?: number | undefined;
-    /** browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value: 0.5 maximum value: 3 */
+    /** *browser screen scale factor* optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored;             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`             minimum value: `0.5` maximum value: `3` */
     browser_screen_scale_factor?: number | undefined;
-    /** store HTML of a crawled page optional field set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint default value: false */
+    /** *store HTML of a crawled page* optional field set to `true` if you want to get the HTML of the page using the [OnPage Raw HTML endpoint](/v3/on_page/raw_html/) default value: `false` */
     store_raw_html?: boolean | undefined;
-    /** disable the cookie popup  optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false */
+    /** *disable the cookie popup* optional field set to `true` if you want to disable the popup requesting cookie consent from the user; default value: `false` */
     disable_cookie_popup?: boolean | undefined;
-    /** language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the 'type':'broken in the response array */
+    /** *language header for accessing the website* optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) **Note:** if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the `'type':'broken` in the response array */
     accept_language?: string | undefined;
-    /** load javascript on a page optional field set to true if you want to load the scripts available on a page default value: false Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
+    /** *load javascript on a page* optional field set to `true` if you want to load the scripts available on a page default value: `false` **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters); the cost can be calculated on the [Pricing Page](https://dataforseo.com/pricing/on-page/onpage-api) */
     enable_javascript?: boolean | undefined;
-    /** emulate browser rendering to measure Core Web Vitals optional field by using this parameter you will be able to emulate a browser when loading a web page; enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page; default value: false set to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response; if you use this field, enable_javascript, and load_resources parameters must be set to true Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
+    /** *emulate browser rendering to measure Core Web Vitals* optional field by using this parameter you will be able to emulate a browser when loading a web page; `enable_browser_rendering` loads styles, images, fonts, animations, videos, and other resources on a page; default value: `false` set to `true` to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response; **if you use this field, `enable_javascript`, and `load_resources` parameters must be set to `true`** **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters); the cost can be calculated on the [Pricing Page](https://dataforseo.com/pricing/on-page/onpage-api) */
     enable_browser_rendering?: boolean | undefined;
-    /** enable XMLHttpRequest on a page optional field set to true if you want our crawler to request data from a web server using the XMLHttpRequest object default value: false if you use this field, enable_javascript must be set to true; */
+    /** *enable XMLHttpRequest on a page* optional field set to `true` if you want our crawler to request data from a web server using the XMLHttpRequest object default value: `false`             if you use this field, `enable_javascript` must be set to `true`; */
     enable_xhr?: boolean | undefined;
-    /** switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors */
+    /** *switch proxy pool* optional field if `true`, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional `rate-limit` and/or `site_unreachable` errors */
     switch_pool?: boolean | undefined;
-    /** proxy pool optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors possible values: us, de */
+    /** *proxy pool* optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional `site_unreachable` errors possible values: `us`, `de` */
     ip_pool_for_scan?: string | undefined;
-    /** return page content as markdown optional field if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response; default value: false */
+    /** *return page content as markdown* optional field if set to `true`, the markdown-formatted content of the page will be returned in the `page_as_markdown` field of the response; default value: `false` */
     markdown_view?: boolean | undefined;
     [key: string]: any;
 }
 export declare class OnPageContentParsingLiveRequestInfo implements IOnPageContentParsingLiveRequestInfo {
-    /** URL of the content to parse required field URL of the page to parse example: https://www.fujielectric.com/ */
+    /** *URL of the content to parse* **required field** URL of the page to parse example: `https://www.fujielectric.com/` */
     url?: string | undefined;
-    /** custom user agent optional field custom user agent for crawling a website example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36 default value: Mozilla/5.0 (compatible; RSiteAuditor) */
+    /** *custom user agent* optional field custom user agent for crawling a website example: `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36` default value: `Mozilla/5.0 (compatible; RSiteAuditor)` */
     custom_user_agent?: string | undefined;
-    /** preset for browser screen parameters optional field if you use this field, you don’t need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factor possible values: desktop, mobile, tablet desktop preset will apply the following values: browser_screen_width: 1920 browser_screen_height: 1080 browser_screen_scale_factor: 1 mobile preset will apply the following values: browser_screen_width: 390 browser_screen_height: 844 browser_screen_scale_factor: 3 tablet preset will apply the following values: browser_screen_width: 1024 browser_screen_height: 1366 browser_screen_scale_factor: 2 Note: to use this parameter, set enable_javascript or enable_browser_rendering to true */
+    /** *preset for browser screen parameters* optional field if you use this field, you don't need to indicate `browser_screen_width`, `browser_screen_height`, `browser_screen_scale_factor`             possible values: `desktop`, `mobile`, `tablet`             `desktop` preset will apply the following values:             `browser_screen_width: 1920` `browser_screen_height: 1080` `browser_screen_scale_factor: 1`             `mobile` preset will apply the following values:             `browser_screen_width: 390` `browser_screen_height: 844` `browser_screen_scale_factor: 3`             `tablet` preset will apply the following values:             `browser_screen_width: 1024` `browser_screen_height: 1366` `browser_screen_scale_factor: 2`             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true` */
     browser_preset?: string | undefined;
-    /** browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value, in pixels: 240 maximum value, in pixels: 9999 */
+    /** *browser screen width* optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored;             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`             minimum value, in pixels: `240` maximum value, in pixels: `9999` */
     browser_screen_width?: number | undefined;
-    /** browser screen height optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value, in pixels: 240 maximum value, in pixels: 9999 */
+    /** *browser screen height* optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored;             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`             minimum value, in pixels: `240` maximum value, in pixels: `9999` */
     browser_screen_height?: number | undefined;
-    /** browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value: 0.5 maximum value: 3 */
+    /** *browser screen scale factor* optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored;             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`             minimum value: `0.5` maximum value: `3` */
     browser_screen_scale_factor?: number | undefined;
-    /** store HTML of a crawled page optional field set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint default value: false */
+    /** *store HTML of a crawled page* optional field set to `true` if you want to get the HTML of the page using the [OnPage Raw HTML endpoint](/v3/on_page/raw_html/) default value: `false` */
     store_raw_html?: boolean | undefined;
-    /** disable the cookie popup  optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false */
+    /** *disable the cookie popup* optional field set to `true` if you want to disable the popup requesting cookie consent from the user; default value: `false` */
     disable_cookie_popup?: boolean | undefined;
-    /** language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the 'type':'broken in the response array */
+    /** *language header for accessing the website* optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) **Note:** if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the `'type':'broken` in the response array */
     accept_language?: string | undefined;
-    /** load javascript on a page optional field set to true if you want to load the scripts available on a page default value: false Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
+    /** *load javascript on a page* optional field set to `true` if you want to load the scripts available on a page default value: `false` **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters); the cost can be calculated on the [Pricing Page](https://dataforseo.com/pricing/on-page/onpage-api) */
     enable_javascript?: boolean | undefined;
-    /** emulate browser rendering to measure Core Web Vitals optional field by using this parameter you will be able to emulate a browser when loading a web page; enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page; default value: false set to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response; if you use this field, enable_javascript, and load_resources parameters must be set to true Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
+    /** *emulate browser rendering to measure Core Web Vitals* optional field by using this parameter you will be able to emulate a browser when loading a web page; `enable_browser_rendering` loads styles, images, fonts, animations, videos, and other resources on a page; default value: `false` set to `true` to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response; **if you use this field, `enable_javascript`, and `load_resources` parameters must be set to `true`** **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters); the cost can be calculated on the [Pricing Page](https://dataforseo.com/pricing/on-page/onpage-api) */
     enable_browser_rendering?: boolean | undefined;
-    /** enable XMLHttpRequest on a page optional field set to true if you want our crawler to request data from a web server using the XMLHttpRequest object default value: false if you use this field, enable_javascript must be set to true; */
+    /** *enable XMLHttpRequest on a page* optional field set to `true` if you want our crawler to request data from a web server using the XMLHttpRequest object default value: `false`             if you use this field, `enable_javascript` must be set to `true`; */
     enable_xhr?: boolean | undefined;
-    /** switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors */
+    /** *switch proxy pool* optional field if `true`, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional `rate-limit` and/or `site_unreachable` errors */
     switch_pool?: boolean | undefined;
-    /** proxy pool optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors possible values: us, de */
+    /** *proxy pool* optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional `site_unreachable` errors possible values: `us`, `de` */
     ip_pool_for_scan?: string | undefined;
-    /** return page content as markdown optional field if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response; default value: false */
+    /** *return page content as markdown* optional field if set to `true`, the markdown-formatted content of the page will be returned in the `page_as_markdown` field of the response; default value: `false` */
     markdown_view?: boolean | undefined;
     [key: string]: any;
     constructor(data?: IOnPageContentParsingLiveRequestInfo);

package/dist/esm/models/OnPageContentParsingLiveResponseInfo.d.ts

@@ -1,12 +1,12 @@
 import { OnPageContentParsingLiveTaskInfo } from "./OnPageContentParsingLiveTaskInfo";
 import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
 export interface IOnPageContentParsingLiveResponseInfo extends IBaseResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: OnPageContentParsingLiveTaskInfo[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageContentParsingLiveResponseInfo extends BaseResponseInfo implements IOnPageContentParsingLiveResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: OnPageContentParsingLiveTaskInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageContentParsingLiveResponseInfo);

package/dist/esm/models/OnPageContentParsingLiveResultInfo.d.ts

@@ -1,24 +1,24 @@
 import { CrawlStatusInfo } from "./CrawlStatusInfo";
 import { ContentParsingElement } from "./ContentParsingElement";
 export interface IOnPageContentParsingLiveResultInfo {
-    /** 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?: ContentParsingElement[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageContentParsingLiveResultInfo implements IOnPageContentParsingLiveResultInfo {
-    /** 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?: ContentParsingElement[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageContentParsingLiveResultInfo);

package/dist/esm/models/OnPageContentParsingLiveTaskInfo.d.ts

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

package/dist/esm/models/OnPageContentParsingRequestInfo.d.ts

@@ -1,18 +1,18 @@
 export interface IOnPageContentParsingRequestInfo {
-    /** URL of the content to parse required field URL of the page to parse example: https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api */
+    /** *URL of the content to parse* **required field** URL of the page to parse example: `https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api` */
     url?: string | undefined;
-    /** ID of the task required field you can get this ID in the response of the Task POST endpoint note: the enable_content_parsing parameter in the POST request must be set to true example: '07131248-1535-0216-1000-17384017ad04' */
+    /** *ID of the task* **required field** you can get this ID in the response of the [Task POST](/v3/on_page/task_post/) endpoint **note:** the `enable_content_parsing` parameter in the POST request must be set to `true` example: `'07131248-1535-0216-1000-17384017ad04'` */
     id?: string | undefined;
-    /** return page content as markdown optional field if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response; default value: false */
+    /** *return page content as markdown* optional field if set to `true`, the markdown-formatted content of the page will be returned in the `page_as_markdown` field of the response; default value: `false` */
     markdown_view?: boolean | undefined;
     [key: string]: any;
 }
 export declare class OnPageContentParsingRequestInfo implements IOnPageContentParsingRequestInfo {
-    /** URL of the content to parse required field URL of the page to parse example: https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api */
+    /** *URL of the content to parse* **required field** URL of the page to parse example: `https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api` */
     url?: string | undefined;
-    /** ID of the task required field you can get this ID in the response of the Task POST endpoint note: the enable_content_parsing parameter in the POST request must be set to true example: '07131248-1535-0216-1000-17384017ad04' */
+    /** *ID of the task* **required field** you can get this ID in the response of the [Task POST](/v3/on_page/task_post/) endpoint **note:** the `enable_content_parsing` parameter in the POST request must be set to `true` example: `'07131248-1535-0216-1000-17384017ad04'` */
     id?: string | undefined;
-    /** return page content as markdown optional field if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response; default value: false */
+    /** *return page content as markdown* optional field if set to `true`, the markdown-formatted content of the page will be returned in the `page_as_markdown` field of the response; default value: `false` */
     markdown_view?: boolean | undefined;
     [key: string]: any;
     constructor(data?: IOnPageContentParsingRequestInfo);

package/dist/esm/models/OnPageContentParsingResponseInfo.d.ts

@@ -1,12 +1,12 @@
 import { OnPageContentParsingTaskInfo } from "./OnPageContentParsingTaskInfo";
 import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
 export interface IOnPageContentParsingResponseInfo extends IBaseResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: OnPageContentParsingTaskInfo[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageContentParsingResponseInfo extends BaseResponseInfo implements IOnPageContentParsingResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: OnPageContentParsingTaskInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageContentParsingResponseInfo);

package/dist/esm/models/OnPageContentParsingResultInfo.d.ts

@@ -1,24 +1,24 @@
 import { CrawlStatusInfo } from "./CrawlStatusInfo";
 import { ContentParsingElement } from "./ContentParsingElement";
 export interface IOnPageContentParsingResultInfo {
-    /** 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?: ContentParsingElement[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageContentParsingResultInfo implements IOnPageContentParsingResultInfo {
-    /** 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?: ContentParsingElement[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageContentParsingResultInfo);

package/dist/esm/models/OnPageContentParsingTaskInfo.d.ts

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

package/dist/esm/models/OnPageDuplicateTagsItem.d.ts

@@ -1,19 +1,19 @@
 import { OnPageHtmlResourceItem } from "./BaseOnPageResourceItem";
 export interface IOnPageDuplicateTagsItem {
-    /** contains the value of duplicated tag */
+    /** *contains the value of duplicated tag* */
     accumulator?: string | undefined;
-    /** total count of duplicate pages */
+    /** *total count of duplicate pages* */
     total_count?: number | undefined;
-    /** pages with duplicate tags */
+    /** *pages with duplicate tags* */
     pages?: OnPageHtmlResourceItem[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageDuplicateTagsItem implements IOnPageDuplicateTagsItem {
-    /** contains the value of duplicated tag */
+    /** *contains the value of duplicated tag* */
     accumulator?: string | undefined;
-    /** total count of duplicate pages */
+    /** *total count of duplicate pages* */
     total_count?: number | undefined;
-    /** pages with duplicate tags */
+    /** *pages with duplicate tags* */
     pages?: OnPageHtmlResourceItem[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageDuplicateTagsItem);

package/dist/esm/models/OnPageDuplicateTagsRequestInfo.d.ts

@@ -1,30 +1,30 @@
 export interface IOnPageDuplicateTagsRequestInfo {
-    /** ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” */
+    /** *ID of the task* **required field** you can get this ID in the response of the [Task POST](https://docs.dataforseo.com/v3/on_page/task_post/) endpoint example: '07131248-1535-0216-1000-17384017ad04' */
     id?: string | undefined;
     /** type of element */
     type?: string | undefined;
-    /** tag value optional field specify a title or description here if you want to receive a list of duplicate pages that contains this tag */
+    /** *tag value* optional field specify a title or description here if you want to receive a list of duplicate pages that contains this tag */
     accumulator?: string | undefined;
-    /** the maximum number of returned pages optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned pages* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned pages optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
+    /** *offset in the results array of returned pages* optional field default value: `0` maximum value: `2000000` if you specify the `10` value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
     offset?: number | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
 }
 export declare class OnPageDuplicateTagsRequestInfo implements IOnPageDuplicateTagsRequestInfo {
-    /** ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” */
+    /** *ID of the task* **required field** you can get this ID in the response of the [Task POST](https://docs.dataforseo.com/v3/on_page/task_post/) endpoint example: '07131248-1535-0216-1000-17384017ad04' */
     id?: string | undefined;
     /** type of element */
     type?: string | undefined;
-    /** tag value optional field specify a title or description here if you want to receive a list of duplicate pages that contains this tag */
+    /** *tag value* optional field specify a title or description here if you want to receive a list of duplicate pages that contains this tag */
     accumulator?: string | undefined;
-    /** the maximum number of returned pages optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned pages* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned pages optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
+    /** *offset in the results array of returned pages* optional field default value: `0` maximum value: `2000000` if you specify the `10` value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
     offset?: number | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
     constructor(data?: IOnPageDuplicateTagsRequestInfo);

package/dist/esm/models/OnPageDuplicateTagsResponseInfo.d.ts

@@ -1,12 +1,12 @@
 import { OnPageDuplicateTagsTaskInfo } from "./OnPageDuplicateTagsTaskInfo";
 import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
 export interface IOnPageDuplicateTagsResponseInfo extends IBaseResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: OnPageDuplicateTagsTaskInfo[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageDuplicateTagsResponseInfo extends BaseResponseInfo implements IOnPageDuplicateTagsResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: OnPageDuplicateTagsTaskInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageDuplicateTagsResponseInfo);

package/dist/esm/models/OnPageDuplicateTagsResultInfo.d.ts

@@ -1,32 +1,32 @@
 import { CrawlStatusInfo } from "./CrawlStatusInfo";
 import { OnPageDuplicateTagsItem } from "./OnPageDuplicateTagsItem";
 export interface IOnPageDuplicateTagsResultInfo {
-    /** 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;
-    /** total number of pages with duplicate tags displays the total number of pages with duplicate tags of the target website */
+    /** *total number of pages with duplicate tags* displays the total number of pages with duplicate tags of the target website */
     total_pages_count?: number | undefined;
-    /** number of pages with duplicate tags in the response displays the number of pages with duplicate tags returned in the response */
+    /** *number of pages with duplicate tags in the response* displays the number of pages with duplicate tags returned in the response */
     pages_count?: number | undefined;
-    /** number of items in the results array */
+    /** *number of items in the results array* */
     items_count?: number | undefined;
-    /** items array */
+    /** *items array* */
     items?: OnPageDuplicateTagsItem[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageDuplicateTagsResultInfo implements IOnPageDuplicateTagsResultInfo {
-    /** 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;
-    /** total number of pages with duplicate tags displays the total number of pages with duplicate tags of the target website */
+    /** *total number of pages with duplicate tags* displays the total number of pages with duplicate tags of the target website */
     total_pages_count?: number | undefined;
-    /** number of pages with duplicate tags in the response displays the number of pages with duplicate tags returned in the response */
+    /** *number of pages with duplicate tags in the response* displays the number of pages with duplicate tags returned in the response */
     pages_count?: number | undefined;
-    /** number of items in the results array */
+    /** *number of items in the results array* */
     items_count?: number | undefined;
-    /** items array */
+    /** *items array* */
     items?: OnPageDuplicateTagsItem[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageDuplicateTagsResultInfo);

package/dist/esm/models/OnPageDuplicateTagsTaskInfo.d.ts

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

package/dist/esm/models/OnPageErrorsRequestInfo.d.ts

@@ -1,26 +1,26 @@
 export interface IOnPageErrorsRequestInfo {
-    /** the maximum number of returned tasks that responded with an error optional field default value: 1000 maximum value: 1000 */
+    /** *the maximum number of returned tasks that responded with an error* optional field default value: `1000` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned tasks optional field default value: 0 if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks */
+    /** *offset in the results array of returned tasks* optional field default value: `0` if you specify the `10` value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks */
     offset?: number | undefined;
-    /** return tasks with a certain function use this field to obtain a list of tasks that returned an error filtered by a certain function you can filter the results by the values you receive in the function fields of the API response i.e., once you receive unfiltered results, you can call this API again to filter them by function example: on_page/task_post, postback_url, pingback_url */
+    /** *return tasks with a certain function* use this field to obtain a list of tasks that returned an error filtered by a certain function you can filter the results by the values you receive in the `function` fields of the API response i.e., once you receive unfiltered results, you can call this API again to filter them by `function`  example: `on_page/task_post`, `postback_url`, `pingback_url` */
     filtered_function?: string | undefined;
-    /** start time for filtering results optional field allows filtering results by the datetime parameter within the range of the last 7 days; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2021-11-15 12:57:46 +00:00 */
+    /** *start time for filtering results* optional field allows filtering results by the `datetime` parameter within the range of the last 7 days; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2021-11-15 12:57:46 +00:00` */
     datetime_from?: string | undefined;
-    /** finish time for filtering results optional field allows filtering results by the datetime parameter within the range of the last 7 days; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2021-11-15 13:57:46 +00:00 */
+    /** *finish time for filtering results* optional field allows filtering results by the `datetime` parameter within the range of the last 7 days; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2021-11-15 13:57:46 +00:00` */
     datetime_to?: string | undefined;
     [key: string]: any;
 }
 export declare class OnPageErrorsRequestInfo implements IOnPageErrorsRequestInfo {
-    /** the maximum number of returned tasks that responded with an error optional field default value: 1000 maximum value: 1000 */
+    /** *the maximum number of returned tasks that responded with an error* optional field default value: `1000` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned tasks optional field default value: 0 if you specify the 10 value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks */
+    /** *offset in the results array of returned tasks* optional field default value: `0` if you specify the `10` value, the first ten tasks in the results array will be omitted and the data will be provided for the successive tasks */
     offset?: number | undefined;
-    /** return tasks with a certain function use this field to obtain a list of tasks that returned an error filtered by a certain function you can filter the results by the values you receive in the function fields of the API response i.e., once you receive unfiltered results, you can call this API again to filter them by function example: on_page/task_post, postback_url, pingback_url */
+    /** *return tasks with a certain function* use this field to obtain a list of tasks that returned an error filtered by a certain function you can filter the results by the values you receive in the `function` fields of the API response i.e., once you receive unfiltered results, you can call this API again to filter them by `function`  example: `on_page/task_post`, `postback_url`, `pingback_url` */
     filtered_function?: string | undefined;
-    /** start time for filtering results optional field allows filtering results by the datetime parameter within the range of the last 7 days; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2021-11-15 12:57:46 +00:00 */
+    /** *start time for filtering results* optional field allows filtering results by the `datetime` parameter within the range of the last 7 days; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2021-11-15 12:57:46 +00:00` */
     datetime_from?: string | undefined;
-    /** finish time for filtering results optional field allows filtering results by the datetime parameter within the range of the last 7 days; must be specified in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2021-11-15 13:57:46 +00:00 */
+    /** *finish time for filtering results* optional field allows filtering results by the `datetime` parameter within the range of the last 7 days; must be specified in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2021-11-15 13:57:46 +00:00` */
     datetime_to?: string | undefined;
     [key: string]: any;
     constructor(data?: IOnPageErrorsRequestInfo);

package/dist/esm/models/OnPageErrorsResponseInfo.d.ts

@@ -1,12 +1,12 @@
 import { OnPageErrorsTaskInfo } from "./OnPageErrorsTaskInfo";
 import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
 export interface IOnPageErrorsResponseInfo extends IBaseResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: OnPageErrorsTaskInfo[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageErrorsResponseInfo extends BaseResponseInfo implements IOnPageErrorsResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: OnPageErrorsTaskInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageErrorsResponseInfo);

package/dist/esm/models/OnPageErrorsResultInfo.d.ts

@@ -1,46 +1,46 @@
 export interface IOnPageErrorsResultInfo {
-    /** task identifier unique task identifier in our system in the UUID format */
+    /** *task identifier* **unique task identifier in our system in the [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format** */
     id?: string | undefined;
-    /** date and time when an error occurred 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 an error occurred* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` */
     datetime?: string | undefined;
-    /** corresponding API function */
+    /** *corresponding API function* */
     function?: string | undefined;
-    /** error code */
+    /** *error code* */
     error_code?: number | undefined;
-    /** error message or error URL error message (see full list) or URL that caused an error */
+    /** *error message or error URL* error message [(see full list)](https://docs.dataforseo.com/v3/appendix/errors/) or URL that caused an error */
     error_message?: string | undefined;
-    /** URL that caused an error URL you used for making an API call or pingback/postback URL */
+    /** *URL that caused an error* URL you used for making an API call or pingback/postback URL */
     http_url?: string | undefined;
-    /** HTTP method */
+    /** *HTTP method* */
     http_method?: string | undefined;
-    /** HTTP status code */
+    /** *HTTP status code* */
     http_code?: number | undefined;
-    /** time taken by HTTP request for tasks set with a pingback/postback, this field will show the time it took your server to respond */
+    /** *time taken by HTTP request* for tasks set with a pingback/postback, this field will show the time it took your server to respond */
     http_time?: number | undefined;
-    /** HTTP response server response */
+    /** *HTTP response* server response */
     http_response?: string | undefined;
     [key: string]: any;
 }
 export declare class OnPageErrorsResultInfo implements IOnPageErrorsResultInfo {
-    /** task identifier unique task identifier in our system in the UUID format */
+    /** *task identifier* **unique task identifier in our system in the [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format** */
     id?: string | undefined;
-    /** date and time when an error occurred 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 an error occurred* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` */
     datetime?: string | undefined;
-    /** corresponding API function */
+    /** *corresponding API function* */
     function?: string | undefined;
-    /** error code */
+    /** *error code* */
     error_code?: number | undefined;
-    /** error message or error URL error message (see full list) or URL that caused an error */
+    /** *error message or error URL* error message [(see full list)](https://docs.dataforseo.com/v3/appendix/errors/) or URL that caused an error */
     error_message?: string | undefined;
-    /** URL that caused an error URL you used for making an API call or pingback/postback URL */
+    /** *URL that caused an error* URL you used for making an API call or pingback/postback URL */
     http_url?: string | undefined;
-    /** HTTP method */
+    /** *HTTP method* */
     http_method?: string | undefined;
-    /** HTTP status code */
+    /** *HTTP status code* */
     http_code?: number | undefined;
-    /** time taken by HTTP request for tasks set with a pingback/postback, this field will show the time it took your server to respond */
+    /** *time taken by HTTP request* for tasks set with a pingback/postback, this field will show the time it took your server to respond */
     http_time?: number | undefined;
-    /** HTTP response server response */
+    /** *HTTP response* server response */
     http_response?: string | undefined;
     [key: string]: any;
     constructor(data?: IOnPageErrorsResultInfo);

package/dist/esm/models/OnPageErrorsTaskInfo.d.ts

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