dataforseo-client 2.1.3 → 2.1.5

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/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/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/esm/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);

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

@@ -1,15 +1,15 @@
 import { BaseSerpApiGoogleFinanceElementItem } from "./BaseSerpApiGoogleFinanceElementItem";
 export interface IMarkets {
-    /** financial market identifier possible values: US, Europe, Asia, Currencies, Crypto, Futures */
+    /** *financial market identifier* possible values: `US`, `Europe`, `Asia`, `Currencies`, `Crypto`, `Futures` */
     market?: string | undefined;
-    /** elements of search results found in SERP */
+    /** *elements of search results found in SERP* */
     items?: BaseSerpApiGoogleFinanceElementItem[] | undefined;
     [key: string]: any;
 }
 export declare class Markets implements IMarkets {
-    /** financial market identifier possible values: US, Europe, Asia, Currencies, Crypto, Futures */
+    /** *financial market identifier* possible values: `US`, `Europe`, `Asia`, `Currencies`, `Crypto`, `Futures` */
     market?: string | undefined;
-    /** elements of search results found in SERP */
+    /** *elements of search results found in SERP* */
     items?: BaseSerpApiGoogleFinanceElementItem[] | undefined;
     [key: string]: any;
     constructor(data?: IMarkets);

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

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

package/dist/esm/models/OnPageAvailableFiltersResponseInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"OnPageAvailableFiltersResponseInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageAvailableFiltersResponseInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAmC,MAAM,kCAAkC,CAAC;AACnH,OAAO,EAAE,gBAAgB,EAAqB,MAAM,oBAAoB,CAAC;AAWzE,MAAM,OAAO,kCAAoC,SAAQ,gBAAgB;IAOrE,YAAY,IAA0C;QACtD,KAAK,CAAC,IAAI,CAAC,CAAC;IAEZ,CAAC;IAED,IAAI,CAAC,IAAU;QACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;gBAC/B,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;gBAChB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC7B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,8BAA8B,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBACjE,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,kCAAkC,EAAE,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAGnB,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;QACrB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACnB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC1B,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;oBAC5C,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,CAAC,CAAC;gBACvC,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}
+{"version":3,"file":"OnPageAvailableFiltersResponseInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageAvailableFiltersResponseInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,8BAA8B,EAAmC,MAAM,kCAAkC,CAAC;AACnH,OAAO,EAAE,gBAAgB,EAAqB,MAAM,oBAAoB,CAAC;AAYzE,MAAM,OAAO,kCAAoC,SAAQ,gBAAgB;IAUrE,YAAY,IAA0C;QACtD,KAAK,CAAC,IAAI,CAAC,CAAC;IAEZ,CAAC;IAED,IAAI,CAAC,IAAU;QACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC;gBAC/B,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;gBAChB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC;oBAC7B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,8BAA8B,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBACjE,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,kCAAkC,EAAE,CAAC;QACtD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAGnB,IAAI,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;QACrB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC5B,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACnB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC1B,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;oBAC5C,IAAI,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,CAAC,CAAC;gBACvC,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}

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

@@ -1,10 +1,12 @@
 import { OnPageAvailableFiltersResultInfo } from "./OnPageAvailableFiltersResultInfo";
 import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
 export interface IOnPageAvailableFiltersTaskInfo extends IBaseResponseTaskInfo {
+    /** *array of results* contains the full list of available parameters that can be used for data filtration the parameters are grouped by the endpoint they can be used with */
     result?: OnPageAvailableFiltersResultInfo[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageAvailableFiltersTaskInfo extends BaseResponseTaskInfo implements IOnPageAvailableFiltersTaskInfo {
+    /** *array of results* contains the full list of available parameters that can be used for data filtration the parameters are grouped by the endpoint they can be used with */
     result?: OnPageAvailableFiltersResultInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageAvailableFiltersTaskInfo);

package/dist/esm/models/OnPageAvailableFiltersTaskInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"OnPageAvailableFiltersTaskInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageAvailableFiltersTaskInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAqC,MAAM,oCAAoC,CAAC;AACzH,OAAO,EAAE,oBAAoB,EAAyB,MAAM,wBAAwB,CAAC;AAWrF,MAAM,OAAO,8BAAgC,SAAQ,oBAAoB;IAOrE,YAAY,IAAsC;QAClD,KAAK,CAAC,IAAI,CAAC,CAAC;IAEZ,CAAC;IAED,IAAI,CAAC,IAAU;QACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;gBACjB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC9B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBACpE,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,8BAA8B,EAAE,CAAC;QAClD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAGnB,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;QACtB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACpB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC3B,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;oBAC5C,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,CAAC,CAAC;gBACxC,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}
+{"version":3,"file":"OnPageAvailableFiltersTaskInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageAvailableFiltersTaskInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gCAAgC,EAAqC,MAAM,oCAAoC,CAAC;AACzH,OAAO,EAAE,oBAAoB,EAAyB,MAAM,wBAAwB,CAAC;AAYrF,MAAM,OAAO,8BAAgC,SAAQ,oBAAoB;IAUrE,YAAY,IAAsC;QAClD,KAAK,CAAC,IAAI,CAAC,CAAC;IAEZ,CAAC;IAED,IAAI,CAAC,IAAU;QACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;gBAChC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC;gBACjB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAC9B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBACpE,CAAC;YACL,CAAC;QACL,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,8BAA8B,EAAE,CAAC;QAClD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAGnB,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC;QACtB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;YACpB,KAAK,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,EAAE,CAAC;gBAC3B,IAAI,IAAI,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;oBAC5C,IAAI,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,MAAM,EAAE,CAAC,CAAC;gBACxC,CAAC;YACL,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}

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

@@ -1,66 +1,66 @@
 export interface IOnPageContentParsingLiveRequestInfo {
-    /** URL of the content to parse required field URL of the page to parse example: https://www.fujielectric.com/ */
+    /** *URL of the content to parse* **required field** URL of the page to parse example: `https://www.fujielectric.com/` */
     url?: string | undefined;
-    /** custom user agent optional field custom user agent for crawling a website example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36 default value: Mozilla/5.0 (compatible; RSiteAuditor) */
+    /** *custom user agent* optional field custom user agent for crawling a website example: `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36` default value: `Mozilla/5.0 (compatible; RSiteAuditor)` */
     custom_user_agent?: string | undefined;
-    /** preset for browser screen parameters optional field if you use this field, you don’t need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factor possible values: desktop, mobile, tablet desktop preset will apply the following values: browser_screen_width: 1920 browser_screen_height: 1080 browser_screen_scale_factor: 1 mobile preset will apply the following values: browser_screen_width: 390 browser_screen_height: 844 browser_screen_scale_factor: 3 tablet preset will apply the following values: browser_screen_width: 1024 browser_screen_height: 1366 browser_screen_scale_factor: 2 Note: to use this parameter, set enable_javascript or enable_browser_rendering to true */
+    /** *preset for browser screen parameters* optional field if you use this field, you don't need to indicate `browser_screen_width`, `browser_screen_height`, `browser_screen_scale_factor`             possible values: `desktop`, `mobile`, `tablet`             `desktop` preset will apply the following values:             `browser_screen_width: 1920` `browser_screen_height: 1080` `browser_screen_scale_factor: 1`             `mobile` preset will apply the following values:             `browser_screen_width: 390` `browser_screen_height: 844` `browser_screen_scale_factor: 3`             `tablet` preset will apply the following values:             `browser_screen_width: 1024` `browser_screen_height: 1366` `browser_screen_scale_factor: 2`             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true` */
     browser_preset?: string | undefined;
-    /** browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value, in pixels: 240 maximum value, in pixels: 9999 */
+    /** *browser screen width* optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored;             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`             minimum value, in pixels: `240` maximum value, in pixels: `9999` */
     browser_screen_width?: number | undefined;
-    /** browser screen height optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value, in pixels: 240 maximum value, in pixels: 9999 */
+    /** *browser screen height* optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored;             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`             minimum value, in pixels: `240` maximum value, in pixels: `9999` */
     browser_screen_height?: number | undefined;
-    /** browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value: 0.5 maximum value: 3 */
+    /** *browser screen scale factor* optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored;             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`             minimum value: `0.5` maximum value: `3` */
     browser_screen_scale_factor?: number | undefined;
-    /** store HTML of a crawled page optional field set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint default value: false */
+    /** *store HTML of a crawled page* optional field set to `true` if you want to get the HTML of the page using the [OnPage Raw HTML endpoint](/v3/on_page/raw_html/) default value: `false` */
     store_raw_html?: boolean | undefined;
-    /** disable the cookie popup  optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false */
+    /** *disable the cookie popup* optional field set to `true` if you want to disable the popup requesting cookie consent from the user; default value: `false` */
     disable_cookie_popup?: boolean | undefined;
-    /** language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the 'type':'broken in the response array */
+    /** *language header for accessing the website* optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) **Note:** if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the `'type':'broken` in the response array */
     accept_language?: string | undefined;
-    /** load javascript on a page optional field set to true if you want to load the scripts available on a page default value: false Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
+    /** *load javascript on a page* optional field set to `true` if you want to load the scripts available on a page default value: `false` **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters); the cost can be calculated on the [Pricing Page](https://dataforseo.com/pricing/on-page/onpage-api) */
     enable_javascript?: boolean | undefined;
-    /** emulate browser rendering to measure Core Web Vitals optional field by using this parameter you will be able to emulate a browser when loading a web page; enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page; default value: false set to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response; if you use this field, enable_javascript, and load_resources parameters must be set to true Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
+    /** *emulate browser rendering to measure Core Web Vitals* optional field by using this parameter you will be able to emulate a browser when loading a web page; `enable_browser_rendering` loads styles, images, fonts, animations, videos, and other resources on a page; default value: `false` set to `true` to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response; **if you use this field, `enable_javascript`, and `load_resources` parameters must be set to `true`** **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters); the cost can be calculated on the [Pricing Page](https://dataforseo.com/pricing/on-page/onpage-api) */
     enable_browser_rendering?: boolean | undefined;
-    /** enable XMLHttpRequest on a page optional field set to true if you want our crawler to request data from a web server using the XMLHttpRequest object default value: false if you use this field, enable_javascript must be set to true; */
+    /** *enable XMLHttpRequest on a page* optional field set to `true` if you want our crawler to request data from a web server using the XMLHttpRequest object default value: `false`             if you use this field, `enable_javascript` must be set to `true`; */
     enable_xhr?: boolean | undefined;
-    /** switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors */
+    /** *switch proxy pool* optional field if `true`, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional `rate-limit` and/or `site_unreachable` errors */
     switch_pool?: boolean | undefined;
-    /** proxy pool optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors possible values: us, de */
+    /** *proxy pool* optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional `site_unreachable` errors possible values: `us`, `de` */
     ip_pool_for_scan?: string | undefined;
-    /** return page content as markdown optional field if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response; default value: false */
+    /** *return page content as markdown* optional field if set to `true`, the markdown-formatted content of the page will be returned in the `page_as_markdown` field of the response; default value: `false` */
     markdown_view?: boolean | undefined;
     [key: string]: any;
 }
 export declare class OnPageContentParsingLiveRequestInfo implements IOnPageContentParsingLiveRequestInfo {
-    /** URL of the content to parse required field URL of the page to parse example: https://www.fujielectric.com/ */
+    /** *URL of the content to parse* **required field** URL of the page to parse example: `https://www.fujielectric.com/` */
     url?: string | undefined;
-    /** custom user agent optional field custom user agent for crawling a website example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36 default value: Mozilla/5.0 (compatible; RSiteAuditor) */
+    /** *custom user agent* optional field custom user agent for crawling a website example: `Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36` default value: `Mozilla/5.0 (compatible; RSiteAuditor)` */
     custom_user_agent?: string | undefined;
-    /** preset for browser screen parameters optional field if you use this field, you don’t need to indicate browser_screen_width, browser_screen_height, browser_screen_scale_factor possible values: desktop, mobile, tablet desktop preset will apply the following values: browser_screen_width: 1920 browser_screen_height: 1080 browser_screen_scale_factor: 1 mobile preset will apply the following values: browser_screen_width: 390 browser_screen_height: 844 browser_screen_scale_factor: 3 tablet preset will apply the following values: browser_screen_width: 1024 browser_screen_height: 1366 browser_screen_scale_factor: 2 Note: to use this parameter, set enable_javascript or enable_browser_rendering to true */
+    /** *preset for browser screen parameters* optional field if you use this field, you don't need to indicate `browser_screen_width`, `browser_screen_height`, `browser_screen_scale_factor`             possible values: `desktop`, `mobile`, `tablet`             `desktop` preset will apply the following values:             `browser_screen_width: 1920` `browser_screen_height: 1080` `browser_screen_scale_factor: 1`             `mobile` preset will apply the following values:             `browser_screen_width: 390` `browser_screen_height: 844` `browser_screen_scale_factor: 3`             `tablet` preset will apply the following values:             `browser_screen_width: 1024` `browser_screen_height: 1366` `browser_screen_scale_factor: 2`             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true` */
     browser_preset?: string | undefined;
-    /** browser screen width optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value, in pixels: 240 maximum value, in pixels: 9999 */
+    /** *browser screen width* optional field you can set a custom browser screen width to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored;             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`             minimum value, in pixels: `240` maximum value, in pixels: `9999` */
     browser_screen_width?: number | undefined;
-    /** browser screen height optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value, in pixels: 240 maximum value, in pixels: 9999 */
+    /** *browser screen height* optional field you can set a custom browser screen height to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored;             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`             minimum value, in pixels: `240` maximum value, in pixels: `9999` */
     browser_screen_height?: number | undefined;
-    /** browser screen scale factor optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don’t need to indicate browser_preset as it will be ignored; Note: to use this parameter, set enable_javascript or enable_browser_rendering to true minimum value: 0.5 maximum value: 3 */
+    /** *browser screen scale factor* optional field you can set a custom browser screen resolution ratio to perform audit for a particular device; if you use this field, you don't need to indicate `browser_preset` as it will be ignored;             **Note:** to use this parameter, set `enable_javascript` or `enable_browser_rendering` to `true`             minimum value: `0.5` maximum value: `3` */
     browser_screen_scale_factor?: number | undefined;
-    /** store HTML of a crawled page optional field set to true if you want to get the HTML of the page using the OnPage Raw HTML endpoint default value: false */
+    /** *store HTML of a crawled page* optional field set to `true` if you want to get the HTML of the page using the [OnPage Raw HTML endpoint](/v3/on_page/raw_html/) default value: `false` */
     store_raw_html?: boolean | undefined;
-    /** disable the cookie popup  optional field set to true if you want to disable the popup requesting cookie consent from the user; default value: false */
+    /** *disable the cookie popup* optional field set to `true` if you want to disable the popup requesting cookie consent from the user; default value: `false` */
     disable_cookie_popup?: boolean | undefined;
-    /** language header for accessing the website optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) Note: if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the 'type':'broken in the response array */
+    /** *language header for accessing the website* optional field all locale formats are supported (xx, xx-XX, xxx-XX, etc.) **Note:** if you do not specify this parameter, some websites may deny access; in this case, pages will be returned with the `'type':'broken` in the response array */
     accept_language?: string | undefined;
-    /** load javascript on a page optional field set to true if you want to load the scripts available on a page default value: false Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
+    /** *load javascript on a page* optional field set to `true` if you want to load the scripts available on a page default value: `false` **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters); the cost can be calculated on the [Pricing Page](https://dataforseo.com/pricing/on-page/onpage-api) */
     enable_javascript?: boolean | undefined;
-    /** emulate browser rendering to measure Core Web Vitals optional field by using this parameter you will be able to emulate a browser when loading a web page; enable_browser_rendering loads styles, images, fonts, animations, videos, and other resources on a page; default value: false set to true to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response; if you use this field, enable_javascript, and load_resources parameters must be set to true Note: if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter in our help article; the cost can be calculated on the Pricing Page */
+    /** *emulate browser rendering to measure Core Web Vitals* optional field by using this parameter you will be able to emulate a browser when loading a web page; `enable_browser_rendering` loads styles, images, fonts, animations, videos, and other resources on a page; default value: `false` set to `true` to obtain Core Web Vitals (FID, CLS, LCP) metrics in the response; **if you use this field, `enable_javascript`, and `load_resources` parameters must be set to `true`** **Note:** if you use this parameter, additional charges will apply; learn more about the cost of tasks with this parameter [in our help article](https://dataforseo.com/help-center/cost-of-onpage-api-parameters); the cost can be calculated on the [Pricing Page](https://dataforseo.com/pricing/on-page/onpage-api) */
     enable_browser_rendering?: boolean | undefined;
-    /** enable XMLHttpRequest on a page optional field set to true if you want our crawler to request data from a web server using the XMLHttpRequest object default value: false if you use this field, enable_javascript must be set to true; */
+    /** *enable XMLHttpRequest on a page* optional field set to `true` if you want our crawler to request data from a web server using the XMLHttpRequest object default value: `false`             if you use this field, `enable_javascript` must be set to `true`; */
     enable_xhr?: boolean | undefined;
-    /** switch proxy pool optional field if true, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional rate-limit and/or site_unreachable errors */
+    /** *switch proxy pool* optional field if `true`, additional proxy pools will be used to obtain the requested data; the parameter can be used if a multitude of tasks is set simultaneously, resulting in occasional `rate-limit` and/or `site_unreachable` errors */
     switch_pool?: boolean | undefined;
-    /** proxy pool optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional site_unreachable errors possible values: us, de */
+    /** *proxy pool* optional field you can choose a location of the proxy pool that will be used to obtain the requested data; the parameter can be used if page content is inaccessible in one of the locations, resulting in occasional `site_unreachable` errors possible values: `us`, `de` */
     ip_pool_for_scan?: string | undefined;
-    /** return page content as markdown optional field if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response; default value: false */
+    /** *return page content as markdown* optional field if set to `true`, the markdown-formatted content of the page will be returned in the `page_as_markdown` field of the response; default value: `false` */
     markdown_view?: boolean | undefined;
     [key: string]: any;
     constructor(data?: IOnPageContentParsingLiveRequestInfo);

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

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

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

@@ -1,24 +1,24 @@
 import { CrawlStatusInfo } from "./CrawlStatusInfo";
 import { ContentParsingElement } from "./ContentParsingElement";
 export interface IOnPageContentParsingLiveResultInfo {
-    /** status of the crawling session possible values: in_progress, finished */
+    /** *status of the crawling session* possible values: `in_progress`, `finished` */
     crawl_progress?: string | undefined;
-    /** details of the crawling session */
+    /** *details of the crawling session* */
     crawl_status?: CrawlStatusInfo | undefined;
-    /** number of items in the results array */
+    /** *number of items in the results array* */
     items_count?: number | undefined;
-    /** items array */
+    /** *items array* */
     items?: ContentParsingElement[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageContentParsingLiveResultInfo implements IOnPageContentParsingLiveResultInfo {
-    /** status of the crawling session possible values: in_progress, finished */
+    /** *status of the crawling session* possible values: `in_progress`, `finished` */
     crawl_progress?: string | undefined;
-    /** details of the crawling session */
+    /** *details of the crawling session* */
     crawl_status?: CrawlStatusInfo | undefined;
-    /** number of items in the results array */
+    /** *number of items in the results array* */
     items_count?: number | undefined;
-    /** items array */
+    /** *items array* */
     items?: ContentParsingElement[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageContentParsingLiveResultInfo);

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

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

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

@@ -1,18 +1,18 @@
 export interface IOnPageContentParsingRequestInfo {
-    /** URL of the content to parse required field URL of the page to parse example: https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api */
+    /** *URL of the content to parse* **required field** URL of the page to parse example: `https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api` */
     url?: string | undefined;
-    /** ID of the task required field you can get this ID in the response of the Task POST endpoint note: the enable_content_parsing parameter in the POST request must be set to true example: '07131248-1535-0216-1000-17384017ad04' */
+    /** *ID of the task* **required field** you can get this ID in the response of the [Task POST](/v3/on_page/task_post/) endpoint **note:** the `enable_content_parsing` parameter in the POST request must be set to `true` example: `'07131248-1535-0216-1000-17384017ad04'` */
     id?: string | undefined;
-    /** return page content as markdown optional field if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response; default value: false */
+    /** *return page content as markdown* optional field if set to `true`, the markdown-formatted content of the page will be returned in the `page_as_markdown` field of the response; default value: `false` */
     markdown_view?: boolean | undefined;
     [key: string]: any;
 }
 export declare class OnPageContentParsingRequestInfo implements IOnPageContentParsingRequestInfo {
-    /** URL of the content to parse required field URL of the page to parse example: https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api */
+    /** *URL of the content to parse* **required field** URL of the page to parse example: `https://dataforseo.com/blog/a-versatile-alternative-to-google-trends-exploring-the-power-of-dataforseo-trends-api` */
     url?: string | undefined;
-    /** ID of the task required field you can get this ID in the response of the Task POST endpoint note: the enable_content_parsing parameter in the POST request must be set to true example: '07131248-1535-0216-1000-17384017ad04' */
+    /** *ID of the task* **required field** you can get this ID in the response of the [Task POST](/v3/on_page/task_post/) endpoint **note:** the `enable_content_parsing` parameter in the POST request must be set to `true` example: `'07131248-1535-0216-1000-17384017ad04'` */
     id?: string | undefined;
-    /** return page content as markdown optional field if set to true, the markdown-formatted content of the page will be returned in the page_as_markdown field of the response; default value: false */
+    /** *return page content as markdown* optional field if set to `true`, the markdown-formatted content of the page will be returned in the `page_as_markdown` field of the response; default value: `false` */
     markdown_view?: boolean | undefined;
     [key: string]: any;
     constructor(data?: IOnPageContentParsingRequestInfo);

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

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

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

@@ -1,24 +1,24 @@
 import { CrawlStatusInfo } from "./CrawlStatusInfo";
 import { ContentParsingElement } from "./ContentParsingElement";
 export interface IOnPageContentParsingResultInfo {
-    /** status of the crawling session possible values: in_progress, finished */
+    /** *status of the crawling session*             possible values: `in_progress`, `finished` */
     crawl_progress?: string | undefined;
-    /** details of the crawling session */
+    /** *details of the crawling session* */
     crawl_status?: CrawlStatusInfo | undefined;
-    /** number of items in the results array */
+    /** *number of items in the results array* */
     items_count?: number | undefined;
-    /** items array */
+    /** *items array* */
     items?: ContentParsingElement[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageContentParsingResultInfo implements IOnPageContentParsingResultInfo {
-    /** status of the crawling session possible values: in_progress, finished */
+    /** *status of the crawling session*             possible values: `in_progress`, `finished` */
     crawl_progress?: string | undefined;
-    /** details of the crawling session */
+    /** *details of the crawling session* */
     crawl_status?: CrawlStatusInfo | undefined;
-    /** number of items in the results array */
+    /** *number of items in the results array* */
     items_count?: number | undefined;
-    /** items array */
+    /** *items array* */
     items?: ContentParsingElement[] | undefined;
     [key: string]: any;
     constructor(data?: IOnPageContentParsingResultInfo);

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

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

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

@@ -1,13 +1,11 @@
 import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
 export interface IOnPageLighthouseTaskGetJsonTaskInfo extends IBaseResponseTaskInfo {
-    /** *results of Lighthouse audit* this array will include data according to the parameters specified in the POST request; description of the fields in the `result` array is available in the [official documentation](https://github.com/GoogleChrome/lighthouse/blob/master/readme.md) */
     result?: {
         [key: string]: any;
     }[] | undefined;
     [key: string]: any;
 }
 export declare class OnPageLighthouseTaskGetJsonTaskInfo extends BaseResponseTaskInfo implements IOnPageLighthouseTaskGetJsonTaskInfo {
-    /** *results of Lighthouse audit* this array will include data according to the parameters specified in the POST request; description of the fields in the `result` array is available in the [official documentation](https://github.com/GoogleChrome/lighthouse/blob/master/readme.md) */
     result?: {
         [key: string]: any;
     }[] | undefined;

package/dist/esm/models/OnPageLighthouseTaskGetJsonTaskInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"OnPageLighthouseTaskGetJsonTaskInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageLighthouseTaskGetJsonTaskInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAyB,MAAM,wBAAwB,CAAC;AAYrF,MAAM,OAAO,mCAAqC,SAAQ,oBAAoB;IAU1E,YAAY,IAA2C;QACvD,KAAK,CAAC,IAAI,CAAC,CAAC;IAEZ,CAAC;IAED,IAAI,CAAC,IAAU;QACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,mCAAmC,EAAE,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAGnB,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}
+{"version":3,"file":"OnPageLighthouseTaskGetJsonTaskInfo.js","sourceRoot":"","sources":["../../../src/models/OnPageLighthouseTaskGetJsonTaskInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAyB,MAAM,wBAAwB,CAAC;AAWrF,MAAM,OAAO,mCAAqC,SAAQ,oBAAoB;IAO1E,YAAY,IAA2C;QACvD,KAAK,CAAC,IAAI,CAAC,CAAC;IAEZ,CAAC;IAED,IAAI,CAAC,IAAU;QACX,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACjB,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBAC7B,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;YACxC,CAAC;YACD,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjC,CAAC;IACL,CAAC;IAED,MAAM,CAAC,MAAM,CAAC,IAAS;QACnB,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,IAAI,MAAM,GAAG,IAAI,mCAAmC,EAAE,CAAC;QACvD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAClB,OAAO,MAAM,CAAC;IAClB,CAAC;IAED,MAAM,CAAC,IAAU;QACb,IAAI,GAAG,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QAG5C,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAGnB,IAAI,CAAC,QAAQ,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC7B,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}