dataforseo-client 2.1.2 → 2.1.5

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

@@ -1,50 +1,50 @@
 export interface IHtmlContentInfo {
-    /** total size of the text on the page measured in bytes */
+    /** *total size of the text on the page measured in bytes* */
     plain_text_size?: number | undefined;
     /** plaintext rate value plain_text_size to size ratio */
     plain_text_rate?: number | undefined;
-    /** number of words on the page */
+    /** *number of words on the page* */
     plain_text_word_count?: number | undefined;
-    /** Automated Readability Index */
+    /** *[Automated Readability Index](https://en.wikipedia.org/wiki/Automated_readability_index)* */
     automated_readability_index?: number | undefined;
-    /** Coleman–Liau Index */
+    /** *[Coleman–Liau Index](https://en.wikipedia.org/wiki/Coleman%E2%80%93Liau_index)* */
     coleman_liau_readability_index?: number | undefined;
-    /** Dale–Chall Readability Index */
+    /** *[Dale–Chall Readability Index](https://en.wikipedia.org/wiki/Dale%E2%80%93Chall_readability_formula)* */
     dale_chall_readability_index?: number | undefined;
-    /** Flesch–Kincaid Readability Index */
+    /** *[Flesch–Kincaid Readability Index](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests)* */
     flesch_kincaid_readability_index?: number | undefined;
-    /** SMOG Readability Index */
+    /** *[SMOG Readability Index](https://en.wikipedia.org/wiki/SMOG)* */
     smog_readability_index?: number | undefined;
-    /** consistency of the meta description tag with the page content measured from 0 to 1 */
+    /** *consistency of the meta `description` tag with the page content* measured from 0 to 1 */
     description_to_content_consistency?: number | undefined;
-    /** consistency of the meta title tag with the page content measured from 0 to 1 */
+    /** *consistency of the meta `title` tag with the page content* measured from 0 to 1 */
     title_to_content_consistency?: number | undefined;
-    /** consistency of meta keywordstag with the page content measured from 0 to 1 */
+    /** *consistency of meta `keywords`tag with the page content* measured from 0 to 1 */
     meta_keywords_to_content_consistency?: number | undefined;
     [key: string]: any;
 }
 export declare class HtmlContentInfo implements IHtmlContentInfo {
-    /** total size of the text on the page measured in bytes */
+    /** *total size of the text on the page measured in bytes* */
     plain_text_size?: number | undefined;
     /** plaintext rate value plain_text_size to size ratio */
     plain_text_rate?: number | undefined;
-    /** number of words on the page */
+    /** *number of words on the page* */
     plain_text_word_count?: number | undefined;
-    /** Automated Readability Index */
+    /** *[Automated Readability Index](https://en.wikipedia.org/wiki/Automated_readability_index)* */
     automated_readability_index?: number | undefined;
-    /** Coleman–Liau Index */
+    /** *[Coleman–Liau Index](https://en.wikipedia.org/wiki/Coleman%E2%80%93Liau_index)* */
     coleman_liau_readability_index?: number | undefined;
-    /** Dale–Chall Readability Index */
+    /** *[Dale–Chall Readability Index](https://en.wikipedia.org/wiki/Dale%E2%80%93Chall_readability_formula)* */
     dale_chall_readability_index?: number | undefined;
-    /** Flesch–Kincaid Readability Index */
+    /** *[Flesch–Kincaid Readability Index](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests)* */
     flesch_kincaid_readability_index?: number | undefined;
-    /** SMOG Readability Index */
+    /** *[SMOG Readability Index](https://en.wikipedia.org/wiki/SMOG)* */
     smog_readability_index?: number | undefined;
-    /** consistency of the meta description tag with the page content measured from 0 to 1 */
+    /** *consistency of the meta `description` tag with the page content* measured from 0 to 1 */
     description_to_content_consistency?: number | undefined;
-    /** consistency of the meta title tag with the page content measured from 0 to 1 */
+    /** *consistency of the meta `title` tag with the page content* measured from 0 to 1 */
     title_to_content_consistency?: number | undefined;
-    /** consistency of meta keywordstag with the page content measured from 0 to 1 */
+    /** *consistency of meta `keywords`tag with the page content* measured from 0 to 1 */
     meta_keywords_to_content_consistency?: number | undefined;
     [key: string]: any;
     constructor(data?: IHtmlContentInfo);

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

@@ -1,15 +1,15 @@
 import { HunspellMisspelledInfo } from "./HunspellMisspelledInfo";
 export interface IHunspellInfo {
-    /** spellcheck language code */
+    /** *spellcheck language code* */
     hunspell_language_code?: string | undefined;
-    /** array of misspelled words */
+    /** *array of misspelled words* */
     misspelled?: HunspellMisspelledInfo[] | undefined;
     [key: string]: any;
 }
 export declare class HunspellInfo implements IHunspellInfo {
-    /** spellcheck language code */
+    /** *spellcheck language code* */
     hunspell_language_code?: string | undefined;
-    /** array of misspelled words */
+    /** *array of misspelled words* */
     misspelled?: HunspellMisspelledInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IHunspellInfo);

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

@@ -1,10 +1,10 @@
 export interface IHunspellMisspelledInfo {
-    /** misspelled word */
+    /** *misspelled word* */
     word?: string | undefined;
     [key: string]: any;
 }
 export declare class HunspellMisspelledInfo implements IHunspellMisspelledInfo {
-    /** misspelled word */
+    /** *misspelled word* */
     word?: string | undefined;
     [key: string]: any;
     constructor(data?: IHunspellMisspelledInfo);

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

@@ -1,15 +1,15 @@
 import { AbsoluteItems } from "./AbsoluteItems";
 export interface IInterestsComparison {
-    /** contains keyword popularity and related data */
+    /** *contains keyword popularity and related data* */
     items?: AbsoluteItems[] | undefined;
-    /** keyword popularity rates across all locations values in this array represent percentages relative to the maximum value across all locations */
+    /** *keyword popularity rates across all locations* values in this array represent percentages relative to the maximum value across all locations */
     absolute_items?: AbsoluteItems[] | undefined;
     [key: string]: any;
 }
 export declare class InterestsComparison implements IInterestsComparison {
-    /** contains keyword popularity and related data */
+    /** *contains keyword popularity and related data* */
     items?: AbsoluteItems[] | undefined;
-    /** keyword popularity rates across all locations values in this array represent percentages relative to the maximum value across all locations */
+    /** *keyword popularity rates across all locations* values in this array represent percentages relative to the maximum value across all locations */
     absolute_items?: AbsoluteItems[] | undefined;
     [key: string]: any;
     constructor(data?: IInterestsComparison);

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

@@ -1,46 +1,46 @@
 export interface IJobsElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** link description */
+    /** *link description* */
     description?: string | undefined;
-    /** location for which the job vacancy is posted */
+    /** *location for which the job vacancy is posted* */
     location?: string | undefined;
-    /** author */
+    /** *author* */
     author?: string | undefined;
-    /** the time when the job was posted */
+    /** *the time when the job was posted* */
     job_posted_time?: string | undefined;
-    /** date and time when the result was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when the result was published* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
     timestamp?: string | undefined;
-    /** contract type */
+    /** *contract type* */
     contract_type?: string | undefined;
-    /** salary */
+    /** *salary* */
     salary?: string | undefined;
-    /** source URL */
+    /** *source URL* */
     url?: string | undefined;
     [key: string]: any;
 }
 export declare class JobsElement implements IJobsElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** link description */
+    /** *link description* */
     description?: string | undefined;
-    /** location for which the job vacancy is posted */
+    /** *location for which the job vacancy is posted* */
     location?: string | undefined;
-    /** author */
+    /** *author* */
     author?: string | undefined;
-    /** the time when the job was posted */
+    /** *the time when the job was posted* */
     job_posted_time?: string | undefined;
-    /** date and time when the result was published in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-11-15 12:57:46 +00:00 */
+    /** *date and time when the result was published* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
     timestamp?: string | undefined;
-    /** contract type */
+    /** *contract type* */
     contract_type?: string | undefined;
-    /** salary */
+    /** *salary* */
     salary?: string | undefined;
-    /** source URL */
+    /** *source URL* */
     url?: string | undefined;
     [key: string]: any;
     constructor(data?: IJobsElement);

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

@@ -6,56 +6,56 @@ import { SerpInfo } from "./SerpInfo";
 import { AvgBacklinksInfo } from "./AvgBacklinksInfo";
 import { SearchIntentInfo } from "./SearchIntentInfo";
 export interface IKeywordDataInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** returned keyword idea */
+    /** *returned keyword idea* */
     keyword?: string | undefined;
-    /** location code in a POST array */
+    /** *location code in a POST array* */
     location_code?: number | undefined;
-    /** language code in a POST array */
+    /** *language code in a POST array* */
     language_code?: string | undefined;
-    /** keyword data for the returned keyword idea */
+    /** *keyword data for the returned keyword idea* */
     keyword_info?: KeywordInfo | undefined;
-    /** contains keyword search volume normalized with Bing search volume */
+    /** *contains keyword search volume normalized with Bing search volume* */
     keyword_info_normalized_with_bing?: KeywordInfoNormalizedWithInfo | undefined;
-    /** contains keyword search volume normalized with clickstream data */
+    /** *contains keyword search volume normalized with clickstream data* */
     keyword_info_normalized_with_clickstream?: KeywordInfoNormalizedWithInfo | undefined;
-    /** clickstream data for the returned keywordto retrieve results for this field, the parameter include_clickstream_data must be set to true */
+    /** *clickstream data for the returned keyword* to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true` */
     clickstream_keyword_info?: ClickstreamKeywordInfo | undefined;
-    /** additional information about the keyword */
+    /** *additional information about the keyword* */
     keyword_properties?: KeywordProperties | undefined;
-    /** SERP datathe value will be null if you didn't set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
+    /** *SERP data* the value will be `null` if you didn't set the field `include_serp_info` to `true` in the POST array or if there is no SERP data for this keyword in our database */
     serp_info?: SerpInfo | undefined;
-    /** backlink data for the returned keywordthis object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 webpages ranking organically for the keyword */
+    /** *backlink data for the returned keyword* this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 webpages ranking organically for the keyword */
     avg_backlinks_info?: AvgBacklinksInfo | undefined;
-    /** search intent info for the returned keywordlearn about search intent in this help center article */
+    /** *search intent info for the returned keyword* learn about search intent in this [help center article](https://dataforseo.com/help-center/search-intent-and-its-types) */
     search_intent_info?: SearchIntentInfo | undefined;
     [key: string]: any;
 }
 export declare class KeywordDataInfo implements IKeywordDataInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** returned keyword idea */
+    /** *returned keyword idea* */
     keyword?: string | undefined;
-    /** location code in a POST array */
+    /** *location code in a POST array* */
     location_code?: number | undefined;
-    /** language code in a POST array */
+    /** *language code in a POST array* */
     language_code?: string | undefined;
-    /** keyword data for the returned keyword idea */
+    /** *keyword data for the returned keyword idea* */
     keyword_info?: KeywordInfo | undefined;
-    /** contains keyword search volume normalized with Bing search volume */
+    /** *contains keyword search volume normalized with Bing search volume* */
     keyword_info_normalized_with_bing?: KeywordInfoNormalizedWithInfo | undefined;
-    /** contains keyword search volume normalized with clickstream data */
+    /** *contains keyword search volume normalized with clickstream data* */
     keyword_info_normalized_with_clickstream?: KeywordInfoNormalizedWithInfo | undefined;
-    /** clickstream data for the returned keywordto retrieve results for this field, the parameter include_clickstream_data must be set to true */
+    /** *clickstream data for the returned keyword* to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true` */
     clickstream_keyword_info?: ClickstreamKeywordInfo | undefined;
-    /** additional information about the keyword */
+    /** *additional information about the keyword* */
     keyword_properties?: KeywordProperties | undefined;
-    /** SERP datathe value will be null if you didn't set the field include_serp_info to true in the POST array or if there is no SERP data for this keyword in our database */
+    /** *SERP data* the value will be `null` if you didn't set the field `include_serp_info` to `true` in the POST array or if there is no SERP data for this keyword in our database */
     serp_info?: SerpInfo | undefined;
-    /** backlink data for the returned keywordthis object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 webpages ranking organically for the keyword */
+    /** *backlink data for the returned keyword* this object provides the average number of backlinks, referring pages and domains, as well as the average rank values among the top-10 webpages ranking organically for the keyword */
     avg_backlinks_info?: AvgBacklinksInfo | undefined;
-    /** search intent info for the returned keywordlearn about search intent in this help center article */
+    /** *search intent info for the returned keyword* learn about search intent in this [help center article](https://dataforseo.com/help-center/search-intent-and-its-types) */
     search_intent_info?: SearchIntentInfo | undefined;
     [key: string]: any;
     constructor(data?: IKeywordDataInfo);

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

@@ -1,52 +1,52 @@
 import { MonthlySearchesInfo } from "./MonthlySearchesInfo";
 import { SearchVolumeTrend } from "./SearchVolumeTrend";
 export interface IKeywordInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** date and time when keyword data was updatedin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”example:2019-11-15 12:57:46 +00:00 */
+    /** *date and time when keyword data was updated* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
     last_updated_time?: string | undefined;
-    /** competitionrepresents the relative amount of competition associated with the given keyword. This value is based on Google Ads data and can be between 0 and 1 (inclusive) */
+    /** *competition* represents the relative amount of competition associated with the given keyword. This value is based on Google Ads data and can be between 0 and 1 (inclusive) */
     competition?: number | undefined;
-    /** competition levelrepresents the relative level of competition associated with the given keyword in paid SERP only;possible values: LOW, MEDIUM, HIGHif competition level is unknown, the value is null;learn more about the metric in this help center article */
+    /** *competition level* represents the relative level of competition associated with the given keyword in paid SERP only; possible values: `LOW`, `MEDIUM`, `HIGH` if competition level is unknown, the value is `null`; learn more about the metric in [this help center article](https://dataforseo.com/help-center/what-is-competition) */
     competition_level?: string | undefined;
-    /** cost-per-clickrepresents the average cost per click (USD) historically paid for the keyword */
+    /** *cost-per-click* represents the average cost per click (USD) historically paid for the keyword */
     cpc?: number | undefined;
-    /** average monthly search volume raterepresents the (approximate) number of searches for the given keyword idea on google.com */
+    /** *average monthly search volume rate* represents the (approximate) number of searches for the given keyword idea on google.com */
     search_volume?: number | undefined;
-    /** minimum bid for the ad to be displayed at the top of the first pageindicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)the value may differ depending on the location specified in a POST request */
+    /** *minimum bid for the ad to be displayed at the top of the first page* indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers) the value may differ depending on the location specified in a POST request */
     low_top_of_page_bid?: number | undefined;
-    /** maximum bid for the ad to be displayed at the top of the first pageindicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)the value may differ depending on the location specified in a POST request */
+    /** *maximum bid for the ad to be displayed at the top of the first page* indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers) the value may differ depending on the location specified in a POST request */
     high_top_of_page_bid?: number | undefined;
-    /** product and service categoriesyou can download the_full list of possible categoriesn */
+    /** *product and service categories* you can download the [full list of possible categories](https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv) */
     categories?: number[] | undefined;
-    /** monthly searchesrepresents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations */
+    /** *monthly searches* represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations */
     monthly_searches?: MonthlySearchesInfo[] | undefined;
-    /** search volume trend changesrepresents search volume change in percent compared to the previous period */
+    /** *search volume trend changes* represents search volume change in percent compared to the previous period */
     search_volume_trend?: SearchVolumeTrend | undefined;
     [key: string]: any;
 }
 export declare class KeywordInfo implements IKeywordInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** date and time when keyword data was updatedin the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”example:2019-11-15 12:57:46 +00:00 */
+    /** *date and time when keyword data was updated* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-11-15 12:57:46 +00:00` */
     last_updated_time?: string | undefined;
-    /** competitionrepresents the relative amount of competition associated with the given keyword. This value is based on Google Ads data and can be between 0 and 1 (inclusive) */
+    /** *competition* represents the relative amount of competition associated with the given keyword. This value is based on Google Ads data and can be between 0 and 1 (inclusive) */
     competition?: number | undefined;
-    /** competition levelrepresents the relative level of competition associated with the given keyword in paid SERP only;possible values: LOW, MEDIUM, HIGHif competition level is unknown, the value is null;learn more about the metric in this help center article */
+    /** *competition level* represents the relative level of competition associated with the given keyword in paid SERP only; possible values: `LOW`, `MEDIUM`, `HIGH` if competition level is unknown, the value is `null`; learn more about the metric in [this help center article](https://dataforseo.com/help-center/what-is-competition) */
     competition_level?: string | undefined;
-    /** cost-per-clickrepresents the average cost per click (USD) historically paid for the keyword */
+    /** *cost-per-click* represents the average cost per click (USD) historically paid for the keyword */
     cpc?: number | undefined;
-    /** average monthly search volume raterepresents the (approximate) number of searches for the given keyword idea on google.com */
+    /** *average monthly search volume rate* represents the (approximate) number of searches for the given keyword idea on google.com */
     search_volume?: number | undefined;
-    /** minimum bid for the ad to be displayed at the top of the first pageindicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)the value may differ depending on the location specified in a POST request */
+    /** *minimum bid for the ad to be displayed at the top of the first page* indicates the value greater than about 20% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers) the value may differ depending on the location specified in a POST request */
     low_top_of_page_bid?: number | undefined;
-    /** maximum bid for the ad to be displayed at the top of the first pageindicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers)the value may differ depending on the location specified in a POST request */
+    /** *maximum bid for the ad to be displayed at the top of the first page* indicates the value greater than about 80% of the lowest bids for which ads were displayed (based on Google Ads statistics for advertisers) the value may differ depending on the location specified in a POST request */
     high_top_of_page_bid?: number | undefined;
-    /** product and service categoriesyou can download the_full list of possible categoriesn */
+    /** *product and service categories* you can download the [full list of possible categories](https://cdn.dataforseo.com/v3/categories/categories_dataforseo_labs_2023_10_25.csv) */
     categories?: number[] | undefined;
-    /** monthly searchesrepresents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations */
+    /** *monthly searches* represents the (approximate) number of searches on this keyword idea (as available for the past twelve months), targeted to the specified geographic locations */
     monthly_searches?: MonthlySearchesInfo[] | undefined;
-    /** search volume trend changesrepresents search volume change in percent compared to the previous period */
+    /** *search volume trend changes* represents search volume change in percent compared to the previous period */
     search_volume_trend?: SearchVolumeTrend | undefined;
     [key: string]: any;
     constructor(data?: IKeywordInfo);

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

@@ -1,19 +1,19 @@
 import { KeywordKpiItemInfo } from "./KeywordKpiItemInfo";
 export interface IKeywordKpi {
-    /** keyword data aggregated for desktop devices if there is no data, then the value is null */
+    /** *keyword data aggregated for desktop devices* if there is no data, then the value is_`null`n */
     desktop?: KeywordKpiItemInfo[] | undefined;
-    /** keyword data aggregated for mobile devices if there is no data, then the value is null */
+    /** *keyword data aggregated for mobile devices* if there is no data, then the value is_`null`n */
     mobile?: KeywordKpiItemInfo[] | undefined;
-    /** keyword data aggregated for tablet devices if there is no data, then the value is null */
+    /** *keyword data aggregated for tablet devices* if there is no data, then the value is_`null`n */
     tablet?: KeywordKpiItemInfo[] | undefined;
     [key: string]: any;
 }
 export declare class KeywordKpi implements IKeywordKpi {
-    /** keyword data aggregated for desktop devices if there is no data, then the value is null */
+    /** *keyword data aggregated for desktop devices* if there is no data, then the value is_`null`n */
     desktop?: KeywordKpiItemInfo[] | undefined;
-    /** keyword data aggregated for mobile devices if there is no data, then the value is null */
+    /** *keyword data aggregated for mobile devices* if there is no data, then the value is_`null`n */
     mobile?: KeywordKpiItemInfo[] | undefined;
-    /** keyword data aggregated for tablet devices if there is no data, then the value is null */
+    /** *keyword data aggregated for tablet devices* if there is no data, then the value is_`null`n */
     tablet?: KeywordKpiItemInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IKeywordKpi);

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

@@ -1,34 +1,34 @@
 export interface IKeywordKpiItemInfo {
-    /** represents the position of the relevant ad in SERP can take the following values: FirstPage1: The first ad to appear on the right side of the first search results page FirstPage2: The second ad to appear on the right side of the first search results page FirstPage3: The third ad to appear on the right side of the first search results page FirstPage4: The fourth ad to appear on the right side of the first search results page FirstPage5: The fifth ad to appear on the right side of the first search results page FirstPage6: The sixth ad to appear on the right side of the first search results page FirstPage7: The seventh ad to appear on the right side of the first search results page FirstPage8: The eighth ad to appear on the right side of the first search results page FirstPage9: The ninth ad to appear on the right side of the first search results page FirstPage10: The tenth ad to appear on the right side of the first search results page MainLine1: The first ad to appear at the top of the search results page MainLine2: The second ad to appear at the top of the search results page MainLine3: The third ad to appear at the top of the search results page MainLine4: The fourth ad to appear at the top of the search results page */
+    /** *represents the position of the relevant ad in SERP* can take the following values: `FirstPage1`: The first ad to appear on the right side of the first search results page `FirstPage2`: The second ad to appear on the right side of the first search results page `FirstPage3`: The third ad to appear on the right side of the first search results page `FirstPage4`: The fourth ad to appear on the right side of the first search results page `FirstPage5`: The fifth ad to appear on the right side of the first search results page `FirstPage6`: The sixth ad to appear on the right side of the first search results page `FirstPage7`: The seventh ad to appear on the right side of the first search results page `FirstPage8`: The eighth ad to appear on the right side of the first search results page `FirstPage9`: The ninth ad to appear on the right side of the first search results page `FirstPage10`: The tenth ad to appear on the right side of the first search results page `MainLine1`: The first ad to appear at the top of the search results page `MainLine2`: The second ad to appear at the top of the search results page `MainLine3`: The third ad to appear at the top of the search results page `MainLine4`: The fourth ad to appear at the top of the search results page */
     ad_position?: string | undefined;
-    /** ad clicks the number of clicks that the keyword and match type generated during the last month */
+    /** *ad clicks* the number of clicks that the keyword and match type generated during the last month */
     clicks?: number | undefined;
-    /** ad impressions the number of impressions that the keyword and match type generated during the last month */
+    /** *ad impressions* the number of impressions that the keyword and match type generated during the last month */
     impressions?: number | undefined;
-    /** average cost per click, USD calculated by dividing the cost of all clicks by the number of clicks */
+    /** *average cost per click, USD* calculated by dividing the cost of all clicks by the number of clicks */
     average_cpc?: number | undefined;
-    /** click-through rate as a percentage calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100 */
+    /** *click-through rate as a percentage* calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100 */
     ctr?: number | undefined;
-    /** total cost of an ad, USD the cost of using the specified keyword and match type during the last month */
+    /** *total cost of an ad, USD* the cost of using the specified keyword and match type during the last month */
     total_cost?: number | undefined;
-    /** average bid of the keyword */
+    /** *average bid of the keyword* */
     average_bid?: number | undefined;
     [key: string]: any;
 }
 export declare class KeywordKpiItemInfo implements IKeywordKpiItemInfo {
-    /** represents the position of the relevant ad in SERP can take the following values: FirstPage1: The first ad to appear on the right side of the first search results page FirstPage2: The second ad to appear on the right side of the first search results page FirstPage3: The third ad to appear on the right side of the first search results page FirstPage4: The fourth ad to appear on the right side of the first search results page FirstPage5: The fifth ad to appear on the right side of the first search results page FirstPage6: The sixth ad to appear on the right side of the first search results page FirstPage7: The seventh ad to appear on the right side of the first search results page FirstPage8: The eighth ad to appear on the right side of the first search results page FirstPage9: The ninth ad to appear on the right side of the first search results page FirstPage10: The tenth ad to appear on the right side of the first search results page MainLine1: The first ad to appear at the top of the search results page MainLine2: The second ad to appear at the top of the search results page MainLine3: The third ad to appear at the top of the search results page MainLine4: The fourth ad to appear at the top of the search results page */
+    /** *represents the position of the relevant ad in SERP* can take the following values: `FirstPage1`: The first ad to appear on the right side of the first search results page `FirstPage2`: The second ad to appear on the right side of the first search results page `FirstPage3`: The third ad to appear on the right side of the first search results page `FirstPage4`: The fourth ad to appear on the right side of the first search results page `FirstPage5`: The fifth ad to appear on the right side of the first search results page `FirstPage6`: The sixth ad to appear on the right side of the first search results page `FirstPage7`: The seventh ad to appear on the right side of the first search results page `FirstPage8`: The eighth ad to appear on the right side of the first search results page `FirstPage9`: The ninth ad to appear on the right side of the first search results page `FirstPage10`: The tenth ad to appear on the right side of the first search results page `MainLine1`: The first ad to appear at the top of the search results page `MainLine2`: The second ad to appear at the top of the search results page `MainLine3`: The third ad to appear at the top of the search results page `MainLine4`: The fourth ad to appear at the top of the search results page */
     ad_position?: string | undefined;
-    /** ad clicks the number of clicks that the keyword and match type generated during the last month */
+    /** *ad clicks* the number of clicks that the keyword and match type generated during the last month */
     clicks?: number | undefined;
-    /** ad impressions the number of impressions that the keyword and match type generated during the last month */
+    /** *ad impressions* the number of impressions that the keyword and match type generated during the last month */
     impressions?: number | undefined;
-    /** average cost per click, USD calculated by dividing the cost of all clicks by the number of clicks */
+    /** *average cost per click, USD* calculated by dividing the cost of all clicks by the number of clicks */
     average_cpc?: number | undefined;
-    /** click-through rate as a percentage calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100 */
+    /** *click-through rate as a percentage* calculated by dividing the number of clicks by the number of impressions and multiplying the result by 100 */
     ctr?: number | undefined;
-    /** total cost of an ad, USD the cost of using the specified keyword and match type during the last month */
+    /** *total cost of an ad, USD* the cost of using the specified keyword and match type during the last month */
     total_cost?: number | undefined;
-    /** average bid of the keyword */
+    /** *average bid of the keyword* */
     average_bid?: number | undefined;
     [key: string]: any;
     constructor(data?: IKeywordKpiItemInfo);

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

@@ -1,34 +1,34 @@
 export interface IKeywordProperties {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** main keyword in a groupcontains the main keyword in a group determined by the synonym clustering algorithmif the value is null, our database does not contain any keywords the corresponding algorithm could identify as synonymous with keyword */
+    /** *main keyword in a group* contains the main keyword in a group determined by the synonym clustering algorithm if the value is `null`, our database does not contain any keywords the corresponding algorithm could identify as synonymous with `keyword` */
     core_keyword?: string | undefined;
-    /** the algorithm used to identify synonymspossible values:keyword_metrics - indicates the algorithm based on keyword_info parameterstext_processing - indicates the text-based algorithmif the value is null, our database does not contain any keywords the corresponding algorithm could identify as synonymous with keyword */
+    /** *the algorithm used to identify synonyms* possible values: `keyword_metrics` - indicates the algorithm based on `keyword_info` parameters `text_processing` - indicates the text-based algorithm if the value is `null`, our database does not contain any keywords the corresponding algorithm could identify as synonymous with `keyword` */
     synonym_clustering_algorithm?: string | undefined;
-    /** difficulty of ranking in the first top-10 organic results for a keywordindicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP;learn more about the metric in this help center guide */
+    /** *difficulty of ranking in the first top-10 organic results for a keyword* indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100; calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP; learn more about the metric in [this help center guide](https://dataforseo.com/help-center/what-is-keyword-difficulty-and-how-is-it-calculated) */
     keyword_difficulty?: number | undefined;
-    /** detected language of the keywordindicates the language of the keyword as identified by our system */
+    /** *detected language of the keyword* indicates the language of the keyword as identified by our system */
     detected_language?: string | undefined;
-    /** detected language of the keyword is different from the set languageif true, the language set in the request does not match the language determined by our system for a given keyword */
+    /** *detected language of the keyword is different from the set language* if `true`, the language set in the request does not match the language determined by our system for a given keyword */
     is_another_language?: boolean | undefined;
-    /** number of words in the keywordindicates how many words the keyword consists of */
+    /** *number of words in the keyword* indicates how many words the keyword consists of */
     words_count?: number | undefined;
     [key: string]: any;
 }
 export declare class KeywordProperties implements IKeywordProperties {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** main keyword in a groupcontains the main keyword in a group determined by the synonym clustering algorithmif the value is null, our database does not contain any keywords the corresponding algorithm could identify as synonymous with keyword */
+    /** *main keyword in a group* contains the main keyword in a group determined by the synonym clustering algorithm if the value is `null`, our database does not contain any keywords the corresponding algorithm could identify as synonymous with `keyword` */
     core_keyword?: string | undefined;
-    /** the algorithm used to identify synonymspossible values:keyword_metrics - indicates the algorithm based on keyword_info parameterstext_processing - indicates the text-based algorithmif the value is null, our database does not contain any keywords the corresponding algorithm could identify as synonymous with keyword */
+    /** *the algorithm used to identify synonyms* possible values: `keyword_metrics` - indicates the algorithm based on `keyword_info` parameters `text_processing` - indicates the text-based algorithm if the value is `null`, our database does not contain any keywords the corresponding algorithm could identify as synonymous with `keyword` */
     synonym_clustering_algorithm?: string | undefined;
-    /** difficulty of ranking in the first top-10 organic results for a keywordindicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100;calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP;learn more about the metric in this help center guide */
+    /** *difficulty of ranking in the first top-10 organic results for a keyword* indicates the chance of getting in top-10 organic results for a keyword on a logarithmic scale from 0 to 100; calculated by analysing, among other parameters, link profiles of the first 10 pages in SERP; learn more about the metric in [this help center guide](https://dataforseo.com/help-center/what-is-keyword-difficulty-and-how-is-it-calculated) */
     keyword_difficulty?: number | undefined;
-    /** detected language of the keywordindicates the language of the keyword as identified by our system */
+    /** *detected language of the keyword* indicates the language of the keyword as identified by our system */
     detected_language?: string | undefined;
-    /** detected language of the keyword is different from the set languageif true, the language set in the request does not match the language determined by our system for a given keyword */
+    /** *detected language of the keyword is different from the set language* if `true`, the language set in the request does not match the language determined by our system for a given keyword */
     is_another_language?: boolean | undefined;
-    /** number of words in the keywordindicates how many words the keyword consists of */
+    /** *number of words in the keyword* indicates how many words the keyword consists of */
     words_count?: number | undefined;
     [key: string]: any;
     constructor(data?: IKeywordProperties);

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

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

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

@@ -1,14 +1,14 @@
 export interface IKeywordsDataBingAudienceEstimationIndustriesResultInfo {
-    /** ID of the industry */
+    /** *ID of the industry* */
     industry_id?: number | undefined;
-    /** name of the industry */
+    /** *name of the industry* */
     industry_name?: string | undefined;
     [key: string]: any;
 }
 export declare class KeywordsDataBingAudienceEstimationIndustriesResultInfo implements IKeywordsDataBingAudienceEstimationIndustriesResultInfo {
-    /** ID of the industry */
+    /** *ID of the industry* */
     industry_id?: number | undefined;
-    /** name of the industry */
+    /** *name of the industry* */
     industry_name?: string | undefined;
     [key: string]: any;
     constructor(data?: IKeywordsDataBingAudienceEstimationIndustriesResultInfo);

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

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

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

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

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

@@ -1,14 +1,14 @@
 export interface IKeywordsDataBingAudienceEstimationJobFunctionsResultInfo {
-    /** ID of the job function */
+    /** *ID of the job function* */
     job_function_id?: number | undefined;
-    /** name of the job function */
+    /** *name of the job function* */
     job_function_name?: string | undefined;
     [key: string]: any;
 }
 export declare class KeywordsDataBingAudienceEstimationJobFunctionsResultInfo implements IKeywordsDataBingAudienceEstimationJobFunctionsResultInfo {
-    /** ID of the job function */
+    /** *ID of the job function* */
     job_function_id?: number | undefined;
-    /** name of the job function */
+    /** *name of the job function* */
     job_function_name?: string | undefined;
     [key: string]: any;
     constructor(data?: IKeywordsDataBingAudienceEstimationJobFunctionsResultInfo);