dataforseo-client 2.1.1 → 2.1.2

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

@@ -1,38 +1,38 @@
 export interface ISerpBaiduOrganicTasksReadyResultInfo {
-    /** 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 SerpBaiduOrganicTasksReadyResultInfo implements ISerpBaiduOrganicTasksReadyResultInfo {
-    /** 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?: ISerpBaiduOrganicTasksReadyResultInfo);

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

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

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

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

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

@@ -1,14 +1,14 @@
 export interface ISerpBingLanguagesResultInfo {
-    /** language name */
+    /** *language name* */
     language_name?: string | undefined;
-    /** language code according to ISO 639-1 */
+    /** *language code according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)* */
     language_code?: string | undefined;
     [key: string]: any;
 }
 export declare class SerpBingLanguagesResultInfo implements ISerpBingLanguagesResultInfo {
-    /** language name */
+    /** *language name* */
     language_name?: string | undefined;
-    /** language code according to ISO 639-1 */
+    /** *language code according to [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes)* */
     language_code?: string | undefined;
     [key: string]: any;
     constructor(data?: ISerpBingLanguagesResultInfo);

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

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

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

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

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

@@ -1,26 +1,26 @@
 export interface ISerpBingLocationsCountryResultInfo {
-    /** location code */
+    /** *location code* */
     location_code?: number | undefined;
-    /** full name of the location */
+    /** *full name of the location* */
     location_name?: string | undefined;
-    /** the code of the superordinate location example: 'location_code': 9041134, 'location_name': 'Vienna International Airport,Lower Austria,Austria', 'location_code_parent': 20044 where location_code_parent corresponds to: 'location_code': 20044, 'location_name': 'Lower Austria,Austria' */
+    /** *the code of the superordinate location* example: `'location_code': 9041134`, `'location_name': 'Vienna International Airport,Lower Austria,Austria'`, `'location_code_parent': 20044` where `location_code_parent` corresponds to: `'location_code': 20044`, `'location_name': 'Lower Austria,Austria'` */
     location_code_parent?: number | undefined;
-    /** ISO country code of the location */
+    /** *ISO country code of the location* */
     country_iso_code?: string | undefined;
-    /** location type indicates the geographic classification of the location example: 'location_type': 'Country', or 'location_type': 'State' */
+    /** *location type* indicates the geographic classification of the location example: `'location_type': 'Country'`, or `'location_type': 'State'` */
     location_type?: string | undefined;
     [key: string]: any;
 }
 export declare class SerpBingLocationsCountryResultInfo implements ISerpBingLocationsCountryResultInfo {
-    /** location code */
+    /** *location code* */
     location_code?: number | undefined;
-    /** full name of the location */
+    /** *full name of the location* */
     location_name?: string | undefined;
-    /** the code of the superordinate location example: 'location_code': 9041134, 'location_name': 'Vienna International Airport,Lower Austria,Austria', 'location_code_parent': 20044 where location_code_parent corresponds to: 'location_code': 20044, 'location_name': 'Lower Austria,Austria' */
+    /** *the code of the superordinate location* example: `'location_code': 9041134`, `'location_name': 'Vienna International Airport,Lower Austria,Austria'`, `'location_code_parent': 20044` where `location_code_parent` corresponds to: `'location_code': 20044`, `'location_name': 'Lower Austria,Austria'` */
     location_code_parent?: number | undefined;
-    /** ISO country code of the location */
+    /** *ISO country code of the location* */
     country_iso_code?: string | undefined;
-    /** location type indicates the geographic classification of the location example: 'location_type': 'Country', or 'location_type': 'State' */
+    /** *location type* indicates the geographic classification of the location example: `'location_type': 'Country'`, or `'location_type': 'State'` */
     location_type?: string | undefined;
     [key: string]: any;
     constructor(data?: ISerpBingLocationsCountryResultInfo);

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

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

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

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

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

@@ -1,26 +1,26 @@
 export interface ISerpBingLocationsResultInfo {
-    /** location code */
+    /** *location code* */
     location_code?: number | undefined;
-    /** full name of the location */
+    /** *full name of the location* */
     location_name?: string | undefined;
-    /** the code of the superordinate location example: 'location_code': 9041134, 'location_name': 'Vienna International Airport,Lower Austria,Austria', 'location_code_parent': 20044 where location_code_parent corresponds to: 'location_code': 20044, 'location_name': 'Lower Austria,Austria' */
+    /** *the code of the superordinate location* example: `'location_code': 9041134`, `'location_name': 'Vienna International Airport,Lower Austria,Austria'`, `'location_code_parent': 20044` where `location_code_parent` corresponds to: `'location_code': 20044`, `'location_name': 'Lower Austria,Austria'` */
     location_code_parent?: number | undefined;
-    /** ISO country code of the location */
+    /** *ISO country code of the location* */
     country_iso_code?: string | undefined;
-    /** location type indicates the geographic classification of the location example: 'location_type': 'Country', or 'location_type': 'State' */
+    /** *location type* indicates the geographic classification of the location example: `'location_type': 'Country'`, or `'location_type': 'State'` */
     location_type?: string | undefined;
     [key: string]: any;
 }
 export declare class SerpBingLocationsResultInfo implements ISerpBingLocationsResultInfo {
-    /** location code */
+    /** *location code* */
     location_code?: number | undefined;
-    /** full name of the location */
+    /** *full name of the location* */
     location_name?: string | undefined;
-    /** the code of the superordinate location example: 'location_code': 9041134, 'location_name': 'Vienna International Airport,Lower Austria,Austria', 'location_code_parent': 20044 where location_code_parent corresponds to: 'location_code': 20044, 'location_name': 'Lower Austria,Austria' */
+    /** *the code of the superordinate location* example: `'location_code': 9041134`, `'location_name': 'Vienna International Airport,Lower Austria,Austria'`, `'location_code_parent': 20044` where `location_code_parent` corresponds to: `'location_code': 20044`, `'location_name': 'Lower Austria,Austria'` */
     location_code_parent?: number | undefined;
-    /** ISO country code of the location */
+    /** *ISO country code of the location* */
     country_iso_code?: string | undefined;
-    /** location type indicates the geographic classification of the location example: 'location_type': 'Country', or 'location_type': 'State' */
+    /** *location type* indicates the geographic classification of the location example: `'location_type': 'Country'`, or `'location_type': 'State'` */
     location_type?: string | undefined;
     [key: string]: any;
     constructor(data?: ISerpBingLocationsResultInfo);

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

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

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

@@ -1,71 +1,71 @@
 import { SerpApiStopCrawlOnMatchInfo } from "./SerpApiStopCrawlOnMatchInfo";
 export interface ISerpBingOrganicLiveHtmlRequestInfo {
-    /** 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;
     /** 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 SerpBingOrganicLiveHtmlRequestInfo implements ISerpBingOrganicLiveHtmlRequestInfo {
-    /** 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;
     /** 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?: ISerpBingOrganicLiveHtmlRequestInfo);

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

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

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

@@ -1,39 +1,39 @@
 import { HtmlItemInfo } from "./HtmlItemInfo";
 export interface ISerpBingOrganicLiveHtmlResultInfo {
-    /** 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;
-    /** 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;
-    /** 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?: HtmlItemInfo[] | undefined;
     [key: string]: any;
 }
 export declare class SerpBingOrganicLiveHtmlResultInfo implements ISerpBingOrganicLiveHtmlResultInfo {
-    /** 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;
-    /** 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;
-    /** 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?: HtmlItemInfo[] | undefined;
     [key: string]: any;
     constructor(data?: ISerpBingOrganicLiveHtmlResultInfo);

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

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

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

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

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

@@ -1,39 +1,39 @@
 import { HtmlItemInfo } from "./HtmlItemInfo";
 export interface ISerpBingOrganicTaskGetHtmlResultInfo {
-    /** 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;
-    /** 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;
-    /** 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?: HtmlItemInfo[] | undefined;
     [key: string]: any;
 }
 export declare class SerpBingOrganicTaskGetHtmlResultInfo implements ISerpBingOrganicTaskGetHtmlResultInfo {
-    /** 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;
-    /** 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;
-    /** 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?: HtmlItemInfo[] | undefined;
     [key: string]: any;
     constructor(data?: ISerpBingOrganicTaskGetHtmlResultInfo);

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

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