dataforseo-client 2.1.1 → 2.1.3

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

@@ -1,48 +1,48 @@
 export interface IDataforseoLabsGoogleSerpCompetitorsLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** domain name of the detected SERP competitor */
+    /** *domain name of the detected SERP competitor* */
     domain?: string | undefined;
-    /** the average position of the domain for the specified keywords the arithmetic mean of values in the keywords_positions array */
+    /** *the average position of the domain for the specified keywords* the arithmetic mean of values in the `keywords_positions` array */
     avg_position?: number | undefined;
-    /** the median position of the domain for the specified keywords the median of the values in the keywords_positions array */
+    /** *the median position of the domain for the specified keywords* the median of the values in the `keywords_positions` array */
     median_position?: number | undefined;
-    /** the margin between the greatest possible and actual keyword positions represents the relative visibility rate of the domain in SERP for the specified keywords calculated as sum(100-keywords_positions) */
+    /** *the margin between the greatest possible and actual keyword positions* represents the relative visibility rate of the domain in SERP for the specified keywords calculated as *sum(100-`keywords_positions`)* */
     rating?: number | undefined;
-    /** estimated traffic volume represents the estimated monthly traffic that specified keywords are driving to the website calculated as the sum of the products of the specified keywords’ search volume values and CTR (click-through-rate) rates at certain positions in SERP learn more about how the metric is calculated in this help center article */
+    /** *estimated traffic volume* represents the estimated monthly traffic that specified keywords are driving to the website calculated as the sum of the products of the specified keywords' search volume values and CTR (click-through-rate) rates at certain positions in SERP learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-etv-calculated) */
     etv?: number | undefined;
-    /** the number of specified keywords the domain has positions for in SERPs */
+    /** *the number of specified keywords the domain has positions for in SERPs* */
     keywords_count?: number | undefined;
-    /** SERP visibility rate represents the website visibility rate based on the SERP positions of the specified keywords Keywords with positions in the range from 1 to 10 are assigned the visibility index from 1 to 0.1, respectively Keywords with positions in the range from 11 to 20 have the fixed visibility index of 0.05 keywords with positions from 20 to 100 have the visibility index equal to 0 */
+    /** *SERP visibility rate* represents the website visibility rate based on the SERP positions of the specified keywords Keywords with positions in the range from **1 to 10** are assigned the visibility index from 1 to 0.1, respectively Keywords with positions in the range from **11 to 20** have the fixed visibility index of 0.05 keywords with positions from **20 to 100** have the visibility index equal to 0 */
     visibility?: number | undefined;
-    /** the number of SERP elements relevant to the domain represents the number of search results in SERP relevant to the domain for the specified keywords */
+    /** *the number of SERP elements relevant to the domain* represents the number of search results in SERP relevant to the domain for the specified keywords */
     relevant_serp_items?: number | undefined;
-    /** keyword positions SERP positions the related domain holds in SERP for the specified keywords */
+    /** *keyword positions* SERP positions the related domain holds in SERP for the specified keywords */
     keywords_positions?: {
         [key: string]: number[];
     } | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleSerpCompetitorsLiveItem implements IDataforseoLabsGoogleSerpCompetitorsLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** domain name of the detected SERP competitor */
+    /** *domain name of the detected SERP competitor* */
     domain?: string | undefined;
-    /** the average position of the domain for the specified keywords the arithmetic mean of values in the keywords_positions array */
+    /** *the average position of the domain for the specified keywords* the arithmetic mean of values in the `keywords_positions` array */
     avg_position?: number | undefined;
-    /** the median position of the domain for the specified keywords the median of the values in the keywords_positions array */
+    /** *the median position of the domain for the specified keywords* the median of the values in the `keywords_positions` array */
     median_position?: number | undefined;
-    /** the margin between the greatest possible and actual keyword positions represents the relative visibility rate of the domain in SERP for the specified keywords calculated as sum(100-keywords_positions) */
+    /** *the margin between the greatest possible and actual keyword positions* represents the relative visibility rate of the domain in SERP for the specified keywords calculated as *sum(100-`keywords_positions`)* */
     rating?: number | undefined;
-    /** estimated traffic volume represents the estimated monthly traffic that specified keywords are driving to the website calculated as the sum of the products of the specified keywords’ search volume values and CTR (click-through-rate) rates at certain positions in SERP learn more about how the metric is calculated in this help center article */
+    /** *estimated traffic volume* represents the estimated monthly traffic that specified keywords are driving to the website calculated as the sum of the products of the specified keywords' search volume values and CTR (click-through-rate) rates at certain positions in SERP learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-etv-calculated) */
     etv?: number | undefined;
-    /** the number of specified keywords the domain has positions for in SERPs */
+    /** *the number of specified keywords the domain has positions for in SERPs* */
     keywords_count?: number | undefined;
-    /** SERP visibility rate represents the website visibility rate based on the SERP positions of the specified keywords Keywords with positions in the range from 1 to 10 are assigned the visibility index from 1 to 0.1, respectively Keywords with positions in the range from 11 to 20 have the fixed visibility index of 0.05 keywords with positions from 20 to 100 have the visibility index equal to 0 */
+    /** *SERP visibility rate* represents the website visibility rate based on the SERP positions of the specified keywords Keywords with positions in the range from **1 to 10** are assigned the visibility index from 1 to 0.1, respectively Keywords with positions in the range from **11 to 20** have the fixed visibility index of 0.05 keywords with positions from **20 to 100** have the visibility index equal to 0 */
     visibility?: number | undefined;
-    /** the number of SERP elements relevant to the domain represents the number of search results in SERP relevant to the domain for the specified keywords */
+    /** *the number of SERP elements relevant to the domain* represents the number of search results in SERP relevant to the domain for the specified keywords */
     relevant_serp_items?: number | undefined;
-    /** keyword positions SERP positions the related domain holds in SERP for the specified keywords */
+    /** *keyword positions* SERP positions the related domain holds in SERP for the specified keywords */
     keywords_positions?: {
         [key: string]: number[];
     } | undefined;

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

@@ -1,54 +1,54 @@
 export interface IDataforseoLabsGoogleSerpCompetitorsLiveRequestInfo {
-    /** keywords array required field the results will be based on the keywords you specify in this array UTF-8 encoding; the keywords will be converted to lowercase format; you can specify the maximum of 200 keywords learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** *keywords array* **required field** the results will be based on the keywords you specify in this array UTF-8 encoding; the keywords will be converted to lowercase format; **you can specify the maximum of 200 keywords** 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 location_name parameters 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 `location_name` parameters 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 parameters 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` parameters 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 languages with their language_name parameters 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 languages with their `language_name` parameters by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `English` */
     language_name?: string | undefined;
-    /** unique language identifier 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 parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en */
+    /** *unique language identifier* **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` parameters by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `en` */
     language_code?: string | undefined;
-    /** indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true */
+    /** *indicates if the subdomains will be included in the search* optional field if set to `false`, the subdomains will be ignored default value: `true` */
     include_subdomains?: boolean | undefined;
-    /** search results type indicates type of search results included in the response optional field possible values: ['organic', 'paid', 'featured_snippet', 'local_pack'] default value: ['organic', 'paid'] */
+    /** *search results type* indicates type of search results included in the response optional field possible values:  `['organic', 'paid', 'featured_snippet', 'local_pack']` default value:  `['organic', 'paid']` */
     item_types?: string[] | undefined;
-    /** the maximum number of returned domains optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned domains* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains */
+    /** *offset in the results array of returned domains* optional field default value: `0` if you specify the `10` value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains */
     offset?: number | 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: ['median_position','in',[1,10]] [['median_position','in',[1,10]],'and',['domain','not_like','%wikipedia.org%']] [['domain','not_like','%wikipedia.org%'], 'and', [['relevant_serp_items','>',0],'or',['median_position','in',[1,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: `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: `['median_position','in',[1,10]]` `[['median_position','in',[1,10]],'and',['domain','not_like','%wikipedia.org%']]` `[['domain','not_like','%wikipedia.org%'],'and',[['relevant_serp_items','>',0],'or',['median_position','in',[1,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 the comma is used as a separator example: ['avg_position,asc'] default rule: ['rating,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: ['avg_position,asc','etv,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 the comma is used as a separator example: `['avg_position,asc']` default rule: `['rating,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: `['avg_position,asc','etv,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 DataforseoLabsGoogleSerpCompetitorsLiveRequestInfo implements IDataforseoLabsGoogleSerpCompetitorsLiveRequestInfo {
-    /** keywords array required field the results will be based on the keywords you specify in this array UTF-8 encoding; the keywords will be converted to lowercase format; you can specify the maximum of 200 keywords learn more about rules and limitations of keyword and keywords fields in DataForSEO APIs in this Help Center article */
+    /** *keywords array* **required field** the results will be based on the keywords you specify in this array UTF-8 encoding; the keywords will be converted to lowercase format; **you can specify the maximum of 200 keywords** 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 location_name parameters 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 `location_name` parameters 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 parameters 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` parameters 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 languages with their language_name parameters 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 languages with their `language_name` parameters by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `English` */
     language_name?: string | undefined;
-    /** unique language identifier 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 parameters by making a separate request to the https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages example: en */
+    /** *unique language identifier* **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` parameters by making a separate request to the  `https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages` example: `en` */
     language_code?: string | undefined;
-    /** indicates if the subdomains will be included in the search optional field if set to false, the subdomains will be ignored default value: true */
+    /** *indicates if the subdomains will be included in the search* optional field if set to `false`, the subdomains will be ignored default value: `true` */
     include_subdomains?: boolean | undefined;
-    /** search results type indicates type of search results included in the response optional field possible values: ['organic', 'paid', 'featured_snippet', 'local_pack'] default value: ['organic', 'paid'] */
+    /** *search results type* indicates type of search results included in the response optional field possible values:  `['organic', 'paid', 'featured_snippet', 'local_pack']` default value:  `['organic', 'paid']` */
     item_types?: string[] | undefined;
-    /** the maximum number of returned domains optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned domains* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains */
+    /** *offset in the results array of returned domains* optional field default value: `0` if you specify the `10` value, the first ten domains in the results array will be omitted and the data will be provided for the successive domains */
     offset?: number | 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: ['median_position','in',[1,10]] [['median_position','in',[1,10]],'and',['domain','not_like','%wikipedia.org%']] [['domain','not_like','%wikipedia.org%'], 'and', [['relevant_serp_items','>',0],'or',['median_position','in',[1,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: `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: `['median_position','in',[1,10]]` `[['median_position','in',[1,10]],'and',['domain','not_like','%wikipedia.org%']]` `[['domain','not_like','%wikipedia.org%'],'and',[['relevant_serp_items','>',0],'or',['median_position','in',[1,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 the comma is used as a separator example: ['avg_position,asc'] default rule: ['rating,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: ['avg_position,asc','etv,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 the comma is used as a separator example: `['avg_position,asc']` default rule: `['rating,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: `['avg_position,asc','etv,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?: IDataforseoLabsGoogleSerpCompetitorsLiveRequestInfo);

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

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

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

@@ -1,35 +1,35 @@
 import { DataforseoLabsGoogleSerpCompetitorsLiveItem } from "./DataforseoLabsGoogleSerpCompetitorsLiveItem";
 export interface IDataforseoLabsGoogleSerpCompetitorsLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keywords specified in the request keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
+    /** *keywords specified in the request* **keyword is returned with decoded %## (plus character '+' will be decoded to a space character)** */
     seed_keywords?: string[] | undefined;
-    /** location code in a POST array if there is no data, then the value is null */
+    /** *location code in a POST array* if there is no data, then the value is_`null`n */
     location_code?: number | undefined;
-    /** language code in a POST array if there is no data, then the value is null */
+    /** *language code in a POST array* if there is no data, then the value is_`null`n */
     language_code?: string | undefined;
-    /** the total amount of results in our database relevant to your request */
+    /** *the total amount of results in our database relevant to your request* */
     total_count?: number | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** contains detected SERP competitors and related data */
+    /** *contains detected SERP competitors and related data* */
     items?: DataforseoLabsGoogleSerpCompetitorsLiveItem[] | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleSerpCompetitorsLiveResultInfo implements IDataforseoLabsGoogleSerpCompetitorsLiveResultInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** keywords specified in the request keyword is returned with decoded %## (plus character ‘+’ will be decoded to a space character) */
+    /** *keywords specified in the request* **keyword is returned with decoded %## (plus character '+' will be decoded to a space character)** */
     seed_keywords?: string[] | undefined;
-    /** location code in a POST array if there is no data, then the value is null */
+    /** *location code in a POST array* if there is no data, then the value is_`null`n */
     location_code?: number | undefined;
-    /** language code in a POST array if there is no data, then the value is null */
+    /** *language code in a POST array* if there is no data, then the value is_`null`n */
     language_code?: string | undefined;
-    /** the total amount of results in our database relevant to your request */
+    /** *the total amount of results in our database relevant to your request* */
     total_count?: number | undefined;
-    /** the number of results returned in the items array */
+    /** *the number of results returned in the `items` array* */
     items_count?: number | undefined;
-    /** contains detected SERP competitors and related data */
+    /** *contains detected SERP competitors and related data* */
     items?: DataforseoLabsGoogleSerpCompetitorsLiveItem[] | undefined;
     [key: string]: any;
     constructor(data?: IDataforseoLabsGoogleSerpCompetitorsLiveResultInfo);

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

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

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

@@ -1,21 +1,21 @@
 import { DataforseoLabsMetricsInfo } from "./DataforseoLabsMetricsInfo";
 export interface IDataforseoLabsGoogleSubdomainsLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** returned subdomain */
+    /** *returned subdomain* */
     subdomain?: string | undefined;
-    /** ranking data relevant to subdomain */
+    /** *ranking data relevant to subdomain* */
     metrics?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;
     [key: string]: any;
 }
 export declare class DataforseoLabsGoogleSubdomainsLiveItem implements IDataforseoLabsGoogleSubdomainsLiveItem {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** returned subdomain */
+    /** *returned subdomain* */
     subdomain?: string | undefined;
-    /** ranking data relevant to subdomain */
+    /** *ranking data relevant to subdomain* */
     metrics?: {
         [key: string]: DataforseoLabsMetricsInfo;
     } | undefined;

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

@@ -1,62 +1,62 @@
 export interface IDataforseoLabsGoogleSubdomainsLiveRequestInfo {
-    /** 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 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 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` */
     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 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_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 ignore this field to get the results for all available languages example: English */
+    /** *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` ignore this field to get the results for all available languages example: `English` */
     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 ignore this field to get the results for all available languages example: en */
+    /** *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` ignore this field to get the results for all available languages example: `en` */
     language_code?: string | undefined;
-    /** display results by item type optional field indicates the type of search results included in the response 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; you will not be able to sort and filter results by the types of search results not included in the response; possible values: ['organic', 'paid', 'featured_snippet', 'local_pack'] default value: ['organic', 'paid'] */
+    /** *display results by item type* optional field indicates the type of search results included in the response **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; you will not be able to sort and filter results by the types of search results not included in the response; possible values:  `['organic', 'paid', 'featured_snippet', 'local_pack']` default value:  `['organic', 'paid']` */
     item_types?: string[] | 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 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` 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;
-    /** data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check; all — return metrics for both types of SERPs. default value: live */
+    /** *data collection mode* optional field you can use this field to filter the results; possible types of filtering: `live` — return metrics for SERPs in which the specified `target` currently has ranking results; `lost` — return metrics for SERPs in which the specified `target` had previously had ranking results, but didn't have them during the last check; `all` — return metrics for both types of SERPs. default value: `live` */
     historical_serp_mode?: string | undefined;
-    /** ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true`, only core keywords will be returned, all highly similar keywords will be excluded;   default value: `false` */
     ignore_synonyms?: boolean | undefined;
-    /** array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, , >=, =, <>, in, not_in example: ['metrics.paid.count','>',0] [['metrics.paid.count','>',0],'and',['metrics.paid.etv','>','50']] [['metrics.organic.count','>','10'], 'and', [['metrics.organic.pos_1','<>',0],'or',['metrics.organic.pos_2_3','<>',0]]] 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` example: `['metrics.paid.count','>',0]` `[['metrics.paid.count','>',0],'and',['metrics.paid.etv','>','50']]` `[['metrics.organic.count','>','10'],'and',[['metrics.organic.pos_1','<>',0],'or',['metrics.organic.pos_2_3','<>',0]]]` 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: ['metrics.paid.etv,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: ['metrics.organic.etv,desc','metrics.paid.count,asc'] default rule: ['metrics.organic.count,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: `['metrics.paid.etv,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: `['metrics.organic.etv,desc','metrics.paid.count,asc']` default rule: `['metrics.organic.count,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 DataforseoLabsGoogleSubdomainsLiveRequestInfo implements IDataforseoLabsGoogleSubdomainsLiveRequestInfo {
-    /** 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 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 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` */
     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 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_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 ignore this field to get the results for all available languages example: English */
+    /** *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` ignore this field to get the results for all available languages example: `English` */
     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 ignore this field to get the results for all available languages example: en */
+    /** *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` ignore this field to get the results for all available languages example: `en` */
     language_code?: string | undefined;
-    /** display results by item type optional field indicates the type of search results included in the response 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; you will not be able to sort and filter results by the types of search results not included in the response; possible values: ['organic', 'paid', 'featured_snippet', 'local_pack'] default value: ['organic', 'paid'] */
+    /** *display results by item type* optional field indicates the type of search results included in the response **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; you will not be able to sort and filter results by the types of search results not included in the response; possible values:  `['organic', 'paid', 'featured_snippet', 'local_pack']` default value:  `['organic', 'paid']` */
     item_types?: string[] | 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 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` 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;
-    /** data collection mode optional field you can use this field to filter the results; possible types of filtering: live — return metrics for SERPs in which the specified target currently has ranking results; lost — return metrics for SERPs in which the specified target had previously had ranking results, but didn’t have them during the last check; all — return metrics for both types of SERPs. default value: live */
+    /** *data collection mode* optional field you can use this field to filter the results; possible types of filtering: `live` — return metrics for SERPs in which the specified `target` currently has ranking results; `lost` — return metrics for SERPs in which the specified `target` had previously had ranking results, but didn't have them during the last check; `all` — return metrics for both types of SERPs. default value: `live` */
     historical_serp_mode?: string | undefined;
-    /** ignore highly similar keywords optional field if set to true, only core keywords will be returned, all highly similar keywords will be excluded; default value: false */
+    /** *ignore highly similar keywords* optional field if set to `true`, only core keywords will be returned, all highly similar keywords will be excluded;   default value: `false` */
     ignore_synonyms?: boolean | undefined;
-    /** array of results filtering parameters optional field you can add several filters at once (8 filters maximum) you should set a logical operator and, or between the conditions the following operators are supported: regex, not_regex, , >=, =, <>, in, not_in example: ['metrics.paid.count','>',0] [['metrics.paid.count','>',0],'and',['metrics.paid.etv','>','50']] [['metrics.organic.count','>','10'], 'and', [['metrics.organic.pos_1','<>',0],'or',['metrics.organic.pos_2_3','<>',0]]] 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` example: `['metrics.paid.count','>',0]` `[['metrics.paid.count','>',0],'and',['metrics.paid.etv','>','50']]` `[['metrics.organic.count','>','10'],'and',[['metrics.organic.pos_1','<>',0],'or',['metrics.organic.pos_2_3','<>',0]]]` 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: ['metrics.paid.etv,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: ['metrics.organic.etv,desc','metrics.paid.count,asc'] default rule: ['metrics.organic.count,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: `['metrics.paid.etv,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: `['metrics.organic.etv,desc','metrics.paid.count,asc']` default rule: `['metrics.organic.count,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?: IDataforseoLabsGoogleSubdomainsLiveRequestInfo);

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

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

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

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

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

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