dataforseo-client 2.1.1 → 2.1.3

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

@@ -6,60 +6,60 @@ import { SerpInfo } from "./SerpInfo";
 import { AvgBacklinksInfo } from "./AvgBacklinksInfo";
 import { SearchIntentInfo } from "./SearchIntentInfo";
 export interface IDataforseoLabsGoogleKeywordOverviewLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keyword keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
+    /** *keyword* **keyword is returned with decoded %## (plus character '+' will be decoded to a space character)** */
     keyword?: 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;
-    /** indicates data for Google and partner sites if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search; if false, the results are returned for Google search sites only */
+    /** *indicates data for Google and partner sites* if `true`, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search; if `false`, the results are returned for Google search sites only */
     search_partners?: boolean | undefined;
-    /** keyword data for the returned keyword */
+    /** *keyword data for the returned keyword* */
     keyword_info?: KeywordInfo | undefined;
-    /** contains keyword search volume normalized with Bing search volume */
+    /** *contains keyword search volume normalized with Bing search volume* */
     keyword_info_normalized_with_bing?: KeywordInfoNormalizedWithInfo | undefined;
-    /** contains keyword search volume normalized with clickstream data */
+    /** *contains keyword search volume normalized with clickstream data* */
     keyword_info_normalized_with_clickstream?: KeywordInfoNormalizedWithInfo | undefined;
-    /** clickstream data for the returned keyword to retrieve results for this field, the parameter include_clickstream_data must be set to true */
+    /** *clickstream data for the returned keyword* to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true` */
     clickstream_keyword_info?: ClickstreamKeywordInfo | undefined;
-    /** additional information about the keyword */
+    /** *additional information about the keyword* */
     keyword_properties?: KeywordProperties | undefined;
-    /** SERP data the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
+    /** *SERP data* the value will be `null` if you didn't set the field `include_serp_info` to `true` in the POST array or if there is no SERP data for this keyword in our database */
     serp_info?: SerpInfo | undefined;
-    /** backlink data for the returned keyword this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
+    /** *backlink data for the returned keyword* this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
     avg_backlinks_info?: AvgBacklinksInfo | undefined;
-    /** search intent info for the returned keyword learn about search intent in this help center article */
+    /** *search intent info for the returned keyword* learn about search intent in this [help center article](https://dataforseo.com/help-center/search-intent-and-its-types) */
     search_intent_info?: SearchIntentInfo | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordOverviewLiveItem implements IDataforseoLabsGoogleKeywordOverviewLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keyword keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
+    /** *keyword* **keyword is returned with decoded %## (plus character '+' will be decoded to a space character)** */
     keyword?: 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;
-    /** indicates data for Google and partner sites if true, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search; if false, the results are returned for Google search sites only */
+    /** *indicates data for Google and partner sites* if `true`, the results are returned for owned, operated, and syndicated networks across Google and partner sites that host Google search; if `false`, the results are returned for Google search sites only */
     search_partners?: boolean | undefined;
-    /** keyword data for the returned keyword */
+    /** *keyword data for the returned keyword* */
     keyword_info?: KeywordInfo | undefined;
-    /** contains keyword search volume normalized with Bing search volume */
+    /** *contains keyword search volume normalized with Bing search volume* */
     keyword_info_normalized_with_bing?: KeywordInfoNormalizedWithInfo | undefined;
-    /** contains keyword search volume normalized with clickstream data */
+    /** *contains keyword search volume normalized with clickstream data* */
     keyword_info_normalized_with_clickstream?: KeywordInfoNormalizedWithInfo | undefined;
-    /** clickstream data for the returned keyword to retrieve results for this field, the parameter include_clickstream_data must be set to true */
+    /** *clickstream data for the returned keyword* to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true` */
     clickstream_keyword_info?: ClickstreamKeywordInfo | undefined;
-    /** additional information about the keyword */
+    /** *additional information about the keyword* */
     keyword_properties?: KeywordProperties | undefined;
-    /** SERP data the value will be null if you didn’t set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
+    /** *SERP data* the value will be `null` if you didn't set the field `include_serp_info` to `true` in the POST array or if there is no SERP data for this keyword in our database */
     serp_info?: SerpInfo | undefined;
-    /** backlink data for the returned keyword this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
+    /** *backlink data for the returned keyword* this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 websites ranking organically for the keyword */
     avg_backlinks_info?: AvgBacklinksInfo | undefined;
-    /** search intent info for the returned keyword learn about search intent in this help center article */
+    /** *search intent info for the returned keyword* learn about search intent in this [help center article](https://dataforseo.com/help-center/search-intent-and-its-types) */
     search_intent_info?: SearchIntentInfo | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordOverviewLiveItem);

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

@@ -1,38 +1,38 @@
 export interface IDataforseoLabsGoogleKeywordOverviewLiveRequestInfo {
-    /** keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase format, data will be provided in a separate array note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them you will not be charged for the keywords omitted in the results learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** *keywords* **required field** The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase format, data will be provided in a separate array **note** that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them you will not be charged for the keywords omitted in the results 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) */
     keywords?: 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 the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom */
+    /** *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 the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `United Kingdom` */
     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 the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 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 the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` 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 locations 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 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 locations 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 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 locations 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 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 locations 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;
-    /** include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false */
+    /** *include data from SERP for each keyword* optional field if set to `true`, we will return a `serp_info` array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: `false` */
     include_serp_info?: boolean | undefined;
-    /** include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article */
+    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to `true`, you will receive `clickstream_keyword_info`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     include_clickstream_data?: boolean | 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 DataforseoLabsGoogleKeywordOverviewLiveRequestInfo implements IDataforseoLabsGoogleKeywordOverviewLiveRequestInfo {
-    /** keywords required field The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase format, data will be provided in a separate array note that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn’t contain such keywords and cannot return data on them you will not be charged for the keywords omitted in the results learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** *keywords* **required field** The maximum number of keywords you can specify: 700 The maximum number of characters for each keyword: 80 The maximum number of words for each keyword phrase: 10 the specified keywords will be converted to lowercase format, data will be provided in a separate array **note** that if some of the keywords specified in this array are omitted in the results you receive, then our database doesn't contain such keywords and cannot return data on them you will not be charged for the keywords omitted in the results 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) */
     keywords?: 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 the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: United Kingdom */
+    /** *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 the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `United Kingdom` */
     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 the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages 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 the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` 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 locations 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 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 locations 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 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 locations 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 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 locations 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;
-    /** include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false */
+    /** *include data from SERP for each keyword* optional field if set to `true`, we will return a `serp_info` array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: `false` */
     include_serp_info?: boolean | undefined;
-    /** include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article */
+    /** *include or exclude data from clickstream-based metrics in the result* optional field if the parameter is set to `true`, you will receive `clickstream_keyword_info`, `keyword_info_normalized_with_clickstream`, and `keyword_info_normalized_with_bing` fields in the response default value: `false` with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this [help center article](https://dataforseo.com/help-center/what-are-clickstream-based-metrics-and-how-do-we-calculate-them) */
     include_clickstream_data?: boolean | 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?: IDataforseoLabsGoogleKeywordOverviewLiveRequestInfo);

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

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

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

@@ -1,27 +1,27 @@
 import { DataforseoLabsGoogleKeywordOverviewLiveItem } from "./DataforseoLabsGoogleKeywordOverviewLiveItem";
 export interface IDataforseoLabsGoogleKeywordOverviewLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: 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;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** contains keywords and related data */
+    /** *contains keywords and related data* */
     items?: DataforseoLabsGoogleKeywordOverviewLiveItem[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordOverviewLiveResultInfo implements IDataforseoLabsGoogleKeywordOverviewLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: 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;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** contains keywords and related data */
+    /** *contains keywords and related data* */
     items?: DataforseoLabsGoogleKeywordOverviewLiveItem[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordOverviewLiveResultInfo);

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

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

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

@@ -1,70 +1,70 @@
 export interface IDataforseoLabsGoogleKeywordSuggestionsLiveRequestInfo {
-    /** keyword required field UTF-8 encoding the keywords will be converted to lowercase format; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** keywordrequired fieldUTF-8 encodingthe keywords will be converted to lowercase format;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
     keyword?: string | undefined;
-    /** full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom */
+    /** full name of the locationoptional fieldif you use this field, you don't need to specify location_codeyou can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesignore this field to get the results for all available locationsexample:United Kingdom */
     location_name?: string | undefined;
-    /** location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840 */
+    /** location codeoptional fieldif you use this field, you don't need to specify location_nameyou can receive the list of available locations with their location_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesignore this field to get the results for all available locationsexample:2840 */
     location_code?: number | undefined;
-    /** full name of the language optional field if you use this field, you don’t need to 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 Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
+    /** full name of the languageoptional fieldif you use this field, you don't need to specify language_codeyou can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:EnglishNote: if omitted, results default to the language with the most keyword records in the specified location;refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
     language_name?: string | undefined;
-    /** language code optional field if you use this field, you don’t need to 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 Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
+    /** language codeoptional fieldif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:enNote: if omitted, results default to the language with the most keyword records in the specified location;refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
     language_code?: string | undefined;
-    /** include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false */
+    /** include data for the seed keywordoptional fieldif set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the responsedefault value: false */
     include_seed_keyword?: boolean | undefined;
-    /** include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false */
+    /** include data from SERP for each keywordoptional fieldif set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the responsedefault value: false */
     include_serp_info?: boolean | undefined;
-    /** include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article */
+    /** include or exclude data from clickstream-based metrics in the resultoptional fieldif the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the responsedefault value: falsewith this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article */
     include_clickstream_data?: boolean | undefined;
-    /** search for the exact phrase optional field if set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase default value: false */
+    /** search for the exact phraseoptional fieldif set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrasedefault value: false */
     exact_match?: boolean | 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 keywordsoptional fieldif 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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: ['keyword_info.search_volume','>',0] [['keyword_info.search_volume','in',[0,1000]], 'and', ['keyword_info.competition_level','=','LOW']][['keyword_info.search_volume','>',100], 'and', [['keyword_info.cpc','<',0.5], 'or', ['keyword_info.high_top_of_page_bid','<=',0.5]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
+    /** array of results filtering parametersoptional fieldyou can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are supported:regex, not_regex, , >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_likeyou can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more charactersexample:['keyword_info.search_volume','>',0][['keyword_info.search_volume','in',[0,1000]],'and',['keyword_info.competition_level','=','LOW']][['keyword_info.search_volume','>',100],'and',[['keyword_info.cpc','<',0.5],'or',['keyword_info.high_top_of_page_bid','<=',0.5]]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide */
     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 a comma is used as a separator example: ['keyword_info.competition,desc'] default rule: ['keyword_info.search_volume,desc'] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ['keyword_info.search_volume,desc','keyword_info.cpc,desc'] */
+    /** results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending ordera comma is used as a separatorexample:['keyword_info.competition,desc']default rule:['keyword_info.search_volume,desc']note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:['keyword_info.search_volume,desc','keyword_info.cpc,desc'] */
     order_by?: string[] | undefined;
-    /** the maximum number of returned keywords optional field default value: 100 maximum value: 1000 */
+    /** the maximum number of returned keywordsoptional fielddefault value: 100maximum 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 Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead. */
+    /** offset in the results array of returned keywordsoptional fielddefault value: 0if 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 keywordsNote: we recommend using this parameter only when retrieving up to 10,000 resultsfor retrieving over 10,000 results, use the offset_token instead. */
     offset?: number | undefined;
-    /** offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center */
+    /** offset token for subsequent requestsoptional fieldprovided in the identical filed of the response to each request;use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;offset_token values are unique for each subsequent taskNote: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.learn more about this parameter on our Help Center */
     offset_token?: string | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response */
     tag?: string | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordSuggestionsLiveRequestInfo implements IDataforseoLabsGoogleKeywordSuggestionsLiveRequestInfo {
-    /** keyword required field UTF-8 encoding the keywords will be converted to lowercase format; learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** keywordrequired fieldUTF-8 encodingthe keywords will be converted to lowercase format;learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
     keyword?: string | undefined;
-    /** full name of the location optional field if you use this field, you don’t need to specify location_code you can receive the list of available locations with their location_name by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: United Kingdom */
+    /** full name of the locationoptional fieldif you use this field, you don't need to specify location_codeyou can receive the list of available locations with their location_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesignore this field to get the results for all available locationsexample:United Kingdom */
     location_name?: string | undefined;
-    /** location code optional field if you use this field, you don’t need to specify location_name you can receive the list of available locations with their location_code by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages ignore this field to get the results for all available locations example: 2840 */
+    /** location codeoptional fieldif you use this field, you don't need to specify location_nameyou can receive the list of available locations with their location_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesignore this field to get the results for all available locationsexample:2840 */
     location_code?: number | undefined;
-    /** full name of the language optional field if you use this field, you don’t need to 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 Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
+    /** full name of the languageoptional fieldif you use this field, you don't need to specify language_codeyou can receive the list of available languages with their language_name by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:EnglishNote: if omitted, results default to the language with the most keyword records in the specified location;refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
     language_name?: string | undefined;
-    /** language code optional field if you use this field, you don’t need to 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 Note: if omitted, results default to the language with the most keyword records in the specified location; refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
+    /** language codeoptional fieldif you use this field, you don't need to specify language_nameyou can receive the list of available languages with their language_code by making a separate request to thehttps://api.dataforseo.com/v3/dataforseo_labs/locations_and_languagesexample:enNote: if omitted, results default to the language with the most keyword records in the specified location;refer to the available_languages.keywords field of the Locations and Languages endpoint to determine the default language */
     language_code?: string | undefined;
-    /** include data for the seed keyword optional field if set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the response default value: false */
+    /** include data for the seed keywordoptional fieldif set to true, data for the seed keyword specified in the keyword field will be provided in the seed_keyword_data array of the responsedefault value: false */
     include_seed_keyword?: boolean | undefined;
-    /** include data from SERP for each keyword optional field if set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the response default value: false */
+    /** include data from SERP for each keywordoptional fieldif set to true, we will return a serp_info array containing SERP data (number of search results, relevant URL, and SERP features) for every keyword in the responsedefault value: false */
     include_serp_info?: boolean | undefined;
-    /** include or exclude data from clickstream-based metrics in the result optional field if the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the response default value: false with this parameter enabled, you will be charged double the price for the request learn more about how clickstream-based metrics are calculated in this help center article */
+    /** include or exclude data from clickstream-based metrics in the resultoptional fieldif the parameter is set to true, you will receive clickstream_keyword_info, keyword_info_normalized_with_clickstream, and keyword_info_normalized_with_bing fields in the responsedefault value: falsewith this parameter enabled, you will be charged double the price for the requestlearn more about how clickstream-based metrics are calculated in this help center article */
     include_clickstream_data?: boolean | undefined;
-    /** search for the exact phrase optional field if set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrase default value: false */
+    /** search for the exact phraseoptional fieldif set to true, the returned keywords will include the exact keyword phrase you specified, with potentially other words before or after that phrasedefault value: false */
     exact_match?: boolean | 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 keywordsoptional fieldif 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, match, not_match, ilike, not_ilike, like, not_like you can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more characters example: ['keyword_info.search_volume','>',0] [['keyword_info.search_volume','in',[0,1000]], 'and', ['keyword_info.competition_level','=','LOW']][['keyword_info.search_volume','>',100], 'and', [['keyword_info.cpc','<',0.5], 'or', ['keyword_info.high_top_of_page_bid','<=',0.5]]] for more information about filters, please refer to Dataforseo Labs – Filters or this help center guide */
+    /** array of results filtering parametersoptional fieldyou can add several filters at once (8 filters maximum)you should set a logical operator and, or between the conditionsthe following operators are supported:regex, not_regex, , >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_likeyou can use the % operator with like and not_like, as well as ilike and not_ilike to match any string of zero or more charactersexample:['keyword_info.search_volume','>',0][['keyword_info.search_volume','in',[0,1000]],'and',['keyword_info.competition_level','=','LOW']][['keyword_info.search_volume','>',100],'and',[['keyword_info.cpc','<',0.5],'or',['keyword_info.high_top_of_page_bid','<=',0.5]]]for more information about filters, please refer to Dataforseo Labs - Filters or this help center guide */
     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 a comma is used as a separator example: ['keyword_info.competition,desc'] default rule: ['keyword_info.search_volume,desc'] note that you can set no more than three sorting rules in a single request you should use a comma to separate several sorting rules example: ['keyword_info.search_volume,desc','keyword_info.cpc,desc'] */
+    /** results sorting rulesoptional fieldyou can use the same values as in the filters array to sort the resultspossible sorting types:asc - results will be sorted in the ascending orderdesc - results will be sorted in the descending ordera comma is used as a separatorexample:['keyword_info.competition,desc']default rule:['keyword_info.search_volume,desc']note that you can set no more than three sorting rules in a single requestyou should use a comma to separate several sorting rulesexample:['keyword_info.search_volume,desc','keyword_info.cpc,desc'] */
     order_by?: string[] | undefined;
-    /** the maximum number of returned keywords optional field default value: 100 maximum value: 1000 */
+    /** the maximum number of returned keywordsoptional fielddefault value: 100maximum 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 Note: we recommend using this parameter only when retrieving up to 10,000 results for retrieving over 10,000 results, use the offset_token instead. */
+    /** offset in the results array of returned keywordsoptional fielddefault value: 0if 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 keywordsNote: we recommend using this parameter only when retrieving up to 10,000 resultsfor retrieving over 10,000 results, use the offset_token instead. */
     offset?: number | undefined;
-    /** offset token for subsequent requests optional field provided in the identical filed of the response to each request; use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request; by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task; offset_token values are unique for each subsequent task Note: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task. learn more about this parameter on our Help Center */
+    /** offset token for subsequent requestsoptional fieldprovided in the identical filed of the response to each request;use this parameter to avoid timeouts while trying to obtain over 10,000 results in a single request;by specifying the unique offset_token value from the response array, you will get the subsequent results of the initial task;offset_token values are unique for each subsequent taskNote: if the offset_token is specified in the request, all other parameters except limit will not be taken into account when processing a task.learn more about this parameter on our Help Center */
     offset_token?: string | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** user-defined task identifieroptional fieldthe character limit is 255you can use this parameter to identify the task and match it with the resultyou will find the specified tag value in the data object of the response */
     tag?: string | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordSuggestionsLiveRequestInfo);

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

@@ -4,11 +4,11 @@ export interface IDataforseoLabsGoogleKeywordSuggestionsLiveResultInfo {
     se_type?: string | undefined;
     /** keyword in a POST array */
     seed_keyword?: string | undefined;
-    /** keyword data for the seed keyword fields in this object are identical to those of the items array */
+    /** keyword data for the seed keywordfields in this object are identical to those of the items array */
     seed_keyword_data?: KeywordDataInfo | undefined;
-    /** location code in a POST array if there is no data, then the value is null */
+    /** location code in a POST arrayif there is no data, then the value is_nulln */
     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 arrayif there is no data, then the value is_nulln */
     language_code?: string | undefined;
     /** total amount of results in our database relevant to your request */
     total_count?: number | undefined;
@@ -16,7 +16,7 @@ export interface IDataforseoLabsGoogleKeywordSuggestionsLiveResultInfo {
     items_count?: number | undefined;
     /** current offset value */
     offset?: number | undefined;
-    /** offset token for subsequent requests you can use the string provided in this field to get the subsequent results of the initial task; note: offset_token values are unique for each subsequent task */
+    /** offset token for subsequent requestsyou can use the string provided in this field to get the subsequent results of the initial task;note: offset_token values are unique for each subsequent task */
     offset_token?: string | undefined;
     /** contains keywords and related data */
     items?: KeywordDataInfo[] | undefined;
@@ -27,11 +27,11 @@ export declare class DataforseoLabsGoogleKeywordSuggestionsLiveResultInfo implem
     se_type?: string | undefined;
     /** keyword in a POST array */
     seed_keyword?: string | undefined;
-    /** keyword data for the seed keyword fields in this object are identical to those of the items array */
+    /** keyword data for the seed keywordfields in this object are identical to those of the items array */
     seed_keyword_data?: KeywordDataInfo | undefined;
-    /** location code in a POST array if there is no data, then the value is null */
+    /** location code in a POST arrayif there is no data, then the value is_nulln */
     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 arrayif there is no data, then the value is_nulln */
     language_code?: string | undefined;
     /** total amount of results in our database relevant to your request */
     total_count?: number | undefined;
@@ -39,7 +39,7 @@ export declare class DataforseoLabsGoogleKeywordSuggestionsLiveResultInfo implem
     items_count?: number | undefined;
     /** current offset value */
     offset?: number | undefined;
-    /** offset token for subsequent requests you can use the string provided in this field to get the subsequent results of the initial task; note: offset_token values are unique for each subsequent task */
+    /** offset token for subsequent requestsyou can use the string provided in this field to get the subsequent results of the initial task;note: offset_token values are unique for each subsequent task */
     offset_token?: string | undefined;
     /** contains keywords and related data */
     items?: KeywordDataInfo[] | undefined;

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

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

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

@@ -1,46 +1,46 @@
 export interface IDataforseoLabsGoogleKeywordsForAppLiveRequestInfo {
-    /** id of the apps required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger */
+    /** *id of the apps* **required field** ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL `https://play.google.com/store/apps/details?id=org.telegram.messenger` the id is `org.telegram.messenger` */
     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 DataforseoLabsGoogleKeywordsForAppLiveRequestInfo implements IDataforseoLabsGoogleKeywordsForAppLiveRequestInfo {
-    /** id of the apps required field ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL https://play.google.com/store/apps/details?id=org.telegram.messenger the id is org.telegram.messenger */
+    /** *id of the apps* **required field** ID of the mobile application on Google Play; you can find the ID in the URL of every app listed on Google Play; example: in the URL `https://play.google.com/store/apps/details?id=org.telegram.messenger` the id is `org.telegram.messenger` */
     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?: IDataforseoLabsGoogleKeywordsForAppLiveRequestInfo);

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

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