dataforseo-client 2.1.3 → 2.1.6

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

@@ -1,15 +1,15 @@
 import { BaseSerpApiGoogleFinanceElementItem } from "./BaseSerpApiGoogleFinanceElementItem";
 export interface IMarkets {
-    /** financial market identifier possible values: US, Europe, Asia, Currencies, Crypto, Futures */
+    /** *financial market identifier* possible values: `US`, `Europe`, `Asia`, `Currencies`, `Crypto`, `Futures` */
     market?: string | undefined;
-    /** elements of search results found in SERP */
+    /** *elements of search results found in SERP* */
     items?: BaseSerpApiGoogleFinanceElementItem[] | undefined;
     [key: string]: any;
 }
 export declare class Markets implements IMarkets {
-    /** financial market identifier possible values: US, Europe, Asia, Currencies, Crypto, Futures */
+    /** *financial market identifier* possible values: `US`, `Europe`, `Asia`, `Currencies`, `Crypto`, `Futures` */
     market?: string | undefined;
-    /** elements of search results found in SERP */
+    /** *elements of search results found in SERP* */
     items?: BaseSerpApiGoogleFinanceElementItem[] | undefined;
     [key: string]: any;
     constructor(data?: IMarkets);

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

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

package/dist/esm/models/OnPageAvailableFiltersResponseInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"OnPageAvailableFiltersResponseInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageAvailableFiltersResponseInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAmC,MAAM,kCAAkC,CAAC;AACnH,OAAO,EAAE,gBAAgB,EAAqB,MAAM,oBAAoB,CAAC;AAWzE,MAAM,OAAO,kCAAoC,SAAQ,gBAAgB;IAOrE,YAAY,IAA0C;QACtD,KAAK,CAAC,IAAI,CAAC,CAAC;IAEZ,CAAC;IAED,IAAI,CAAC,IAAU;QACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;gBAC/B,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;gBAChB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC7B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,8BAA8B,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBACjE,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,kCAAkC,EAAE,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAGnB,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;QACrB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACnB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC1B,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;oBAC5C,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,CAAC,CAAC;gBACvC,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}
+{"version":3,"file":"OnPageAvailableFiltersResponseInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageAvailableFiltersResponseInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAmC,MAAM,kCAAkC,CAAC;AACnH,OAAO,EAAE,gBAAgB,EAAqB,MAAM,oBAAoB,CAAC;AAYzE,MAAM,OAAO,kCAAoC,SAAQ,gBAAgB;IAUrE,YAAY,IAA0C;QACtD,KAAK,CAAC,IAAI,CAAC,CAAC;IAEZ,CAAC;IAED,IAAI,CAAC,IAAU;QACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;gBAC/B,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;gBAChB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC7B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,8BAA8B,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBACjE,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,kCAAkC,EAAE,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAGnB,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;QACrB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACnB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC1B,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;oBAC5C,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,CAAC,CAAC;gBACvC,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}

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

@@ -1,10 +1,12 @@
 import { OnPageAvailableFiltersResultInfo } from "./OnPageAvailableFiltersResultInfo";
 import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
 export interface IOnPageAvailableFiltersTaskInfo extends IBaseResponseTaskInfo {
+    /** *array of results* contains the full list of available parameters that can be used for data filtration the parameters are grouped by the endpoint they can be used with */
     result?: OnPageAvailableFiltersResultInfo[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageAvailableFiltersTaskInfo extends BaseResponseTaskInfo implements IOnPageAvailableFiltersTaskInfo {
+    /** *array of results* contains the full list of available parameters that can be used for data filtration the parameters are grouped by the endpoint they can be used with */
     result?: OnPageAvailableFiltersResultInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageAvailableFiltersTaskInfo);

package/dist/esm/models/OnPageAvailableFiltersTaskInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"OnPageAvailableFiltersTaskInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageAvailableFiltersTaskInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAqC,MAAM,oCAAoC,CAAC;AACzH,OAAO,EAAE,oBAAoB,EAAyB,MAAM,wBAAwB,CAAC;AAWrF,MAAM,OAAO,8BAAgC,SAAQ,oBAAoB;IAOrE,YAAY,IAAsC;QAClD,KAAK,CAAC,IAAI,CAAC,CAAC;IAEZ,CAAC;IAED,IAAI,CAAC,IAAU;QACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;gBACjB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC9B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBACpE,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,8BAA8B,EAAE,CAAC;QAClD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAGnB,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;QACtB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACpB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC3B,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;oBAC5C,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,CAAC,CAAC;gBACxC,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}
+{"version":3,"file":"OnPageAvailableFiltersTaskInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageAvailableFiltersTaskInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAqC,MAAM,oCAAoC,CAAC;AACzH,OAAO,EAAE,oBAAoB,EAAyB,MAAM,wBAAwB,CAAC;AAYrF,MAAM,OAAO,8BAAgC,SAAQ,oBAAoB;IAUrE,YAAY,IAAsC;QAClD,KAAK,CAAC,IAAI,CAAC,CAAC;IAEZ,CAAC;IAED,IAAI,CAAC,IAAU;QACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;gBACjB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC9B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBACpE,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,8BAA8B,EAAE,CAAC;QAClD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAGnB,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;QACtB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACpB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC3B,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;oBAC5C,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,CAAC,CAAC;gBACxC,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}

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/OnPageInstantPagesRequestInfo.d.ts

@@ -1,86 +1,90 @@
 export interface IOnPageInstantPagesRequestInfo {
-    /** *target page url* **required field** absolute URL of the target page; **Note #1:** results will be returned for the specified URL only; **Note #2:** to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error; to prevent this error from occurring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue */
+    /** target page urlrequired fieldabsolute URL of the target page;Note #1: results will be returned for the specified URL only;Note #2: to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error;to prevent this error from occurring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue */
     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 agentoptional fieldcustom user agent for crawling a websiteexample: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36default 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 parametersoptional fieldif you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values:desktop, mobile, tabletdesktop preset will apply the following values:browser_screen_width: 1920browser_screen_height: 1080browser_screen_scale_factor: 1mobile preset will apply the following values:browser_screen_width: 390browser_screen_height: 844browser_screen_scale_factor: 3tablet preset will apply the following values:browser_screen_width: 1024browser_screen_height: 1366browser_screen_scale_factor: 2Note: 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 widthoptional fieldyou 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 trueminimum value, in pixels: 240maximum 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 heightoptional fieldyou 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 trueminimum value, in pixels: 240maximum 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 factoroptional fieldyou 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 trueminimum value: 0.5maximum value: 3 */
     browser_screen_scale_factor?: number | undefined;
-    /** *store HTML of a crawled page* optional field set to `true` if you want get the HTML of the page using the [OnPage Raw HTML endpoint](/v3/on_page/raw_html/) default value: `false` */
+    /** store HTML of a crawled pageoptional fieldset to true if you want get the HTML of the page using the OnPage Raw HTML endpointdefault value: false */
     store_raw_html?: 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 websiteoptional fieldall 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 resources* optional field set to `true` if you want to load image, stylesheets, scripts, and broken resources 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) */
+    /** load resourcesoptional fieldset to true if you want to load image, stylesheets, scripts, and broken resourcesdefault value: falseNote: 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_resources?: 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, parameters `enable_javascript`, and `load_resources` are enabled automatically;** **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) */
+    /** emulate browser rendering to measure Core Web Vitalsoptional fieldby 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: falseset to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;if you use this field, parameters enable_javascript, and load_resources are enabled automatically;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 */
     enable_browser_rendering?: 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 fieldset to true if you want to disable the popup requesting cookie consent from the user;default value:false */
     disable_cookie_popup?: boolean | undefined;
-    /** *return data on pages despite the timeout error* optional field if `true`, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error; default value: `false` */
+    /** return data on pages despite the timeout erroroptional fieldif true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error;default value: false */
     return_despite_timeout?: 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`; */
+    /** load javascript on a pageoptional fieldset to true if you want to load the scripts available on a pagedefault value: falseNote: 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 */
+    enable_javascript?: boolean | undefined;
+    /** enable XMLHttpRequest on a pageoptional fieldset to true if you want our crawler to request data from a web server using the XMLHttpRequest objectdefault value:falseif you use this field, enable_javascript must be set to true; */
     enable_xhr?: boolean | undefined;
-    /** *custom javascript* optional field`Note` that the execution time for the script you enter here should be 700 ms maximum; for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a `scr` attribute: `let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i = 0)rn      meta.haveGoogleAnalytics = true;rntif (src.indexOf('gtm.js') >= 0)rn      meta.haveTagManager = true;rn  }rn}rnmeta;`the returned value depends on what you specified in this field. For instance, if you specify the following script: `meta = {}; meta.url = document.URL; meta.test = 'test'; meta;` as a response you will receive the following data: `'custom_js_response': {'url': 'https://dataforseo.com/','test': 'test'}` */
+    /** custom javascriptoptional fieldNote that the execution time for the script you enter here should be 700 ms maximum;for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a scr attribute:let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i = 0)rn      meta.haveGoogleAnalytics = true;rntif (src.indexOf('gtm.js') >= 0)rn      meta.haveTagManager = true;rn  }rn}rnmeta;the returned value depends on what you specified in this field. For instance, if you specify the following script:meta = {}; meta.url = document.URL; meta.test = 'test'; meta;as a response you will receive the following data:'custom_js_response': {'url': 'https://dataforseo.com/','test': 'test'} */
     custom_js?: string | undefined;
-    /** *enable microdata validation* optional field if set to `true`, you can use the [OnPage API Microdata endpoint](/v3/on_page/microdata/) with the `id` of the task; default value: `false` */
+    /** enable microdata validationoptional fieldif set to true, you can use the OnPage API Microdata endpoint with the id of the task;default value: false */
     validate_micromarkup?: boolean | undefined;
-    /** *check spelling* optional field set to `true` to check spelling on a website using [Hunspell](http://hunspell.github.io/) library default value: `false` */
+    /** check spellingoptional fieldset to true to check spelling on a website using Hunspell librarydefault value: false */
     check_spell?: boolean | undefined;
-    /** *custom threshold values for checks* optional field you can specify custom threshold values for the parameters included in the `checks` array of OnPage API responses; **Note:** only integer threshold values can be modified; */
+    /** custom threshold values for checksoptional fieldyou can specify custom threshold values for the parameters included in the checks array of OnPage API responses;Note: only integer threshold values can be modified; */
     checks_threshold?: {
         [key: string]: number;
     } | 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 pooloptional fieldif 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 pooloptional fieldyou 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 errorspossible values: us, de */
     ip_pool_for_scan?: string | undefined;
     [key: string]: any;
 }
 export declare class OnPageInstantPagesRequestInfo implements IOnPageInstantPagesRequestInfo {
-    /** *target page url* **required field** absolute URL of the target page; **Note #1:** results will be returned for the specified URL only; **Note #2:** to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error; to prevent this error from occurring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue */
+    /** target page urlrequired fieldabsolute URL of the target page;Note #1: results will be returned for the specified URL only;Note #2: to prevent denial-of-service events, tasks that contain a duplicate crawl host will be returned with a 40501 error;to prevent this error from occurring, avoid setting tasks with the same domain if at least one of your previous tasks with this domain (including a page URL on the domain) is still in a crawling queue */
     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 agentoptional fieldcustom user agent for crawling a websiteexample: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36default 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 parametersoptional fieldif you use this field, you don't need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factorpossible values:desktop, mobile, tabletdesktop preset will apply the following values:browser_screen_width: 1920browser_screen_height: 1080browser_screen_scale_factor: 1mobile preset will apply the following values:browser_screen_width: 390browser_screen_height: 844browser_screen_scale_factor: 3tablet preset will apply the following values:browser_screen_width: 1024browser_screen_height: 1366browser_screen_scale_factor: 2Note: 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 widthoptional fieldyou 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 trueminimum value, in pixels: 240maximum 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 heightoptional fieldyou 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 trueminimum value, in pixels: 240maximum 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 factoroptional fieldyou 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 trueminimum value: 0.5maximum value: 3 */
     browser_screen_scale_factor?: number | undefined;
-    /** *store HTML of a crawled page* optional field set to `true` if you want get the HTML of the page using the [OnPage Raw HTML endpoint](/v3/on_page/raw_html/) default value: `false` */
+    /** store HTML of a crawled pageoptional fieldset to true if you want get the HTML of the page using the OnPage Raw HTML endpointdefault value: false */
     store_raw_html?: 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 websiteoptional fieldall 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 resources* optional field set to `true` if you want to load image, stylesheets, scripts, and broken resources 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) */
+    /** load resourcesoptional fieldset to true if you want to load image, stylesheets, scripts, and broken resourcesdefault value: falseNote: 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_resources?: 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, parameters `enable_javascript`, and `load_resources` are enabled automatically;** **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) */
+    /** emulate browser rendering to measure Core Web Vitalsoptional fieldby 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: falseset to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response;if you use this field, parameters enable_javascript, and load_resources are enabled automatically;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 */
     enable_browser_rendering?: 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 fieldset to true if you want to disable the popup requesting cookie consent from the user;default value:false */
     disable_cookie_popup?: boolean | undefined;
-    /** *return data on pages despite the timeout error* optional field if `true`, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error; default value: `false` */
+    /** return data on pages despite the timeout erroroptional fieldif true, the data will be provided on pages that failed to load within 120 seconds and responded with a timeout error;default value: false */
     return_despite_timeout?: 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`; */
+    /** load javascript on a pageoptional fieldset to true if you want to load the scripts available on a pagedefault value: falseNote: 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 */
+    enable_javascript?: boolean | undefined;
+    /** enable XMLHttpRequest on a pageoptional fieldset to true if you want our crawler to request data from a web server using the XMLHttpRequest objectdefault value:falseif you use this field, enable_javascript must be set to true; */
     enable_xhr?: boolean | undefined;
-    /** *custom javascript* optional field`Note` that the execution time for the script you enter here should be 700 ms maximum; for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a `scr` attribute: `let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i = 0)rn      meta.haveGoogleAnalytics = true;rntif (src.indexOf('gtm.js') >= 0)rn      meta.haveTagManager = true;rn  }rn}rnmeta;`the returned value depends on what you specified in this field. For instance, if you specify the following script: `meta = {}; meta.url = document.URL; meta.test = 'test'; meta;` as a response you will receive the following data: `'custom_js_response': {'url': 'https://dataforseo.com/','test': 'test'}` */
+    /** custom javascriptoptional fieldNote that the execution time for the script you enter here should be 700 ms maximum;for example, you can use the following JS snippet to check if the website contains Google Tag Manager as a scr attribute:let meta = { haveGoogleAnalytics: false, haveTagManager: false };rnfor (var i = 0; i = 0)rn      meta.haveGoogleAnalytics = true;rntif (src.indexOf('gtm.js') >= 0)rn      meta.haveTagManager = true;rn  }rn}rnmeta;the returned value depends on what you specified in this field. For instance, if you specify the following script:meta = {}; meta.url = document.URL; meta.test = 'test'; meta;as a response you will receive the following data:'custom_js_response': {'url': 'https://dataforseo.com/','test': 'test'} */
     custom_js?: string | undefined;
-    /** *enable microdata validation* optional field if set to `true`, you can use the [OnPage API Microdata endpoint](/v3/on_page/microdata/) with the `id` of the task; default value: `false` */
+    /** enable microdata validationoptional fieldif set to true, you can use the OnPage API Microdata endpoint with the id of the task;default value: false */
     validate_micromarkup?: boolean | undefined;
-    /** *check spelling* optional field set to `true` to check spelling on a website using [Hunspell](http://hunspell.github.io/) library default value: `false` */
+    /** check spellingoptional fieldset to true to check spelling on a website using Hunspell librarydefault value: false */
     check_spell?: boolean | undefined;
-    /** *custom threshold values for checks* optional field you can specify custom threshold values for the parameters included in the `checks` array of OnPage API responses; **Note:** only integer threshold values can be modified; */
+    /** custom threshold values for checksoptional fieldyou can specify custom threshold values for the parameters included in the checks array of OnPage API responses;Note: only integer threshold values can be modified; */
     checks_threshold?: {
         [key: string]: number;
     } | 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 pooloptional fieldif 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 pooloptional fieldyou 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 errorspossible values: us, de */
     ip_pool_for_scan?: string | undefined;
     [key: string]: any;
     constructor(data?: IOnPageInstantPagesRequestInfo);

package/dist/esm/models/OnPageInstantPagesRequestInfo.js

@@ -25,6 +25,7 @@ export class OnPageInstantPagesRequestInfo {
             this.enable_browser_rendering = data["enable_browser_rendering"];
             this.disable_cookie_popup = data["disable_cookie_popup"];
             this.return_despite_timeout = data["return_despite_timeout"];
+            this.enable_javascript = data["enable_javascript"];
             this.enable_xhr = data["enable_xhr"];
             this.custom_js = data["custom_js"];
             this.validate_micromarkup = data["validate_micromarkup"];
@@ -54,6 +55,7 @@ export class OnPageInstantPagesRequestInfo {
         data["enable_browser_rendering"] = this.enable_browser_rendering;
         data["disable_cookie_popup"] = this.disable_cookie_popup;
         data["return_despite_timeout"] = this.return_despite_timeout;
+        data["enable_javascript"] = this.enable_javascript;
         data["enable_xhr"] = this.enable_xhr;
         data["custom_js"] = this.custom_js;
         data["validate_micromarkup"] = this.validate_micromarkup;