dataforseo-client 2.1.3 → 2.1.6

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

@@ -2,34 +2,34 @@ import { BaseSerpApiGoogleFinanceElementItem } from "./BaseSerpApiGoogleFinanceE
 export interface IGoogleFinanceNewsElement {
     /** type of element */
     type?: string | undefined;
-    /** title of the news article */
+    /** *title of the news article* */
     title?: string | undefined;
-    /** URL to the page of the market index on Google Finance */
+    /** *URL to the page of the market index on Google Finance* */
     url?: string | undefined;
-    /** name of the news source name of the website where the news article is published */
+    /** *name of the news source* name of the website where the news article is published */
     source?: string | undefined;
-    /** featured image URL URL of the news article’s featured image */
+    /** *featured image URL* URL of the news article's featured image */
     image_url?: string | undefined;
-    /** date and time of the value readout in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2025-02-10 09:40:00 +00:00 */
+    /** *date and time of the value readout* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2025-02-10 09:40:00 +00:00` */
     timestamp?: string | undefined;
-    /** market indexes quoted in the news article information about market indexes quoted in the google_finance_news_element */
+    /** *market indexes quoted in the news article* information about market indexes quoted in the `google_finance_news_element` */
     quotes?: BaseSerpApiGoogleFinanceElementItem[] | undefined;
     [key: string]: any;
 }
 export declare class GoogleFinanceNewsElement implements IGoogleFinanceNewsElement {
     /** type of element */
     type?: string | undefined;
-    /** title of the news article */
+    /** *title of the news article* */
     title?: string | undefined;
-    /** URL to the page of the market index on Google Finance */
+    /** *URL to the page of the market index on Google Finance* */
     url?: string | undefined;
-    /** name of the news source name of the website where the news article is published */
+    /** *name of the news source* name of the website where the news article is published */
     source?: string | undefined;
-    /** featured image URL URL of the news article’s featured image */
+    /** *featured image URL* URL of the news article's featured image */
     image_url?: string | undefined;
-    /** date and time of the value readout in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2025-02-10 09:40:00 +00:00 */
+    /** *date and time of the value readout* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2025-02-10 09:40:00 +00:00` */
     timestamp?: string | undefined;
-    /** market indexes quoted in the news article information about market indexes quoted in the google_finance_news_element */
+    /** *market indexes quoted in the news article* information about market indexes quoted in the `google_finance_news_element` */
     quotes?: BaseSerpApiGoogleFinanceElementItem[] | undefined;
     [key: string]: any;
     constructor(data?: IGoogleFinanceNewsElement);

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

@@ -2,78 +2,78 @@ import { AiModeRectangleInfo } from "./AiModeRectangleInfo";
 export interface IGoogleJobsItem {
     /** type of element */
     type?: string | undefined;
-    /** group rank in SERP position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group */
+    /** *group rank in SERP* position within a group of elements with identical `type` values positions of elements with different `type` values are omitted from `rank_group` */
     rank_group?: number | undefined;
-    /** absolute rank in SERP absolute position among all the elements in SERP */
+    /** *absolute rank in SERP* absolute position among all the elements in SERP */
     rank_absolute?: number | undefined;
-    /** the alignment of the element in SERP can take the following values: left, right */
+    /** *the alignment of the element in SERP* can take the following values: `left`, `right` */
     position?: string | undefined;
-    /** the XPath of the element */
+    /** *the [XPath](https://en.wikipedia.org/wiki/XPath) of the element* */
     xpath?: string | undefined;
-    /** ID of the job on Google Jobs */
+    /** *ID of the job on Google Jobs* */
     job_id?: string | undefined;
-    /** title of the element */
+    /** *title of the element* */
     title?: string | undefined;
-    /** name of the employer */
+    /** *name of the employer* */
     employer_name?: string | undefined;
-    /** URL to the employer’s website */
+    /** *URL to the employer's website* */
     employer_url?: string | undefined;
-    /** URL to the image used in the job posting */
+    /** *URL to the image used in the job posting* */
     employer_image_url?: string | undefined;
-    /** location for which the job vacancy is posted */
+    /** *location for which the job vacancy is posted* */
     location?: string | undefined;
-    /** original source of the job vacancy */
+    /** *original source of the job vacancy* */
     source_name?: string | undefined;
-    /** URL to the original source of the job vacancy */
+    /** *URL to the original source of the job vacancy* */
     source_url?: string | undefined;
-    /** the salary indicated in the job vacancy if the salary isn’t indicated, this field will equal null */
+    /** *the salary indicated in the job vacancy* if the salary isn't indicated, this field will equal `null` */
     salary?: string | undefined;
-    /** employment contract type */
+    /** *employment contract type* */
     contract_type?: 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;
-    /** indicates how long ago the job vacancy was posted */
+    /** *indicates how long ago the job vacancy was posted* */
     time_ago?: string | undefined;
-    /** rectangle parameters contains cartesian coordinates and pixel dimensions of the result’s snippet in SERP; in this case, will equal null */
+    /** *rectangle parameters* contains cartesian coordinates and pixel dimensions of the result's snippet in SERP; in this case, will equal `null` */
     rectangle?: AiModeRectangleInfo | undefined;
     [key: string]: any;
 }
 export declare class GoogleJobsItem implements IGoogleJobsItem {
     /** type of element */
     type?: string | undefined;
-    /** group rank in SERP position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group */
+    /** *group rank in SERP* position within a group of elements with identical `type` values positions of elements with different `type` values are omitted from `rank_group` */
     rank_group?: number | undefined;
-    /** absolute rank in SERP absolute position among all the elements in SERP */
+    /** *absolute rank in SERP* absolute position among all the elements in SERP */
     rank_absolute?: number | undefined;
-    /** the alignment of the element in SERP can take the following values: left, right */
+    /** *the alignment of the element in SERP* can take the following values: `left`, `right` */
     position?: string | undefined;
-    /** the XPath of the element */
+    /** *the [XPath](https://en.wikipedia.org/wiki/XPath) of the element* */
     xpath?: string | undefined;
-    /** ID of the job on Google Jobs */
+    /** *ID of the job on Google Jobs* */
     job_id?: string | undefined;
-    /** title of the element */
+    /** *title of the element* */
     title?: string | undefined;
-    /** name of the employer */
+    /** *name of the employer* */
     employer_name?: string | undefined;
-    /** URL to the employer’s website */
+    /** *URL to the employer's website* */
     employer_url?: string | undefined;
-    /** URL to the image used in the job posting */
+    /** *URL to the image used in the job posting* */
     employer_image_url?: string | undefined;
-    /** location for which the job vacancy is posted */
+    /** *location for which the job vacancy is posted* */
     location?: string | undefined;
-    /** original source of the job vacancy */
+    /** *original source of the job vacancy* */
     source_name?: string | undefined;
-    /** URL to the original source of the job vacancy */
+    /** *URL to the original source of the job vacancy* */
     source_url?: string | undefined;
-    /** the salary indicated in the job vacancy if the salary isn’t indicated, this field will equal null */
+    /** *the salary indicated in the job vacancy* if the salary isn't indicated, this field will equal `null` */
     salary?: string | undefined;
-    /** employment contract type */
+    /** *employment contract type* */
     contract_type?: 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;
-    /** indicates how long ago the job vacancy was posted */
+    /** *indicates how long ago the job vacancy was posted* */
     time_ago?: string | undefined;
-    /** rectangle parameters contains cartesian coordinates and pixel dimensions of the result’s snippet in SERP; in this case, will equal null */
+    /** *rectangle parameters* contains cartesian coordinates and pixel dimensions of the result's snippet in SERP; in this case, will equal `null` */
     rectangle?: AiModeRectangleInfo | undefined;
     [key: string]: any;
     constructor(data?: IGoogleJobsItem);

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

@@ -1,18 +1,18 @@
 export interface IGraphItems {
-    /** date and time of the value readout in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2025-02-10 09:40:00 +00:00 */
+    /** *date and time of the value readout* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2025-02-10 09:40:00 +00:00` */
     timestamp?: string | undefined;
-    /** point value on graph */
+    /** *point value on graph* */
     value?: number | undefined;
-    /** volume value on graph */
+    /** *volume value on graph* */
     volume?: number | undefined;
     [key: string]: any;
 }
 export declare class GraphItems implements IGraphItems {
-    /** date and time of the value readout in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2025-02-10 09:40:00 +00:00 */
+    /** *date and time of the value readout* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2025-02-10 09:40:00 +00:00` */
     timestamp?: string | undefined;
-    /** point value on graph */
+    /** *point value on graph* */
     value?: number | undefined;
-    /** volume value on graph */
+    /** *volume value on graph* */
     volume?: number | undefined;
     [key: string]: any;
     constructor(data?: IGraphItems);

package/dist/cjs/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](https://en.wikipedia.org/wiki/Automated_readability_index)* */
+    /** Automated Readability Index */
     automated_readability_index?: number | undefined;
-    /** *[Coleman–Liau Index](https://en.wikipedia.org/wiki/Coleman%E2%80%93Liau_index)* */
+    /** Coleman–Liau Index */
     coleman_liau_readability_index?: number | undefined;
-    /** *[Dale–Chall Readability Index](https://en.wikipedia.org/wiki/Dale%E2%80%93Chall_readability_formula)* */
+    /** Dale–Chall Readability Index */
     dale_chall_readability_index?: number | undefined;
-    /** *[Flesch–Kincaid Readability Index](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests)* */
+    /** Flesch–Kincaid Readability Index */
     flesch_kincaid_readability_index?: number | undefined;
-    /** *[SMOG Readability Index](https://en.wikipedia.org/wiki/SMOG)* */
+    /** SMOG Readability Index */
     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 contentmeasured 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 contentmeasured from 0 to 1 */
     title_to_content_consistency?: number | undefined;
-    /** *consistency of meta `keywords`tag with the page content* measured from 0 to 1 */
+    /** consistency of meta keywordstag with the page contentmeasured 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](https://en.wikipedia.org/wiki/Automated_readability_index)* */
+    /** Automated Readability Index */
     automated_readability_index?: number | undefined;
-    /** *[Coleman–Liau Index](https://en.wikipedia.org/wiki/Coleman%E2%80%93Liau_index)* */
+    /** Coleman–Liau Index */
     coleman_liau_readability_index?: number | undefined;
-    /** *[Dale–Chall Readability Index](https://en.wikipedia.org/wiki/Dale%E2%80%93Chall_readability_formula)* */
+    /** Dale–Chall Readability Index */
     dale_chall_readability_index?: number | undefined;
-    /** *[Flesch–Kincaid Readability Index](https://en.wikipedia.org/wiki/Flesch%E2%80%93Kincaid_readability_tests)* */
+    /** Flesch–Kincaid Readability Index */
     flesch_kincaid_readability_index?: number | undefined;
-    /** *[SMOG Readability Index](https://en.wikipedia.org/wiki/SMOG)* */
+    /** SMOG Readability Index */
     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 contentmeasured 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 contentmeasured from 0 to 1 */
     title_to_content_consistency?: number | undefined;
-    /** *consistency of meta `keywords`tag with the page content* measured from 0 to 1 */
+    /** consistency of meta keywordstag with the page contentmeasured from 0 to 1 */
     meta_keywords_to_content_consistency?: number | undefined;
     [key: string]: any;
     constructor(data?: IHtmlContentInfo);

package/dist/cjs/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/cjs/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/cjs/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/cjs/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/cjs/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/cjs/models/LastModified.d.ts

@@ -1,18 +1,18 @@
 export interface ILastModified {
-    /** *date and time when the header was last modified* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` if there is no data, the value will be `null` */
+    /** date and time when the header was last modifiedin the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00'example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null */
     header?: string | undefined;
-    /** *date and time when the sitemap was last modified* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` if there is no data, the value will be `null` */
+    /** date and time when the sitemap was last modifiedin the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00'example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null */
     sitemap?: string | undefined;
-    /** *date and time when the meta tag was last modified* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` if there is no data, the value will be `null` */
+    /** date and time when the meta tag was last modifiedin the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00'example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null */
     meta_tag?: string | undefined;
     [key: string]: any;
 }
 export declare class LastModified implements ILastModified {
-    /** *date and time when the header was last modified* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` if there is no data, the value will be `null` */
+    /** date and time when the header was last modifiedin the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00'example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null */
     header?: string | undefined;
-    /** *date and time when the sitemap was last modified* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` if there is no data, the value will be `null` */
+    /** date and time when the sitemap was last modifiedin the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00'example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null */
     sitemap?: string | undefined;
-    /** *date and time when the meta tag was last modified* in the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00' example: `2019-11-15 12:57:46 +00:00` if there is no data, the value will be `null` */
+    /** date and time when the meta tag was last modifiedin the UTC format: 'yyyy-mm-dd hh-mm-ss +00:00'example:2019-11-15 12:57:46 +00:00if there is no data, the value will be null */
     meta_tag?: string | undefined;
     [key: string]: any;
     constructor(data?: ILastModified);

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

@@ -9,11 +9,11 @@ export interface ILlmMentionsAggregatedMetricsInfo {
     platform?: AggregatedMetricsItemInfo[] | undefined;
     /** *found top source domains relevant to the target* array of objects containing data on top domains that are cited as sources in LLM responses learn more about the sources and how to retrieve LLM citation data at our [Help Center](https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api) */
     sources_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries */
+    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     search_results_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     brand_entities_title?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries **Note:** available only for `chat_gpt` */
     brand_entities_category?: AggregatedMetricsItemInfo[] | undefined;
     /** *aggregated mentions metrics summary* contains overall aggregated LLM mention metrics across all found domains */
     total?: AggregatedMetricsInfoTotalInfo | undefined;
@@ -28,11 +28,11 @@ export declare class LlmMentionsAggregatedMetricsInfo implements ILlmMentionsAgg
     platform?: AggregatedMetricsItemInfo[] | undefined;
     /** *found top source domains relevant to the target* array of objects containing data on top domains that are cited as sources in LLM responses learn more about the sources and how to retrieve LLM citation data at our [Help Center](https://dataforseo.com/help-center/how-to-get-llm-citation-data-with-llm-mentions-api) */
     sources_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries */
+    /** *found top search results domains relevant to the target* array of objects containing data on top domains that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     search_results_domain?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity titles that appear in search results related to LLM queries; **Note:** available only for `chat_gpt` */
     brand_entities_title?: AggregatedMetricsItemInfo[] | undefined;
-    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries */
+    /** *data on brand entities relevant to the target* array of objects containing data on brand entity categories that appear in search results related to LLM queries **Note:** available only for `chat_gpt` */
     brand_entities_category?: AggregatedMetricsItemInfo[] | undefined;
     /** *aggregated mentions metrics summary* contains overall aggregated LLM mention metrics across all found domains */
     total?: AggregatedMetricsInfoTotalInfo | undefined;

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

@@ -1,14 +1,14 @@
 export interface ILocalJustificationInfo {
     /** type of element */
     type?: string | undefined;
-    /** text snippet of local justification */
+    /** *text snippet of local justification* */
     text?: string | undefined;
     [key: string]: any;
 }
 export declare class LocalJustificationInfo implements ILocalJustificationInfo {
     /** type of element */
     type?: string | undefined;
-    /** text snippet of local justification */
+    /** *text snippet of local justification* */
     text?: string | undefined;
     [key: string]: any;
     constructor(data?: ILocalJustificationInfo);