dataforseo-client 2.0.13 → 2.0.15

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

@@ -2,10 +2,10 @@ import { RatingInfo } from "./RatingInfo";
 import { RankChanges } from "./RankChanges";
 import { BacklinksInfo } from "./BacklinksInfo";
 import { RankInfo } from "./RankInfo";
-import { Table } from "./Table";
 import { AdLinkElement } from "./AdLinkElement";
 import { LinkElement } from "./LinkElement";
 import { AboutThisResultElement } from "./AboutThisResultElement";
+import { Table } from "./Table";
 import { DataforseoLabsCarouselElement } from "./DataforseoLabsCarouselElement";
 import { MultiCarouselElement } from "./MultiCarouselElement";
 import { GoogleFlightsElement } from "./GoogleFlightsElement";
@@ -166,92 +166,6 @@ contains information about the ranking changes of the SERP element since the pre
     static fromJS(data: any): DataLabsLocalPackSerpElementItem;
     toJSON(data?: any): any;
 }
-export interface IDataLabsFeaturedSnippetSerpElementItem extends IBaseDataforseoLabsApiElementItem {
-    /** subdomain in SERP */
-    domain?: string | undefined;
-    /** title of the result in SERP */
-    title?: string | undefined;
-    /** the title of the featured snippets source page */
-    featured_title?: string | undefined;
-    /** description of the results element in SERP */
-    description?: string | undefined;
-    /** relevant URL in SERP */
-    url?: string | undefined;
-    /** results table
-if there are none, equals null */
-    table?: Table | 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 paid monthly traffic to the target
-calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the target ranks for
-learn more about how the metric is calculated in this help center article */
-    etv?: number | undefined;
-    /** estimated cost of monthly search traffic
-represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the target ranks for
-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 target website */
-    backlinks_info?: BacklinksInfo | undefined;
-    /** page and domain rank information */
-    rank_info?: RankInfo | undefined;
-    [key: string]: any;
-}
-export declare class DataLabsFeaturedSnippetSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsFeaturedSnippetSerpElementItem {
-    /** subdomain in SERP */
-    domain?: string | undefined;
-    /** title of the result in SERP */
-    title?: string | undefined;
-    /** the title of the featured snippets source page */
-    featured_title?: string | undefined;
-    /** description of the results element in SERP */
-    description?: string | undefined;
-    /** relevant URL in SERP */
-    url?: string | undefined;
-    /** results table
-if there are none, equals null */
-    table?: Table | 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 paid monthly traffic to the target
-calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the target ranks for
-learn more about how the metric is calculated in this help center article */
-    etv?: number | undefined;
-    /** estimated cost of monthly search traffic
-represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the target ranks for
-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 target website */
-    backlinks_info?: BacklinksInfo | undefined;
-    /** page and domain rank information */
-    rank_info?: RankInfo | undefined;
-    [key: string]: any;
-    constructor(data?: IDataLabsFeaturedSnippetSerpElementItem);
-    init(data?: any): void;
-    static fromJS(data: any): DataLabsFeaturedSnippetSerpElementItem;
-    toJSON(data?: any): any;
-}
 export interface IDataLabsPaidSerpElementItem extends IBaseDataforseoLabsApiElementItem {
     /** title of the result in SERP */
     title?: string | undefined;
@@ -357,14 +271,15 @@ contains information about the ranking changes of the SERP element since the pre
     toJSON(data?: any): any;
 }
 export interface IDataLabsOrganicSerpElementItem extends IBaseDataforseoLabsApiElementItem {
-    /** domain in SERP of the Ad element */
+    /** subdomain in SERP */
     domain?: string | undefined;
     /** title of the result in SERP */
     title?: string | undefined;
-    /** sitelink URL */
+    /** 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;
@@ -401,12 +316,12 @@ this feature appears after clicking on the three dots next to most results */
     /** 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
+estimated paid monthly traffic to the target
+calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the target ranks for
 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
+    /** estimated cost of monthly search traffic
+represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the target ranks for
 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
@@ -417,21 +332,22 @@ 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 ranked website */
+    /** backlinks information for the target website */
     backlinks_info?: BacklinksInfo | undefined;
     /** page and domain rank information */
     rank_info?: RankInfo | undefined;
     [key: string]: any;
 }
 export declare class DataLabsOrganicSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsOrganicSerpElementItem {
-    /** domain in SERP of the Ad element */
+    /** subdomain in SERP */
     domain?: string | undefined;
     /** title of the result in SERP */
     title?: string | undefined;
-    /** sitelink URL */
+    /** 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;
@@ -468,12 +384,58 @@ this feature appears after clicking on the three dots next to most results */
     /** URL in SERP that does not specify the HTTPs protocol and domain name */
     relative_url?: string | undefined;
     /** estimated traffic volume
+estimated paid monthly traffic to the target
+calculated as the product of CTR (click-through-rate) and search volume values of all keywords in the category that the target ranks for
+learn more about how the metric is calculated in this help center article */
+    etv?: number | undefined;
+    /** estimated cost of monthly search traffic
+represents the estimated cost of paid monthly traffic (USD) based on etv and cpc values of all keywords in the category that the target ranks for
+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 target website */
+    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 IDataLabsFeaturedSnippetSerpElementItem extends IBaseDataforseoLabsApiElementItem {
+    /** subdomain in SERP */
+    domain?: string | undefined;
+    /** title of the result in SERP */
+    title?: string | undefined;
+    /** the title of the featured snippets source page */
+    featured_title?: string | undefined;
+    /** description of the results element in SERP */
+    description?: string | undefined;
+    /** relevant URL in SERP */
+    url?: string | undefined;
+    /** results table
+if there are none, equals null */
+    table?: Table | 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
+    /** estimated cost of converting organic search traffic into paid
+represents the estimated monthly cost of running ads (USD) for the returned keyword
+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 */
     estimated_paid_traffic_cost?: number | undefined;
     /** estimated traffic volume based on clickstream data
@@ -489,9 +451,51 @@ 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?: IDataLabsOrganicSerpElementItem);
+}
+export declare class DataLabsFeaturedSnippetSerpElementItem extends BaseDataforseoLabsApiElementItem implements IDataLabsFeaturedSnippetSerpElementItem {
+    /** subdomain in SERP */
+    domain?: string | undefined;
+    /** title of the result in SERP */
+    title?: string | undefined;
+    /** the title of the featured snippets source page */
+    featured_title?: string | undefined;
+    /** description of the results element in SERP */
+    description?: string | undefined;
+    /** relevant URL in SERP */
+    url?: string | undefined;
+    /** results table
+if there are none, equals null */
+    table?: Table | 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 converting organic search traffic into paid
+represents the estimated monthly cost of running ads (USD) for the returned keyword
+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 */
+    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?: IDataLabsFeaturedSnippetSerpElementItem);
     init(data?: any): void;
-    static fromJS(data: any): DataLabsOrganicSerpElementItem;
+    static fromJS(data: any): DataLabsFeaturedSnippetSerpElementItem;
     toJSON(data?: any): any;
 }
 export interface IDataLabsAnswerBoxSerpElementItem extends IBaseDataforseoLabsApiElementItem {

package/dist/esm/models/BaseDataforseoLabsApiElementItem.js

@@ -2,10 +2,10 @@ import { RatingInfo } from "./RatingInfo";
 import { RankChanges } from "./RankChanges";
 import { BacklinksInfo } from "./BacklinksInfo";
 import { RankInfo } from "./RankInfo";
-import { Table } from "./Table";
 import { AdLinkElement } from "./AdLinkElement";
 import { LinkElement } from "./LinkElement";
 import { AboutThisResultElement } from "./AboutThisResultElement";
+import { Table } from "./Table";
 import { DataforseoLabsCarouselElement } from "./DataforseoLabsCarouselElement";
 import { MultiCarouselElement } from "./MultiCarouselElement";
 import { GoogleFlightsElement } from "./GoogleFlightsElement";
@@ -64,11 +64,6 @@ export class BaseDataforseoLabsApiElementItem {
             result.init(data);
             return result;
         }
-        if (data["type"] === "featured_snippet") {
-            let result = new DataLabsFeaturedSnippetSerpElementItem();
-            result.init(data);
-            return result;
-        }
         if (data["type"] === "paid") {
             let result = new DataLabsPaidSerpElementItem();
             result.init(data);
@@ -79,6 +74,11 @@ export class BaseDataforseoLabsApiElementItem {
             result.init(data);
             return result;
         }
+        if (data["type"] === "featured_snippet") {
+            let result = new DataLabsFeaturedSnippetSerpElementItem();
+            result.init(data);
+            return result;
+        }
         if (data["type"] === "answer_box") {
             let result = new DataLabsAnswerBoxSerpElementItem();
             result.init(data);
@@ -310,60 +310,6 @@ export class DataLabsLocalPackSerpElementItem extends BaseDataforseoLabsApiEleme
         return data;
     }
 }
-export class DataLabsFeaturedSnippetSerpElementItem extends BaseDataforseoLabsApiElementItem {
-    constructor(data) {
-        super(data);
-    }
-    init(data) {
-        super.init(data);
-        if (data) {
-            for (var property in data) {
-                if (data.hasOwnProperty(property))
-                    this[property] = data[property];
-            }
-            this.domain = data["domain"];
-            this.title = data["title"];
-            this.featured_title = data["featured_title"];
-            this.description = data["description"];
-            this.url = data["url"];
-            this.table = data["table"] ? Table.fromJS(data["table"]) : undefined;
-            this.main_domain = data["main_domain"];
-            this.relative_url = data["relative_url"];
-            this.etv = data["etv"];
-            this.estimated_paid_traffic_cost = data["estimated_paid_traffic_cost"];
-            this.clickstream_etv = data["clickstream_etv"];
-            this.rank_changes = data["rank_changes"] ? RankChanges.fromJS(data["rank_changes"]) : undefined;
-            this.backlinks_info = data["backlinks_info"] ? BacklinksInfo.fromJS(data["backlinks_info"]) : undefined;
-            this.rank_info = data["rank_info"] ? RankInfo.fromJS(data["rank_info"]) : undefined;
-        }
-    }
-    static fromJS(data) {
-        data = typeof data === 'object' ? data : {};
-        let result = new DataLabsFeaturedSnippetSerpElementItem();
-        result.init(data);
-        return result;
-    }
-    toJSON(data) {
-        var _a, _b, _c, _d;
-        data = typeof data === 'object' ? data : {};
-        super.toJSON(data);
-        data["domain"] = this.domain;
-        data["title"] = this.title;
-        data["featured_title"] = this.featured_title;
-        data["description"] = this.description;
-        data["url"] = this.url;
-        data["table"] = this.table ? (_a = Table.fromJS(this.table)) === null || _a === void 0 ? void 0 : _a.toJSON() : undefined;
-        data["main_domain"] = this.main_domain;
-        data["relative_url"] = this.relative_url;
-        data["etv"] = this.etv;
-        data["estimated_paid_traffic_cost"] = this.estimated_paid_traffic_cost;
-        data["clickstream_etv"] = this.clickstream_etv;
-        data["rank_changes"] = this.rank_changes ? (_b = RankChanges.fromJS(this.rank_changes)) === null || _b === void 0 ? void 0 : _b.toJSON() : undefined;
-        data["backlinks_info"] = this.backlinks_info ? (_c = BacklinksInfo.fromJS(this.backlinks_info)) === null || _c === void 0 ? void 0 : _c.toJSON() : undefined;
-        data["rank_info"] = this.rank_info ? (_d = RankInfo.fromJS(this.rank_info)) === null || _d === void 0 ? void 0 : _d.toJSON() : undefined;
-        return data;
-    }
-}
 export class DataLabsPaidSerpElementItem extends BaseDataforseoLabsApiElementItem {
     constructor(data) {
         super(data);
@@ -526,6 +472,60 @@ export class DataLabsOrganicSerpElementItem extends BaseDataforseoLabsApiElement
         return data;
     }
 }
+export class DataLabsFeaturedSnippetSerpElementItem extends BaseDataforseoLabsApiElementItem {
+    constructor(data) {
+        super(data);
+    }
+    init(data) {
+        super.init(data);
+        if (data) {
+            for (var property in data) {
+                if (data.hasOwnProperty(property))
+                    this[property] = data[property];
+            }
+            this.domain = data["domain"];
+            this.title = data["title"];
+            this.featured_title = data["featured_title"];
+            this.description = data["description"];
+            this.url = data["url"];
+            this.table = data["table"] ? Table.fromJS(data["table"]) : undefined;
+            this.main_domain = data["main_domain"];
+            this.relative_url = data["relative_url"];
+            this.etv = data["etv"];
+            this.estimated_paid_traffic_cost = data["estimated_paid_traffic_cost"];
+            this.clickstream_etv = data["clickstream_etv"];
+            this.rank_changes = data["rank_changes"] ? RankChanges.fromJS(data["rank_changes"]) : undefined;
+            this.backlinks_info = data["backlinks_info"] ? BacklinksInfo.fromJS(data["backlinks_info"]) : undefined;
+            this.rank_info = data["rank_info"] ? RankInfo.fromJS(data["rank_info"]) : undefined;
+        }
+    }
+    static fromJS(data) {
+        data = typeof data === 'object' ? data : {};
+        let result = new DataLabsFeaturedSnippetSerpElementItem();
+        result.init(data);
+        return result;
+    }
+    toJSON(data) {
+        var _a, _b, _c, _d;
+        data = typeof data === 'object' ? data : {};
+        super.toJSON(data);
+        data["domain"] = this.domain;
+        data["title"] = this.title;
+        data["featured_title"] = this.featured_title;
+        data["description"] = this.description;
+        data["url"] = this.url;
+        data["table"] = this.table ? (_a = Table.fromJS(this.table)) === null || _a === void 0 ? void 0 : _a.toJSON() : undefined;
+        data["main_domain"] = this.main_domain;
+        data["relative_url"] = this.relative_url;
+        data["etv"] = this.etv;
+        data["estimated_paid_traffic_cost"] = this.estimated_paid_traffic_cost;
+        data["clickstream_etv"] = this.clickstream_etv;
+        data["rank_changes"] = this.rank_changes ? (_b = RankChanges.fromJS(this.rank_changes)) === null || _b === void 0 ? void 0 : _b.toJSON() : undefined;
+        data["backlinks_info"] = this.backlinks_info ? (_c = BacklinksInfo.fromJS(this.backlinks_info)) === null || _c === void 0 ? void 0 : _c.toJSON() : undefined;
+        data["rank_info"] = this.rank_info ? (_d = RankInfo.fromJS(this.rank_info)) === null || _d === void 0 ? void 0 : _d.toJSON() : undefined;
+        return data;
+    }
+}
 export class DataLabsAnswerBoxSerpElementItem extends BaseDataforseoLabsApiElementItem {
     constructor(data) {
         super(data);