dataforseo-client 2.1.2 → 2.1.3

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

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

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

@@ -2,64 +2,64 @@ import { SpellInfo } from "./SpellInfo";
 import { RefinementChipsInfo } from "./RefinementChipsInfo";
 import { BaseBingSerpApiElementItem } from "./BaseBingSerpApiElementItem";
 export interface ISerpBingOrganicLiveAdvancedResultInfo {
-    /** keyword received in a POST array the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
+    /** *keyword received in a POST array***the keyword is returned with decoded %## (plus character '+' 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 equals null */
+    /** *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             equals `null` */
     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: answer_box, carousel, events, featured_snippet, hotels_pack, images, jobs, local_pack, map, organic, paid, people_also_ask, people_also_search, questions_and_answers,recipes, related_searches, shopping, top_stories, video, ai_overview */
+    /** *types of search results in SERP*             contains types of search results (`items`) found in SERP.             possible item types:             [answer_box](#answer_box), [carousel](#carousel), [events](#events), [featured_snippet](#featured_snippet), [hotels_pack](#hotels), [images](#images), [jobs](#jobs), [local_pack](#local_pack), [map](#map), [organic](#organic), [paid](#paid), [people_also_ask](#people_also_ask), [people_also_search](#people_also_search), [questions_and_answers](#questions_and_answers),[recipes](#recipes), [related_searches](#related_searches), [shopping](#shopping), [top_stories](#top_stories), [video](#video), [ai_overview](#ai_overview) */
     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;
-    /** elements of search results found in SERP */
+    /** *elements of search results found in SERP* */
     items?: BaseBingSerpApiElementItem[] | undefined;
     [key: string]: any;
 }
 export declare class SerpBingOrganicLiveAdvancedResultInfo implements ISerpBingOrganicLiveAdvancedResultInfo {
-    /** keyword received in a POST array the keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
+    /** *keyword received in a POST array***the keyword is returned with decoded %## (plus character '+' 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 equals null */
+    /** *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             equals `null` */
     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: answer_box, carousel, events, featured_snippet, hotels_pack, images, jobs, local_pack, map, organic, paid, people_also_ask, people_also_search, questions_and_answers,recipes, related_searches, shopping, top_stories, video, ai_overview */
+    /** *types of search results in SERP*             contains types of search results (`items`) found in SERP.             possible item types:             [answer_box](#answer_box), [carousel](#carousel), [events](#events), [featured_snippet](#featured_snippet), [hotels_pack](#hotels), [images](#images), [jobs](#jobs), [local_pack](#local_pack), [map](#map), [organic](#organic), [paid](#paid), [people_also_ask](#people_also_ask), [people_also_search](#people_also_search), [questions_and_answers](#questions_and_answers),[recipes](#recipes), [related_searches](#related_searches), [shopping](#shopping), [top_stories](#top_stories), [video](#video), [ai_overview](#ai_overview) */
     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;
-    /** elements of search results found in SERP */
+    /** *elements of search results found in SERP* */
     items?: BaseBingSerpApiElementItem[] | undefined;
     [key: string]: any;
     constructor(data?: ISerpBingOrganicLiveAdvancedResultInfo);

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

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

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

@@ -1,75 +1,75 @@
 import { SerpApiStopCrawlOnMatchInfo } from "./SerpApiStopCrawlOnMatchInfo";
 export interface ISerpBingOrganicLiveRegularRequestInfo {
-    /** 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: 200 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: `200` **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;
-    /** 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;
-    /** 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;
-    /** target domain, subdomain, or webpage to get results for optional field a domain or a subdomain should be specified without https:// and www. note that the results of target-specific tasks will only include SERP elements that contain a url string; you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results; examples: example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/; example.com* - returns results for the domain, including all its pages; *example.com* - returns results for the entire domain, including all its pages and subdomains; *example.com  - returns results for the home page regardless of the subdomain, such as https://en.example.com; example.com/example-page - returns results for the exact URL; example.com/example-page* - returns results for all domain's URLs that start with the specified string */
+    /** *target domain, subdomain, or webpage to get results for* optional field a domain or a subdomain should be specified without `https://` and `www.` note that the results of `target`-specific tasks will only include SERP elements that contain a `url` string; you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results; examples: **`example.com`** - returns results for the website's home page with URLs, such as `https://example.com`, or `https://www.example.com/`, or `https://example.com/`; **`example.com*`** - returns results for the domain, including all its pages; **`*example.com*`** - returns results for the entire domain, including all its pages and subdomains; **`*example.com`**  - returns results for the home page regardless of the subdomain, such as `https://en.example.com`; **`example.com/example-page`** - returns results for the exact URL; **`example.com/example-page*`** - returns results for all domain's URLs that start with the specified string */
     target?: 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/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html) */
     search_param?: string | 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 SerpBingOrganicLiveRegularRequestInfo implements ISerpBingOrganicLiveRegularRequestInfo {
-    /** 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: 200 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: `200` **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;
-    /** 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;
-    /** 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;
-    /** target domain, subdomain, or webpage to get results for optional field a domain or a subdomain should be specified without https:// and www. note that the results of target-specific tasks will only include SERP elements that contain a url string; you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results; examples: example.com - returns results for the website's home page with URLs, such as https://example.com, or https://www.example.com/, or https://example.com/; example.com* - returns results for the domain, including all its pages; *example.com* - returns results for the entire domain, including all its pages and subdomains; *example.com  - returns results for the home page regardless of the subdomain, such as https://en.example.com; example.com/example-page - returns results for the exact URL; example.com/example-page* - returns results for all domain's URLs that start with the specified string */
+    /** *target domain, subdomain, or webpage to get results for* optional field a domain or a subdomain should be specified without `https://` and `www.` note that the results of `target`-specific tasks will only include SERP elements that contain a `url` string; you can also use a wildcard (‘*’) character to specify the search pattern in SERP and narrow down the results; examples: **`example.com`** - returns results for the website's home page with URLs, such as `https://example.com`, or `https://www.example.com/`, or `https://example.com/`; **`example.com*`** - returns results for the domain, including all its pages; **`*example.com*`** - returns results for the entire domain, including all its pages and subdomains; **`*example.com`**  - returns results for the home page regardless of the subdomain, such as `https://en.example.com`; **`example.com/example-page`** - returns results for the exact URL; **`example.com/example-page*`** - returns results for all domain's URLs that start with the specified string */
     target?: 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/what-are-google-search-parameters-and-how-to-use-them-with-serp-api.html) */
     search_param?: string | 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?: ISerpBingOrganicLiveRegularRequestInfo);

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

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

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

@@ -2,64 +2,64 @@ import { SpellInfo } from "./SpellInfo";
 import { RefinementChipsInfo } from "./RefinementChipsInfo";
 import { BaseBingSerpApiElementItem } from "./BaseBingSerpApiElementItem";
 export interface ISerpBingOrganicLiveRegularResultInfo {
-    /** keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
+    /** *keyword received in a POST array* **keyword is returned with decoded %## (plus character '+' 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 exact results */
+    /** *direct URL to search engine results*you can use it to make sure that we provided exact 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 in SERP */
+    /** *items in SERP* */
     items?: BaseBingSerpApiElementItem[] | undefined;
     [key: string]: any;
 }
 export declare class SerpBingOrganicLiveRegularResultInfo implements ISerpBingOrganicLiveRegularResultInfo {
-    /** keyword received in a POST array keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
+    /** *keyword received in a POST array* **keyword is returned with decoded %## (plus character '+' 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 exact results */
+    /** *direct URL to search engine results*you can use it to make sure that we provided exact 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 in SERP */
+    /** *items in SERP* */
     items?: BaseBingSerpApiElementItem[] | undefined;
     [key: string]: any;
     constructor(data?: ISerpBingOrganicLiveRegularResultInfo);

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

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

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

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

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

@@ -2,64 +2,64 @@ import { SpellInfo } from "./SpellInfo";
 import { RefinementChipsInfo } from "./RefinementChipsInfo";
 import { BaseBingSerpApiElementItem } from "./BaseBingSerpApiElementItem";
 export interface ISerpBingOrganicTaskGetAdvancedResultInfo {
-    /** keyword received in a POST array the keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character) */
+    /** *keyword received in a POST array***the 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: answer_box, carousel, events, featured_snippet, hotels_pack, images, jobs, local_pack, map, organic, paid, people_also_ask, people_also_search, questions_and_answers,recipes, related_searches, shopping, top_stories, video, ai_overview */
+    /** *types of search results in SERP*             contains types of search results (`items`) found in SERP.             possible item types:             [answer_box](#answer_box), [carousel](#carousel), [events](#events), [featured_snippet](#featured_snippet), [hotels_pack](#hotels), [images](#images), [jobs](#jobs), [local_pack](#local_pack), [map](#map), [organic](#organic), [paid](#paid), [people_also_ask](#people_also_ask), [people_also_search](#people_also_search), [questions_and_answers](#questions_and_answers),[recipes](#recipes), [related_searches](#related_searches), [shopping](#shopping), [top_stories](#top_stories), [video](#video), [ai_overview](#ai_overview) */
     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;
-    /** additional items present in the element if there are none, equals null */
+    /** *additional items present in the element*             if there are none, equals `null` */
     items?: BaseBingSerpApiElementItem[] | undefined;
     [key: string]: any;
 }
 export declare class SerpBingOrganicTaskGetAdvancedResultInfo implements ISerpBingOrganicTaskGetAdvancedResultInfo {
-    /** keyword received in a POST array the keyword is returned with decoded %## (plus symbol ‘+’ will be decoded to a space character) */
+    /** *keyword received in a POST array***the 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: answer_box, carousel, events, featured_snippet, hotels_pack, images, jobs, local_pack, map, organic, paid, people_also_ask, people_also_search, questions_and_answers,recipes, related_searches, shopping, top_stories, video, ai_overview */
+    /** *types of search results in SERP*             contains types of search results (`items`) found in SERP.             possible item types:             [answer_box](#answer_box), [carousel](#carousel), [events](#events), [featured_snippet](#featured_snippet), [hotels_pack](#hotels), [images](#images), [jobs](#jobs), [local_pack](#local_pack), [map](#map), [organic](#organic), [paid](#paid), [people_also_ask](#people_also_ask), [people_also_search](#people_also_search), [questions_and_answers](#questions_and_answers),[recipes](#recipes), [related_searches](#related_searches), [shopping](#shopping), [top_stories](#top_stories), [video](#video), [ai_overview](#ai_overview) */
     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;
-    /** additional items present in the element if there are none, equals null */
+    /** *additional items present in the element*             if there are none, equals `null` */
     items?: BaseBingSerpApiElementItem[] | undefined;
     [key: string]: any;
     constructor(data?: ISerpBingOrganicTaskGetAdvancedResultInfo);

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

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

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

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