dataforseo-client 2.1.1 → 2.1.3

package/dist/cjs/models/SerpBingOrganicTaskGetRegularResultInfo.d.ts

@@ -2,64 +2,64 @@ import { SpellInfo } from "./SpellInfo";
 import { RefinementChipsInfo } from "./RefinementChipsInfo";
 import { BaseBingSerpApiElementItem } from "./BaseBingSerpApiElementItem";
 export interface ISerpBingOrganicTaskGetRegularResultInfo {
-    /** keyword received in a POST array keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character) */
+    /** *keyword received in a POST array* **keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)** */
     keyword?: string | undefined;
     /** type of element */
     type?: string | undefined;
-    /** search engine domain in a POST array */
+    /** *search engine domain in a POST array* */
     se_domain?: string | undefined;
-    /** location code in a POST array */
+    /** *location code in a POST array* */
     location_code?: number | undefined;
-    /** language code in a POST array */
+    /** *language code in a POST array* */
     language_code?: string | undefined;
-    /** direct URL to search engine results you can use it to make sure that we provided accurate results */
+    /** *direct URL to search engine results* you can use it to make sure that we provided accurate results */
     check_url?: string | undefined;
-    /** date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when the result was received* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
     datetime?: string | undefined;
-    /** autocorrection of the search engine if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection */
+    /** *autocorrection of the search engine* if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection */
     spell?: SpellInfo | undefined;
-    /** search refinement chips equals null */
+    /** *search refinement chips* equals `null` */
     refinement_chips?: RefinementChipsInfo | undefined;
-    /** types of search results in SERP contains types of search results (items) found in SERP. possible item types: organic, paid */
+    /** *types of search results in SERP* contains types of search results (`items`) found in SERP. possible item types: `organic`, `paid` */
     item_types?: string[] | undefined;
-    /** total number of results in SERP */
+    /** *total number of results in SERP* */
     se_results_count?: number | undefined;
-    /** total pages retrieved total number of retrieved SERPs in the result */
+    /** *total pages retrieved* total number of retrieved SERPs in the result */
     pages_count?: number | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the **`items`** array* */
     items_count?: number | undefined;
-    /** items inside the element array of 8 search queries related to the keyword */
+    /** *items inside the element* array of 8 search queries related to the keyword */
     items?: BaseBingSerpApiElementItem[] | undefined;
     [key: string]: any;
 }
 export declare class SerpBingOrganicTaskGetRegularResultInfo implements ISerpBingOrganicTaskGetRegularResultInfo {
-    /** keyword received in a POST array keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character) */
+    /** *keyword received in a POST array* **keyword is returned with decoded %## (plus symbol '+' will be decoded to a space character)** */
     keyword?: string | undefined;
     /** type of element */
     type?: string | undefined;
-    /** search engine domain in a POST array */
+    /** *search engine domain in a POST array* */
     se_domain?: string | undefined;
-    /** location code in a POST array */
+    /** *location code in a POST array* */
     location_code?: number | undefined;
-    /** language code in a POST array */
+    /** *language code in a POST array* */
     language_code?: string | undefined;
-    /** direct URL to search engine results you can use it to make sure that we provided accurate results */
+    /** *direct URL to search engine results* you can use it to make sure that we provided accurate results */
     check_url?: string | undefined;
-    /** date and time when the result was received in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when the result was received* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
     datetime?: string | undefined;
-    /** autocorrection of the search engine if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection */
+    /** *autocorrection of the search engine* if the search engine provided results for a keyword that was corrected, we will specify the keyword corrected by the search engine and the type of autocorrection */
     spell?: SpellInfo | undefined;
-    /** search refinement chips equals null */
+    /** *search refinement chips* equals `null` */
     refinement_chips?: RefinementChipsInfo | undefined;
-    /** types of search results in SERP contains types of search results (items) found in SERP. possible item types: organic, paid */
+    /** *types of search results in SERP* contains types of search results (`items`) found in SERP. possible item types: `organic`, `paid` */
     item_types?: string[] | undefined;
-    /** total number of results in SERP */
+    /** *total number of results in SERP* */
     se_results_count?: number | undefined;
-    /** total pages retrieved total number of retrieved SERPs in the result */
+    /** *total pages retrieved* total number of retrieved SERPs in the result */
     pages_count?: number | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the **`items`** array* */
     items_count?: number | undefined;
-    /** items inside the element array of 8 search queries related to the keyword */
+    /** *items inside the element* array of 8 search queries related to the keyword */
     items?: BaseBingSerpApiElementItem[] | undefined;
     [key: string]: any;
     constructor(data?: ISerpBingOrganicTaskGetRegularResultInfo);

package/dist/cjs/models/SerpBingOrganicTaskGetRegularTaskInfo.d.ts

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

package/dist/cjs/models/SerpBingOrganicTaskPostRequestInfo.d.ts

@@ -1,103 +1,103 @@
 import { SerpApiStopCrawlOnMatchInfo } from "./SerpApiStopCrawlOnMatchInfo";
 export interface ISerpBingOrganicTaskPostRequestInfo {
-    /** keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the '%' character for your keyword, please specify it as '%25'; if you need to use the “+” character for your keyword, please specify it as “%2B” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** *keyword* **required field** you can specify **up to 700 characters** in the `keyword` field **all %## will be decoded (plus character '+' will be decoded to a space character)** if you need to use the '%' character for your `keyword`, please specify it as '%25'; if you need to use the “+” character for your `keyword`, please specify it as “%2B” learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) */
     keyword?: string | undefined;
-    /** search engine location code required field if you don't specify location_name or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/bing/locations example: 2840 */
+    /** *search engine location code* **required field if you don't specify** `location_name` or `location_coordinate` **if you use this field, you don't need to specify `location_name` or `location_coordinate`** you can receive the list of available locations of the search engines with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations` example: `2840` */
     location_code?: number | undefined;
-    /** search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/bing/languages example: en */
+    /** *search engine language code* **required field if you don't specify** `language_name` **if you use this field, you don't need to specify `language_name`** you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages`**example:**`en` */
     language_code?: string | undefined;
-    /** parsing depth optional field number of results in SERP default value: 10 max value: 700 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page. */
+    /** *parsing depth* optional field number of results in SERP default value: `10` max value: `700` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges [if the search engine returns more than 10 results](https://dataforseo.com/help-center/how-many-results-scraped); The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/serp/bing-organic-serp-api) page. */
     depth?: number | undefined;
-    /** task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page. */
+    /** *task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/serp/bing-organic-serp-api) page. */
     priority?: number | undefined;
-    /** device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop */
+    /** *device type* optional field return results for a specific device type can take the values:`desktop`, `mobile` default value: `desktop` */
     device?: string | undefined;
-    /** notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center */
+    /** *notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
     pingback_url?: string | undefined;
-    /** URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center */
+    /** *URL for sending task results* optional field once the task is completed, we will send a POST request with its results compressed in the `gzip` format to the `postback_url` you specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/postbackscript?id=$id` `http://your-server.com/postbackscript?id=$id&tag=$tag` **Note:** special characters in `postback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
     postback_url?: string | undefined;
-    /** postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: regular, advanced, html */
+    /** *postback_url datatype* **required field if you specify `postback_url`** corresponds to the datatype that will be sent to your server possible values: `regular`, `advanced`, `html` */
     postback_data?: string | undefined;
-    /** full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/bing/locations example: London,England,United Kingdom */
+    /** *full name of search engine location* **required field if you don't specify** `location_code` or `location_coordinate` **if you use this field, you don't need to specify `location_code` or `location_coordinate`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations` example: `London,England,United Kingdom` */
     location_name?: string | undefined;
-    /** full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/bing/languages example: English */
+    /** *full name of search engine language* **required field if you don't specify** `language_code` **if you use this field, you don't need to specify `language_code`** you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages` example: `English` */
     language_name?: string | undefined;
-    /** device operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, choose from the following values: android, ios default value: android */
+    /** *device operating system* optional field if you specify `desktop` in the `device` field, choose from the following values: `windows`, `macos` default value: `windows` if you specify `mobile` in the `device` field, choose from the following values: `android`, `ios` default value: `android` */
     os?: 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;
     /** array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: 'stop_crawl_on_match':[{'match_value':'dataforseo.com','match_type':'with_subdomains'}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets */
     stop_crawl_on_match?: SerpApiStopCrawlOnMatchInfo[] | undefined;
-    /** target match type required field if stop_crawl_on_match is specified type of match for the match_value possible values: domain – specific domain or subdomain with_subdomains – main domain and subdomains wildcard –  wildcard pattern */
+    /** *target match type* **required field if `stop_crawl_on_match` is specified** type of match for the `match_value` possible values: `domain` – specific domain or subdomain `with_subdomains` – main domain and subdomains `wildcard` –  wildcard pattern */
     match_type?: string | undefined;
-    /** target domain, subdomain, or wildcard value required field if stop_crawl_on_match is specified specify a target domain, subdomain, or wildcard value; Note: domain or subdomain must be specified without a request protocol; example: 'match_value': 'dataforseo.com', 'match_value': '/blog/post-*' */
+    /** *target domain, subdomain, or wildcard value* **required field if `stop_crawl_on_match` is specified** specify a target domain, subdomain, or wildcard value; **Note:** domain or subdomain must be specified without a request protocol; example: `'match_value': 'dataforseo.com'`, `'match_value': '/blog/post-*'` */
     match_value?: string | undefined;
-    /** page crawl limit optional field number of search results pages to crawl default value: 1 max value: 100 Note: the max_crawl_pages and depth parameters complement each other; learn more at our help center */
+    /** *page crawl limit* optional field number of search results pages to crawl default value: `1` max value: `100` **Note:** the `max_crawl_pages` and `depth` parameters complement each other; learn more at [our help center](https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work) */
     max_crawl_pages?: number | undefined;
-    /** additional parameters of the search query optional field get the list of available parameters and additional details here */
+    /** *additional parameters of the search query* optional field [get the list of available parameters and additional details here](https://dataforseo.com/help-center/bing-search-engine-parameters-and-how-to-use-them) */
     search_param?: string | undefined;
-    /** calcualte pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to false Note: you will be charged extra $0.0006 for using this parameter */
+    /** *calcualte pixel rankings for SERP elements in advanced results* optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; [Visit Help Center to learn more>>](https://dataforseo.com/help-center/pixel-ranking-in-serp-api) by default, the parameter is set to `false` **Note:** you will be charged extra $0.0006 for using this parameter */
     calculate_rectangles?: boolean | undefined;
-    /** browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: 240-9999; by default, the parameter is set to: 1920 for desktop; 360 for mobile on android; 375 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true */
+    /** *browser screen width* optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: `240-9999`; by default, the parameter is set to: `1920` for `desktop`; `360` for `mobile` on `android`; `375` for `mobile` on `iOS`; **Note:** to use this parameter, set `calculate_rectangles` to `true` */
     browser_screen_width?: number | undefined;
-    /** browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: 240-9999; by default, the parameter is set to: 1080 for desktop; 640 for mobile on android; 812 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true */
+    /** *browser screen height* optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: `240-9999`; by default, the parameter is set to: `1080` for `desktop`; `640` for `mobile` on `android`; `812` for `mobile` on `iOS`; **Note:** to use this parameter, set `calculate_rectangles` to `true` */
     browser_screen_height?: number | undefined;
-    /** browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: 0.5-3; by default, the parameter is set to: 1 for desktop; 3 for mobile on android; 3 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true */
+    /** *browser screen resolution ratio* optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: `0.5-3`; by default, the parameter is set to: `1` for `desktop`; `3` for `mobile` on `android`; `3` for `mobile` on `iOS`; **Note:** to use this parameter, set `calculate_rectangles` to `true` */
     browser_screen_resolution_ratio?: number | undefined;
-    /** direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE */
+    /** *direct URL of the search query* optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: `https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE` */
     url?: string | undefined;
-    /** GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the 'latitude,longitude' format the maximum number of decimal digits for 'latitude' and 'longitude': 7 example: 53.476225,-2.243572 */
+    /** *GPS coordinates of a location* **required field if you don't specify** `location_name` or `location_code` **if you use this field, you don't need to specify `location_name` or `location_code`** `location_coordinate` parameter should be specified in the *'latitude,longitude'* format the maximum number of decimal digits for *'latitude'* and *'longitude'*: 7 example: `53.476225,-2.243572` */
     location_coordinate?: string | undefined;
     [key: string]: any;
 }
 export declare class SerpBingOrganicTaskPostRequestInfo implements ISerpBingOrganicTaskPostRequestInfo {
-    /** keyword required field you can specify up to 700 characters in the keyword field all %## will be decoded (plus character '+' will be decoded to a space character) if you need to use the '%' character for your keyword, please specify it as '%25'; if you need to use the “+” character for your keyword, please specify it as “%2B” learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** *keyword* **required field** you can specify **up to 700 characters** in the `keyword` field **all %## will be decoded (plus character '+' will be decoded to a space character)** if you need to use the '%' character for your `keyword`, please specify it as '%25'; if you need to use the “+” character for your `keyword`, please specify it as “%2B” learn more about rules and limitations of `keyword` and `keywords` fields in DataForSEO APIs in this [Help Center article](https://dataforseo.com/help-center/rules-and-limitations-of-keyword-and-keywords-fields-in-dataforseo-apis) */
     keyword?: string | undefined;
-    /** search engine location code required field if you don't specify location_name or location_coordinate if you use this field, you don't need to specify location_name or location_coordinate you can receive the list of available locations of the search engines with their location_code by making a separate request to the https://api.dataforseo.com/v3/serp/bing/locations example: 2840 */
+    /** *search engine location code* **required field if you don't specify** `location_name` or `location_coordinate` **if you use this field, you don't need to specify `location_name` or `location_coordinate`** you can receive the list of available locations of the search engines with their `location_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations` example: `2840` */
     location_code?: number | undefined;
-    /** search engine language code required field if you don't specify language_name if you use this field, you don't need to specify language_name you can receive the list of available languages of the search engine with their language_code by making a separate request to the https://api.dataforseo.com/v3/serp/bing/languages example: en */
+    /** *search engine language code* **required field if you don't specify** `language_name` **if you use this field, you don't need to specify `language_name`** you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages`**example:**`en` */
     language_code?: string | undefined;
-    /** parsing depth optional field number of results in SERP default value: 10 max value: 700 Your account will be billed per each SERP containing up to 10 results; Setting depth above 10 may result in additional charges if the search engine returns more than 10 results; The cost can be calculated on the Pricing page. */
+    /** *parsing depth* optional field number of results in SERP default value: `10` max value: `700` **Your account will be billed per each SERP containing up to 10 results;** Setting depth above 10 may result in additional charges [if the search engine returns more than 10 results](https://dataforseo.com/help-center/how-many-results-scraped); The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/serp/bing-organic-serp-api) page. */
     depth?: number | undefined;
-    /** task priority optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the Pricing page. */
+    /** *task priority* optional field can take the following values: 1 – normal execution priority (set by default) 2 – high execution priority You will be additionally charged for the tasks with high execution priority. The cost can be calculated on the [Pricing](https://dataforseo.com/pricing/serp/bing-organic-serp-api) page. */
     priority?: number | undefined;
-    /** device type optional field return results for a specific device type can take the values:desktop, mobile default value: desktop */
+    /** *device type* optional field return results for a specific device type can take the values:`desktop`, `mobile` default value: `desktop` */
     device?: string | undefined;
-    /** notification URL of a completed task optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/pingscript?id=$id http://your-server.com/pingscript?id=$id&tag=$tag Note: special characters in pingback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center */
+    /** *notification URL of a completed task* optional field when a task is completed we will notify you by GET request sent to the URL you have specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/pingscript?id=$id` `http://your-server.com/pingscript?id=$id&tag=$tag` **Note:** special characters in `pingback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
     pingback_url?: string | undefined;
-    /** URL for sending task results optional field once the task is completed, we will send a POST request with its results compressed in the gzip format to the postback_url you specified you can use the ‘$id’ string as a $id variable and ‘$tag’ as urlencoded $tag variable. We will set the necessary values before sending the request. example: http://your-server.com/postbackscript?id=$id http://your-server.com/postbackscript?id=$id&tag=$tag Note: special characters in postback_url will be urlencoded; i.a., the # character will be encoded into %23 learn more on our Help Center */
+    /** *URL for sending task results* optional field once the task is completed, we will send a POST request with its results compressed in the `gzip` format to the `postback_url` you specified you can use the ‘$id’ string as a `$id` variable and ‘$tag’ as urlencoded `$tag` variable. We will set the necessary values before sending the request. example: `http://your-server.com/postbackscript?id=$id` `http://your-server.com/postbackscript?id=$id&tag=$tag` **Note:** special characters in `postback_url` will be urlencoded; i.a., the `#` character will be encoded into `%23` learn more on our [Help Center](https://dataforseo.com/help-center/pingbacks-postbacks-with-dataforseo-api) */
     postback_url?: string | undefined;
-    /** postback_url datatype required field if you specify postback_url corresponds to the datatype that will be sent to your server possible values: regular, advanced, html */
+    /** *postback_url datatype* **required field if you specify `postback_url`** corresponds to the datatype that will be sent to your server possible values: `regular`, `advanced`, `html` */
     postback_data?: string | undefined;
-    /** full name of search engine location required field if you don't specify location_code or location_coordinate if you use this field, you don't need to specify location_code or location_coordinate you can receive the list of available locations of the search engine with their location_name by making a separate request to the https://api.dataforseo.com/v3/serp/bing/locations example: London,England,United Kingdom */
+    /** *full name of search engine location* **required field if you don't specify** `location_code` or `location_coordinate` **if you use this field, you don't need to specify `location_code` or `location_coordinate`** you can receive the list of available locations of the search engine with their `location_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations` example: `London,England,United Kingdom` */
     location_name?: string | undefined;
-    /** full name of search engine language required field if you don't specify language_code if you use this field, you don't need to specify language_code you can receive the list of available languages of the search engine with their language_name by making a separate request to the https://api.dataforseo.com/v3/serp/bing/languages example: English */
+    /** *full name of search engine language* **required field if you don't specify** `language_code` **if you use this field, you don't need to specify `language_code`** you can receive the list of available languages of the search engine with their `language_name` by making a separate request to the `https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages` example: `English` */
     language_name?: string | undefined;
-    /** device operating system optional field if you specify desktop in the device field, choose from the following values: windows, macos default value: windows if you specify mobile in the device field, choose from the following values: android, ios default value: android */
+    /** *device operating system* optional field if you specify `desktop` in the `device` field, choose from the following values: `windows`, `macos` default value: `windows` if you specify `mobile` in the `device` field, choose from the following values: `android`, `ios` default value: `android` */
     os?: 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;
     /** array of targets to stop crawling optional field if specified, the response will contain SERP results up to and including the specified match_value; you can specify up to 10 target values in this array example: 'stop_crawl_on_match':[{'match_value':'dataforseo.com','match_type':'with_subdomains'}] learn more about this parameter on our Help Center - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api Your account will be billed per each SERP crawled through the specified targets */
     stop_crawl_on_match?: SerpApiStopCrawlOnMatchInfo[] | undefined;
-    /** target match type required field if stop_crawl_on_match is specified type of match for the match_value possible values: domain – specific domain or subdomain with_subdomains – main domain and subdomains wildcard –  wildcard pattern */
+    /** *target match type* **required field if `stop_crawl_on_match` is specified** type of match for the `match_value` possible values: `domain` – specific domain or subdomain `with_subdomains` – main domain and subdomains `wildcard` –  wildcard pattern */
     match_type?: string | undefined;
-    /** target domain, subdomain, or wildcard value required field if stop_crawl_on_match is specified specify a target domain, subdomain, or wildcard value; Note: domain or subdomain must be specified without a request protocol; example: 'match_value': 'dataforseo.com', 'match_value': '/blog/post-*' */
+    /** *target domain, subdomain, or wildcard value* **required field if `stop_crawl_on_match` is specified** specify a target domain, subdomain, or wildcard value; **Note:** domain or subdomain must be specified without a request protocol; example: `'match_value': 'dataforseo.com'`, `'match_value': '/blog/post-*'` */
     match_value?: string | undefined;
-    /** page crawl limit optional field number of search results pages to crawl default value: 1 max value: 100 Note: the max_crawl_pages and depth parameters complement each other; learn more at our help center */
+    /** *page crawl limit* optional field number of search results pages to crawl default value: `1` max value: `100` **Note:** the `max_crawl_pages` and `depth` parameters complement each other; learn more at [our help center](https://dataforseo.com/help-center/what-is-max-crawl-pages-and-how-does-it-work) */
     max_crawl_pages?: number | undefined;
-    /** additional parameters of the search query optional field get the list of available parameters and additional details here */
+    /** *additional parameters of the search query* optional field [get the list of available parameters and additional details here](https://dataforseo.com/help-center/bing-search-engine-parameters-and-how-to-use-them) */
     search_param?: string | undefined;
-    /** calcualte pixel rankings for SERP elements in advanced results optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; Visit Help Center to learn more>> by default, the parameter is set to false Note: you will be charged extra $0.0006 for using this parameter */
+    /** *calcualte pixel rankings for SERP elements in advanced results* optional field pixel ranking refers to the distance between the result snippet and top left corner of the screen; [Visit Help Center to learn more>>](https://dataforseo.com/help-center/pixel-ranking-in-serp-api) by default, the parameter is set to `false` **Note:** you will be charged extra $0.0006 for using this parameter */
     calculate_rectangles?: boolean | undefined;
-    /** browser screen width optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: 240-9999; by default, the parameter is set to: 1920 for desktop; 360 for mobile on android; 375 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true */
+    /** *browser screen width* optional field you can set a custom browser screen width to calculate pixel rankings for a particular device; can be specified within the following range: `240-9999`; by default, the parameter is set to: `1920` for `desktop`; `360` for `mobile` on `android`; `375` for `mobile` on `iOS`; **Note:** to use this parameter, set `calculate_rectangles` to `true` */
     browser_screen_width?: number | undefined;
-    /** browser screen height optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: 240-9999; by default, the parameter is set to: 1080 for desktop; 640 for mobile on android; 812 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true */
+    /** *browser screen height* optional field you can set a custom browser screen height to calculate pixel rankings for a particular device; can be specified within the following range: `240-9999`; by default, the parameter is set to: `1080` for `desktop`; `640` for `mobile` on `android`; `812` for `mobile` on `iOS`; **Note:** to use this parameter, set `calculate_rectangles` to `true` */
     browser_screen_height?: number | undefined;
-    /** browser screen resolution ratio optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: 0.5-3; by default, the parameter is set to: 1 for desktop; 3 for mobile on android; 3 for mobile on iOS; Note: to use this parameter, set calculate_rectangles to true */
+    /** *browser screen resolution ratio* optional field you can set a custom browser screen resolution ratio to calculate pixel rankings for a particular device; can be specified within the following range: `0.5-3`; by default, the parameter is set to: `1` for `desktop`; `3` for `mobile` on `android`; `3` for `mobile` on `iOS`; **Note:** to use this parameter, set `calculate_rectangles` to `true` */
     browser_screen_resolution_ratio?: number | undefined;
-    /** direct URL of the search query optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE */
+    /** *direct URL of the search query* optional field you can specify a direct URL and we will sort it out to the necessary fields. Note that this method is the most difficult for our API to process and also requires you to specify the exact language and location in the URL. In most cases, we wouldn’t recommend using this method. example: `https://www.bing.com/search?q=rank%20checker&count=50&first=1&setlang=en&cc=US&safesearch=Moderate&FORM=SEPAGE` */
     url?: string | undefined;
-    /** GPS coordinates of a location required field if you don't specify location_name or location_code if you use this field, you don't need to specify location_name or location_code location_coordinate parameter should be specified in the 'latitude,longitude' format the maximum number of decimal digits for 'latitude' and 'longitude': 7 example: 53.476225,-2.243572 */
+    /** *GPS coordinates of a location* **required field if you don't specify** `location_name` or `location_code` **if you use this field, you don't need to specify `location_name` or `location_code`** `location_coordinate` parameter should be specified in the *'latitude,longitude'* format the maximum number of decimal digits for *'latitude'* and *'longitude'*: 7 example: `53.476225,-2.243572` */
     location_coordinate?: string | undefined;
     [key: string]: any;
     constructor(data?: ISerpBingOrganicTaskPostRequestInfo);

package/dist/cjs/models/SerpBingOrganicTaskPostResponseInfo.d.ts

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

package/dist/cjs/models/SerpBingOrganicTaskPostTaskInfo.d.ts

@@ -1,11 +1,11 @@
 import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
 export interface ISerpBingOrganicTaskPostTaskInfo extends IBaseResponseTaskInfo {
-    /** array of results in this case, the value will be null */
+    /** *array of results* in this case, the value will be `null` */
     result?: any | undefined;
     [key: string]: any;
 }
 export declare class SerpBingOrganicTaskPostTaskInfo extends BaseResponseTaskInfo implements ISerpBingOrganicTaskPostTaskInfo {
-    /** array of results in this case, the value will be null */
+    /** *array of results* in this case, the value will be `null` */
     result?: any | undefined;
     [key: string]: any;
     constructor(data?: ISerpBingOrganicTaskPostTaskInfo);

package/dist/cjs/models/SerpBingOrganicTasksFixedResponseInfo.d.ts

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

package/dist/cjs/models/SerpBingOrganicTasksFixedResultInfo.d.ts

@@ -1,36 +1,36 @@
 export interface ISerpBingOrganicTasksFixedResultInfo {
-    /** task identifier of the completed task unique task identifier in our system in the UUID format */
+    /** *task identifier of the completed task* **unique task identifier in our system in the [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format** */
     id?: string | undefined;
-    /** search engine specified when setting the task */
+    /** *search engine specified when setting the task* */
     se?: string | undefined;
-    /** type of search engine can take the following values: organic */
+    /** *type of search engine* can take the following values: `{{low_se_type_under}}` */
     se_type?: string | undefined;
     date_posted?: string | undefined;
-    /** user-defined task identifier */
+    /** *user-defined task identifier* */
     tag?: string | undefined;
-    /** URL for collecting the results of the SERP Regular task if SERP Regular is not supported in the specified endpoint, the value will be null */
+    /** *URL for collecting the results of the SERP Regular task* if SERP Regular is not supported in the specified endpoint, the value will be `null` */
     endpoint_regular?: string | undefined;
-    /** URL for collecting the results of the SERP Advanced task if SERP Advanced is not supported in the specified endpoint, the value will be null */
+    /** *URL for collecting the results of the SERP Advanced task* if SERP Advanced is not supported in the specified endpoint, the value will be `null` */
     endpoint_advanced?: string | undefined;
-    /** URL for collecting the results of the SERP HTML task if SERP HTML is not supported in the specified endpoint, the value will be null */
+    /** *URL for collecting the results of the SERP HTML task* if SERP HTML is not supported in the specified endpoint, the value will be `null` */
     endpoint_html?: string | undefined;
     [key: string]: any;
 }
 export declare class SerpBingOrganicTasksFixedResultInfo implements ISerpBingOrganicTasksFixedResultInfo {
-    /** task identifier of the completed task unique task identifier in our system in the UUID format */
+    /** *task identifier of the completed task* **unique task identifier in our system in the [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format** */
     id?: string | undefined;
-    /** search engine specified when setting the task */
+    /** *search engine specified when setting the task* */
     se?: string | undefined;
-    /** type of search engine can take the following values: organic */
+    /** *type of search engine* can take the following values: `{{low_se_type_under}}` */
     se_type?: string | undefined;
     date_posted?: string | undefined;
-    /** user-defined task identifier */
+    /** *user-defined task identifier* */
     tag?: string | undefined;
-    /** URL for collecting the results of the SERP Regular task if SERP Regular is not supported in the specified endpoint, the value will be null */
+    /** *URL for collecting the results of the SERP Regular task* if SERP Regular is not supported in the specified endpoint, the value will be `null` */
     endpoint_regular?: string | undefined;
-    /** URL for collecting the results of the SERP Advanced task if SERP Advanced is not supported in the specified endpoint, the value will be null */
+    /** *URL for collecting the results of the SERP Advanced task* if SERP Advanced is not supported in the specified endpoint, the value will be `null` */
     endpoint_advanced?: string | undefined;
-    /** URL for collecting the results of the SERP HTML task if SERP HTML is not supported in the specified endpoint, the value will be null */
+    /** *URL for collecting the results of the SERP HTML task* if SERP HTML is not supported in the specified endpoint, the value will be `null` */
     endpoint_html?: string | undefined;
     [key: string]: any;
     constructor(data?: ISerpBingOrganicTasksFixedResultInfo);

package/dist/cjs/models/SerpBingOrganicTasksFixedTaskInfo.d.ts

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

package/dist/cjs/models/SerpBingOrganicTasksReadyResponseInfo.d.ts

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

package/dist/cjs/models/SerpBingOrganicTasksReadyResultInfo.d.ts

@@ -1,38 +1,38 @@
 export interface ISerpBingOrganicTasksReadyResultInfo {
-    /** task identifier of the completed task unique task identifier in our system in the UUID format */
+    /** *task identifier of the completed task* **unique task identifier in our system in the [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format** */
     id?: string | undefined;
-    /** search engine specified when setting the task */
+    /** *search engine specified when setting the task* */
     se?: string | undefined;
-    /** type of search engine example: organic */
+    /** *type of search engine* example: `{{low_se_type_under}}` */
     se_type?: string | undefined;
-    /** date when the task was posted (in the UTC format) */
+    /** *date when the task was posted (in the UTC format)* */
     date_posted?: string | undefined;
-    /** user-defined task identifier */
+    /** *user-defined task identifier* */
     tag?: string | undefined;
-    /** URL for collecting the results of the SERP Regular task if SERP Regular is not supported in the specified endpoint, the value will be null */
+    /** *URL for collecting the results of the SERP Regular task* if SERP Regular is not supported in the specified endpoint, the value will be `null` */
     endpoint_regular?: string | undefined;
-    /** URL for collecting the results of the SERP Advanced task if SERP Advanced is not supported in the specified endpoint, the value will be null */
+    /** *URL for collecting the results of the SERP Advanced task* if SERP Advanced is not supported in the specified endpoint, the value will be `null` */
     endpoint_advanced?: string | undefined;
-    /** URL for collecting the results of the SERP HTML task if SERP HTML is not supported in the specified endpoint, the value will be null */
+    /** *URL for collecting the results of the SERP HTML task* if SERP HTML is not supported in the specified endpoint, the value will be `null` */
     endpoint_html?: string | undefined;
     [key: string]: any;
 }
 export declare class SerpBingOrganicTasksReadyResultInfo implements ISerpBingOrganicTasksReadyResultInfo {
-    /** task identifier of the completed task unique task identifier in our system in the UUID format */
+    /** *task identifier of the completed task* **unique task identifier in our system in the [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format** */
     id?: string | undefined;
-    /** search engine specified when setting the task */
+    /** *search engine specified when setting the task* */
     se?: string | undefined;
-    /** type of search engine example: organic */
+    /** *type of search engine* example: `{{low_se_type_under}}` */
     se_type?: string | undefined;
-    /** date when the task was posted (in the UTC format) */
+    /** *date when the task was posted (in the UTC format)* */
     date_posted?: string | undefined;
-    /** user-defined task identifier */
+    /** *user-defined task identifier* */
     tag?: string | undefined;
-    /** URL for collecting the results of the SERP Regular task if SERP Regular is not supported in the specified endpoint, the value will be null */
+    /** *URL for collecting the results of the SERP Regular task* if SERP Regular is not supported in the specified endpoint, the value will be `null` */
     endpoint_regular?: string | undefined;
-    /** URL for collecting the results of the SERP Advanced task if SERP Advanced is not supported in the specified endpoint, the value will be null */
+    /** *URL for collecting the results of the SERP Advanced task* if SERP Advanced is not supported in the specified endpoint, the value will be `null` */
     endpoint_advanced?: string | undefined;
-    /** URL for collecting the results of the SERP HTML task if SERP HTML is not supported in the specified endpoint, the value will be null */
+    /** *URL for collecting the results of the SERP HTML task* if SERP HTML is not supported in the specified endpoint, the value will be `null` */
     endpoint_html?: string | undefined;
     [key: string]: any;
     constructor(data?: ISerpBingOrganicTasksReadyResultInfo);

package/dist/cjs/models/SerpBingOrganicTasksReadyTaskInfo.d.ts

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

package/dist/cjs/models/SerpErrorsRequestInfo.d.ts

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