dataforseo-client 2.1.1 → 2.1.2

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

@@ -1,80 +1,80 @@
 export interface IBacklinksPageMeta {
-    /** page title */
+    /** *page title* */
     title?: string | undefined;
-    /** canonical page */
+    /** *canonical page* */
     canonical?: string | undefined;
-    /** number of internal links on the page */
+    /** *number of internal links on the page* */
     internal_links_count?: number | undefined;
-    /** number of external links on the page */
+    /** *number of external links on the page* */
     external_links_count?: number | undefined;
-    /** number of images on the page */
+    /** *number of images on the page* */
     images_count?: number | undefined;
-    /** number of words on the page */
+    /** *number of words on the page* */
     words_count?: number | undefined;
-    /** spam score of the page learn more about how the metric is calculated on this help center page */
+    /** *spam score of the page* learn more about how the metric is calculated on [this help center page](https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated) */
     page_spam_score?: number | undefined;
-    /** array of social media tags found on the page contains social media tags and their content supported tags include but are not limited to Open Graph and Twitter card */
+    /** *array of social media tags found on the page* contains social media tags and their content supported tags include but are not limited to [Open Graph](https://ogp.me/) and [Twitter card](https://developer.twitter.com/en/docs/twitter-for-websites/cards/guides/getting-started) */
     social_media_tags?: {
         [key: string]: string;
     } | undefined;
-    /** h1 tag content of h1 tags */
+    /** *h1 tag* content of `h1` tags */
     h_1?: string[] | undefined;
-    /** h2 tag content of h2 tags */
+    /** *h2 tag* content of `h2` tags */
     h_2?: string[] | undefined;
-    /** h3 tag content of h3 tags */
+    /** *h3 tag* content of `h3` tags */
     h_3?: string[] | undefined;
-    /** content of alt tags */
+    /** *content of `alt` tags* */
     images_alt?: string[] | undefined;
-    /** CMS details */
+    /** *CMS details* */
     powered_by?: string[] | undefined;
-    /** page content language example: en */
+    /** *page content language* example: `en` */
     language?: string | undefined;
-    /** character encoding examples: utf-8 */
+    /** *character encoding* examples: `utf-8` */
     charset?: string | undefined;
-    /** type of a platform */
+    /** *type of a platform* */
     platform_type?: string[] | undefined;
-    /** website technologies */
+    /** *website technologies* */
     technologies?: {
         [key: string]: string;
     } | undefined;
     [key: string]: any;
 }
 export declare class BacklinksPageMeta implements IBacklinksPageMeta {
-    /** page title */
+    /** *page title* */
     title?: string | undefined;
-    /** canonical page */
+    /** *canonical page* */
     canonical?: string | undefined;
-    /** number of internal links on the page */
+    /** *number of internal links on the page* */
     internal_links_count?: number | undefined;
-    /** number of external links on the page */
+    /** *number of external links on the page* */
     external_links_count?: number | undefined;
-    /** number of images on the page */
+    /** *number of images on the page* */
     images_count?: number | undefined;
-    /** number of words on the page */
+    /** *number of words on the page* */
     words_count?: number | undefined;
-    /** spam score of the page learn more about how the metric is calculated on this help center page */
+    /** *spam score of the page* learn more about how the metric is calculated on [this help center page](https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated) */
     page_spam_score?: number | undefined;
-    /** array of social media tags found on the page contains social media tags and their content supported tags include but are not limited to Open Graph and Twitter card */
+    /** *array of social media tags found on the page* contains social media tags and their content supported tags include but are not limited to [Open Graph](https://ogp.me/) and [Twitter card](https://developer.twitter.com/en/docs/twitter-for-websites/cards/guides/getting-started) */
     social_media_tags?: {
         [key: string]: string;
     } | undefined;
-    /** h1 tag content of h1 tags */
+    /** *h1 tag* content of `h1` tags */
     h_1?: string[] | undefined;
-    /** h2 tag content of h2 tags */
+    /** *h2 tag* content of `h2` tags */
     h_2?: string[] | undefined;
-    /** h3 tag content of h3 tags */
+    /** *h3 tag* content of `h3` tags */
     h_3?: string[] | undefined;
-    /** content of alt tags */
+    /** *content of `alt` tags* */
     images_alt?: string[] | undefined;
-    /** CMS details */
+    /** *CMS details* */
     powered_by?: string[] | undefined;
-    /** page content language example: en */
+    /** *page content language* example: `en` */
     language?: string | undefined;
-    /** character encoding examples: utf-8 */
+    /** *character encoding* examples: `utf-8` */
     charset?: string | undefined;
-    /** type of a platform */
+    /** *type of a platform* */
     platform_type?: string[] | undefined;
-    /** website technologies */
+    /** *website technologies* */
     technologies?: {
         [key: string]: string;
     } | undefined;

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

@@ -1,59 +1,59 @@
 export interface IBacklinksReferringDomainsLiveItem {
     /** type of element */
     type?: string | undefined;
-    /** referring domain */
+    /** *referring domain* */
     domain?: string | undefined;
-    /** domain rank rank volume that a referring website passes to the target 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 */
+    /** *domain rank* rank volume that a referring website passes to the `target` `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](https://dataforseo.com/help-center/what_is_rank_in_backlinks_api) */
     rank?: number | undefined;
-    /** indicates the number of backlinks pointing to the target */
+    /** *indicates the number of backlinks pointing to the `target`* */
     backlinks?: number | undefined;
-    /** date and time when our crawler found the backlink 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 */
+    /** *date and time when our crawler found the backlink 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 from this domain 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 */
+    /** *date and time when the last backlink from this domain 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 pointing to the domain learn more about how the metric is calculated on this help center page */
+    /** *average spam score of all backlinks pointing to the domain* learn more about how the metric is calculated on [this help center page](https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated) */
     backlinks_spam_score?: number | undefined;
-    /** number of broken backlinks number of broken backlinks pointing to the domain */
+    /** *number of broken backlinks* number of broken backlinks pointing to the domain */
     broken_backlinks?: number | undefined;
-    /** number of broken pages number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to */
+    /** *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 note that we calculate main domains (root domains, like example.com) and their subdomains (e.g. blog.example.com) separately for this metric */
+    /** *indicates the number of referring domains* note that we calculate main domains (root domains, like `example.com`) and their subdomains (e.g. `blog.example.com`) separately for this metric */
     referring_domains?: number | undefined;
-    /** number of domains pointing at least one nofollow link to the target */
+    /** *number of domains pointing at least one nofollow link to the `target`* */
     referring_domains_nofollow?: number | undefined;
-    /** indicates the number of referring main domains the number of primary (root) domains referring to your target */
+    /** *indicates the number of referring main domains* the number of primary (root) domains referring to your target */
     referring_main_domains?: number | undefined;
-    /** number of main domains pointing at least one nofollow link to the target */
+    /** *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 */
+    /** *number of referring IP addresses* number of IP addresses pointing to this page */
     referring_ips?: number | undefined;
-    /** number of referring subnetworks */
+    /** *number of referring subnetworks* */
     referring_subnets?: number | undefined;
-    /** indicates the number of pages pointing to the target specified */
+    /** *indicates the number of pages pointing to the `target` specified* */
     referring_pages?: number | undefined;
-    /** number of referring pages pointing at least one nofollow link to the target */
+    /** *number of referring pages pointing at least one nofollow link to the `target`* */
     referring_pages_nofollow?: number | undefined;
-    /** top-level domains of the referring links contains top level domains and referring link count per each */
+    /** *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 */
+    /** *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 */
+    /** *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 link count per each platform possible values: cms, blogs, ecommerce, message-boards, wikis, news, organization */
+    /** *types of referring platforms* indicates referring platform types 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 the link count per each semantic location you can get the full list of semantic elements here examples: article, section, summary */
+    /** *semantic locations of the referring links* indicates semantic elements in HTML where the referring links are located and the link count per each semantic location you can get the full list of semantic elements [here](https://www.w3schools.com/html/html5_semantic_elements.asp) 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 */
+    /** *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;
@@ -62,59 +62,59 @@ export interface IBacklinksReferringDomainsLiveItem {
 export declare class BacklinksReferringDomainsLiveItem implements IBacklinksReferringDomainsLiveItem {
     /** type of element */
     type?: string | undefined;
-    /** referring domain */
+    /** *referring domain* */
     domain?: string | undefined;
-    /** domain rank rank volume that a referring website passes to the target 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 */
+    /** *domain rank* rank volume that a referring website passes to the `target` `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](https://dataforseo.com/help-center/what_is_rank_in_backlinks_api) */
     rank?: number | undefined;
-    /** indicates the number of backlinks pointing to the target */
+    /** *indicates the number of backlinks pointing to the `target`* */
     backlinks?: number | undefined;
-    /** date and time when our crawler found the backlink 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 */
+    /** *date and time when our crawler found the backlink 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 from this domain 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 */
+    /** *date and time when the last backlink from this domain 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 pointing to the domain learn more about how the metric is calculated on this help center page */
+    /** *average spam score of all backlinks pointing to the domain* learn more about how the metric is calculated on [this help center page](https://dataforseo.com/help-center/what-is-spam-score-and-how-is-it-calculated) */
     backlinks_spam_score?: number | undefined;
-    /** number of broken backlinks number of broken backlinks pointing to the domain */
+    /** *number of broken backlinks* number of broken backlinks pointing to the domain */
     broken_backlinks?: number | undefined;
-    /** number of broken pages number of pages that respond with 4xx or 5xx status codes where backlinks are pointing to */
+    /** *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 note that we calculate main domains (root domains, like example.com) and their subdomains (e.g. blog.example.com) separately for this metric */
+    /** *indicates the number of referring domains* note that we calculate main domains (root domains, like `example.com`) and their subdomains (e.g. `blog.example.com`) separately for this metric */
     referring_domains?: number | undefined;
-    /** number of domains pointing at least one nofollow link to the target */
+    /** *number of domains pointing at least one nofollow link to the `target`* */
     referring_domains_nofollow?: number | undefined;
-    /** indicates the number of referring main domains the number of primary (root) domains referring to your target */
+    /** *indicates the number of referring main domains* the number of primary (root) domains referring to your target */
     referring_main_domains?: number | undefined;
-    /** number of main domains pointing at least one nofollow link to the target */
+    /** *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 */
+    /** *number of referring IP addresses* number of IP addresses pointing to this page */
     referring_ips?: number | undefined;
-    /** number of referring subnetworks */
+    /** *number of referring subnetworks* */
     referring_subnets?: number | undefined;
-    /** indicates the number of pages pointing to the target specified */
+    /** *indicates the number of pages pointing to the `target` specified* */
     referring_pages?: number | undefined;
-    /** number of referring pages pointing at least one nofollow link to the target */
+    /** *number of referring pages pointing at least one nofollow link to the `target`* */
     referring_pages_nofollow?: number | undefined;
-    /** top-level domains of the referring links contains top level domains and referring link count per each */
+    /** *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 */
+    /** *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 */
+    /** *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 link count per each platform possible values: cms, blogs, ecommerce, message-boards, wikis, news, organization */
+    /** *types of referring platforms* indicates referring platform types 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 the link count per each semantic location you can get the full list of semantic elements here examples: article, section, summary */
+    /** *semantic locations of the referring links* indicates semantic elements in HTML where the referring links are located and the link count per each semantic location you can get the full list of semantic elements [here](https://www.w3schools.com/html/html5_semantic_elements.asp) 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 */
+    /** *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;

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

@@ -1,58 +1,58 @@
 export interface IBacklinksReferringDomainsLiveRequestInfo {
-    /** domain, subdomain or webpage to get referring domains 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://) */
+    /** *domain, subdomain or webpage to get referring domains 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 domains optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned domains* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages */
+    /** *offset in the results array of returned domains* optional field default value: `0` if you specify the `10` value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages */
     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 */
+    /** *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 */
+    /** *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, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ['referring_pages','>','1'] [['referring_pages','>','2'], 'and', ['backlinks','>','10']] [['first_seen','>','2017-10-23 11:31:45 +00:00'], 'and', [['domain','like','%dataforseo.com%'],'or',['referring_domains','>','10']]] The full list of possible filters is available here. */
+    /** *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`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['referring_pages','>','1']` `[['referring_pages','>','2'],'and',['backlinks','>','10']]` `[['first_seen','>','2017-10-23 11:31:45 +00:00'],'and',[['domain','like','%dataforseo.com%'],'or',['referring_domains','>','10']]]` The full list of possible filters is available [here.](/v3/backlinks/filters/?bash) */
     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'] */
+    /** *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] */
+    /** *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](/v3/backlinks/backlinks/live) 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 */
+    /** *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 */
+    /** *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 */
+    /** *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 */
+    /** *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](https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale) */
     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 */
+    /** *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 declare class BacklinksReferringDomainsLiveRequestInfo implements IBacklinksReferringDomainsLiveRequestInfo {
-    /** domain, subdomain or webpage to get referring domains 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://) */
+    /** *domain, subdomain or webpage to get referring domains 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 domains optional field default value: 100 maximum value: 1000 */
+    /** *the maximum number of returned domains* optional field default value: `100` maximum value: `1000` */
     limit?: number | undefined;
-    /** offset in the results array of returned domains optional field default value: 0 if you specify the 10 value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages */
+    /** *offset in the results array of returned domains* optional field default value: `0` if you specify the `10` value, the first ten domains in the results array will be omitted and the data will be provided for the successive pages */
     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 */
+    /** *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 */
+    /** *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, match, not_match you can use the % operator with like and not_like to match any string of zero or more characters example: ['referring_pages','>','1'] [['referring_pages','>','2'], 'and', ['backlinks','>','10']] [['first_seen','>','2017-10-23 11:31:45 +00:00'], 'and', [['domain','like','%dataforseo.com%'],'or',['referring_domains','>','10']]] The full list of possible filters is available here. */
+    /** *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`, `match`, `not_match` you can use the `%` operator with `like` and `not_like` to match any string of zero or more characters example: `['referring_pages','>','1']` `[['referring_pages','>','2'],'and',['backlinks','>','10']]` `[['first_seen','>','2017-10-23 11:31:45 +00:00'],'and',[['domain','like','%dataforseo.com%'],'or',['referring_domains','>','10']]]` The full list of possible filters is available [here.](/v3/backlinks/filters/?bash) */
     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'] */
+    /** *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] */
+    /** *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](/v3/backlinks/backlinks/live) 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 */
+    /** *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 */
+    /** *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 */
+    /** *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 */
+    /** *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](https://dataforseo.com/help-center/what_is_rank_in_backlinks_api#rank_scale) */
     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 */
+    /** *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?: IBacklinksReferringDomainsLiveRequestInfo);

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

@@ -1,12 +1,12 @@
 import { BacklinksReferringDomainsLiveTaskInfo } from "./BacklinksReferringDomainsLiveTaskInfo";
 import { BaseResponseInfo, IBaseResponseInfo } from "./BaseResponseInfo";
 export interface IBacklinksReferringDomainsLiveResponseInfo extends IBaseResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: BacklinksReferringDomainsLiveTaskInfo[] | undefined;
     [key: string]: any;
 }
 export declare class BacklinksReferringDomainsLiveResponseInfo extends BaseResponseInfo implements IBacklinksReferringDomainsLiveResponseInfo {
-    /** array of tasks */
+    /** *array of tasks* */
     tasks?: BacklinksReferringDomainsLiveTaskInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IBacklinksReferringDomainsLiveResponseInfo);

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

@@ -1,23 +1,23 @@
 import { BacklinksReferringDomainsLiveItem } from "./BacklinksReferringDomainsLiveItem";
 export interface IBacklinksReferringDomainsLiveResultInfo {
-    /** target in a POST array */
+    /** *`target` in a POST array* */
     target?: string | undefined;
-    /** total number of relevant items in the database total number of main domains referring to your target; example.com and blog.example.com are counted as one referring domain */
+    /** *total number of relevant items in the database* total number of main domains referring to your target; example.com and blog.example.com are counted as one referring domain */
     total_count?: number | undefined;
-    /** number of items in the items array */
+    /** *number of items in the `items` array* */
     items_count?: number | undefined;
-    /** items array */
+    /** *items array* */
     items?: BacklinksReferringDomainsLiveItem[] | undefined;
     [key: string]: any;
 }
 export declare class BacklinksReferringDomainsLiveResultInfo implements IBacklinksReferringDomainsLiveResultInfo {
-    /** target in a POST array */
+    /** *`target` in a POST array* */
     target?: string | undefined;
-    /** total number of relevant items in the database total number of main domains referring to your target; example.com and blog.example.com are counted as one referring domain */
+    /** *total number of relevant items in the database* total number of main domains referring to your target; example.com and blog.example.com are counted as one referring domain */
     total_count?: number | undefined;
-    /** number of items in the items array */
+    /** *number of items in the `items` array* */
     items_count?: number | undefined;
-    /** items array */
+    /** *items array* */
     items?: BacklinksReferringDomainsLiveItem[] | undefined;
     [key: string]: any;
     constructor(data?: IBacklinksReferringDomainsLiveResultInfo);

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

@@ -1,12 +1,12 @@
 import { BacklinksReferringDomainsLiveResultInfo } from "./BacklinksReferringDomainsLiveResultInfo";
 import { BaseResponseTaskInfo, IBaseResponseTaskInfo } from "./BaseResponseTaskInfo";
 export interface IBacklinksReferringDomainsLiveTaskInfo extends IBaseResponseTaskInfo {
-    /** array of results */
+    /** *array of results* */
     result?: BacklinksReferringDomainsLiveResultInfo[] | undefined;
     [key: string]: any;
 }
 export declare class BacklinksReferringDomainsLiveTaskInfo extends BaseResponseTaskInfo implements IBacklinksReferringDomainsLiveTaskInfo {
-    /** array of results */
+    /** *array of results* */
     result?: BacklinksReferringDomainsLiveResultInfo[] | undefined;
     [key: string]: any;
     constructor(data?: IBacklinksReferringDomainsLiveTaskInfo);