dataforseo-client 2.1.1 → 2.1.3

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

@@ -1,36 +1,36 @@
 export interface IOnPageIdListResultInfo {
-    /** 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;
-    /** URL of the task URL you used for making an API call */
+    /** *URL of the task* URL you used for making an API call */
     url?: string | undefined;
-    /** date and time when the task was made in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *date and time when the task was made* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_posted?: string | undefined;
-    /** date and time when the task was completed in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *date and time when the task was completed* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_done?: string | undefined;
-    /** informational message of the task you can find the full list of general informational messages here */
+    /** *informational message of the task* you can find the full list of general informational messages [here](/v3/appendix-errors/) */
     status?: string | undefined;
-    /** total tasks cost, USD */
+    /** *total tasks cost, USD* */
     cost?: number | undefined;
-    /** contains parameters you specified in the POST request */
+    /** *contains parameters you specified in the POST request* */
     metadata?: {
         [key: string]: any;
     } | undefined;
     [key: string]: any;
 }
 export declare class OnPageIdListResultInfo implements IOnPageIdListResultInfo {
-    /** 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;
-    /** URL of the task URL you used for making an API call */
+    /** *URL of the task* URL you used for making an API call */
     url?: string | undefined;
-    /** date and time when the task was made in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *date and time when the task was made* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_posted?: string | undefined;
-    /** date and time when the task was completed in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2023-01-15 12:57:46 +00:00 */
+    /** *date and time when the task was completed* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2023-01-15 12:57:46 +00:00` */
     datetime_done?: string | undefined;
-    /** informational message of the task you can find the full list of general informational messages here */
+    /** *informational message of the task* you can find the full list of general informational messages [here](/v3/appendix-errors/) */
     status?: string | undefined;
-    /** total tasks cost, USD */
+    /** *total tasks cost, USD* */
     cost?: number | undefined;
-    /** contains parameters you specified in the POST request */
+    /** *contains parameters you specified in the POST request* */
     metadata?: {
         [key: string]: any;
     } | undefined;

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

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

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

@@ -1,90 +1,86 @@
 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 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 */
     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_factorpossible values: desktop, mobile, tabletdesktop 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 trueminimum 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 trueminimum 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 trueminimum 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 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 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;
-    /** 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 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; the cost can be calculated on the Pricing Page */
+    /** *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_resources?: boolean | 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 */
-    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, 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 */
+    /** *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) */
     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 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;
-    /** 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 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_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: falseif 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;
-    /** custom javascript optional 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 };\r\nfor (var i = 0; i = 0)\r\n      meta.haveGoogleAnalytics = true;\r\n\tif (src.indexOf(\'gtm.js\') >= 0)\r\n      meta.haveTagManager = true;\r\n  }\r\n}\r\nmeta;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 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_js?: string | undefined;
-    /** enable microdata validation optional field if set to true, you can use the OnPage API Microdata endpoint with the id of the task; default value: false */
+    /** *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` */
     validate_micromarkup?: boolean | undefined;
-    /** check spelling optional field set to true to check spelling on a website using Hunspell library default value: false */
+    /** *check spelling* optional field set to `true` to check spelling on a website using [Hunspell](http://hunspell.github.io/) library default 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 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; */
     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 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;
     [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 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 */
     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_factorpossible values: desktop, mobile, tabletdesktop 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 trueminimum 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 trueminimum 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 trueminimum 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 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 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;
-    /** 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 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; the cost can be calculated on the Pricing Page */
+    /** *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_resources?: boolean | 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 */
-    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, 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 */
+    /** *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) */
     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 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;
-    /** 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 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_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: falseif 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;
-    /** custom javascript optional 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 };\r\nfor (var i = 0; i = 0)\r\n      meta.haveGoogleAnalytics = true;\r\n\tif (src.indexOf(\'gtm.js\') >= 0)\r\n      meta.haveTagManager = true;\r\n  }\r\n}\r\nmeta;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 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_js?: string | undefined;
-    /** enable microdata validation optional field if set to true, you can use the OnPage API Microdata endpoint with the id of the task; default value: false */
+    /** *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` */
     validate_micromarkup?: boolean | undefined;
-    /** check spelling optional field set to true to check spelling on a website using Hunspell library default value: false */
+    /** *check spelling* optional field set to `true` to check spelling on a website using [Hunspell](http://hunspell.github.io/) library default 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 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; */
     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 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;
     [key: string]: any;
     constructor(data?: IOnPageInstantPagesRequestInfo);

package/dist/esm/models/OnPageInstantPagesRequestInfo.js

@@ -22,7 +22,6 @@ export class OnPageInstantPagesRequestInfo {
             this.store_raw_html = data["store_raw_html"];
             this.accept_language = data["accept_language"];
             this.load_resources = data["load_resources"];
-            this.enable_javascript = data["enable_javascript"];
             this.enable_browser_rendering = data["enable_browser_rendering"];
             this.disable_cookie_popup = data["disable_cookie_popup"];
             this.return_despite_timeout = data["return_despite_timeout"];
@@ -52,7 +51,6 @@ export class OnPageInstantPagesRequestInfo {
         data["store_raw_html"] = this.store_raw_html;
         data["accept_language"] = this.accept_language;
         data["load_resources"] = this.load_resources;
-        data["enable_javascript"] = this.enable_javascript;
         data["enable_browser_rendering"] = this.enable_browser_rendering;
         data["disable_cookie_popup"] = this.disable_cookie_popup;
         data["return_despite_timeout"] = this.return_despite_timeout;

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

@@ -1 +1 @@
-{"version":3,"file":"OnPageInstantPagesRequestInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageInstantPagesRequestInfo.ts"],"names":[],"mappings":"AAkEA,MAAM,OAAO,6BAA6B;IAyGtC,YAAY,IAAqC;QAEjD,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBACvB,IAAK,CAAC,QAAQ,CAAC,GAAS,IAAK,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;QACL,CAAC;IAED,CAAC;IAED,IAAI,CAAC,IAAU;QACX,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,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACnD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC7C,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzD,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAC3D,IAAI,CAAC,2BAA2B,GAAG,IAAI,CAAC,6BAA6B,CAAC,CAAC;YACvE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC7C,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC/C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC7C,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACnD,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,0BAA0B,CAAC,CAAC;YACjE,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzD,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,wBAAwB,CAAC,CAAC;YAC7D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;YACrC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;YACnC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YACvC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACjD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YACvC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACrD,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,6BAA6B,EAAE,CAAC;QACjD,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;QAI5C,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAC3D,IAAI,CAAC,6BAA6B,CAAC,GAAG,IAAI,CAAC,2BAA2B,CAAC;QACvE,IAAI,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,0BAA0B,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAC;QACjE,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC,sBAAsB,CAAC;QAC7D,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}
+{"version":3,"file":"OnPageInstantPagesRequestInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageInstantPagesRequestInfo.ts"],"names":[],"mappings":"AA+DA,MAAM,OAAO,6BAA6B;IAoGtC,YAAY,IAAqC;QAEjD,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBACvB,IAAK,CAAC,QAAQ,CAAC,GAAS,IAAK,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;QACL,CAAC;IAED,CAAC;IAED,IAAI,CAAC,IAAU;QACX,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,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YACvB,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACnD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC7C,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzD,IAAI,CAAC,qBAAqB,GAAG,IAAI,CAAC,uBAAuB,CAAC,CAAC;YAC3D,IAAI,CAAC,2BAA2B,GAAG,IAAI,CAAC,6BAA6B,CAAC,CAAC;YACvE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC7C,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC/C,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,gBAAgB,CAAC,CAAC;YAC7C,IAAI,CAAC,wBAAwB,GAAG,IAAI,CAAC,0BAA0B,CAAC,CAAC;YACjE,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzD,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,wBAAwB,CAAC,CAAC;YAC7D,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC;YACrC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;YACnC,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YACvC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC;YACjD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;YACvC,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC;QACrD,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,6BAA6B,EAAE,CAAC;QACjD,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;QAI5C,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC;QACvB,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,uBAAuB,CAAC,GAAG,IAAI,CAAC,qBAAqB,CAAC;QAC3D,IAAI,CAAC,6BAA6B,CAAC,GAAG,IAAI,CAAC,2BAA2B,CAAC;QACvE,IAAI,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QAC/C,IAAI,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,0BAA0B,CAAC,GAAG,IAAI,CAAC,wBAAwB,CAAC;QACjE,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC,sBAAsB,CAAC;QAC7D,IAAI,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACjD,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACvC,IAAI,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}

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

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

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

@@ -1,27 +1,27 @@
 import { BaseOnPageResourceItem } from "./BaseOnPageResourceItem";
 export interface IOnPageInstantPagesResultInfo {
-    /** 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 in this case the value will be null */
+    /** *details of the crawling session* in this case the value will be `null` */
     crawl_status?: any | undefined;
-    /** crawler ip address displays the IP address used by the crawler to initiate the current crawling session you can find the full list of IPs used by our crawler in the Overview section */
+    /** *crawler ip address* displays the IP address used by the crawler to initiate the current crawling session you can find the full list of IPs used by our crawler in the [Overview section](/v3/on_page/overview) */
     crawl_gateway_address?: string | undefined;
-    /** number of items in the results array */
+    /** *number of items in the results array* */
     items_count?: number | undefined;
-    /** items array */
+    /** *items array* */
     items?: BaseOnPageResourceItem[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageInstantPagesResultInfo implements IOnPageInstantPagesResultInfo {
-    /** 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 in this case the value will be null */
+    /** *details of the crawling session* in this case the value will be `null` */
     crawl_status?: any | undefined;
-    /** crawler ip address displays the IP address used by the crawler to initiate the current crawling session you can find the full list of IPs used by our crawler in the Overview section */
+    /** *crawler ip address* displays the IP address used by the crawler to initiate the current crawling session you can find the full list of IPs used by our crawler in the [Overview section](/v3/on_page/overview) */
     crawl_gateway_address?: string | undefined;
-    /** number of items in the results array */
+    /** *number of items in the results array* */
     items_count?: number | undefined;
-    /** items array */
+    /** *items array* */
     items?: BaseOnPageResourceItem[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageInstantPagesResultInfo);

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

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

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

@@ -1,18 +1,18 @@
 export interface IOnPageKeywordDensityItem {
-    /** returned keyword */
+    /** *returned keyword* */
     keyword?: string | undefined;
-    /** keyword frequency number of times the keyword appears on the website (or webpage if you specified a url) */
+    /** *keyword frequency* number of times the keyword appears on the website (or webpage if you specified a `url`) */
     frequency?: number | undefined;
-    /** keyword density calculated as a ratio of frequency to the total count of keywords with the set keyword_length on the web page or website */
+    /** *keyword density* calculated as a ratio of `frequency` to the total count of keywords with the set `keyword_length` on the web page or website */
     density?: number | undefined;
     [key: string]: any;
 }
 export declare class OnPageKeywordDensityItem implements IOnPageKeywordDensityItem {
-    /** returned keyword */
+    /** *returned keyword* */
     keyword?: string | undefined;
-    /** keyword frequency number of times the keyword appears on the website (or webpage if you specified a url) */
+    /** *keyword frequency* number of times the keyword appears on the website (or webpage if you specified a `url`) */
     frequency?: number | undefined;
-    /** keyword density calculated as a ratio of frequency to the total count of keywords with the set keyword_length on the web page or website */
+    /** *keyword density* calculated as a ratio of `frequency` to the total count of keywords with the set `keyword_length` on the web page or website */
     density?: number | undefined;
     [key: string]: any;
     constructor(data?: IOnPageKeywordDensityItem);

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

@@ -1,34 +1,34 @@
 export interface IOnPageKeywordDensityRequestInfo {
-    /** 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](/v3/on_page/task_post/) endpoint example: '07131248-1535-0216-1000-17384017ad04' */
     id?: string | undefined;
-    /** number of words for a keyword required field possible values: 1, 2, 3, 4, 5 */
+    /** *number of words for a keyword* **required field** possible values: `1`, `2`, `3`, `4`, `5` */
     keyword_length?: number | undefined;
-    /** page URL optional field if you do not specify a page here, the results will be provided for the whole website if you use this field, the API response will contain only keywords from the specified page a page should be specified with absolute URL (including http:// or https://) */
+    /** *page URL* optional field **if you do not specify a page here, the results will be provided for the whole website** if you use this field, the API response will contain only keywords from the specified page a page should be specified with absolute URL (including `http://` or `https://`) */
     url?: string | undefined;
-    /** the maximum number of returned keywords optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned keywords* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, <>, in, not_in, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters example: ['keyword','=','%seo%'] [['keyword','=','%seo%'], 'and', ['frequency','','6'],'or',['density','>','0.02']]] The full list of possible filters is available by this link. */
+    /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `regex`, `not_regex`, `=`, `<>`, `in`, `not_in`, `like`, `not_like` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['keyword','=','%seo%']` `[['keyword','=','%seo%'],'and',['frequency','','6'],'or',['density','>','0.02']]]` The full list of possible filters is available [by this link.](/v3/on_page/filters_and_thresholds/?bash) */
     filters?: any[] | undefined;
-    /** results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting type example: ['frequency,desc'] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ['keyword,asc','frequency,desc'] */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` - results will be sorted in the ascending order `desc` - results will be sorted in the descending order you should use a comma to set up a sorting type example: `['frequency,desc']` **note that you can set no more than three sorting rules in a single request** you should use a comma to separate several sorting rules example: `['keyword,asc','frequency,desc']` */
     order_by?: string[] | 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 OnPageKeywordDensityRequestInfo implements IOnPageKeywordDensityRequestInfo {
-    /** 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](/v3/on_page/task_post/) endpoint example: '07131248-1535-0216-1000-17384017ad04' */
     id?: string | undefined;
-    /** number of words for a keyword required field possible values: 1, 2, 3, 4, 5 */
+    /** *number of words for a keyword* **required field** possible values: `1`, `2`, `3`, `4`, `5` */
     keyword_length?: number | undefined;
-    /** page URL optional field if you do not specify a page here, the results will be provided for the whole website if you use this field, the API response will contain only keywords from the specified page a page should be specified with absolute URL (including http:// or https://) */
+    /** *page URL* optional field **if you do not specify a page here, the results will be provided for the whole website** if you use this field, the API response will contain only keywords from the specified page a page should be specified with absolute URL (including `http://` or `https://`) */
     url?: string | undefined;
-    /** the maximum number of returned keywords optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned keywords* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, =, <>, in, not_in, like, not_like you can use the % operator with like and not_like to match any string of zero or more characters example: ['keyword','=','%seo%'] [['keyword','=','%seo%'], 'and', ['frequency','','6'],'or',['density','>','0.02']]] The full list of possible filters is available by this link. */
+    /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `regex`, `not_regex`, `=`, `<>`, `in`, `not_in`, `like`, `not_like` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['keyword','=','%seo%']` `[['keyword','=','%seo%'],'and',['frequency','','6'],'or',['density','>','0.02']]]` The full list of possible filters is available [by this link.](/v3/on_page/filters_and_thresholds/?bash) */
     filters?: any[] | undefined;
-    /** results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting type example: ['frequency,desc'] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ['keyword,asc','frequency,desc'] */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` - results will be sorted in the ascending order `desc` - results will be sorted in the descending order you should use a comma to set up a sorting type example: `['frequency,desc']` **note that you can set no more than three sorting rules in a single request** you should use a comma to separate several sorting rules example: `['keyword,asc','frequency,desc']` */
     order_by?: string[] | 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?: IOnPageKeywordDensityRequestInfo);

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

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

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

@@ -1,28 +1,28 @@
 import { CrawlStatusInfo } from "./CrawlStatusInfo";
 import { OnPageKeywordDensityItem } from "./OnPageKeywordDensityItem";
 export interface IOnPageKeywordDensityResultInfo {
-    /** 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 relevant items total number of keywords on the specified website or web page matching the set keyword_length and filters */
+    /** *total number of relevant items* total number of keywords on the specified website or web page matching the set `keyword_length` and `filters` */
     total_items_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?: OnPageKeywordDensityItem[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageKeywordDensityResultInfo implements IOnPageKeywordDensityResultInfo {
-    /** 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 relevant items total number of keywords on the specified website or web page matching the set keyword_length and filters */
+    /** *total number of relevant items* total number of keywords on the specified website or web page matching the set `keyword_length` and `filters` */
     total_items_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?: OnPageKeywordDensityItem[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageKeywordDensityResultInfo);

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

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

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

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

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

@@ -1,10 +1,10 @@
 export interface IOnPageLighthouseAuditsResultInfo {
-    /** the list of available lighthouse audits an array containing the titles of available audits; Note: the titles can change depending on if the audit passed or failed and may contain markdown code; Note #2: if you’re using the audit that contains a slash (/) in its name, search by the last word after the slash */
+    /** *the list of available lighthouse audits* an array containing the titles of available audits; **Note:** the titles can change depending on if the audit passed or failed and may contain markdown code; **Note #2:** if you're using the audit that contains a slash (`/`) in its name, search by the last word after the slash */
     audits?: string[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageLighthouseAuditsResultInfo implements IOnPageLighthouseAuditsResultInfo {
-    /** the list of available lighthouse audits an array containing the titles of available audits; Note: the titles can change depending on if the audit passed or failed and may contain markdown code; Note #2: if you’re using the audit that contains a slash (/) in its name, search by the last word after the slash */
+    /** *the list of available lighthouse audits* an array containing the titles of available audits; **Note:** the titles can change depending on if the audit passed or failed and may contain markdown code; **Note #2:** if you're using the audit that contains a slash (`/`) in its name, search by the last word after the slash */
     audits?: string[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageLighthouseAuditsResultInfo);

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

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

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

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