dataforseo-client 2.1.9 → 2.1.11

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

@@ -1,10 +1,10 @@
 import { RatingInfo } from "./RatingInfo";
-import { LinkElement } from "./LinkElement";
-import { AboutThisResultElement } from "./AboutThisResultElement";
 import { RankChanges } from "./RankChanges";
 import { BacklinksInfo } from "./BacklinksInfo";
 import { RankInfo } from "./RankInfo";
 import { Table } from "./Table";
+import { LinkElement } from "./LinkElement";
+import { AboutThisResultElement } from "./AboutThisResultElement";
 import { AdLinkElement } from "./AdLinkElement";
 import { DataforseoLabsCarouselElement } from "./DataforseoLabsCarouselElement";
 import { MultiCarouselElement } from "./MultiCarouselElement";
@@ -71,43 +71,21 @@ export declare class BaseDataforseoLabsApiElementItem implements IBaseDataforseo
     static fromJS(data: any): BaseDataforseoLabsApiElementItem;
     toJSON(data?: any): any;
 }
-export interface IDataLabsOrganicSerpElementItem extends IBaseDataforseoLabsApiElementItem {
-    /** *subdomain in SERP* */
-    domain?: string | undefined;
+export interface IDataLabsLocalPackSerpElementItem extends IBaseDataforseoLabsApiElementItem {
     /** *title of the result in SERP* */
     title?: string | undefined;
-    /** *relevant URL in SERP* */
-    url?: string | undefined;
-    /** *breadcrumb in SERP* */
-    breadcrumb?: string | undefined;
-    /** *relevant website name in SERP* */
-    website_name?: string | undefined;
-    /** *indicates whether the element contains an `image`* **Note:** this check no longer appears in SERP */
-    is_image?: boolean | undefined;
-    /** *indicates whether the element contains a `video`* **Note:** this check no longer appears in SERP */
-    is_video?: boolean | undefined;
-    /** *indicates whether the element is a `featured_snippet`* **Note:** this check no longer appears in SERP */
-    is_featured_snippet?: boolean | undefined;
-    /** *indicates whether the element is marked as malicious* **Note:** this check no longer appears in SERP */
-    is_malicious?: boolean | undefined;
-    /** *array of properties detected for the SERP element* lists the properties that are true for this element each value in the array represents a detected property  example: if `is_image` is present in the array, the element contains an image possible values in the array: `is_image`, `is_video`, `is_featured_snippet`, `amp_version`, `is_malicious`, `is_web_story`, `is_highly_cited` equals `null` if none of the properties are detected for the element learn more about the `checks` array in [this Help Center article](https://dataforseo.com/help-center/whats-a-checks-array-in-the-google-organic-serp-api) */
-    checks?: string[] | undefined;
     /** *description of the results element in SERP* */
     description?: string | undefined;
-    /** *includes additional information appended before the result description in SERP* */
-    pre_snippet?: string | undefined;
-    /** *includes additional information appended after the result description in SERP* */
-    extended_snippet?: string | undefined;
-    /** *Accelerated Mobile Pages* indicates whether an item has the Accelerated Mobile Page (AMP) version **Note:** this check no longer appears in SERP */
-    amp_version?: boolean | undefined;
+    /** *subdomain in SERP* */
+    domain?: string | undefined;
+    /** *phone number* */
+    phone?: string | undefined;
+    /** *relevant URL in SERP* */
+    url?: string | undefined;
+    /** *indicates whether the element is an ad* */
+    is_paid?: boolean | undefined;
     /** *the item's rating*             the popularity rate based on reviews and displayed in SERP */
     rating?: RatingInfo | undefined;
-    /** *words highlighted in bold within the results `description`* */
-    highlighted?: string[] | undefined;
-    /** *sitelinks*             the links shown below some of Google's search results             if there are none, equals `null` */
-    links?: LinkElement[] | undefined;
-    /** @deprecated *contains information from the 'About this result' panel*             ['About this result' panel](https://blog.google/products/search/learn-more-and-get-more-from-search/) provides additional context about why Google returned this result for the given query;             this feature appears after clicking on the three dots next to most results */
-    about_this_result?: AboutThisResultElement | undefined;
     /** *primary domain name in SERP* */
     main_domain?: string | undefined;
     /** *URL in SERP that does not specify the HTTPs protocol and domain name* */
@@ -126,43 +104,21 @@ export interface IDataLabsOrganicSerpElementItem extends IBaseDataforseoLabsApiE
     rank_info?: RankInfo | undefined;
     [key: string]: any;
 }
-export declare class DataLabsOrganicSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsOrganicSerpElementItem {
-    /** *subdomain in SERP* */
-    domain?: string | undefined;
+export declare class DataLabsLocalPackSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsLocalPackSerpElementItem {
     /** *title of the result in SERP* */
     title?: string | undefined;
-    /** *relevant URL in SERP* */
-    url?: string | undefined;
-    /** *breadcrumb in SERP* */
-    breadcrumb?: string | undefined;
-    /** *relevant website name in SERP* */
-    website_name?: string | undefined;
-    /** *indicates whether the element contains an `image`* **Note:** this check no longer appears in SERP */
-    is_image?: boolean | undefined;
-    /** *indicates whether the element contains a `video`* **Note:** this check no longer appears in SERP */
-    is_video?: boolean | undefined;
-    /** *indicates whether the element is a `featured_snippet`* **Note:** this check no longer appears in SERP */
-    is_featured_snippet?: boolean | undefined;
-    /** *indicates whether the element is marked as malicious* **Note:** this check no longer appears in SERP */
-    is_malicious?: boolean | undefined;
-    /** *array of properties detected for the SERP element* lists the properties that are true for this element each value in the array represents a detected property  example: if `is_image` is present in the array, the element contains an image possible values in the array: `is_image`, `is_video`, `is_featured_snippet`, `amp_version`, `is_malicious`, `is_web_story`, `is_highly_cited` equals `null` if none of the properties are detected for the element learn more about the `checks` array in [this Help Center article](https://dataforseo.com/help-center/whats-a-checks-array-in-the-google-organic-serp-api) */
-    checks?: string[] | undefined;
     /** *description of the results element in SERP* */
     description?: string | undefined;
-    /** *includes additional information appended before the result description in SERP* */
-    pre_snippet?: string | undefined;
-    /** *includes additional information appended after the result description in SERP* */
-    extended_snippet?: string | undefined;
-    /** *Accelerated Mobile Pages* indicates whether an item has the Accelerated Mobile Page (AMP) version **Note:** this check no longer appears in SERP */
-    amp_version?: boolean | undefined;
+    /** *subdomain in SERP* */
+    domain?: string | undefined;
+    /** *phone number* */
+    phone?: string | undefined;
+    /** *relevant URL in SERP* */
+    url?: string | undefined;
+    /** *indicates whether the element is an ad* */
+    is_paid?: boolean | undefined;
     /** *the item's rating*             the popularity rate based on reviews and displayed in SERP */
     rating?: RatingInfo | undefined;
-    /** *words highlighted in bold within the results `description`* */
-    highlighted?: string[] | undefined;
-    /** *sitelinks*             the links shown below some of Google's search results             if there are none, equals `null` */
-    links?: LinkElement[] | undefined;
-    /** @deprecated *contains information from the 'About this result' panel*             ['About this result' panel](https://blog.google/products/search/learn-more-and-get-more-from-search/) provides additional context about why Google returned this result for the given query;             this feature appears after clicking on the three dots next to most results */
-    about_this_result?: AboutThisResultElement | undefined;
     /** *primary domain name in SERP* */
     main_domain?: string | undefined;
     /** *URL in SERP that does not specify the HTTPs protocol and domain name* */
@@ -180,9 +136,9 @@ export declare class DataLabsOrganicSerpElementItem extends BaseDataforseoLabsAp
     /** *page and domain rank information* */
     rank_info?: RankInfo | undefined;
     [key: string]: any;
-    constructor(data?: IDataLabsOrganicSerpElementItem);
+    constructor(data?: IDataLabsLocalPackSerpElementItem);
     init(data?: any): void;
-    static fromJS(data: any): DataLabsOrganicSerpElementItem;
+    static fromJS(data: any): DataLabsLocalPackSerpElementItem;
     toJSON(data?: any): any;
 }
 export interface IDataLabsFeaturedSnippetSerpElementItem extends IBaseDataforseoLabsApiElementItem {
@@ -251,6 +207,120 @@ export declare class DataLabsFeaturedSnippetSerpElementItem extends BaseDatafors
     static fromJS(data: any): DataLabsFeaturedSnippetSerpElementItem;
     toJSON(data?: any): any;
 }
+export interface IDataLabsOrganicSerpElementItem extends IBaseDataforseoLabsApiElementItem {
+    /** *subdomain in SERP* */
+    domain?: string | undefined;
+    /** *title of the result in SERP* */
+    title?: string | undefined;
+    /** *relevant URL in SERP* */
+    url?: string | undefined;
+    /** *breadcrumb in SERP* */
+    breadcrumb?: string | undefined;
+    /** *relevant website name in SERP* */
+    website_name?: string | undefined;
+    /** *indicates whether the element contains an `image`* **Note:** this check no longer appears in SERP */
+    is_image?: boolean | undefined;
+    /** *indicates whether the element contains a `video`* **Note:** this check no longer appears in SERP */
+    is_video?: boolean | undefined;
+    /** *indicates whether the element is a `featured_snippet`* **Note:** this check no longer appears in SERP */
+    is_featured_snippet?: boolean | undefined;
+    /** *indicates whether the element is marked as malicious* **Note:** this check no longer appears in SERP */
+    is_malicious?: boolean | undefined;
+    /** *array of properties detected for the SERP element* lists the properties that are true for this element each value in the array represents a detected property  example: if `is_image` is present in the array, the element contains an image possible values in the array: `is_image`, `is_video`, `is_featured_snippet`, `amp_version`, `is_malicious`, `is_web_story`, `is_highly_cited` equals `null` if none of the properties are detected for the element learn more about the `checks` array in [this Help Center article](https://dataforseo.com/help-center/whats-a-checks-array-in-the-google-organic-serp-api) */
+    checks?: string[] | undefined;
+    /** *description of the results element in SERP* */
+    description?: string | undefined;
+    /** *includes additional information appended before the result description in SERP* */
+    pre_snippet?: string | undefined;
+    /** *includes additional information appended after the result description in SERP* */
+    extended_snippet?: string | undefined;
+    /** *Accelerated Mobile Pages* indicates whether an item has the Accelerated Mobile Page (AMP) version **Note:** this check no longer appears in SERP */
+    amp_version?: boolean | undefined;
+    /** *the item's rating*             the popularity rate based on reviews and displayed in SERP */
+    rating?: RatingInfo | undefined;
+    /** *words highlighted in bold within the results `description`* */
+    highlighted?: string[] | undefined;
+    /** *sitelinks*             the links shown below some of Google's search results             if there are none, equals `null` */
+    links?: LinkElement[] | undefined;
+    /** @deprecated *contains information from the 'About this result' panel*             ['About this result' panel](https://blog.google/products/search/learn-more-and-get-more-from-search/) provides additional context about why Google returned this result for the given query;             this feature appears after clicking on the three dots next to most results */
+    about_this_result?: AboutThisResultElement | undefined;
+    /** *primary domain name in SERP* */
+    main_domain?: string | undefined;
+    /** *URL in SERP that does not specify the HTTPs protocol and domain name* */
+    relative_url?: string | undefined;
+    /** *estimated traffic volume*             estimated organic monthly traffic to the domain or webpage;             calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain or webpage rank for;             learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-etv-calculated) */
+    etv?: number | undefined;
+    /** *estimated cost of converting organic search traffic into paid*             represents the estimated monthly cost of running ads for all keywords that a domain or webpage ranks for;             the metric is calculated as the product of organic `etv` and paid `cpc` values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search;             learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-traffic-cost-calculated) */
+    estimated_paid_traffic_cost?: number | undefined;
+    /** *estimated traffic volume based on clickstream data*             calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain or webpage ranks for;             to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true`;             learn more about how the metric is calculated in this [help center article](https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated) */
+    clickstream_etv?: number | undefined;
+    /** *changes in rankings*             contains information about the ranking changes of the SERP element since the `previous_updated_time` */
+    rank_changes?: RankChanges | undefined;
+    /** *backlinks information for the relevant page URL* */
+    backlinks_info?: BacklinksInfo | undefined;
+    /** *page and domain rank information* */
+    rank_info?: RankInfo | undefined;
+    [key: string]: any;
+}
+export declare class DataLabsOrganicSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsOrganicSerpElementItem {
+    /** *subdomain in SERP* */
+    domain?: string | undefined;
+    /** *title of the result in SERP* */
+    title?: string | undefined;
+    /** *relevant URL in SERP* */
+    url?: string | undefined;
+    /** *breadcrumb in SERP* */
+    breadcrumb?: string | undefined;
+    /** *relevant website name in SERP* */
+    website_name?: string | undefined;
+    /** *indicates whether the element contains an `image`* **Note:** this check no longer appears in SERP */
+    is_image?: boolean | undefined;
+    /** *indicates whether the element contains a `video`* **Note:** this check no longer appears in SERP */
+    is_video?: boolean | undefined;
+    /** *indicates whether the element is a `featured_snippet`* **Note:** this check no longer appears in SERP */
+    is_featured_snippet?: boolean | undefined;
+    /** *indicates whether the element is marked as malicious* **Note:** this check no longer appears in SERP */
+    is_malicious?: boolean | undefined;
+    /** *array of properties detected for the SERP element* lists the properties that are true for this element each value in the array represents a detected property  example: if `is_image` is present in the array, the element contains an image possible values in the array: `is_image`, `is_video`, `is_featured_snippet`, `amp_version`, `is_malicious`, `is_web_story`, `is_highly_cited` equals `null` if none of the properties are detected for the element learn more about the `checks` array in [this Help Center article](https://dataforseo.com/help-center/whats-a-checks-array-in-the-google-organic-serp-api) */
+    checks?: string[] | undefined;
+    /** *description of the results element in SERP* */
+    description?: string | undefined;
+    /** *includes additional information appended before the result description in SERP* */
+    pre_snippet?: string | undefined;
+    /** *includes additional information appended after the result description in SERP* */
+    extended_snippet?: string | undefined;
+    /** *Accelerated Mobile Pages* indicates whether an item has the Accelerated Mobile Page (AMP) version **Note:** this check no longer appears in SERP */
+    amp_version?: boolean | undefined;
+    /** *the item's rating*             the popularity rate based on reviews and displayed in SERP */
+    rating?: RatingInfo | undefined;
+    /** *words highlighted in bold within the results `description`* */
+    highlighted?: string[] | undefined;
+    /** *sitelinks*             the links shown below some of Google's search results             if there are none, equals `null` */
+    links?: LinkElement[] | undefined;
+    /** @deprecated *contains information from the 'About this result' panel*             ['About this result' panel](https://blog.google/products/search/learn-more-and-get-more-from-search/) provides additional context about why Google returned this result for the given query;             this feature appears after clicking on the three dots next to most results */
+    about_this_result?: AboutThisResultElement | undefined;
+    /** *primary domain name in SERP* */
+    main_domain?: string | undefined;
+    /** *URL in SERP that does not specify the HTTPs protocol and domain name* */
+    relative_url?: string | undefined;
+    /** *estimated traffic volume*             estimated organic monthly traffic to the domain or webpage;             calculated as the product of CTR (click-through-rate) and search volume values of all keywords the domain or webpage rank for;             learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-etv-calculated) */
+    etv?: number | undefined;
+    /** *estimated cost of converting organic search traffic into paid*             represents the estimated monthly cost of running ads for all keywords that a domain or webpage ranks for;             the metric is calculated as the product of organic `etv` and paid `cpc` values and indicates the cost of driving the estimated volume of monthly organic traffic through PPC advertising in Google Search;             learn more about how the metric is calculated in [this help center article](https://dataforseo.com/help-center/how-is-traffic-cost-calculated) */
+    estimated_paid_traffic_cost?: number | undefined;
+    /** *estimated traffic volume based on clickstream data*             calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain or webpage ranks for;             to retrieve results for this field, the parameter `include_clickstream_data` must be set to `true`;             learn more about how the metric is calculated in this [help center article](https://dataforseo.com/help-center/whats-clickstream-estimated-traffic-volume-and-how-is-it-calculated) */
+    clickstream_etv?: number | undefined;
+    /** *changes in rankings*             contains information about the ranking changes of the SERP element since the `previous_updated_time` */
+    rank_changes?: RankChanges | undefined;
+    /** *backlinks information for the relevant page URL* */
+    backlinks_info?: BacklinksInfo | undefined;
+    /** *page and domain rank information* */
+    rank_info?: RankInfo | undefined;
+    [key: string]: any;
+    constructor(data?: IDataLabsOrganicSerpElementItem);
+    init(data?: any): void;
+    static fromJS(data: any): DataLabsOrganicSerpElementItem;
+    toJSON(data?: any): any;
+}
 export interface IDataLabsPaidSerpElementItem extends IBaseDataforseoLabsApiElementItem {
     /** title of the result in SERP */
     title?: string | undefined;
@@ -335,76 +405,6 @@ export declare class DataLabsPaidSerpElementItem extends BaseDataforseoLabsApiEl
     static fromJS(data: any): DataLabsPaidSerpElementItem;
     toJSON(data?: any): any;
 }
-export interface IDataLabsLocalPackSerpElementItem extends IBaseDataforseoLabsApiElementItem {
-    /** title of the result in SERP */
-    title?: string | undefined;
-    /** description of the results element in SERP */
-    description?: string | undefined;
-    /** subdomain in SERP */
-    domain?: string | undefined;
-    /** phone number */
-    phone?: string | undefined;
-    /** relevant URL in SERP */
-    url?: string | undefined;
-    /** indicates whether the element is an ad */
-    is_paid?: boolean | undefined;
-    /** the item's rating             the popularity rate based on reviews and displayed in SERP */
-    rating?: RatingInfo | undefined;
-    /** primary domain name in SERP */
-    main_domain?: string | undefined;
-    /** URL in SERP that does not specify the HTTPs protocol and domain name */
-    relative_url?: string | undefined;
-    /** estimated traffic volume            estimated organic monthly traffic to the domain            calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword            learn more about how the metric is calculated in this help center article */
-    etv?: number | undefined;
-    /** estimated cost of paid monthly search traffic            represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values            learn more about how the metric is calculated in this help center article */
-    estimated_paid_traffic_cost?: number | undefined;
-    /** estimated traffic volume based on clickstream data            calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for            to retrieve results for this field, the parameter include_clickstream_data must be set to true            learn more about how the metric is calculated in this help center article */
-    clickstream_etv?: number | undefined;
-    /** changes in rankings            contains information about the ranking changes of the SERP element since the previous_updated_time */
-    rank_changes?: RankChanges | undefined;
-    /** backlinks information for the ranked website */
-    backlinks_info?: BacklinksInfo | undefined;
-    /** page and domain rank information */
-    rank_info?: RankInfo | undefined;
-    [key: string]: any;
-}
-export declare class DataLabsLocalPackSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsLocalPackSerpElementItem {
-    /** title of the result in SERP */
-    title?: string | undefined;
-    /** description of the results element in SERP */
-    description?: string | undefined;
-    /** subdomain in SERP */
-    domain?: string | undefined;
-    /** phone number */
-    phone?: string | undefined;
-    /** relevant URL in SERP */
-    url?: string | undefined;
-    /** indicates whether the element is an ad */
-    is_paid?: boolean | undefined;
-    /** the item's rating             the popularity rate based on reviews and displayed in SERP */
-    rating?: RatingInfo | undefined;
-    /** primary domain name in SERP */
-    main_domain?: string | undefined;
-    /** URL in SERP that does not specify the HTTPs protocol and domain name */
-    relative_url?: string | undefined;
-    /** estimated traffic volume            estimated organic monthly traffic to the domain            calculated as the product of CTR (click-through-rate) and search volume values of the returned keyword            learn more about how the metric is calculated in this help center article */
-    etv?: number | undefined;
-    /** estimated cost of paid monthly search traffic            represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values            learn more about how the metric is calculated in this help center article */
-    estimated_paid_traffic_cost?: number | undefined;
-    /** estimated traffic volume based on clickstream data            calculated as the product of click-through-rate and clickstream search volume values of all keywords the domain ranks for            to retrieve results for this field, the parameter include_clickstream_data must be set to true            learn more about how the metric is calculated in this help center article */
-    clickstream_etv?: number | undefined;
-    /** changes in rankings            contains information about the ranking changes of the SERP element since the previous_updated_time */
-    rank_changes?: RankChanges | undefined;
-    /** backlinks information for the ranked website */
-    backlinks_info?: BacklinksInfo | undefined;
-    /** page and domain rank information */
-    rank_info?: RankInfo | undefined;
-    [key: string]: any;
-    constructor(data?: IDataLabsLocalPackSerpElementItem);
-    init(data?: any): void;
-    static fromJS(data: any): DataLabsLocalPackSerpElementItem;
-    toJSON(data?: any): any;
-}
 export interface IDataLabsAnswerBoxSerpElementItem extends IBaseDataforseoLabsApiElementItem {
     /** *text*             if there is none, equals `null` */
     text?: string[] | undefined;