dataforseo-client 2.1.2 → 2.1.3

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

@@ -10,7 +10,7 @@ export interface IAiOptimizationLlmMentionsTopMentionedBrandsLiteLiveRequestInfo
     language_name?: string | undefined;
     /** *search language code* optional field if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages` default value: `en` Note: `chat_gpt` data is available for `en` only */
     language_code?: string | undefined;
-    /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
+    /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** data specific to brand entities is available for `chat_gpt` only; **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>', 1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;
@@ -43,7 +43,7 @@ export declare class AiOptimizationLlmMentionsTopMentionedBrandsLiteLiveRequestI
     language_name?: string | undefined;
     /** *search language code* optional field if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages` default value: `en` Note: `chat_gpt` data is available for `en` only */
     language_code?: string | undefined;
-    /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
+    /** *target platform* optional field possible values: `chat_gpt`, `google` default value: `google` **Note:** data specific to brand entities is available for `chat_gpt` only; **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>', 1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;

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

@@ -10,7 +10,7 @@ export interface IAiOptimizationLlmMentionsTopMentionedBrandsLiveRequestInfo {
     language_name?: string | undefined;
     /** *search language code* optional field if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages` default value: `en` Note: `chat_gpt` data is available for `en` only */
     language_code?: string | undefined;
-    /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
+    /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** data specific to brand entities is available for `chat_gpt` only; **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;
@@ -43,7 +43,7 @@ export declare class AiOptimizationLlmMentionsTopMentionedBrandsLiveRequestInfo
     language_name?: string | undefined;
     /** *search language code* optional field if you use this field, you don't need to specify `language_name`; you can receive the list of available languages of the search engine with their `language_code` by making a separate request to the `https://api.dataforseo.com/v3/ai_optimization/llm_mentions/locations_and_languages` default value: `en` Note: `chat_gpt` data is available for `en` only */
     language_code?: string | undefined;
-    /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** if the `platform` is not specified, the data is returned for both platforms **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
+    /** *target platform* optional field possible values: `chat_gpt`, `google` **Note:** data specific to brand entities is available for `chat_gpt` only; **Note #2:**`chat_gpt` data is available for the `United States` and `English` only */
     platform?: string | undefined;
     /** *array of results filtering parameters* optional field **you can add several filters at once (8 filters maximum)** you should set a logical operator `and`, `or` between the conditions the following operators are supported: `=`, `<>`, `in`, `not_in`, `like`, `not_like`, `ilike`, `not_ilike`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['ai_search_volume','>',1000]` The full list of possible filters is available [here.](/v3/ai_optimization/llm_mentions/filters/) */
     filters?: any[] | undefined;

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

@@ -3,26 +3,26 @@ import { AiModeAiOverviewReferenceInfo } from "./AiModeAiOverviewReferenceInfo";
 export interface IAiOverviewElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** content within the item */
+    /** *content within the item* */
     text?: string | undefined;
-    /** images of the element */
+    /** *images of the element* */
     images?: AiModeImagesElementInfo[] | undefined;
-    /** references relevant to the element includes references to webpages that were used to generate the ai_overview_element */
+    /** *references relevant to the element* includes references to webpages that were used to generate the `ai_overview_element` */
     references?: AiModeAiOverviewReferenceInfo[] | undefined;
     [key: string]: any;
 }
 export declare class AiOverviewElement implements IAiOverviewElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** content within the item */
+    /** *content within the item* */
     text?: string | undefined;
-    /** images of the element */
+    /** *images of the element* */
     images?: AiModeImagesElementInfo[] | undefined;
-    /** references relevant to the element includes references to webpages that were used to generate the ai_overview_element */
+    /** *references relevant to the element* includes references to webpages that were used to generate the `ai_overview_element` */
     references?: AiModeAiOverviewReferenceInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IAiOverviewElement);

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

@@ -4,34 +4,34 @@ import { AiModeAiOverviewReferenceInfo } from "./AiModeAiOverviewReferenceInfo";
 export interface IAiOverviewExpandedComponent {
     /** type of element */
     type?: string | undefined;
-    /** reference page title */
+    /** *reference page title* */
     title?: string | undefined;
-    /** reference text text snippet from the page that was used to generate the ai_overview_element */
+    /** *reference text* text snippet from the page that was used to generate the `ai_overview_element` */
     text?: string | undefined;
-    /** content of the element in markdown format */
+    /** *content of the element in markdown format* */
     markdown?: string | undefined;
-    /** images of the element if there is none, equals null */
+    /** *images of the element* if there is none, equals `null` */
     images?: AiModeImagesElementInfo[] | undefined;
-    /** sitelinks the links shown below some of Google’s search results if there are none, equals null */
+    /** *sitelinks* the links shown below some of Google's search results if there are none, equals `null` */
     links?: LinkElement[] | undefined;
-    /** references relevant to the element includes references to webpages that were used to generate the ai_overview_element */
+    /** *references relevant to the element* includes references to webpages that were used to generate the `ai_overview_element` */
     references?: AiModeAiOverviewReferenceInfo[] | undefined;
     [key: string]: any;
 }
 export declare class AiOverviewExpandedComponent implements IAiOverviewExpandedComponent {
     /** type of element */
     type?: string | undefined;
-    /** reference page title */
+    /** *reference page title* */
     title?: string | undefined;
-    /** reference text text snippet from the page that was used to generate the ai_overview_element */
+    /** *reference text* text snippet from the page that was used to generate the `ai_overview_element` */
     text?: string | undefined;
-    /** content of the element in markdown format */
+    /** *content of the element in markdown format* */
     markdown?: string | undefined;
-    /** images of the element if there is none, equals null */
+    /** *images of the element* if there is none, equals `null` */
     images?: AiModeImagesElementInfo[] | undefined;
-    /** sitelinks the links shown below some of Google’s search results if there are none, equals null */
+    /** *sitelinks* the links shown below some of Google's search results if there are none, equals `null` */
     links?: LinkElement[] | undefined;
-    /** references relevant to the element includes references to webpages that were used to generate the ai_overview_element */
+    /** *references relevant to the element* includes references to webpages that were used to generate the `ai_overview_element` */
     references?: AiModeAiOverviewReferenceInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IAiOverviewExpandedComponent);

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

@@ -1,85 +1,85 @@
 import { RatingInfo } from "./RatingInfo";
 import { AmazonDeliveryInfo } from "./AmazonDeliveryInfo";
 export interface IAmazonInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
     /** type of element */
     type?: string | undefined;
-    /** position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group */
+    /** *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 Amazon SERP absolute position among all the elements in SERP */
+    /** *absolute rank in Amazon SERP* absolute position among all the elements in SERP */
     rank_absolute?: number | undefined;
-    /** the alignment of the element in Amazon SERP can take the following values: left, right */
+    /** *the alignment of the element in Amazon 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;
-    /** Amazon domain */
+    /** *Amazon domain* */
     domain?: string | undefined;
-    /** product title */
+    /** *product title* */
     title?: string | undefined;
-    /** URL of the product page */
+    /** *URL of the product page* */
     url?: string | undefined;
-    /** ASIN in a POST array */
+    /** *ASIN in a POST array* */
     asin?: string | undefined;
-    /** URL of the product image featured in the results */
+    /** *URL of the product image featured in the results* */
     image_url?: string | undefined;
-    /** the regular price of a product example: 49.98 */
+    /** *the regular price of a product* example: `49.98` */
     price_from?: number | undefined;
-    /** the upper limit of the product price range example: 384.99 */
+    /** *the upper limit of the product price range* example: `384.99` */
     price_to?: number | undefined;
-    /** currency in the ISO format example: USD */
+    /** *currency in the [ISO](https://en.wikipedia.org/wiki/ISO_4217) format* example: `USD` */
     currency?: string | undefined;
-    /** special offer details contains special offer details, including coupon and Subscribe & Save discounts */
+    /** *special offer details* contains special offer details, including coupon and Subscribe & Save discounts */
     special_offers?: string[] | undefined;
-    /** “Best Seller” label if the value is true, the product is marked with the “Best Seller” label */
+    /** *'Best Seller' label* if the value is `true`, the product is marked with the 'Best Seller' label */
     is_best_seller?: boolean | undefined;
-    /** “Amazon’s choice” label if the value is true, the product is marked with the “Amazon’s choice” label */
+    /** *'Amazon's choice' label* if the value is `true`, the product is marked with the 'Amazon's choice' label */
     is_amazon_choice?: boolean | undefined;
-    /** the item’s rating  the popularity rate based on reviews and displayed in SERP */
+    /** *the item's rating* the popularity rate based on reviews and displayed in SERP */
     rating?: RatingInfo | undefined;
-    /** delivery information delivery information including free and fast delivery date ranges */
+    /** *delivery information* delivery information including free and fast delivery date ranges */
     delivery_info?: AmazonDeliveryInfo | undefined;
     bought_past_month?: number | undefined;
     [key: string]: any;
 }
 export declare class AmazonInfo implements IAmazonInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
     /** type of element */
     type?: string | undefined;
-    /** position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group */
+    /** *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 Amazon SERP absolute position among all the elements in SERP */
+    /** *absolute rank in Amazon SERP* absolute position among all the elements in SERP */
     rank_absolute?: number | undefined;
-    /** the alignment of the element in Amazon SERP can take the following values: left, right */
+    /** *the alignment of the element in Amazon 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;
-    /** Amazon domain */
+    /** *Amazon domain* */
     domain?: string | undefined;
-    /** product title */
+    /** *product title* */
     title?: string | undefined;
-    /** URL of the product page */
+    /** *URL of the product page* */
     url?: string | undefined;
-    /** ASIN in a POST array */
+    /** *ASIN in a POST array* */
     asin?: string | undefined;
-    /** URL of the product image featured in the results */
+    /** *URL of the product image featured in the results* */
     image_url?: string | undefined;
-    /** the regular price of a product example: 49.98 */
+    /** *the regular price of a product* example: `49.98` */
     price_from?: number | undefined;
-    /** the upper limit of the product price range example: 384.99 */
+    /** *the upper limit of the product price range* example: `384.99` */
     price_to?: number | undefined;
-    /** currency in the ISO format example: USD */
+    /** *currency in the [ISO](https://en.wikipedia.org/wiki/ISO_4217) format* example: `USD` */
     currency?: string | undefined;
-    /** special offer details contains special offer details, including coupon and Subscribe & Save discounts */
+    /** *special offer details* contains special offer details, including coupon and Subscribe & Save discounts */
     special_offers?: string[] | undefined;
-    /** “Best Seller” label if the value is true, the product is marked with the “Best Seller” label */
+    /** *'Best Seller' label* if the value is `true`, the product is marked with the 'Best Seller' label */
     is_best_seller?: boolean | undefined;
-    /** “Amazon’s choice” label if the value is true, the product is marked with the “Amazon’s choice” label */
+    /** *'Amazon's choice' label* if the value is `true`, the product is marked with the 'Amazon's choice' label */
     is_amazon_choice?: boolean | undefined;
-    /** the item’s rating  the popularity rate based on reviews and displayed in SERP */
+    /** *the item's rating* the popularity rate based on reviews and displayed in SERP */
     rating?: RatingInfo | undefined;
-    /** delivery information delivery information including free and fast delivery date ranges */
+    /** *delivery information* delivery information including free and fast delivery date ranges */
     delivery_info?: AmazonDeliveryInfo | undefined;
     bought_past_month?: number | undefined;
     [key: string]: any;

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

@@ -1,35 +1,35 @@
 import { AmazonInfo } from "./AmazonInfo";
 export interface IAmazonRankedSerpElement {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** contains data on the SERP element the list of supported SERP elements can be found below */
+    /** *contains data on the SERP element* the list of supported SERP elements can be found below */
     serp_item?: AmazonInfo | undefined;
-    /** direct URL to Amazon results you can use it to make sure that we provided accurate results */
+    /** *direct URL to Amazon results* you can use it to make sure that we provided accurate results */
     check_url?: string | undefined;
-    /** direct URL to Amazon results contains types of all search results (items) found in the returned SERP; possible item types: amazon_serp, amazon_paid, editorial_recommendations, top_rated_from_our_brands, related_searches */
+    /** *direct URL to Amazon results* contains types of all search results (`items`) found in the returned SERP; possible item types: `amazon_serp`, `amazon_paid`, `editorial_recommendations`, `top_rated_from_our_brands`, `related_searches` */
     serp_item_types?: string[] | undefined;
-    /** total number of results in Amazon SERP */
+    /** *total number of results in Amazon SERP* */
     se_results_count?: number | undefined;
-    /** 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 */
+    /** *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;
-    /** previous to the most recent update of SERP data in the ISO 8601 format: “YYYY-MM-DDThh:mm:ss.sssssssZ” example: 2020-09-12T00:07:43.0733218Z */
+    /** *previous to the most recent update of SERP data* in the [ISO 860](https://en.wikipedia.org/wiki/ISO_8601)1 format: “YYYY-MM-DDThh:mm:ss.sssssssZ” example: `2020-09-12T00:07:43.0733218Z` */
     previous_updated_time?: string | undefined;
     [key: string]: any;
 }
 export declare class AmazonRankedSerpElement implements IAmazonRankedSerpElement {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** contains data on the SERP element the list of supported SERP elements can be found below */
+    /** *contains data on the SERP element* the list of supported SERP elements can be found below */
     serp_item?: AmazonInfo | undefined;
-    /** direct URL to Amazon results you can use it to make sure that we provided accurate results */
+    /** *direct URL to Amazon results* you can use it to make sure that we provided accurate results */
     check_url?: string | undefined;
-    /** direct URL to Amazon results contains types of all search results (items) found in the returned SERP; possible item types: amazon_serp, amazon_paid, editorial_recommendations, top_rated_from_our_brands, related_searches */
+    /** *direct URL to Amazon results* contains types of all search results (`items`) found in the returned SERP; possible item types: `amazon_serp`, `amazon_paid`, `editorial_recommendations`, `top_rated_from_our_brands`, `related_searches` */
     serp_item_types?: string[] | undefined;
-    /** total number of results in Amazon SERP */
+    /** *total number of results in Amazon SERP* */
     se_results_count?: number | undefined;
-    /** 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 */
+    /** *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;
-    /** previous to the most recent update of SERP data in the ISO 8601 format: “YYYY-MM-DDThh:mm:ss.sssssssZ” example: 2020-09-12T00:07:43.0733218Z */
+    /** *previous to the most recent update of SERP data* in the [ISO 860](https://en.wikipedia.org/wiki/ISO_8601)1 format: “YYYY-MM-DDThh:mm:ss.sssssssZ” example: `2020-09-12T00:07:43.0733218Z` */
     previous_updated_time?: string | undefined;
     [key: string]: any;
     constructor(data?: IAmazonRankedSerpElement);

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

@@ -2,26 +2,26 @@ import { PriceInfo } from "./PriceInfo";
 export interface IAppElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** link description */
+    /** *link description* */
     description?: string | undefined;
-    /** source URL */
+    /** *source URL* */
     url?: string | undefined;
-    /** price indicated in the element */
+    /** *price indicated in the element* */
     price?: PriceInfo | undefined;
     [key: string]: any;
 }
 export declare class AppElement implements IAppElement {
     /** type of element */
     type?: string | undefined;
-    /** title of a given link element */
+    /** *title of a given link element* */
     title?: string | undefined;
-    /** link description */
+    /** *link description* */
     description?: string | undefined;
-    /** source URL */
+    /** *source URL* */
     url?: string | undefined;
-    /** price indicated in the element */
+    /** *price indicated in the element* */
     price?: PriceInfo | undefined;
     [key: string]: any;
     constructor(data?: IAppElement);

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

@@ -3,54 +3,54 @@ import { PriceInfo } from "./PriceInfo";
 export interface IAppStoreSearchOrganic {
     /** type of element */
     type?: string | undefined;
-    /** position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group */
+    /** *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;
-    /** id of the app in a POST array */
+    /** *id of the app in a POST array* */
     app_id?: string | undefined;
-    /** title of the app */
+    /** *title of the app* */
     title?: string | undefined;
-    /** URL to the app page on App Store */
+    /** *URL to the app page on App Store* */
     url?: string | undefined;
-    /** URL to the app icon */
+    /** *URL to the app icon* */
     icon?: string | undefined;
-    /** the total number of reviews of the app */
+    /** *the total number of reviews of the app* */
     reviews_count?: number | undefined;
-    /** average rating of the app */
+    /** *average rating of the app* */
     rating?: RatingInfo | undefined;
-    /** indicates whether the app is free */
+    /** *indicates whether the app is free* */
     is_free?: boolean | undefined;
-    /** price of the app */
+    /** *pricing information for the app* */
     price?: PriceInfo | undefined;
     [key: string]: any;
 }
 export declare class AppStoreSearchOrganic implements IAppStoreSearchOrganic {
     /** type of element */
     type?: string | undefined;
-    /** position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group */
+    /** *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;
-    /** id of the app in a POST array */
+    /** *id of the app in a POST array* */
     app_id?: string | undefined;
-    /** title of the app */
+    /** *title of the app* */
     title?: string | undefined;
-    /** URL to the app page on App Store */
+    /** *URL to the app page on App Store* */
     url?: string | undefined;
-    /** URL to the app icon */
+    /** *URL to the app icon* */
     icon?: string | undefined;
-    /** the total number of reviews of the app */
+    /** *the total number of reviews of the app* */
     reviews_count?: number | undefined;
-    /** average rating of the app */
+    /** *average rating of the app* */
     rating?: RatingInfo | undefined;
-    /** indicates whether the app is free */
+    /** *indicates whether the app is free* */
     is_free?: boolean | undefined;
-    /** price of the app */
+    /** *pricing information for the app* */
     price?: PriceInfo | undefined;
     [key: string]: any;
     constructor(data?: IAppStoreSearchOrganic);

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

@@ -1,31 +1,31 @@
 import { AppStoreSearchOrganic } from "./AppStoreSearchOrganic";
 export interface IAppleRankedSerpElementInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** contains data on the SERP element the list of supported SERP elements can be found below */
+    /** *contains data on the SERP element* the list of supported SERP elements can be found below */
     serp_item?: AppStoreSearchOrganic | undefined;
-    /** direct URL to search engine results you can use it to make sure that we provided accurate results */
+    /** *direct URL to search engine results* you can use it to make sure that we provided accurate results */
     check_url?: string | undefined;
-    /** number of search results for the returned keyword */
+    /** *number of search results for the returned keyword* */
     se_results_count?: number | undefined;
-    /** 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 */
+    /** *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;
-    /** previous to the most recent date and time when SERP data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-10-15 12:57:46 +00:00; in this case, will equal null */
+    /** *previous to the most recent date and time when SERP data was updated* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-10-15 12:57:46 +00:00`; in this case, will equal null */
     previous_updated_time?: string | undefined;
     [key: string]: any;
 }
 export declare class AppleRankedSerpElementInfo implements IAppleRankedSerpElementInfo {
-    /** search engine type */
+    /** *search engine type* */
     se_type?: string | undefined;
-    /** contains data on the SERP element the list of supported SERP elements can be found below */
+    /** *contains data on the SERP element* the list of supported SERP elements can be found below */
     serp_item?: AppStoreSearchOrganic | undefined;
-    /** direct URL to search engine results you can use it to make sure that we provided accurate results */
+    /** *direct URL to search engine results* you can use it to make sure that we provided accurate results */
     check_url?: string | undefined;
-    /** number of search results for the returned keyword */
+    /** *number of search results for the returned keyword* */
     se_results_count?: number | undefined;
-    /** 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 */
+    /** *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;
-    /** previous to the most recent date and time when SERP data was updated in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: 2019-10-15 12:57:46 +00:00; in this case, will equal null */
+    /** *previous to the most recent date and time when SERP data was updated* in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00” example: `2019-10-15 12:57:46 +00:00`; in this case, will equal null */
     previous_updated_time?: string | undefined;
     [key: string]: any;
     constructor(data?: IAppleRankedSerpElementInfo);

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

@@ -1,14 +1,14 @@
 export interface IAudienceEstimationInfo {
-    /** indicates the upper bound of the range result */
+    /** *indicates the upper bound of the range result* */
     high?: number | undefined;
-    /** indicates the lower bound of the range result */
+    /** *indicates the lower bound of the range result* */
     low?: number | undefined;
     [key: string]: any;
 }
 export declare class AudienceEstimationInfo implements IAudienceEstimationInfo {
-    /** indicates the upper bound of the range result */
+    /** *indicates the upper bound of the range result* */
     high?: number | undefined;
-    /** indicates the lower bound of the range result */
+    /** *indicates the lower bound of the range result* */
     low?: number | undefined;
     [key: string]: any;
     constructor(data?: IAudienceEstimationInfo);

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

@@ -1,22 +1,22 @@
 export interface IAvailableLocations {
-    /** location code */
+    /** *location code* */
     location_code?: number | undefined;
-    /** location name */
+    /** *location name* */
     location_name?: string | undefined;
-    /** ISO country code of the location */
+    /** *ISO country code of the location* */
     country_iso_code?: string | undefined;
-    /** location type possible values: Country, Region */
+    /** *location type* possible values: `Country`, `Region` */
     location_type?: string | undefined;
     [key: string]: any;
 }
 export declare class AvailableLocations implements IAvailableLocations {
-    /** location code */
+    /** *location code* */
     location_code?: number | undefined;
-    /** location name */
+    /** *location name* */
     location_name?: string | undefined;
-    /** ISO country code of the location */
+    /** *ISO country code of the location* */
     country_iso_code?: string | undefined;
-    /** location type possible values: Country, Region */
+    /** *location type* possible values: `Country`, `Region` */
     location_type?: string | undefined;
     [key: string]: any;
     constructor(data?: IAvailableLocations);

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

@@ -1,14 +1,14 @@
 export interface IAvailibleVersions {
-    /** lighthouse version */
+    /** *lighthouse version* */
     version?: string | undefined;
-    /** the version is used by default if false, the version is not used by default and should be specified in the corresponding field of the POST request if necessary */
+    /** *the version is used by default* if `false`, the version is not used by default and should be specified in the corresponding field of the POST request if necessary */
     default_?: boolean | undefined;
     [key: string]: any;
 }
 export declare class AvailibleVersions implements IAvailibleVersions {
-    /** lighthouse version */
+    /** *lighthouse version* */
     version?: string | undefined;
-    /** the version is used by default if false, the version is not used by default and should be specified in the corresponding field of the POST request if necessary */
+    /** *the version is used by default* if `false`, the version is not used by default and should be specified in the corresponding field of the POST request if necessary */
     default_?: boolean | undefined;
     [key: string]: any;
     constructor(data?: IAvailibleVersions);

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

@@ -2,6 +2,7 @@ export interface IBacklinksAvailableFiltersResultInfo {
     content_duplicates?: {
         [key: string]: string;
     } | undefined;
+    /** filters available for the backlinks endpoint: */
     backlinks?: {
         [key: string]: string;
     } | undefined;
@@ -17,6 +18,7 @@ export interface IBacklinksAvailableFiltersResultInfo {
     domain_intersection?: {
         [key: string]: string;
     } | undefined;
+    /** filters available for the page intersection endpoint: */
     page_intersection?: {
         [key: string]: string;
     } | undefined;
@@ -35,6 +37,7 @@ export declare class BacklinksAvailableFiltersResultInfo implements IBacklinksAv
     content_duplicates?: {
         [key: string]: string;
     } | undefined;
+    /** filters available for the backlinks endpoint: */
     backlinks?: {
         [key: string]: string;
     } | undefined;
@@ -50,6 +53,7 @@ export declare class BacklinksAvailableFiltersResultInfo implements IBacklinksAv
     domain_intersection?: {
         [key: string]: string;
     } | undefined;
+    /** filters available for the page intersection endpoint: */
     page_intersection?: {
         [key: string]: string;
     } | undefined;

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

@@ -1 +1 @@
-{"version":3,"file":"BacklinksAvailableFiltersResultInfo.js","sourceRoot":"","sources":["../../../src/models/BacklinksAvailableFiltersResultInfo.ts"],"names":[],"mappings":"AA0BA,MAAM,OAAO,mCAAmC;IAyB5C,YAAY,IAA2C;QAEvD,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBACvB,IAAK,CAAC,QAAQ,CAAC,GAAS,IAAK,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;QACL,CAAC;IAED,CAAC;IAED,IAAI,CAAC,IAAU;QACX,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,kBAAkB,GAAG,IAAI,CAAC,oBAAoB,CAAC,CAAC;YACrD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;YACnC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;YACzC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACnD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACvD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACnD,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,oBAAoB,CAAC,CAAC;YACrD,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3C,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;QAI5C,IAAI,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QACrD,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC;QACvD,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QACrD,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACvC,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}
+{"version":3,"file":"BacklinksAvailableFiltersResultInfo.js","sourceRoot":"","sources":["../../../src/models/BacklinksAvailableFiltersResultInfo.ts"],"names":[],"mappings":"AA4BA,MAAM,OAAO,mCAAmC;IA+B5C,YAAY,IAA2C;QAEvD,IAAI,IAAI,EAAE,CAAC;YACP,KAAK,IAAI,QAAQ,IAAI,IAAI,EAAE,CAAC;gBACxB,IAAI,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC;oBACvB,IAAK,CAAC,QAAQ,CAAC,GAAS,IAAK,CAAC,QAAQ,CAAC,CAAC;YACtD,CAAC;QACL,CAAC;IAED,CAAC;IAED,IAAI,CAAC,IAAU;QACX,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,kBAAkB,GAAG,IAAI,CAAC,oBAAoB,CAAC,CAAC;YACrD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;YACnC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;YACzC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/B,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACnD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC,qBAAqB,CAAC,CAAC;YACvD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,mBAAmB,CAAC,CAAC;YACnD,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,oBAAoB,CAAC,CAAC;YACrD,IAAI,CAAC,oBAAoB,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC;YACzD,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,aAAa,CAAC,CAAC;QAC3C,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;QAI5C,IAAI,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QACrD,IAAI,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;QAC/B,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,mBAAmB,CAAC;QACvD,IAAI,CAAC,mBAAmB,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC;QACnD,IAAI,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QACrD,IAAI,CAAC,sBAAsB,CAAC,GAAG,IAAI,CAAC,oBAAoB,CAAC;QACzD,IAAI,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QACvC,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ"}