dataforseo-client 2.1.2 → 2.1.5

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

@@ -3,34 +3,34 @@ import { RatingInfo } from "./RatingInfo";
 export interface ICommercialUnitsElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** source URL */
+    /** *source URL* */
     url?: string | undefined;
-    /** domain where a link points */
+    /** *domain where a link points* */
     domain?: string | undefined;
-    /** price indicated in the element */
+    /** *price indicated in the element* */
     price?: PriceInfo | undefined;
-    /** reference source name or title */
+    /** *reference source name or title* */
     source?: string | undefined;
-    /** the item’s rating  the popularity rate based on reviews and displayed in SERP; if there is none, equals null */
+    /** *the item's rating* the popularity rate based on reviews and displayed in SERP; if there is none, equals `null` */
     rating?: RatingInfo | undefined;
     [key: string]: any;
 }
 export declare class CommercialUnitsElement implements ICommercialUnitsElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** source URL */
+    /** *source URL* */
     url?: string | undefined;
-    /** domain where a link points */
+    /** *domain where a link points* */
     domain?: string | undefined;
-    /** price indicated in the element */
+    /** *price indicated in the element* */
     price?: PriceInfo | undefined;
-    /** reference source name or title */
+    /** *reference source name or title* */
     source?: string | undefined;
-    /** the item’s rating  the popularity rate based on reviews and displayed in SERP; if there is none, equals null */
+    /** *the item's rating* the popularity rate based on reviews and displayed in SERP; if there is none, equals `null` */
     rating?: RatingInfo | undefined;
     [key: string]: any;
     constructor(data?: ICommercialUnitsElement);

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

@@ -1,30 +1,30 @@
 export interface ICompareSitesElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** source URL */
+    /** *source URL* */
     url?: string | undefined;
-    /** domain where a link points */
+    /** *domain where a link points* */
     domain?: string | undefined;
-    /** URL of the image the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available) */
+    /** *URL of the image* the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available) */
     image_url?: string | undefined;
-    /** reference source name or title */
+    /** *reference source name or title* */
     source?: string | undefined;
     [key: string]: any;
 }
 export declare class CompareSitesElement implements ICompareSitesElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** source URL */
+    /** *source URL* */
     url?: string | undefined;
-    /** domain where a link points */
+    /** *domain where a link points* */
     domain?: string | undefined;
-    /** URL of the image the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available) */
+    /** *URL of the image* the URL leading to the image on the original resource or DataForSEO storage (in case the original source is not available) */
     image_url?: string | undefined;
-    /** reference source name or title */
+    /** *reference source name or title* */
     source?: string | undefined;
     [key: string]: any;
     constructor(data?: ICompareSitesElement);

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

@@ -1,14 +1,14 @@
 export interface IContacts {
-    /** array of telephone numbers */
+    /** *array of telephone numbers* */
     telephones?: string[] | undefined;
-    /** array of emails */
+    /** *array of emails* */
     emails?: string[] | undefined;
     [key: string]: any;
 }
 export declare class Contacts implements IContacts {
-    /** array of telephone numbers */
+    /** *array of telephone numbers* */
     telephones?: string[] | undefined;
-    /** array of emails */
+    /** *array of emails* */
     emails?: string[] | undefined;
     [key: string]: any;
     constructor(data?: IContacts);

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

@@ -2,26 +2,26 @@ import { PageContentInfo } from "./PageContentInfo";
 export interface IContentParsingElement {
     /** type of element */
     type?: string | undefined;
-    /** date and time when the content was fethced example: '2022-11-01 10:02:52 +00:00' */
+    /** *date and time when the content was fethced*             example:             `'2022-11-01 10:02:52 +00:00'` */
     fetch_time?: string | undefined;
-    /** general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions */
+    /** *general status code*             you can find the full list of the response codes [here](/v3/appendix/errors)             **Note:** we strongly recommend designing a necessary system for handling related exceptional or error conditions */
     status_code?: number | undefined;
-    /** parsed content of the page */
+    /** *parsed content of the page* */
     page_content?: PageContentInfo | undefined;
-    /** page content in the markdown format page content in the text-to-HTML markdown format specify markdown_view as true in the request to return the value */
+    /** *page content in the markdown format*             page content in the [text-to-HTML markdown format](https://daringfireball.net/projects/markdown/)             specify `markdown_view` as `true` in the request to return the value */
     page_as_markdown?: string | undefined;
     [key: string]: any;
 }
 export declare class ContentParsingElement implements IContentParsingElement {
     /** type of element */
     type?: string | undefined;
-    /** date and time when the content was fethced example: '2022-11-01 10:02:52 +00:00' */
+    /** *date and time when the content was fethced*             example:             `'2022-11-01 10:02:52 +00:00'` */
     fetch_time?: string | undefined;
-    /** general status code you can find the full list of the response codes here Note: we strongly recommend designing a necessary system for handling related exceptional or error conditions */
+    /** *general status code*             you can find the full list of the response codes [here](/v3/appendix/errors)             **Note:** we strongly recommend designing a necessary system for handling related exceptional or error conditions */
     status_code?: number | undefined;
-    /** parsed content of the page */
+    /** *parsed content of the page* */
     page_content?: PageContentInfo | undefined;
-    /** page content in the markdown format page content in the text-to-HTML markdown format specify markdown_view as true in the request to return the value */
+    /** *page content in the markdown format*             page content in the [text-to-HTML markdown format](https://daringfireball.net/projects/markdown/)             specify `markdown_view` as `true` in the request to return the value */
     page_as_markdown?: string | undefined;
     [key: string]: any;
     constructor(data?: IContentParsingElement);

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

@@ -1,18 +1,18 @@
 export interface ICountryDistribution {
-    /** country ISO code */
+    /** *country ISO code* */
     country_iso_code?: string | undefined;
-    /** clickstream-based average monthly search volume rate represents the (approximate) number of searches for the given keyword idea based on clickstream you can learn more about clickstream search volume in this Help Center article */
+    /** *clickstream-based average monthly search volume rate* represents the (approximate) number of searches for the given keyword idea based on clickstream you can learn more about clickstream search volume in [this Help Center article](https://dataforseo.com/help-center/what-is-clickstream-search-volume-and-how-to-get-it-with-dataforseo) */
     search_volume?: number | undefined;
-    /** percentage of global search volume */
+    /** *percentage of global search volume* */
     percentage?: number | undefined;
     [key: string]: any;
 }
 export declare class CountryDistribution implements ICountryDistribution {
-    /** country ISO code */
+    /** *country ISO code* */
     country_iso_code?: string | undefined;
-    /** clickstream-based average monthly search volume rate represents the (approximate) number of searches for the given keyword idea based on clickstream you can learn more about clickstream search volume in this Help Center article */
+    /** *clickstream-based average monthly search volume rate* represents the (approximate) number of searches for the given keyword idea based on clickstream you can learn more about clickstream search volume in [this Help Center article](https://dataforseo.com/help-center/what-is-clickstream-search-volume-and-how-to-get-it-with-dataforseo) */
     search_volume?: number | undefined;
-    /** percentage of global search volume */
+    /** *percentage of global search volume* */
     percentage?: number | undefined;
     [key: string]: any;
     constructor(data?: ICountryDistribution);

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

@@ -1,20 +1,20 @@
 import { KeywordDataInfo } from "./KeywordDataInfo";
 import { AmazonRankedSerpElement } from "./AmazonRankedSerpElement";
 export interface IDataforseoLabsAmazonRankedKeywordsLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keyword data for the returned keyword */
+    /** *keyword data for the returned keyword* */
     keyword_data?: KeywordDataInfo | undefined;
-    /** contains data on the products’s SERP element found for the returned keyword */
+    /** *contains data on the products's SERP element found for the returned `keyword`* */
     ranked_serp_element?: AmazonRankedSerpElement | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsAmazonRankedKeywordsLiveItem implements IDataforseoLabsAmazonRankedKeywordsLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keyword data for the returned keyword */
+    /** *keyword data for the returned keyword* */
     keyword_data?: KeywordDataInfo | undefined;
-    /** contains data on the products’s SERP element found for the returned keyword */
+    /** *contains data on the products's SERP element found for the returned `keyword`* */
     ranked_serp_element?: AmazonRankedSerpElement | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsAmazonRankedKeywordsLiveItem);

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

@@ -1,50 +1,50 @@
 export interface IDataforseoLabsAmazonRankedKeywordsLiveRequestInfo {
-    /** product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint */
+    /** *product ID* **required field** [unique product identifier (ASIN)](https://dataforseo.com/help-center/asin-in-amazon-api) on Amazon; you can receive the `asin` parameter by making a separate request to the [Amazon Products endpoint](/v3/merchant/amazon/products/task_post/) */
     asin?: string | undefined;
-    /** full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States */
+    /** *full name of the location* **required field if don't specify `location_code`** you can receive the list of available locations with their `location_name` by making a separate request to `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; **Note:** this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: `United States` */
     location_name?: string | undefined;
-    /** location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840 */
+    /** *location code* **required field if don't specify `location_name`** you can receive the list of available locations with their `location_code` by making a separate request to  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; **Note:** this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: `2840` */
     location_code?: number | undefined;
-    /** full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English */
+    /** *full name of the language* **required field if don't specify `language_code`** you can receive the list of available languages with their `language_name` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `English` */
     language_name?: string | undefined;
-    /** language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en */
+    /** *language code* **required field if don't specify `language_name`** you can receive the list of available languages with their `language_code` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `en` */
     language_code?: string | undefined;
-    /** the maximum number of products in the results array optional field default value: 100; maximum value: 1000 */
+    /** *the maximum number of products in the results array* optional field default value: `100`; maximum value: `1000` */
     limit?: number | undefined;
-    /** ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true` only core keywords will be returned, all highly similar keywords will be excluded;   default value: `false` */
     ignore_synonyms?: boolean | undefined;
-    /** array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, , >=, =, <>, in, not_in, like, not_like, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ['keyword_data.keyword_info.search_volume','in',[100,1000]]; for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
+    /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `regex`, `not_regex`, ``, `>=`, `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['keyword_data.keyword_info.search_volume','in',[100,1000]]`; for more information about filters, please refer to [Dataforseo Labs - Filters](/v3/dataforseo_labs/filters) or this [help center guide](https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api) */
     filters?: any[] | undefined;
-    /** results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting parameter example: ['keyword_data.keyword_info.competition,desc'] default rule: ['ranked_serp_element.serp_item.rank_group,asc'] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ['keyword_data.keyword_info.search_volume,desc','keyword_data.keyword_info.cpc,desc'] */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` - results will be sorted in the ascending order `desc` - results will be sorted in the descending order you should use a comma to set up a sorting parameter example: `['keyword_data.keyword_info.competition,desc']` default rule: `['ranked_serp_element.serp_item.rank_group,asc']` **note that you can set no more than three sorting rules in a single request** you should use a comma to separate several sorting rules example: `['keyword_data.keyword_info.search_volume,desc','keyword_data.keyword_info.cpc,desc']` */
     order_by?: string[] | undefined;
-    /** offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
+    /** *offset in the results array of returned keywords* optional field default value: `0` if you specify the `10` value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
     offset?: number | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsAmazonRankedKeywordsLiveRequestInfo implements IDataforseoLabsAmazonRankedKeywordsLiveRequestInfo {
-    /** product ID required field unique product identifier (ASIN) on Amazon; you can receive the asin parameter by making a separate request to the Amazon Products endpoint */
+    /** *product ID* **required field** [unique product identifier (ASIN)](https://dataforseo.com/help-center/asin-in-amazon-api) on Amazon; you can receive the `asin` parameter by making a separate request to the [Amazon Products endpoint](/v3/merchant/amazon/products/task_post/) */
     asin?: string | undefined;
-    /** full name of the location required field if don’t specify location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: United States */
+    /** *full name of the location* **required field if don't specify `location_code`** you can receive the list of available locations with their `location_name` by making a separate request to `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; **Note:** this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: `United States` */
     location_name?: string | undefined;
-    /** location code required field if don’t specify location_name you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: 2840 */
+    /** *location code* **required field if don't specify `location_name`** you can receive the list of available locations with their `location_code` by making a separate request to  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; **Note:** this endpoint currently supports the US, Egypt, Saudi Arabia, and the United Arab Emirates locations only; example: `2840` */
     location_code?: number | undefined;
-    /** full name of the language required field if don’t specify language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: English */
+    /** *full name of the language* **required field if don't specify `language_code`** you can receive the list of available languages with their `language_name` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `English` */
     language_name?: string | undefined;
-    /** language code required field if don’t specify language_name you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en */
+    /** *language code* **required field if don't specify `language_name`** you can receive the list of available languages with their `language_code` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `en` */
     language_code?: string | undefined;
-    /** the maximum number of products in the results array optional field default value: 100; maximum value: 1000 */
+    /** *the maximum number of products in the results array* optional field default value: `100`; maximum value: `1000` */
     limit?: number | undefined;
-    /** ignore highly similar keywords optional field if set to true only core keywords will be returned, all highly similar keywords will be excluded; default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true` only core keywords will be returned, all highly similar keywords will be excluded;   default value: `false` */
     ignore_synonyms?: boolean | undefined;
-    /** array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, , >=, =, <>, in, not_in, like, not_like, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ['keyword_data.keyword_info.search_volume','in',[100,1000]]; for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
+    /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `regex`, `not_regex`, ``, `>=`, `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['keyword_data.keyword_info.search_volume','in',[100,1000]]`; for more information about filters, please refer to [Dataforseo Labs - Filters](/v3/dataforseo_labs/filters) or this [help center guide](https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api) */
     filters?: any[] | undefined;
-    /** results sorting rules optional field you can use the same values as in the filters array to sort the results possible sorting types: asc – results will be sorted in the ascending order desc – results will be sorted in the descending order you should use a comma to set up a sorting parameter example: ['keyword_data.keyword_info.competition,desc'] default rule: ['ranked_serp_element.serp_item.rank_group,asc'] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ['keyword_data.keyword_info.search_volume,desc','keyword_data.keyword_info.cpc,desc'] */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results possible sorting types: `asc` - results will be sorted in the ascending order `desc` - results will be sorted in the descending order you should use a comma to set up a sorting parameter example: `['keyword_data.keyword_info.competition,desc']` default rule: `['ranked_serp_element.serp_item.rank_group,asc']` **note that you can set no more than three sorting rules in a single request** you should use a comma to separate several sorting rules example: `['keyword_data.keyword_info.search_volume,desc','keyword_data.keyword_info.cpc,desc']` */
     order_by?: string[] | undefined;
-    /** offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
+    /** *offset in the results array of returned keywords* optional field default value: `0` if you specify the `10` value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
     offset?: number | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsAmazonRankedKeywordsLiveRequestInfo);

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

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

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

@@ -1,35 +1,35 @@
 import { DataforseoLabsAmazonRankedKeywordsLiveItem } from "./DataforseoLabsAmazonRankedKeywordsLiveItem";
 export interface IDataforseoLabsAmazonRankedKeywordsLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** ASIN in a POST array */
+    /** *ASIN in a POST array* */
     asin?: string | undefined;
-    /** location code in a POST array if there is no data, then the value is null */
+    /** *location code in a POST array* if there is no data, then the value is `null` */
     location_code?: number | undefined;
-    /** language code in a POST array if there is no data, then the value is null */
+    /** *language code in a POST array* if there is no data, then the value is `null` */
     language_code?: string | undefined;
-    /** total amount of results in our database relevant to your request */
+    /** *total amount of results in our database relevant to your request* */
     total_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;
-    /** contains detected Amazon product competitors and related data */
+    /** *contains detected Amazon product competitors and related data* */
     items?: DataforseoLabsAmazonRankedKeywordsLiveItem[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsAmazonRankedKeywordsLiveResultInfo implements IDataforseoLabsAmazonRankedKeywordsLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** ASIN in a POST array */
+    /** *ASIN in a POST array* */
     asin?: string | undefined;
-    /** location code in a POST array if there is no data, then the value is null */
+    /** *location code in a POST array* if there is no data, then the value is `null` */
     location_code?: number | undefined;
-    /** language code in a POST array if there is no data, then the value is null */
+    /** *language code in a POST array* if there is no data, then the value is `null` */
     language_code?: string | undefined;
-    /** total amount of results in our database relevant to your request */
+    /** *total amount of results in our database relevant to your request* */
     total_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;
-    /** contains detected Amazon product competitors and related data */
+    /** *contains detected Amazon product competitors and related data* */
     items?: DataforseoLabsAmazonRankedKeywordsLiveItem[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsAmazonRankedKeywordsLiveResultInfo);

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

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

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

@@ -1,20 +1,20 @@
 import { KeywordDataInfo } from "./KeywordDataInfo";
 import { AppleRankedSerpElementInfo } from "./AppleRankedSerpElementInfo";
 export interface IDataforseoLabsAppleKeywordsForAppLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keyword data for the returned keyword */
+    /** *keyword data for the returned keyword* */
     keyword_data?: KeywordDataInfo | undefined;
-    /** contains data on the domain’s SERP element found for the returned keyword */
+    /** *contains data on the domain's SERP element found for the returned `keyword`* */
     ranked_serp_element?: AppleRankedSerpElementInfo | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsAppleKeywordsForAppLiveItem implements IDataforseoLabsAppleKeywordsForAppLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keyword data for the returned keyword */
+    /** *keyword data for the returned keyword* */
     keyword_data?: KeywordDataInfo | undefined;
-    /** contains data on the domain’s SERP element found for the returned keyword */
+    /** *contains data on the domain's SERP element found for the returned `keyword`* */
     ranked_serp_element?: AppleRankedSerpElementInfo | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsAppleKeywordsForAppLiveItem);

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

@@ -1,46 +1,46 @@
 export interface IDataforseoLabsAppleKeywordsForAppLiveRequestInfo {
-    /** id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320 */
+    /** *id of the app* **required field** ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL `https://apps.apple.com/us/app/id835599320` the id is `835599320` */
     app_id?: string | undefined;
-    /** full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States */
+    /** *full name of the location* **required field if you don't specify** `location_code` **Note:** it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_name` by making a separate request to  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; **Note:** this endpoint currently supports the US location only; example: `United States` */
     location_name?: string | undefined;
-    /** location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840 */
+    /** *location code* **required field if you don't specify** `location_name` **Note:** it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_code` by making a separate request to  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; **Note:** this endpoint currently supports the US location only; example: `2840` */
     location_code?: number | undefined;
-    /** full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English */
+    /** *full name of the language* **required field if you don't specify** `language_code` **Note:** it is required to specify either `language_name` or `language_code` you can receive the list of available languages with their `language_name` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; **Note:** this endpoint currently supports the English language only; example: `English` */
     language_name?: string | undefined;
-    /** language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en */
+    /** *language code* **required field if you don't specify** `language_name` **Note:** it is required to specify either `language_name` or `language_code` you can receive the list of available languages with their `language_code` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; **Note:** this endpoint currently supports the English language only example: `en` */
     language_code?: string | undefined;
-    /** array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: , >=, =, <>, in, not_in example: ['keyword_data.keyword_info.search_volume','>',500] [['keyword_data.keyword_info.search_volume','<>',500],'and',['ranked_serp_element.serp_item.rank_group','>=','10']] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
+    /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: ``, `>=`, `=`, `<>`, `in`, `not_in` example: `['keyword_data.keyword_info.search_volume','>',500]` `[['keyword_data.keyword_info.search_volume','<>',500],'and',['ranked_serp_element.serp_item.rank_group','>=','10']]` for more information about filters, please refer to [Dataforseo Labs - Filters](/v3/dataforseo_labs/filters) or this [help center guide](https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api) */
     filters?: any[] | undefined;
-    /** results sorting rules optional field you can use the same values as in the filters array to sort the results; possible sorting types: asc – results will be sorted in the ascending order; desc – results will be sorted in the descending order; you should use a comma to specify a sorting type; example: ['ranked_serp_element.serp_item.rank_group,asc'] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: ['ranked_serp_element.serp_item.rank_group,desc','keyword_data.keyword_info.search_volume,asc'] default rule: ['keyword_data.keyword_info.search_volume,desc'] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results; possible sorting types: `asc` - results will be sorted in the ascending order; `desc` - results will be sorted in the descending order; you should use a comma to specify a sorting type; example: `['ranked_serp_element.serp_item.rank_group,asc']` **Note:** you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: `['ranked_serp_element.serp_item.rank_group,desc','keyword_data.keyword_info.search_volume,asc']` default rule: `['keyword_data.keyword_info.search_volume,desc']` **Note:** if the `item_types` array contains item types that are different from `organic`, the results will be ordered by the first item type in the array */
     order_by?: string[] | undefined;
-    /** the maximum number of returned keywords optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned keywords* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
+    /** *offset in the results array of returned keywords* optional field default value: `0` if you specify the `10` value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
     offset?: number | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsAppleKeywordsForAppLiveRequestInfo implements IDataforseoLabsAppleKeywordsForAppLiveRequestInfo {
-    /** id of the app required field ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL https://apps.apple.com/us/app/id835599320 the id is 835599320 */
+    /** *id of the app* **required field** ID of the mobile application on App Store; you can find the ID in the URL of every app listed on App Store; example: in the URL `https://apps.apple.com/us/app/id835599320` the id is `835599320` */
     app_id?: string | undefined;
-    /** full name of the location required field if you don’t specify location_code Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_name by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: United States */
+    /** *full name of the location* **required field if you don't specify** `location_code` **Note:** it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_name` by making a separate request to  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; **Note:** this endpoint currently supports the US location only; example: `United States` */
     location_name?: string | undefined;
-    /** location code required field if you don’t specify location_name Note: it is required to specify either location_name or location_code you can receive the list of available locations with their location_code by making a separate request to https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the US location only; example: 2840 */
+    /** *location code* **required field if you don't specify** `location_name` **Note:** it is required to specify either `location_name` or `location_code` you can receive the list of available locations with their `location_code` by making a separate request to  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; **Note:** this endpoint currently supports the US location only; example: `2840` */
     location_code?: number | undefined;
-    /** full name of the language required field if you don’t specify language_code Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only; example: English */
+    /** *full name of the language* **required field if you don't specify** `language_code` **Note:** it is required to specify either `language_name` or `language_code` you can receive the list of available languages with their `language_name` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; **Note:** this endpoint currently supports the English language only; example: `English` */
     language_name?: string | undefined;
-    /** language code required field if you don’t specify language_name Note: it is required to specify either language_name or language_code you can receive the list of available languages with their language_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages; Note: this endpoint currently supports the English language only example: en */
+    /** *language code* **required field if you don't specify** `language_name` **Note:** it is required to specify either `language_name` or `language_code` you can receive the list of available languages with their `language_code` by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages`; **Note:** this endpoint currently supports the English language only example: `en` */
     language_code?: string | undefined;
-    /** array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: , >=, =, <>, in, not_in example: ['keyword_data.keyword_info.search_volume','>',500] [['keyword_data.keyword_info.search_volume','<>',500],'and',['ranked_serp_element.serp_item.rank_group','>=','10']] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
+    /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: ``, `>=`, `=`, `<>`, `in`, `not_in` example: `['keyword_data.keyword_info.search_volume','>',500]` `[['keyword_data.keyword_info.search_volume','<>',500],'and',['ranked_serp_element.serp_item.rank_group','>=','10']]` for more information about filters, please refer to [Dataforseo Labs - Filters](/v3/dataforseo_labs/filters) or this [help center guide](https://dataforseo.com/help-center/how-to-use-filters-in-dataforseo-labs-api) */
     filters?: any[] | undefined;
-    /** results sorting rules optional field you can use the same values as in the filters array to sort the results; possible sorting types: asc – results will be sorted in the ascending order; desc – results will be sorted in the descending order; you should use a comma to specify a sorting type; example: ['ranked_serp_element.serp_item.rank_group,asc'] Note: you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: ['ranked_serp_element.serp_item.rank_group,desc','keyword_data.keyword_info.search_volume,asc'] default rule: ['keyword_data.keyword_info.search_volume,desc'] Note: if the item_types array contains item types that are different from organic, the results will be ordered by the first item type in the array */
+    /** *results sorting rules* optional field you can use the same values as in the `filters` array to sort the results; possible sorting types: `asc` - results will be sorted in the ascending order; `desc` - results will be sorted in the descending order; you should use a comma to specify a sorting type; example: `['ranked_serp_element.serp_item.rank_group,asc']` **Note:** you can set no more than three sorting rules in a single request; you should use a comma to separate several sorting rules; example: `['ranked_serp_element.serp_item.rank_group,desc','keyword_data.keyword_info.search_volume,asc']` default rule: `['keyword_data.keyword_info.search_volume,desc']` **Note:** if the `item_types` array contains item types that are different from `organic`, the results will be ordered by the first item type in the array */
     order_by?: string[] | undefined;
-    /** the maximum number of returned keywords optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned keywords* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned keywords optional field default value: 0 if you specify the 10 value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
+    /** *offset in the results array of returned keywords* optional field default value: `0` if you specify the `10` value, the first ten keywords in the results array will be omitted and the data will be provided for the successive keywords */
     offset?: number | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsAppleKeywordsForAppLiveRequestInfo);

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

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

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

@@ -1,35 +1,35 @@
 import { DataforseoLabsAppleKeywordsForAppLiveItem } from "./DataforseoLabsAppleKeywordsForAppLiveItem";
 export interface IDataforseoLabsAppleKeywordsForAppLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** id of the app in a POST array */
+    /** *id of the app in a POST array* */
     app_id?: 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;
-    /** total amount of results in our database relevant to your request */
+    /** *total amount of results in our database relevant to your request* */
     total_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;
-    /** contains data related to the ranking keywords for the app specified in the app_id field */
+    /** *contains data related to the ranking keywords for the app specified in the `app_id` field* */
     items?: DataforseoLabsAppleKeywordsForAppLiveItem[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsAppleKeywordsForAppLiveResultInfo implements IDataforseoLabsAppleKeywordsForAppLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** id of the app in a POST array */
+    /** *id of the app in a POST array* */
     app_id?: 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;
-    /** total amount of results in our database relevant to your request */
+    /** *total amount of results in our database relevant to your request* */
     total_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;
-    /** contains data related to the ranking keywords for the app specified in the app_id field */
+    /** *contains data related to the ranking keywords for the app specified in the `app_id` field* */
     items?: DataforseoLabsAppleKeywordsForAppLiveItem[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsAppleKeywordsForAppLiveResultInfo);

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

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