dataforseo-client 2.0.1 → 2.0.2

package/src/models/BacklinksAnchorsLiveItem.ts

@@ -1,307 +0,0 @@
-export interface IBacklinksAnchorsLiveItem   {
-        
-        /** type of element */
-        type?: string | undefined
-        
-        /** anchor of the backlink */
-        anchor?: string | undefined
-        
-        /** rank of the anchor links
-rank volume that referring websites pass to the target through links with a particular anchor
-rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
-learn more about the metric and how it is calculated in this help center article */
-        rank?: number | undefined
-        
-        /** indicates the number of backlinks */
-        backlinks?: number | undefined
-        
-        /** date and time when our crawler found the backlink with this anchor for the first time
-in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
-example:
-2019-11-15 12:57:46 +00:00 */
-        first_seen?: string | undefined
-        
-        /** date and time when the last backlink with this anchor was lost
-indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed
-in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
-example:
-2017-01-24 13:20:59 +00:00 */
-        lost_date?: string | undefined
-        
-        /** average spam score of all backlinks with this anchor
-learn more about how the metric is calculated on this help center page */
-        backlinks_spam_score?: number | undefined
-        
-        /** number of broken backlinks
-number of broken backlinks pointing to the target */
-        broken_backlinks?: number | undefined
-        
-        /** number of broken pages
-number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to */
-        broken_pages?: number | undefined
-        
-        /** indicates the number of referring domains */
-        referring_domains?: number | undefined
-        
-        /** number of domains pointing at least one nofollow link to the target */
-        referring_domains_nofollow?: number | undefined
-        
-        /** indicates the number of referring main domains */
-        referring_main_domains?: number | undefined
-        
-        /** number of main domains pointing at least one nofollow link to the target */
-        referring_main_domains_nofollow?: number | undefined
-        
-        /** number of referring IP addresses
-number of IP addresses pointing to this page */
-        referring_ips?: number | undefined
-        
-        /** number of referring subnetworks */
-        referring_subnets?: number | undefined
-        
-        /** indicates the number of pages pointing to target with this anchor */
-        referring_pages?: number | undefined
-        
-        /** number of referring pages pointing at least one nofollow link to the target with this anchor */
-        referring_pages_nofollow?: number | undefined
-        
-        /** top-level domains of the referring links
-contains top level domains and referring link count per each */
-        referring_links_tld?: { [key: string]: number; } | undefined
-        
-        /** types of referring links
-indicates the types of the referring links and link count per each type
-possible values:
-anchor, image, link, meta, canonical, alternate, redirect */
-        referring_links_types?: { [key: string]: number; } | undefined
-        
-        /** link attributes of the referring links
-indicates link attributes of the referring links and link count per each attribute */
-        referring_links_attributes?: { [key: string]: number; } | undefined
-        
-        /** types of referring platforms
-indicates referring platform types and and link count per each platform
-possible values: cms, blogs, ecommerce, message-boards, wikis, news, organization */
-        referring_links_platform_types?: { [key: string]: number; } | undefined
-        
-        /** semantic locations of the referring links
-indicates semantic elements in HTML where the referring links are located and link count per each semantic location
-you can get the full list of semantic elements here
-examples:
-article, section, summary */
-        referring_links_semantic_locations?: { [key: string]: number; } | undefined
-        
-        /** ISO country codes of the referring links
-indicates ISO country codes of the domains where the referring links are located and the link count per each country */
-        referring_links_countries?: { [key: string]: number; } | undefined
-
-    [key: string]: any;
-
-    }
-
-export class BacklinksAnchorsLiveItem  implements IBacklinksAnchorsLiveItem {
-    
-    /** type of element */
-
-    type?: string | undefined;
-    
-    /** anchor of the backlink */
-
-    anchor?: string | undefined;
-    
-    /** rank of the anchor links
-rank volume that referring websites pass to the target through links with a particular anchor
-rank is calculated based on the method for node ranking in a linked database – a principle used in the original Google PageRank algorithm
-learn more about the metric and how it is calculated in this help center article */
-
-    rank?: number | undefined;
-    
-    /** indicates the number of backlinks */
-
-    backlinks?: number | undefined;
-    
-    /** date and time when our crawler found the backlink with this anchor for the first time
-in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
-example:
-2019-11-15 12:57:46 +00:00 */
-
-    first_seen?: string | undefined;
-    
-    /** date and time when the last backlink with this anchor was lost
-indicates the date and time when our crawler visited the page and it responded with 4xx or 5xx status code or the last backlink was removed
-in the UTC format: “yyyy-mm-dd hh-mm-ss +00:00”
-example:
-2017-01-24 13:20:59 +00:00 */
-
-    lost_date?: string | undefined;
-    
-    /** average spam score of all backlinks with this anchor
-learn more about how the metric is calculated on this help center page */
-
-    backlinks_spam_score?: number | undefined;
-    
-    /** number of broken backlinks
-number of broken backlinks pointing to the target */
-
-    broken_backlinks?: number | undefined;
-    
-    /** number of broken pages
-number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to */
-
-    broken_pages?: number | undefined;
-    
-    /** indicates the number of referring domains */
-
-    referring_domains?: number | undefined;
-    
-    /** number of domains pointing at least one nofollow link to the target */
-
-    referring_domains_nofollow?: number | undefined;
-    
-    /** indicates the number of referring main domains */
-
-    referring_main_domains?: number | undefined;
-    
-    /** number of main domains pointing at least one nofollow link to the target */
-
-    referring_main_domains_nofollow?: number | undefined;
-    
-    /** number of referring IP addresses
-number of IP addresses pointing to this page */
-
-    referring_ips?: number | undefined;
-    
-    /** number of referring subnetworks */
-
-    referring_subnets?: number | undefined;
-    
-    /** indicates the number of pages pointing to target with this anchor */
-
-    referring_pages?: number | undefined;
-    
-    /** number of referring pages pointing at least one nofollow link to the target with this anchor */
-
-    referring_pages_nofollow?: number | undefined;
-    
-    /** top-level domains of the referring links
-contains top level domains and referring link count per each */
-
-    referring_links_tld?: { [key: string]: number; } | undefined;
-    
-    /** types of referring links
-indicates the types of the referring links and link count per each type
-possible values:
-anchor, image, link, meta, canonical, alternate, redirect */
-
-    referring_links_types?: { [key: string]: number; } | undefined;
-    
-    /** link attributes of the referring links
-indicates link attributes of the referring links and link count per each attribute */
-
-    referring_links_attributes?: { [key: string]: number; } | undefined;
-    
-    /** types of referring platforms
-indicates referring platform types and and link count per each platform
-possible values: cms, blogs, ecommerce, message-boards, wikis, news, organization */
-
-    referring_links_platform_types?: { [key: string]: number; } | undefined;
-    
-    /** semantic locations of the referring links
-indicates semantic elements in HTML where the referring links are located and link count per each semantic location
-you can get the full list of semantic elements here
-examples:
-article, section, summary */
-
-    referring_links_semantic_locations?: { [key: string]: number; } | undefined;
-    
-    /** ISO country codes of the referring links
-indicates ISO country codes of the domains where the referring links are located and the link count per each country */
-
-    referring_links_countries?: { [key: string]: number; } | undefined;
-
-    [key: string]: any;
-
-
-    constructor(data?: IBacklinksAnchorsLiveItem) {
-
-    if (data) {
-        for (var property in data) {
-            if (data.hasOwnProperty(property))
-                (<any>this)[property] = (<any>data)[property];
-        }
-    }
-
-    }
-
-    init(data?: any) {
-        if (data) {
-            for (var property in data) {
-                if (data.hasOwnProperty(property))
-                    this[property] = data[property];
-            }
-            this.type = data["type"];
-            this.anchor = data["anchor"];
-            this.rank = data["rank"];
-            this.backlinks = data["backlinks"];
-            this.first_seen = data["first_seen"];
-            this.lost_date = data["lost_date"];
-            this.backlinks_spam_score = data["backlinks_spam_score"];
-            this.broken_backlinks = data["broken_backlinks"];
-            this.broken_pages = data["broken_pages"];
-            this.referring_domains = data["referring_domains"];
-            this.referring_domains_nofollow = data["referring_domains_nofollow"];
-            this.referring_main_domains = data["referring_main_domains"];
-            this.referring_main_domains_nofollow = data["referring_main_domains_nofollow"];
-            this.referring_ips = data["referring_ips"];
-            this.referring_subnets = data["referring_subnets"];
-            this.referring_pages = data["referring_pages"];
-            this.referring_pages_nofollow = data["referring_pages_nofollow"];
-            this.referring_links_tld = data["referring_links_tld"];
-            this.referring_links_types = data["referring_links_types"];
-            this.referring_links_attributes = data["referring_links_attributes"];
-            this.referring_links_platform_types = data["referring_links_platform_types"];
-            this.referring_links_semantic_locations = data["referring_links_semantic_locations"];
-            this.referring_links_countries = data["referring_links_countries"];
-        }
-    }
-
-    static fromJS(data: any): BacklinksAnchorsLiveItem {
-        data = typeof data === 'object' ? data : {};
-
-
-        let result = new BacklinksAnchorsLiveItem();
-        result.init(data);
-        return result;
-    }
-
-    toJSON(data?: any) {
-        data = typeof data === 'object' ? data : {};
-
-        
-        
-        data["type"] = this.type;
-        data["anchor"] = this.anchor;
-        data["rank"] = this.rank;
-        data["backlinks"] = this.backlinks;
-        data["first_seen"] = this.first_seen;
-        data["lost_date"] = this.lost_date;
-        data["backlinks_spam_score"] = this.backlinks_spam_score;
-        data["broken_backlinks"] = this.broken_backlinks;
-        data["broken_pages"] = this.broken_pages;
-        data["referring_domains"] = this.referring_domains;
-        data["referring_domains_nofollow"] = this.referring_domains_nofollow;
-        data["referring_main_domains"] = this.referring_main_domains;
-        data["referring_main_domains_nofollow"] = this.referring_main_domains_nofollow;
-        data["referring_ips"] = this.referring_ips;
-        data["referring_subnets"] = this.referring_subnets;
-        data["referring_pages"] = this.referring_pages;
-        data["referring_pages_nofollow"] = this.referring_pages_nofollow;
-        data["referring_links_tld"] = this.referring_links_tld;
-        data["referring_links_types"] = this.referring_links_types;
-        data["referring_links_attributes"] = this.referring_links_attributes;
-        data["referring_links_platform_types"] = this.referring_links_platform_types;
-        data["referring_links_semantic_locations"] = this.referring_links_semantic_locations;
-        data["referring_links_countries"] = this.referring_links_countries;
-        return data;
-    }
-}

package/src/models/BacklinksAnchorsLiveRequestInfo.ts

@@ -1,323 +0,0 @@
-export interface IBacklinksAnchorsLiveRequestInfo   {
-        
-        /** domain, subdomain or webpage to get anchors for
-required field
-a domain or a subdomain should be specified without https:// and www.
-a page should be specified with absolute URL (including http:// or https://) */
-        target?: string | undefined
-        
-        /** the maximum number of returned anchors
-optional field
-default value: 100
-maximum value: 1000 */
-        limit?: number | undefined
-        
-        /** offset in the results array of returned anchors
-optional field
-default value: 0
-if you specify the 10 value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors */
-        offset?: number | undefined
-        
-        /** maximum number of elements within internal arrays
-optional field
-you can use this field to limit the number of elements within the following arrays:
-referring_links_tld
-referring_links_types
-referring_links_attributes
-referring_links_platform_types
-referring_links_semantic_locations
-default value: 10
-maximum value: 1000 */
-        internal_list_limit?: number | undefined
-        
-        /** set what backlinks to return and count
-optional field
-you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
-possible values:
-all – all backlinks will be returned and counted;
-live – backlinks found during the last check will be returned and counted;
-lost – lost backlinks will be returned and counted;
-default value: live */
-        backlinks_status_type?: 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:
-regex, not_regex, =, <>, 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:
-['referring_links_types.anchors','>','1']
-[['broken_pages','>','2'],
-'and',
-['backlinks','>','10']]
-[['first_seen','>','2017-10-23 11:31:45 +00:00'],
-'and',
-[['anchor','like','%seo%'],'or',['referring_domains','>','10']]]
-The full list of possible filters is available here. */
-        filters?: any[] | undefined
-        
-        /** results sorting rules
-optional field
-you can use the same values as in the filters array to sort the results
-possible sorting types:
-asc – results will be sorted in the ascending order
-desc – results will be sorted in the descending order
-you should use a comma to set up a sorting type
-example:
-['backlinks,desc']
-note that you can set no more than three sorting rules in a single request
-you should use a comma to separate several sorting rules
-example:
-['backlinks,desc','rank,asc'] */
-        order_by?: string[] | undefined
-        
-        /** filter the backlinks of your target
-optional field
-you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
-you can filter the backlinks by all fields available in the response of this endpoint
-using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
-example:
-'backlinks_filters': [['dofollow', '=', true]] */
-        backlinks_filters?: any[] | undefined
-        
-        /** indicates if the subdomains of the target will be included in the search
-optional field
-if set to false, the subdomains will be ignored
-default value: true */
-        include_subdomains?: boolean | undefined
-        
-        /** indicates if indirect links to the target will be included in the results
-optional field
-if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page
-if set to false, indirect links will be ignored
-default value: true */
-        include_indirect_links?: boolean | undefined
-        
-        /** indicates whether the backlinks from subdomains of the target are excluded
-optional field
-if set to false, the backlinks from subdomains of the target will be ommited and you won’t receive the same domain in the response;
-default value: true */
-        exclude_internal_backlinks?: boolean | undefined
-        
-        /** defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
-optional field
-you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale
-possible values:
-one_hundred — rank values are displayed on a 0–100 scale
-one_thousand — rank values are displayed on a 0–1000 scale
-default value: one_thousand
-learn more about how this parameter works and how ranking metrics are calculated in this Help Center article */
-        rank_scale?: string | undefined
-        
-        /** user-defined task identifier
-optional field
-the character limit is 255
-you can use this parameter to identify the task and match it with the result
-you will find the specified tag value in the data object of the response */
-        tag?: string | undefined
-
-    [key: string]: any;
-
-    }
-
-export class BacklinksAnchorsLiveRequestInfo  implements IBacklinksAnchorsLiveRequestInfo {
-    
-    /** domain, subdomain or webpage to get anchors for
-required field
-a domain or a subdomain should be specified without https:// and www.
-a page should be specified with absolute URL (including http:// or https://) */
-
-    target?: string | undefined;
-    
-    /** the maximum number of returned anchors
-optional field
-default value: 100
-maximum value: 1000 */
-
-    limit?: number | undefined;
-    
-    /** offset in the results array of returned anchors
-optional field
-default value: 0
-if you specify the 10 value, the first ten anchors in the results array will be omitted and the data will be provided for the successive anchors */
-
-    offset?: number | undefined;
-    
-    /** maximum number of elements within internal arrays
-optional field
-you can use this field to limit the number of elements within the following arrays:
-referring_links_tld
-referring_links_types
-referring_links_attributes
-referring_links_platform_types
-referring_links_semantic_locations
-default value: 10
-maximum value: 1000 */
-
-    internal_list_limit?: number | undefined;
-    
-    /** set what backlinks to return and count
-optional field
-you can use this field to choose what backlinks will be returned and used for aggregated metrics for your target;
-possible values:
-all – all backlinks will be returned and counted;
-live – backlinks found during the last check will be returned and counted;
-lost – lost backlinks will be returned and counted;
-default value: live */
-
-    backlinks_status_type?: 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:
-regex, not_regex, =, <>, 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:
-['referring_links_types.anchors','>','1']
-[['broken_pages','>','2'],
-'and',
-['backlinks','>','10']]
-[['first_seen','>','2017-10-23 11:31:45 +00:00'],
-'and',
-[['anchor','like','%seo%'],'or',['referring_domains','>','10']]]
-The full list of possible filters is available here. */
-
-    filters?: any[] | undefined;
-    
-    /** results sorting rules
-optional field
-you can use the same values as in the filters array to sort the results
-possible sorting types:
-asc – results will be sorted in the ascending order
-desc – results will be sorted in the descending order
-you should use a comma to set up a sorting type
-example:
-['backlinks,desc']
-note that you can set no more than three sorting rules in a single request
-you should use a comma to separate several sorting rules
-example:
-['backlinks,desc','rank,asc'] */
-
-    order_by?: string[] | undefined;
-    
-    /** filter the backlinks of your target
-optional field
-you can use this field to filter the initial backlinks that will be included in the dataset for aggregated metrics for your target
-you can filter the backlinks by all fields available in the response of this endpoint
-using this parameter, you can include only dofollow backlinks in the response and create a flexible backlinks dataset to calculate the metrics for
-example:
-'backlinks_filters': [['dofollow', '=', true]] */
-
-    backlinks_filters?: any[] | undefined;
-    
-    /** indicates if the subdomains of the target will be included in the search
-optional field
-if set to false, the subdomains will be ignored
-default value: true */
-
-    include_subdomains?: boolean | undefined;
-    
-    /** indicates if indirect links to the target will be included in the results
-optional field
-if set to true, the results will include data on indirect links pointing to a page that either redirects to the target, or points to a canonical page
-if set to false, indirect links will be ignored
-default value: true */
-
-    include_indirect_links?: boolean | undefined;
-    
-    /** indicates whether the backlinks from subdomains of the target are excluded
-optional field
-if set to false, the backlinks from subdomains of the target will be ommited and you won’t receive the same domain in the response;
-default value: true */
-
-    exclude_internal_backlinks?: boolean | undefined;
-    
-    /** defines the scale used for calculating and displaying the rank, domain_from_rank, and page_from_rank values
-optional field
-you can use this parameter to choose whether rank values are presented on a 0–100 or 0–1000 scale
-possible values:
-one_hundred — rank values are displayed on a 0–100 scale
-one_thousand — rank values are displayed on a 0–1000 scale
-default value: one_thousand
-learn more about how this parameter works and how ranking metrics are calculated in this Help Center article */
-
-    rank_scale?: string | undefined;
-    
-    /** user-defined task identifier
-optional field
-the character limit is 255
-you can use this parameter to identify the task and match it with the result
-you will find the specified tag value in the data object of the response */
-
-    tag?: string | undefined;
-
-    [key: string]: any;
-
-
-    constructor(data?: IBacklinksAnchorsLiveRequestInfo) {
-
-    if (data) {
-        for (var property in data) {
-            if (data.hasOwnProperty(property))
-                (<any>this)[property] = (<any>data)[property];
-        }
-    }
-
-    }
-
-    init(data?: any) {
-        if (data) {
-            for (var property in data) {
-                if (data.hasOwnProperty(property))
-                    this[property] = data[property];
-            }
-            this.target = data["target"];
-            this.limit = data["limit"];
-            this.offset = data["offset"];
-            this.internal_list_limit = data["internal_list_limit"];
-            this.backlinks_status_type = data["backlinks_status_type"];
-            this.filters = data["filters"];
-            this.order_by = data["order_by"];
-            this.backlinks_filters = data["backlinks_filters"];
-            this.include_subdomains = data["include_subdomains"];
-            this.include_indirect_links = data["include_indirect_links"];
-            this.exclude_internal_backlinks = data["exclude_internal_backlinks"];
-            this.rank_scale = data["rank_scale"];
-            this.tag = data["tag"];
-        }
-    }
-
-    static fromJS(data: any): BacklinksAnchorsLiveRequestInfo {
-        data = typeof data === 'object' ? data : {};
-
-
-        let result = new BacklinksAnchorsLiveRequestInfo();
-        result.init(data);
-        return result;
-    }
-
-    toJSON(data?: any) {
-        data = typeof data === 'object' ? data : {};
-
-        
-        
-        data["target"] = this.target;
-        data["limit"] = this.limit;
-        data["offset"] = this.offset;
-        data["internal_list_limit"] = this.internal_list_limit;
-        data["backlinks_status_type"] = this.backlinks_status_type;
-        data["filters"] = this.filters;
-        data["order_by"] = this.order_by;
-        data["backlinks_filters"] = this.backlinks_filters;
-        data["include_subdomains"] = this.include_subdomains;
-        data["include_indirect_links"] = this.include_indirect_links;
-        data["exclude_internal_backlinks"] = this.exclude_internal_backlinks;
-        data["rank_scale"] = this.rank_scale;
-        data["tag"] = this.tag;
-        return data;
-    }
-}