dataforseo-client 2.1.1 → 2.1.2

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

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

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

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

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

@@ -1,25 +1,25 @@
 import { DataforseoLabsMetricsInfo } from "./DataforseoLabsMetricsInfo";
 export interface IDataforseoLabsGoogleHistoricalRankOverviewLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** year for which the data is provided */
+    /** *year for which the data is provided* */
     year?: number | undefined;
-    /** month for which the data is provided */
+    /** *month for which the data is provided* */
     month?: number | undefined;
-    /** ranking data relevant to the specified domain */
+    /** *ranking data relevant to the specified domain* */
     metrics?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleHistoricalRankOverviewLiveItem implements IDataforseoLabsGoogleHistoricalRankOverviewLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** year for which the data is provided */
+    /** *year for which the data is provided* */
     year?: number | undefined;
-    /** month for which the data is provided */
+    /** *month for which the data is provided* */
     month?: number | undefined;
-    /** ranking data relevant to the specified domain */
+    /** *ranking data relevant to the specified domain* */
     metrics?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;

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

@@ -1,50 +1,50 @@
 export interface IDataforseoLabsGoogleHistoricalRankOverviewLiveRequestInfo {
-    /** domain required field the domain name of the target website the domain should be specified without https:// and www. */
+    /** *domain* **required field** the domain name of the target website the domain should be specified without `https://` and `www.` */
     target?: 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;
-    /** starting date of the time range optional field if you don’t specify this field, the data will be provided for the previous 6 months minimal possible value: 2020-10-01 date format: 'yyyy-mm-dd' */
+    /** *starting date of the time range* optional field if you don't specify this field, the data will be provided for the previous 6 months minimal possible value: `2020-10-01` date format: `'yyyy-mm-dd'` */
     date_from?: string | undefined;
-    /** ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default date format: 'yyyy-mm-dd' example: '2021-04-01' */
+    /** *ending date of the time range* optional field if you don't specify this field, the today's date will be used by default date format: `'yyyy-mm-dd'` example: `'2021-04-01'` */
     date_to?: string | undefined;
-    /** correlate data with previously obtained datasets optional field default value: true if you use this parameter, our system will correlate data you obtain now with previously obtained datasets this parameter is intended to mitigate any inconsistencies that may result from changes to our database we recommend always setting correlate to true */
+    /** *correlate data with previously obtained datasets* optional field default value: `true` if you use this parameter, our system will correlate data you obtain now with previously obtained datasets this parameter is intended to mitigate any inconsistencies that may result from changes to our database we recommend always setting `correlate` to `true` */
     correlate?: boolean | undefined;
-    /** ignore highly similar keywords optional field if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true`, only data based on core keywords will be returned, data for all highly similar keywords will be excluded;   default value: `false` */
     ignore_synonyms?: 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_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response; default value: false; Note: historical clickstream data is available from 2024/05 (May, 2024); 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_etv`, `clickstream_gender_distribution`, and `clickstream_age_distribution` fields with clickstream data in the response; default value: `false`; **Note:** historical clickstream data is available from 2024/05 (May, 2024); **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 DataforseoLabsGoogleHistoricalRankOverviewLiveRequestInfo implements IDataforseoLabsGoogleHistoricalRankOverviewLiveRequestInfo {
-    /** domain required field the domain name of the target website the domain should be specified without https:// and www. */
+    /** *domain* **required field** the domain name of the target website the domain should be specified without `https://` and `www.` */
     target?: 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;
-    /** starting date of the time range optional field if you don’t specify this field, the data will be provided for the previous 6 months minimal possible value: 2020-10-01 date format: 'yyyy-mm-dd' */
+    /** *starting date of the time range* optional field if you don't specify this field, the data will be provided for the previous 6 months minimal possible value: `2020-10-01` date format: `'yyyy-mm-dd'` */
     date_from?: string | undefined;
-    /** ending date of the time range optional field if you don’t specify this field, the today’s date will be used by default date format: 'yyyy-mm-dd' example: '2021-04-01' */
+    /** *ending date of the time range* optional field if you don't specify this field, the today's date will be used by default date format: `'yyyy-mm-dd'` example: `'2021-04-01'` */
     date_to?: string | undefined;
-    /** correlate data with previously obtained datasets optional field default value: true if you use this parameter, our system will correlate data you obtain now with previously obtained datasets this parameter is intended to mitigate any inconsistencies that may result from changes to our database we recommend always setting correlate to true */
+    /** *correlate data with previously obtained datasets* optional field default value: `true` if you use this parameter, our system will correlate data you obtain now with previously obtained datasets this parameter is intended to mitigate any inconsistencies that may result from changes to our database we recommend always setting `correlate` to `true` */
     correlate?: boolean | undefined;
-    /** ignore highly similar keywords optional field if set to true, only data based on core keywords will be returned, data for all highly similar keywords will be excluded; default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true`, only data based on core keywords will be returned, data for all highly similar keywords will be excluded;   default value: `false` */
     ignore_synonyms?: 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_etv, clickstream_gender_distribution, and clickstream_age_distribution fields with clickstream data in the response; default value: false; Note: historical clickstream data is available from 2024/05 (May, 2024); 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_etv`, `clickstream_gender_distribution`, and `clickstream_age_distribution` fields with clickstream data in the response; default value: `false`; **Note:** historical clickstream data is available from 2024/05 (May, 2024); **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?: IDataforseoLabsGoogleHistoricalRankOverviewLiveRequestInfo);

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

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

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

@@ -1,35 +1,35 @@
 import { DataforseoLabsGoogleHistoricalRankOverviewLiveItem } from "./DataforseoLabsGoogleHistoricalRankOverviewLiveItem";
 export interface IDataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** target domain in a POST array */
+    /** *target domain in a POST array* */
     target?: 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 historical ranking and traffic data */
+    /** *contains historical ranking and traffic data* */
     items?: DataforseoLabsGoogleHistoricalRankOverviewLiveItem[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo implements IDataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** target domain in a POST array */
+    /** *target domain in a POST array* */
     target?: 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 historical ranking and traffic data */
+    /** *contains historical ranking and traffic data* */
     items?: DataforseoLabsGoogleHistoricalRankOverviewLiveItem[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleHistoricalRankOverviewLiveResultInfo);

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

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

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

@@ -1,66 +1,66 @@
 export interface IDataforseoLabsGoogleKeywordIdeasLiveRequestInfo {
-    /** keywords required field UTF-8 encoding The maximum number of keywords you can specify: 200. 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 */
+    /** *keywords* **required field** UTF-8 encoding The maximum number of keywords you can specify: 200. 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](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;
-    /** unique location identifier 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 */
+    /** *unique location identifier* **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 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 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](https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages) 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 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](https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages) to determine the default language */
     language_code?: string | undefined;
-    /** search mode optional field if set to true the results will be based on the phrase-match search algorithm if set to false the results will be based on the broad-match search algorithm default value: false */
+    /** *search mode* optional field if set to_`true` the results will be based on the phrase-match search algorithm if set to `false` the results will be based on the broad-match search algorithm default value: `false`n */
     closely_variants?: 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 keywords* optional field if set to_`true` only core keywords will be returned, all highly similar keywords will be excluded;   default value: `false`n */
     ignore_synonyms?: 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 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)n */
     include_clickstream_data?: boolean | undefined;
-    /** the maximum number of keywords in the results array optional field default value: 700 maximum value: 1000 */
+    /** *the maximum number of keywords in the results array* optional field default value: `700` 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 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 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?: 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 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](https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token) */
     offset_token?: 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: 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, not_ilike to match any string of zero or more characters note that you can not filter the results by relevance 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 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`, `not_ilike` to match any string of zero or more characters **note that you can not filter the results by `relevance`** 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',''or',['keyword_info.high_top_of_page_bid','<=',0.5]]]` 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 default rule: ['relevance,desc'] relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint. 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: ['relevance,desc','keyword_info.search_volume,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 default rule: `['relevance,desc']` relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. **Note** that `relevance` is only our internal system identifier, so **it can not be used as a filter**, and you will not find this field in the `result` array. The relevance score is based on a similar principle as used in [the Keywords For Keywords](/v3/keywords_data/google/keywords_for_keywords/live/?php) endpoint. **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: `['relevance,desc','keyword_info.search_volume,desc']` */
     order_by?: string[] | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordIdeasLiveRequestInfo implements IDataforseoLabsGoogleKeywordIdeasLiveRequestInfo {
-    /** keywords required field UTF-8 encoding The maximum number of keywords you can specify: 200. 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 */
+    /** *keywords* **required field** UTF-8 encoding The maximum number of keywords you can specify: 200. 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](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;
-    /** unique location identifier 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 */
+    /** *unique location identifier* **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 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 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](https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages) 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 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](https://docs.dataforseo.com/v3/dataforseo_labs/locations_and_languages) to determine the default language */
     language_code?: string | undefined;
-    /** search mode optional field if set to true the results will be based on the phrase-match search algorithm if set to false the results will be based on the broad-match search algorithm default value: false */
+    /** *search mode* optional field if set to_`true` the results will be based on the phrase-match search algorithm if set to `false` the results will be based on the broad-match search algorithm default value: `false`n */
     closely_variants?: 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 keywords* optional field if set to_`true` only core keywords will be returned, all highly similar keywords will be excluded;   default value: `false`n */
     ignore_synonyms?: 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 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)n */
     include_clickstream_data?: boolean | undefined;
-    /** the maximum number of keywords in the results array optional field default value: 700 maximum value: 1000 */
+    /** *the maximum number of keywords in the results array* optional field default value: `700` 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 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 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?: 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 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](https://dataforseo.com/help-center/what-is-the-difference-between-the-offset-and-offset_token-parameters#offset_token) */
     offset_token?: 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: 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, not_ilike to match any string of zero or more characters note that you can not filter the results by relevance 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 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`, `not_ilike` to match any string of zero or more characters **note that you can not filter the results by `relevance`** 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',''or',['keyword_info.high_top_of_page_bid','<=',0.5]]]` 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 default rule: ['relevance,desc'] relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. Note that relevance is only our internal system identifier, so it can not be used as a filter, and you will not find this field in the result array. The relevance score is based on a similar principle as used in the Keywords For Keywords endpoint. 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: ['relevance,desc','keyword_info.search_volume,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 default rule: `['relevance,desc']` relevance is used as the default sorting rule to provide you with the closest keyword ideas. We recommend using this sorting rule to get highly-relevant search terms. **Note** that `relevance` is only our internal system identifier, so **it can not be used as a filter**, and you will not find this field in the `result` array. The relevance score is based on a similar principle as used in [the Keywords For Keywords](/v3/keywords_data/google/keywords_for_keywords/live/?php) endpoint. **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: `['relevance,desc','keyword_info.search_volume,desc']` */
     order_by?: string[] | undefined;
-    /** user-defined task identifier optional field the character limit is 255 you can use this parameter to identify the task and match it with the result you will find the specified tag value in the data object of the response */
+    /** *user-defined task identifier* optional field *the character limit is 255* you can use this parameter to identify the task and match it with the result you will find the specified `tag` value in the `data` object of the response */
     tag?: string | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordIdeasLiveRequestInfo);

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

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

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

@@ -1,43 +1,43 @@
 import { KeywordDataInfo } from "./KeywordDataInfo";
 export interface IDataforseoLabsGoogleKeywordIdeasLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keywords in a POST array keywords are returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
+    /** *keywords in a POST array* **keywords are returned with decoded %## (plus character '+' will be decoded to a space character)** */
     seed_keywords?: 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 number of results relevant to your request in our database */
+    /** *total number of results relevant to your request in our database* */
     total_count?: number | undefined;
-    /** number of results returned in the items array */
+    /** *number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** current offset value */
+    /** *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 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?: string | undefined;
-    /** contains keyword ideas and related data */
+    /** *contains keyword ideas and related data* */
     items?: KeywordDataInfo[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleKeywordIdeasLiveResultInfo implements IDataforseoLabsGoogleKeywordIdeasLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keywords in a POST array keywords are returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
+    /** *keywords in a POST array* **keywords are returned with decoded %## (plus character '+' will be decoded to a space character)** */
     seed_keywords?: 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 number of results relevant to your request in our database */
+    /** *total number of results relevant to your request in our database* */
     total_count?: number | undefined;
-    /** number of results returned in the items array */
+    /** *number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** current offset value */
+    /** *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 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?: string | undefined;
-    /** contains keyword ideas and related data */
+    /** *contains keyword ideas and related data* */
     items?: KeywordDataInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleKeywordIdeasLiveResultInfo);

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

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