dataforseo-client 2.1.2 → 2.1.3

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

@@ -1,18 +1,18 @@
 export interface IOnPageResourceLocationInfo {
-    /** line number the number of the line on which the resource is located */
+    /** *line number* the number of the line on which the resource is located */
     line?: number | undefined;
-    /** position in line the number of line characters before the resource; sometimes referred to as column Note: counts from 1, i.e. if the resource doesn’t have any characters to the left, the value will be 1 */
+    /** *position in line* the number of line characters before the resource; sometimes referred to as *column* **Note:** counts from 1, i.e. if the resource doesn't have any characters to the left, the value will be 1 */
     offset_left?: number | undefined;
-    /** position in the document the total number of characters between the resource and the top of HTML */
+    /** *position in the document* the total number of characters between the resource and the top of HTML */
     offset_top?: number | undefined;
     [key: string]: any;
 }
 export declare class OnPageResourceLocationInfo implements IOnPageResourceLocationInfo {
-    /** line number the number of the line on which the resource is located */
+    /** *line number* the number of the line on which the resource is located */
     line?: number | undefined;
-    /** position in line the number of line characters before the resource; sometimes referred to as column Note: counts from 1, i.e. if the resource doesn’t have any characters to the left, the value will be 1 */
+    /** *position in line* the number of line characters before the resource; sometimes referred to as *column* **Note:** counts from 1, i.e. if the resource doesn't have any characters to the left, the value will be 1 */
     offset_left?: number | undefined;
-    /** position in the document the total number of characters between the resource and the top of HTML */
+    /** *position in the document* the total number of characters between the resource and the top of HTML */
     offset_top?: number | undefined;
     [key: string]: any;
     constructor(data?: IOnPageResourceLocationInfo);

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

@@ -1,42 +1,42 @@
 export interface IOnPageResourcesRequestInfo {
-    /** 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;
-    /** page URL optional field specify this field if you want to get the resources for a specific page note that to obtain resource’s meta from a particular URL, you should specify the URL in this field; if you do not indicate a url when setting a task, resource’s meta in the results will be returned based on the data from the page where our crawler first saw the resource */
+    /** *page URL* optional field specify this field if you want to get the resources for a specific page note that to obtain resource's `meta` from a particular URL, you should specify the URL in this field; if you do not indicate a `url` when setting a task, resource's `meta` in the results will be returned based on the data from the page where our crawler first saw the resource */
     url?: string | undefined;
-    /** the maximum number of returned resources optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned resources* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned resources optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten resources in the results array will be omitted and the data will be provided for the successive resources */
+    /** *offset in the results array of returned resources* optional field default value: `0` maximum value: `2000000` if you specify the `10` value, the first ten resources in the results array will be omitted and the data will be provided for the successive resources */
     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: ['resource_type','=','stylesheet'] [['resource_type','=','image'], 'and',['checks.is_https','=',false]] [['fetch_timing.duration_time','>',1],'and',[['total_transfer_size','>',100],'or',['checks.high_loading_time','=',true]]] 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: `['resource_type','=','stylesheet']` `[['resource_type','=','image'],'and',['checks.is_https','=',false]]` `[['fetch_timing.duration_time','>',1],'and',[['total_transfer_size','>',100],'or',['checks.high_loading_time','=',true]]]` The full list of possible filters is available [by this link.](/v3/on_page/filters_and_thresholds/?bash) */
     filters?: any[] | undefined;
-    /** filter the resources by relevant pages optional field you can use this field to obtain resources from pages matching to the defined parameters you can apply the same filters here as available for the pages endpoint 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: ['checks.no_image_title','=',true] */
+    /** *filter the resources by relevant pages* optional field you can use this field to obtain resources from pages matching to the defined parameters you can apply the same filters here as available for the [pages endpoint](/v3/on_page/pages/) **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: `['checks.no_image_title','=',true]` */
     relevant_pages_filters?: string[] | 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: ['size,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: ['size,desc','fetch_timing.fetch_end,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: `['size,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: `['size,desc','fetch_timing.fetch_end,desc']` */
     order_by?: string[] | 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 OnPageResourcesRequestInfo implements IOnPageResourcesRequestInfo {
-    /** 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;
-    /** page URL optional field specify this field if you want to get the resources for a specific page note that to obtain resource’s meta from a particular URL, you should specify the URL in this field; if you do not indicate a url when setting a task, resource’s meta in the results will be returned based on the data from the page where our crawler first saw the resource */
+    /** *page URL* optional field specify this field if you want to get the resources for a specific page note that to obtain resource's `meta` from a particular URL, you should specify the URL in this field; if you do not indicate a `url` when setting a task, resource's `meta` in the results will be returned based on the data from the page where our crawler first saw the resource */
     url?: string | undefined;
-    /** the maximum number of returned resources optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned resources* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned resources optional field default value: 0 maximum value: 2000000 if you specify the 10 value, the first ten resources in the results array will be omitted and the data will be provided for the successive resources */
+    /** *offset in the results array of returned resources* optional field default value: `0` maximum value: `2000000` if you specify the `10` value, the first ten resources in the results array will be omitted and the data will be provided for the successive resources */
     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: ['resource_type','=','stylesheet'] [['resource_type','=','image'], 'and',['checks.is_https','=',false]] [['fetch_timing.duration_time','>',1],'and',[['total_transfer_size','>',100],'or',['checks.high_loading_time','=',true]]] 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: `['resource_type','=','stylesheet']` `[['resource_type','=','image'],'and',['checks.is_https','=',false]]` `[['fetch_timing.duration_time','>',1],'and',[['total_transfer_size','>',100],'or',['checks.high_loading_time','=',true]]]` The full list of possible filters is available [by this link.](/v3/on_page/filters_and_thresholds/?bash) */
     filters?: any[] | undefined;
-    /** filter the resources by relevant pages optional field you can use this field to obtain resources from pages matching to the defined parameters you can apply the same filters here as available for the pages endpoint 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: ['checks.no_image_title','=',true] */
+    /** *filter the resources by relevant pages* optional field you can use this field to obtain resources from pages matching to the defined parameters you can apply the same filters here as available for the [pages endpoint](/v3/on_page/pages/) **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: `['checks.no_image_title','=',true]` */
     relevant_pages_filters?: string[] | 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: ['size,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: ['size,desc','fetch_timing.fetch_end,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: `['size,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: `['size,desc','fetch_timing.fetch_end,desc']` */
     order_by?: string[] | 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?: IOnPageResourcesRequestInfo);

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

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

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

@@ -1,32 +1,32 @@
 import { CrawlStatusInfo } from "./CrawlStatusInfo";
 import { BaseOnPageResourceItem } from "./BaseOnPageResourceItem";
 export interface IOnPageResourcesResultInfo {
-    /** 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 crawled */
+    /** *total number of relevant items crawled* */
     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?: BaseOnPageResourceItem[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageResourcesResultInfo implements IOnPageResourcesResultInfo {
-    /** 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 crawled */
+    /** *total number of relevant items crawled* */
     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?: BaseOnPageResourceItem[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageResourcesResultInfo);

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

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

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

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

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

@@ -2,32 +2,32 @@ import { CrawlStatusInfo } from "./CrawlStatusInfo";
 import { DomainInfo } from "./DomainInfo";
 import { PageMetrics } from "./PageMetrics";
 export interface IOnPageSummaryResultInfo {
-    /** 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;
-    /** 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;
-    /** reason why the crawling stopped information about the reason why the crawling process stopped; possible values: limit_exceeded – the limit set in the max_crawl_pages was exceeded; empty_queue – all URLs in the queue were crawled; force_stopped – the crawling process was halted using the On Page API Force Stop function; unexpected_exception – an internal error was encountered while crawling the target, contact support for more info */
+    /** *reason why the crawling stopped* information about the reason why the crawling process stopped; possible values: `limit_exceeded` - the limit set in the `max_crawl_pages` was exceeded; `empty_queue` - all URLs in the queue were crawled; `force_stopped` - the crawling process was halted using the[On Page API Force Stop](/v3/on_page/force_stop) function; `unexpected_exception` - an internal error was encountered while crawling the `target`, contact support for more info */
     crawl_stop_reason?: string | undefined;
-    /** domain-wide info on-page information about the target domain and crawling process */
+    /** *domain-wide info* on-page information about the target domain and crawling process */
     domain_info?: DomainInfo | undefined;
-    /** page-specific info metrics information on the target website pages */
+    /** *page-specific info* metrics information on the target website pages */
     page_metrics?: PageMetrics | undefined;
     [key: string]: any;
 }
 export declare class OnPageSummaryResultInfo implements IOnPageSummaryResultInfo {
-    /** 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;
-    /** 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;
-    /** reason why the crawling stopped information about the reason why the crawling process stopped; possible values: limit_exceeded – the limit set in the max_crawl_pages was exceeded; empty_queue – all URLs in the queue were crawled; force_stopped – the crawling process was halted using the On Page API Force Stop function; unexpected_exception – an internal error was encountered while crawling the target, contact support for more info */
+    /** *reason why the crawling stopped* information about the reason why the crawling process stopped; possible values: `limit_exceeded` - the limit set in the `max_crawl_pages` was exceeded; `empty_queue` - all URLs in the queue were crawled; `force_stopped` - the crawling process was halted using the[On Page API Force Stop](/v3/on_page/force_stop) function; `unexpected_exception` - an internal error was encountered while crawling the `target`, contact support for more info */
     crawl_stop_reason?: string | undefined;
-    /** domain-wide info on-page information about the target domain and crawling process */
+    /** *domain-wide info* on-page information about the target domain and crawling process */
     domain_info?: DomainInfo | undefined;
-    /** page-specific info metrics information on the target website pages */
+    /** *page-specific info* metrics information on the target website pages */
     page_metrics?: PageMetrics | undefined;
     [key: string]: any;
     constructor(data?: IOnPageSummaryResultInfo);

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

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