dataforseo-client 2.0.16 → 2.0.18

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

@@ -1,10 +1,10 @@
-import { RatingInfo } from "./RatingInfo";
-import { LinkElement } from "./LinkElement";
-import { AboutThisResultElement } from "./AboutThisResultElement";
+import { AdLinkElement } from "./AdLinkElement";
 import { RankChanges } from "./RankChanges";
 import { BacklinksInfo } from "./BacklinksInfo";
 import { RankInfo } from "./RankInfo";
-import { AdLinkElement } from "./AdLinkElement";
+import { RatingInfo } from "./RatingInfo";
+import { LinkElement } from "./LinkElement";
+import { AboutThisResultElement } from "./AboutThisResultElement";
 import { Table } from "./Table";
 import { DataforseoLabsCarouselElement } from "./DataforseoLabsCarouselElement";
 import { MultiCarouselElement } from "./MultiCarouselElement";
@@ -31,7 +31,6 @@ import { FindResultsOnElement } from "./FindResultsOnElement";
 import { PriceInfo } from "./PriceInfo";
 import { Graph } from "./Graph";
 import { CommercialUnitsElement } from "./CommercialUnitsElement";
-import { LocalServicesElement } from "./LocalServicesElement";
 import { MathSolverElement } from "./MathSolverElement";
 export interface IBaseDataforseoLabsApiElementItem {
     /** type of element */
@@ -76,47 +75,29 @@ left, right */
     static fromJS(data: any): BaseDataforseoLabsApiElementItem;
     toJSON(data?: any): any;
 }
-export interface IDataLabsOrganicSerpElementItem extends IBaseDataforseoLabsApiElementItem {
-    /** subdomain in SERP */
-    domain?: string | undefined;
+export interface IDataLabsPaidSerpElementItem 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 */
-    is_image?: boolean | undefined;
-    /** indicates whether the element contains a video */
-    is_video?: boolean | undefined;
-    /** indicates whether the element is a featured_snippet */
-    is_featured_snippet?: boolean | undefined;
-    /** indicates whether the element is marked as malicious */
-    is_malicious?: boolean | undefined;
+    /** subdomain in SERP */
+    domain?: 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 */
-    amp_version?: boolean | undefined;
-    /** the item’s rating
-the popularity rate based on reviews and displayed in SERP */
-    rating?: RatingInfo | undefined;
+    /** breadcrumb in SERP */
+    breadcrumb?: string | undefined;
+    /** relevant URL in SERP */
+    url?: string | undefined;
     /** words highlighted in bold within the results description */
     highlighted?: string[] | undefined;
+    extra?: {
+        [key: string]: string;
+    } | undefined;
+    /** extended description
+if there is none, equals null */
+    description_rows?: string[] | undefined;
     /** sitelinks
 the links shown below some of Google’s search results
 if there are none, equals null */
-    links?: LinkElement[] | undefined;
-    /** contains information from the ‘About this result’ panel
-‘About this result’ panel 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;
+    links?: AdLinkElement[] | undefined;
     /** primary domain name in SERP */
     main_domain?: string | undefined;
     /** URL in SERP that does not specify the HTTPs protocol and domain name */
@@ -138,53 +119,35 @@ learn more about how the metric is calculated in this help center article */
     /** 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 target website */
+    /** 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;
+export declare class DataLabsPaidSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsPaidSerpElementItem {
     /** 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 */
-    is_image?: boolean | undefined;
-    /** indicates whether the element contains a video */
-    is_video?: boolean | undefined;
-    /** indicates whether the element is a featured_snippet */
-    is_featured_snippet?: boolean | undefined;
-    /** indicates whether the element is marked as malicious */
-    is_malicious?: boolean | undefined;
+    /** subdomain in SERP */
+    domain?: 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 */
-    amp_version?: boolean | undefined;
-    /** the item’s rating
-the popularity rate based on reviews and displayed in SERP */
-    rating?: RatingInfo | undefined;
+    /** breadcrumb in SERP */
+    breadcrumb?: string | undefined;
+    /** relevant URL in SERP */
+    url?: string | undefined;
     /** words highlighted in bold within the results description */
     highlighted?: string[] | undefined;
+    extra?: {
+        [key: string]: string;
+    } | undefined;
+    /** extended description
+if there is none, equals null */
+    description_rows?: string[] | undefined;
     /** sitelinks
 the links shown below some of Google’s search results
 if there are none, equals null */
-    links?: LinkElement[] | undefined;
-    /** contains information from the ‘About this result’ panel
-‘About this result’ panel 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;
+    links?: AdLinkElement[] | undefined;
     /** primary domain name in SERP */
     main_domain?: string | undefined;
     /** URL in SERP that does not specify the HTTPs protocol and domain name */
@@ -206,39 +169,32 @@ learn more about how the metric is calculated in this help center article */
     /** 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 target website */
+    /** 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);
+    constructor(data?: IDataLabsPaidSerpElementItem);
     init(data?: any): void;
-    static fromJS(data: any): DataLabsOrganicSerpElementItem;
+    static fromJS(data: any): DataLabsPaidSerpElementItem;
     toJSON(data?: any): any;
 }
-export interface IDataLabsPaidSerpElementItem extends IBaseDataforseoLabsApiElementItem {
+export interface IDataLabsLocalPackSerpElementItem extends IBaseDataforseoLabsApiElementItem {
     /** title of the result in SERP */
     title?: string | undefined;
-    /** subdomain in SERP */
-    domain?: string | undefined;
     /** description of the results element in SERP */
     description?: string | undefined;
-    /** breadcrumb in SERP */
-    breadcrumb?: string | undefined;
+    /** subdomain in SERP */
+    domain?: string | undefined;
+    /** phone number */
+    phone?: string | undefined;
     /** relevant URL in SERP */
     url?: string | undefined;
-    /** words highlighted in bold within the results description */
-    highlighted?: string[] | undefined;
-    extra?: {
-        [key: string]: string;
-    } | undefined;
-    /** extended description
-if there is none, equals null */
-    description_rows?: string[] | undefined;
-    /** sitelinks
-the links shown below some of Google’s search results
-if there are none, equals null */
-    links?: AdLinkElement[] | 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 */
@@ -260,35 +216,28 @@ learn more about how the metric is calculated in this help center article */
     /** 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 target website */
+    /** 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 DataLabsPaidSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsPaidSerpElementItem {
+export declare class DataLabsLocalPackSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsLocalPackSerpElementItem {
     /** title of the result in SERP */
     title?: string | undefined;
-    /** subdomain in SERP */
-    domain?: string | undefined;
     /** description of the results element in SERP */
     description?: string | undefined;
-    /** breadcrumb in SERP */
-    breadcrumb?: string | undefined;
+    /** subdomain in SERP */
+    domain?: string | undefined;
+    /** phone number */
+    phone?: string | undefined;
     /** relevant URL in SERP */
     url?: string | undefined;
-    /** words highlighted in bold within the results description */
-    highlighted?: string[] | undefined;
-    extra?: {
-        [key: string]: string;
-    } | undefined;
-    /** extended description
-if there is none, equals null */
-    description_rows?: string[] | undefined;
-    /** sitelinks
-the links shown below some of Google’s search results
-if there are none, equals null */
-    links?: AdLinkElement[] | 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 */
@@ -310,32 +259,56 @@ learn more about how the metric is calculated in this help center article */
     /** 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 target website */
+    /** 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?: IDataLabsPaidSerpElementItem);
+    constructor(data?: IDataLabsLocalPackSerpElementItem);
     init(data?: any): void;
-    static fromJS(data: any): DataLabsPaidSerpElementItem;
+    static fromJS(data: any): DataLabsLocalPackSerpElementItem;
     toJSON(data?: any): any;
 }
-export interface IDataLabsLocalPackSerpElementItem extends IBaseDataforseoLabsApiElementItem {
+export interface IDataLabsOrganicSerpElementItem extends IBaseDataforseoLabsApiElementItem {
+    /** domain in SERP of the Ad element */
+    domain?: string | undefined;
     /** title of the result in SERP */
     title?: string | undefined;
+    /** result’s URL */
+    url?: string | undefined;
+    /** breadcrumb of the Ad element in SERP */
+    breadcrumb?: string | undefined;
+    website_name?: string | undefined;
+    /** indicates whether the element contains an image */
+    is_image?: boolean | undefined;
+    /** indicates whether the element contains a video */
+    is_video?: boolean | undefined;
+    /** indicates whether the element is a featured_snippet */
+    is_featured_snippet?: boolean | undefined;
+    /** indicates whether the element is marked as malicious */
+    is_malicious?: boolean | undefined;
     /** description of the results element in SERP */
     description?: string | undefined;
-    /** domain in SERP of the Ad element */
-    domain?: string | undefined;
-    /** phone number */
-    phone?: string | undefined;
-    /** relevant URL of the Ad element in SERP */
-    url?: string | undefined;
-    /** indicates whether the element is an ad */
-    is_paid?: boolean | 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 */
+    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;
+    /** contains information from the ‘About this result’ panel
+‘About this result’ panel 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 */
@@ -363,22 +336,46 @@ contains information about the ranking changes of the SERP element since the pre
     rank_info?: RankInfo | undefined;
     [key: string]: any;
 }
-export declare class DataLabsLocalPackSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsLocalPackSerpElementItem {
+export declare class DataLabsOrganicSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsOrganicSerpElementItem {
+    /** domain in SERP of the Ad element */
+    domain?: string | undefined;
     /** title of the result in SERP */
     title?: string | undefined;
+    /** result’s URL */
+    url?: string | undefined;
+    /** breadcrumb of the Ad element in SERP */
+    breadcrumb?: string | undefined;
+    website_name?: string | undefined;
+    /** indicates whether the element contains an image */
+    is_image?: boolean | undefined;
+    /** indicates whether the element contains a video */
+    is_video?: boolean | undefined;
+    /** indicates whether the element is a featured_snippet */
+    is_featured_snippet?: boolean | undefined;
+    /** indicates whether the element is marked as malicious */
+    is_malicious?: boolean | undefined;
     /** description of the results element in SERP */
     description?: string | undefined;
-    /** domain in SERP of the Ad element */
-    domain?: string | undefined;
-    /** phone number */
-    phone?: string | undefined;
-    /** relevant URL of the Ad element in SERP */
-    url?: string | undefined;
-    /** indicates whether the element is an ad */
-    is_paid?: boolean | 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 */
+    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;
+    /** contains information from the ‘About this result’ panel
+‘About this result’ panel 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 */
@@ -405,9 +402,9 @@ contains information about the ranking changes of the SERP element since the pre
     /** page and domain rank information */
     rank_info?: RankInfo | undefined;
     [key: string]: any;
-    constructor(data?: IDataLabsLocalPackSerpElementItem);
+    constructor(data?: IDataLabsOrganicSerpElementItem);
     init(data?: any): void;
-    static fromJS(data: any): DataLabsLocalPackSerpElementItem;
+    static fromJS(data: any): DataLabsOrganicSerpElementItem;
     toJSON(data?: any): any;
 }
 export interface IDataLabsFeaturedSnippetSerpElementItem extends IBaseDataforseoLabsApiElementItem {
@@ -639,7 +636,7 @@ export interface IDataLabsImagesSerpElementItem extends IBaseDataforseoLabsApiEl
     items?: AiModeImagesElementInfo[] | undefined;
     /** contains keywords and images related to the specified search term
 if there are none, equals null */
-    related_image_searches?: RelatedImageSearchesElement[] | undefined;
+    related_image_searches?: RelatedImageSearchesElement | undefined;
     [key: string]: any;
 }
 export declare class DataLabsImagesSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsImagesSerpElementItem {
@@ -651,7 +648,7 @@ export declare class DataLabsImagesSerpElementItem extends BaseDataforseoLabsApi
     items?: AiModeImagesElementInfo[] | undefined;
     /** contains keywords and images related to the specified search term
 if there are none, equals null */
-    related_image_searches?: RelatedImageSearchesElement[] | undefined;
+    related_image_searches?: RelatedImageSearchesElement | undefined;
     [key: string]: any;
     constructor(data?: IDataLabsImagesSerpElementItem);
     init(data?: any): void;
@@ -691,7 +688,7 @@ export interface IDataLabsKnowledgeGraphSerpElementItem extends IBaseDataforseoL
     card_id?: string | undefined;
     /** sitelink URL */
     url?: string | undefined;
-    /** URL of the image */
+    /** URL of a specific image */
     image_url?: string | undefined;
     /** URL of the logo from knowledge graph */
     logo_url?: string | undefined;
@@ -712,7 +709,7 @@ export declare class DataLabsKnowledgeGraphSerpElementItem extends BaseDataforse
     card_id?: string | undefined;
     /** sitelink URL */
     url?: string | undefined;
-    /** URL of the image */
+    /** URL of a specific image */
     image_url?: string | undefined;
     /** URL of the logo from knowledge graph */
     logo_url?: string | undefined;
@@ -1120,7 +1117,7 @@ export interface IDataLabsLocalServicesSerpElementItem extends IBaseDataforseoLa
     /** domain in SERP */
     domain?: string | undefined;
     /** historical SERPs and related data found in the database */
-    items?: LocalServicesElement[] | undefined;
+    items?: any | undefined;
     [key: string]: any;
 }
 export declare class DataLabsLocalServicesSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsLocalServicesSerpElementItem {
@@ -1131,7 +1128,7 @@ export declare class DataLabsLocalServicesSerpElementItem extends BaseDataforseo
     /** domain in SERP */
     domain?: string | undefined;
     /** historical SERPs and related data found in the database */
-    items?: LocalServicesElement[] | undefined;
+    items?: any | undefined;
     [key: string]: any;
     constructor(data?: IDataLabsLocalServicesSerpElementItem);
     init(data?: any): void;