dataforseo-client 2.1.2 → 2.1.3

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

@@ -1,38 +1,38 @@
 export interface IOnPageLinksRequestInfo {
-    /** ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” */
+    /** *ID of the task* **required field** you can get this ID in the response of the [Task POST](https://docs.dataforseo.com/v3/on_page/task_post/) endpoint example: '07131248-1535-0216-1000-17384017ad04' */
     id?: string | undefined;
-    /** relative page URL optional field if you use this field, the API response will contain only links from the specified page note that in this field you can specify relative URLs only */
+    /** *relative page URL* optional field if you use this field, the API response will contain only links from the specified page note that in this field you can specify relative URLs only */
     page_from?: string | undefined;
-    /** relative page URL optional field if you use this field, the API response will contain only internal links pointing to the specified page note that in this field you can specify relative URLs only */
+    /** *relative page URL* optional field if you use this field, the API response will contain only internal links pointing to the specified page note that in this field you can specify relative URLs only */
     page_to?: string | undefined;
-    /** the maximum number of returned links optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned links* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned links optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten links in the results array will be omitted and the data will be provided for the successive links */
+    /** *offset in the results array of returned links* optional field default value: `0` maximum value: `2000000` if you specify the `10` value, the first ten links in the results array will be omitted and the data will be provided for the successive links */
     offset?: 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: ['direction','=','external'] [['domain_to','<>','example.com'], 'and', ['link_from','not_like','%example.com/blog%']] [['direction','=','external'], 'and', [['link_from','like','%example.com/blog%'],'or',['link_from','like','%example.com/help%']]] 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: `['direction','=','external']` `[['domain_to','<>','example.com'],'and',['link_from','not_like','%example.com/blog%']]` `[['direction','=','external'],'and',[['link_from','like','%example.com/blog%'],'or',['link_from','like','%example.com/help%']]]` The full list of possible filters is available [by this link.](/v3/on_page/filters_and_thresholds/?bash) */
     filters?: any[] | undefined;
-    /** token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request; by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task; search_after_token values are unique for each subsequent task ; Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request */
+    /** *token for subsequent requests* optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over `20,000` results in a single request; by specifying the unique `search_after_token` value from the response array, you will get the subsequent results of the initial task; `search_after_token` values are unique for each subsequent task ; **Note:** if the `search_after_token` is specified in the request, all other parameters should be identical to the previous request */
     search_after_token?: 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 OnPageLinksRequestInfo implements IOnPageLinksRequestInfo {
-    /** ID of the task required field you can get this ID in the response of the Task POST endpoint example: “07131248-1535-0216-1000-17384017ad04” */
+    /** *ID of the task* **required field** you can get this ID in the response of the [Task POST](https://docs.dataforseo.com/v3/on_page/task_post/) endpoint example: '07131248-1535-0216-1000-17384017ad04' */
     id?: string | undefined;
-    /** relative page URL optional field if you use this field, the API response will contain only links from the specified page note that in this field you can specify relative URLs only */
+    /** *relative page URL* optional field if you use this field, the API response will contain only links from the specified page note that in this field you can specify relative URLs only */
     page_from?: string | undefined;
-    /** relative page URL optional field if you use this field, the API response will contain only internal links pointing to the specified page note that in this field you can specify relative URLs only */
+    /** *relative page URL* optional field if you use this field, the API response will contain only internal links pointing to the specified page note that in this field you can specify relative URLs only */
     page_to?: string | undefined;
-    /** the maximum number of returned links optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned links* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned links optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten links in the results array will be omitted and the data will be provided for the successive links */
+    /** *offset in the results array of returned links* optional field default value: `0` maximum value: `2000000` if you specify the `10` value, the first ten links in the results array will be omitted and the data will be provided for the successive links */
     offset?: 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: ['direction','=','external'] [['domain_to','<>','example.com'], 'and', ['link_from','not_like','%example.com/blog%']] [['direction','=','external'], 'and', [['link_from','like','%example.com/blog%'],'or',['link_from','like','%example.com/help%']]] 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: `['direction','=','external']` `[['domain_to','<>','example.com'],'and',['link_from','not_like','%example.com/blog%']]` `[['direction','=','external'],'and',[['link_from','like','%example.com/blog%'],'or',['link_from','like','%example.com/help%']]]` The full list of possible filters is available [by this link.](/v3/on_page/filters_and_thresholds/?bash) */
     filters?: any[] | undefined;
-    /** token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 20,000 results in a single request; by specifying the unique search_after_token value from the response array, you will get the subsequent results of the initial task; search_after_token values are unique for each subsequent task ; Note: if the search_after_token is specified in the request, all other parameters should be identical to the previous request */
+    /** *token for subsequent requests* optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over `20,000` results in a single request; by specifying the unique `search_after_token` value from the response array, you will get the subsequent results of the initial task; `search_after_token` values are unique for each subsequent task ; **Note:** if the `search_after_token` is specified in the request, all other parameters should be identical to the previous request */
     search_after_token?: 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?: IOnPageLinksRequestInfo);

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

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

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

@@ -1,32 +1,32 @@
 import { CrawlStatusInfo } from "./CrawlStatusInfo";
 import { BaseOnPageLinkItem } from "./BaseOnPageLinkItem";
 export interface IOnPageLinksResultInfo {
-    /** 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;
     search_after_token?: string | undefined;
     current_offset?: number | undefined;
-    /** total number of relevant items in the database */
+    /** *total number of relevant items in the database* */
     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?: BaseOnPageLinkItem[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageLinksResultInfo implements IOnPageLinksResultInfo {
-    /** 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;
     search_after_token?: string | undefined;
     current_offset?: number | undefined;
-    /** total number of relevant items in the database */
+    /** *total number of relevant items in the database* */
     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?: BaseOnPageLinkItem[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageLinksResultInfo);

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

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

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

@@ -2,14 +2,14 @@ import { MicrodataInspectionInfo } from "./MicrodataInspectionInfo";
 export interface IOnPageMicrodataInfoItem {
     /** type of element */
     type?: string | undefined;
-    /** information related to microdata validation */
+    /** *information related to microdata validation* */
     inspection_info?: MicrodataInspectionInfo | undefined;
     [key: string]: any;
 }
 export declare class OnPageMicrodataInfoItem implements IOnPageMicrodataInfoItem {
     /** type of element */
     type?: string | undefined;
-    /** information related to microdata validation */
+    /** *information related to microdata validation* */
     inspection_info?: MicrodataInspectionInfo | undefined;
     [key: string]: any;
     constructor(data?: IOnPageMicrodataInfoItem);

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

@@ -1,18 +1,18 @@
 export interface IOnPageMicrodataRequestInfo {
-    /** 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;
-    /** resource URL required field you can get this URL in the response of the Pages endpoint example: https://dataforseo.com/apis */
+    /** *resource URL* **required field** you can get this URL in the response of the [Pages](/v3/on_page/pages/) endpoint example: `https://dataforseo.com/apis` */
     url?: 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 OnPageMicrodataRequestInfo implements IOnPageMicrodataRequestInfo {
-    /** 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;
-    /** resource URL required field you can get this URL in the response of the Pages endpoint example: https://dataforseo.com/apis */
+    /** *resource URL* **required field** you can get this URL in the response of the [Pages](/v3/on_page/pages/) endpoint example: `https://dataforseo.com/apis` */
     url?: 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?: IOnPageMicrodataRequestInfo);

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

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

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

@@ -2,28 +2,28 @@ import { CrawlStatusInfo } from "./CrawlStatusInfo";
 import { TestSummary } from "./TestSummary";
 import { OnPageMicrodataInfoItem } from "./OnPageMicrodataInfoItem";
 export interface IOnPageMicrodataResultInfo {
-    /** 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;
-    /** microdata validation test results */
+    /** *microdata validation test results* */
     test_summary?: TestSummary | undefined;
-    /** number of items in the results array */
+    /** *number of items in the results array* */
     items_count?: number | undefined;
-    /** items array */
+    /** *items array* */
     items?: OnPageMicrodataInfoItem[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageMicrodataResultInfo implements IOnPageMicrodataResultInfo {
-    /** 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;
-    /** microdata validation test results */
+    /** *microdata validation test results* */
     test_summary?: TestSummary | undefined;
-    /** number of items in the results array */
+    /** *number of items in the results array* */
     items_count?: number | undefined;
-    /** items array */
+    /** *items array* */
     items?: OnPageMicrodataInfoItem[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageMicrodataResultInfo);

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

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

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

@@ -1,14 +1,14 @@
 export interface IOnPageNonIndexableItem {
-    /** the reason why the page is non-indexable can take the following values: robots_txt, meta_tag, http_header, attribute, too_many_redirects */
+    /** *the reason why the page is non-indexable* can take the following values: `robots_txt`, `meta_tag`, `http_header`, `attribute`, `too_many_redirects` */
     reason?: string | undefined;
-    /** url of the non-indexable page */
+    /** *url of the non-indexable page* */
     url?: string | undefined;
     [key: string]: any;
 }
 export declare class OnPageNonIndexableItem implements IOnPageNonIndexableItem {
-    /** the reason why the page is non-indexable can take the following values: robots_txt, meta_tag, http_header, attribute, too_many_redirects */
+    /** *the reason why the page is non-indexable* can take the following values: `robots_txt`, `meta_tag`, `http_header`, `attribute`, `too_many_redirects` */
     reason?: string | undefined;
-    /** url of the non-indexable page */
+    /** *url of the non-indexable page* */
     url?: string | undefined;
     [key: string]: any;
     constructor(data?: IOnPageNonIndexableItem);

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

@@ -1,22 +1,22 @@
 export interface IOnPageNonIndexableRequestInfo {
-    /** 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;
-    /** the maximum number of returned pages optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned pages* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned pages optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
+    /** *offset in the results array of returned pages* optional field default value: `0` maximum value: `2000000` if you specify the `10` value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
     offset?: number | undefined;
-    /** 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: ['reason','=','robots_txt'][['reason','<>','robots_txt'], 'and', ['url','not_like','%/wp-admin/%']] [['url','not_like','%/wp-admin/%'], 'and', [['reason','<>','meta_tag'],'or',['reason','<>','http_header']]] 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: `[['reason','<>','robots_txt'],'and',['url','not_like','%/wp-admin/%']]` `[['url','not_like','%/wp-admin/%'],'and',[['reason','<>','meta_tag'],'or',['reason','<>','http_header']]]` The full list of possible filters is available [by this link.](/v3/on_page/filters_and_thresholds/?bash) */
     filters?: any[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageNonIndexableRequestInfo implements IOnPageNonIndexableRequestInfo {
-    /** 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;
-    /** the maximum number of returned pages optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned pages* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned pages optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
+    /** *offset in the results array of returned pages* optional field default value: `0` maximum value: `2000000` if you specify the `10` value, the first ten pages in the results array will be omitted and the data will be provided for the successive pages */
     offset?: number | undefined;
-    /** 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: ['reason','=','robots_txt'][['reason','<>','robots_txt'], 'and', ['url','not_like','%/wp-admin/%']] [['url','not_like','%/wp-admin/%'], 'and', [['reason','<>','meta_tag'],'or',['reason','<>','http_header']]] 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: `[['reason','<>','robots_txt'],'and',['url','not_like','%/wp-admin/%']]` `[['url','not_like','%/wp-admin/%'],'and',[['reason','<>','meta_tag'],'or',['reason','<>','http_header']]]` The full list of possible filters is available [by this link.](/v3/on_page/filters_and_thresholds/?bash) */
     filters?: any[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageNonIndexableRequestInfo);

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

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

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

@@ -1,28 +1,28 @@
 import { CrawlStatusInfo } from "./CrawlStatusInfo";
 import { OnPageNonIndexableItem } from "./OnPageNonIndexableItem";
 export interface IOnPageNonIndexableResultInfo {
-    /** 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 in the database */
+    /** *total number of relevant items in the database* */
     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?: OnPageNonIndexableItem[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageNonIndexableResultInfo implements IOnPageNonIndexableResultInfo {
-    /** 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 in the database */
+    /** *total number of relevant items in the database* */
     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?: OnPageNonIndexableItem[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageNonIndexableResultInfo);

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

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

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

@@ -1,50 +1,50 @@
 export interface IOnPagePageScreenshotRequestInfo {
-    /** page url required field absolute URL of the page to snap note: if the URL you indicate here returns a 404 status code or the indicated value is not a valid URL, you will obtain 'error_message':'Screenshot is empty' in the response array */
+    /** *page url* **required field** absolute URL of the page to snap **note:** if the URL you indicate here returns a 404 status code or the indicated value is not a valid URL, you will obtain `'error_message':'Screenshot is empty'` in the response array */
     url?: string | 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, you will obtain 'error_message':'Screenshot is empty' 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, you will obtain `'error_message':'Screenshot is empty'` in the response array */
     accept_language?: 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: in this endpoint, the enable_browser_rendering, enable_javascript, load_resources, and enable_xhr parameters are always enabled. */
+    /** *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:** in this endpoint, the `enable_browser_rendering`, `enable_javascript`, `load_resources`, and `enable_xhr` parameters are always enabled. */
     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; 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; 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; 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; 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; 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; minimum value: `0.5`  maximum value: `3` */
     browser_screen_scale_factor?: number | undefined;
-    /** take a screenshot of the full page optional field set to false if you want to capture only the part of the page displayed before scrolling default value: true */
+    /** *take a screenshot of the full page* optional field set to `false` if you want to capture only the part of the page displayed before scrolling default value: `true` */
     full_page_screenshot?: 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;
-    /** 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 OnPagePageScreenshotRequestInfo implements IOnPagePageScreenshotRequestInfo {
-    /** page url required field absolute URL of the page to snap note: if the URL you indicate here returns a 404 status code or the indicated value is not a valid URL, you will obtain 'error_message':'Screenshot is empty' in the response array */
+    /** *page url* **required field** absolute URL of the page to snap **note:** if the URL you indicate here returns a 404 status code or the indicated value is not a valid URL, you will obtain `'error_message':'Screenshot is empty'` in the response array */
     url?: string | 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, you will obtain 'error_message':'Screenshot is empty' 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, you will obtain `'error_message':'Screenshot is empty'` in the response array */
     accept_language?: 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: in this endpoint, the enable_browser_rendering, enable_javascript, load_resources, and enable_xhr parameters are always enabled. */
+    /** *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:** in this endpoint, the `enable_browser_rendering`, `enable_javascript`, `load_resources`, and `enable_xhr` parameters are always enabled. */
     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; 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; 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; 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; 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; 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; minimum value: `0.5`  maximum value: `3` */
     browser_screen_scale_factor?: number | undefined;
-    /** take a screenshot of the full page optional field set to false if you want to capture only the part of the page displayed before scrolling default value: true */
+    /** *take a screenshot of the full page* optional field set to `false` if you want to capture only the part of the page displayed before scrolling default value: `true` */
     full_page_screenshot?: 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;
-    /** 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?: IOnPagePageScreenshotRequestInfo);

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

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

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

@@ -1,23 +1,23 @@
 import { ScreenshotItem } from "./ScreenshotItem";
 export interface IOnPagePageScreenshotResultInfo {
-    /** status of the crawling session possible values: in_progress, finished */
+    /** *status of the crawling session* possible values: `in_progress`, `finished` */
     crawl_progress?: string | undefined;
-    /** error message if the url you indicated returns a 404 status code or is not a valid URL, you will obtain 'error_message':'Screenshot is empty' if no error is encountered, the value will be null */
+    /** *error message* if the `url` you indicated returns a 404 status code or is not a valid URL, you will obtain `'error_message':'Screenshot is empty'` if no error is encountered, the value will be `null` */
     error_message?: 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?: ScreenshotItem[] | undefined;
     [key: string]: any;
 }
 export declare class OnPagePageScreenshotResultInfo implements IOnPagePageScreenshotResultInfo {
-    /** status of the crawling session possible values: in_progress, finished */
+    /** *status of the crawling session* possible values: `in_progress`, `finished` */
     crawl_progress?: string | undefined;
-    /** error message if the url you indicated returns a 404 status code or is not a valid URL, you will obtain 'error_message':'Screenshot is empty' if no error is encountered, the value will be null */
+    /** *error message* if the `url` you indicated returns a 404 status code or is not a valid URL, you will obtain `'error_message':'Screenshot is empty'` if no error is encountered, the value will be `null` */
     error_message?: 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?: ScreenshotItem[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPagePageScreenshotResultInfo);

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

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