dataforseo-client 2.1.2 → 2.1.3

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

@@ -3,70 +3,70 @@ import { RatingInfo } from "./RatingInfo";
 export interface IBaseMerchantGoogleShoppingSellersElementItem {
     /** type of element */
     type?: string | undefined;
-    /** position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group */
+    /** *position within a group of elements with identical `type` values* positions of elements with different `type` values are omitted from `rank_group` */
     rank_group?: number | undefined;
-    /** absolute rank in SERP absolute position among all the elements found in Google Shopping SERP */
+    /** *absolute rank in SERP* absolute position among all the elements found in Google Shopping SERP */
     rank_absolute?: number | undefined;
-    /** the alignment of the element in Google Shopping SERP possible values: left, right */
+    /** *the alignment of the element in Google Shopping SERP* possible values: `left`, `right` */
     position?: string | undefined;
-    /** XPath of the element */
+    /** *[XPath](https://en.wikipedia.org/wiki/XPath) of the element* */
     xpath?: string | undefined;
-    /** domain in SERP */
+    /** *domain in SERP* */
     domain?: string | undefined;
-    /** product title */
+    /** *product title* */
     title?: string | undefined;
-    /** Google Shopping URL forwarding to the product page on the seller’s website if you want to obtain a URL of the advertisement forwarding to the product page on the seller’s website, please refer to the Google Shopping Sellers Ad URL endpoint */
+    /** *Google Shopping URL forwarding to the product page on the seller’s website* if you want to obtain a URL of the advertisement forwarding to the product page on the seller's website, please refer to the [Google Shopping Sellers Ad URL](/v3/merchant/google/sellers/ad_url/) endpoint */
     url?: string | undefined;
-    /** details and special offers if there are no details, the value will be null */
+    /** *details and special offers* if there are no details, the value will be `null` */
     details?: string | undefined;
-    /** product price without tax and shipping */
+    /** *product price without tax and shipping* */
     base_price?: number | undefined;
-    /** the amount of tax tax is specified as the actual amount of money, not as the percentage */
+    /** *the amount of tax* tax is specified as the actual amount of money, not as the percentage */
     tax?: number | undefined;
-    /** product shipping price */
+    /** *product shipping price* */
     shipping_price?: number | undefined;
-    /** product price including tax and shipping */
+    /** *product price including tax and shipping* */
     total_price?: number | undefined;
-    /** currency in the ISO format example: USD */
+    /** *currency in the [ISO](https://en.wikipedia.org/wiki/ISO_4217) format* example: `USD` */
     currency?: string | undefined;
-    /** name of the seller the name of the company that placed a corresponding product on Google Shopping */
+    /** *name of the seller* the name of the company that placed a corresponding product on Google Shopping */
     seller_name?: string | undefined;
-    /** unique ad click referral parameter using this parameter you can get a URL of the advertisement in Google Shopping Sellers Ad URL */
+    /** *unique ad click referral parameter* using this parameter you can get a URL of the advertisement in [Google Shopping Sellers Ad URL](/v3/merchant/google/sellers/ad_url/) */
     shop_ad_aclk?: string | undefined;
     [key: string]: any;
 }
 export declare class BaseMerchantGoogleShoppingSellersElementItem implements IBaseMerchantGoogleShoppingSellersElementItem {
     /** type of element */
     type?: string | undefined;
-    /** position within a group of elements with identical type values positions of elements with different type values are omitted from rank_group */
+    /** *position within a group of elements with identical `type` values* positions of elements with different `type` values are omitted from `rank_group` */
     rank_group?: number | undefined;
-    /** absolute rank in SERP absolute position among all the elements found in Google Shopping SERP */
+    /** *absolute rank in SERP* absolute position among all the elements found in Google Shopping SERP */
     rank_absolute?: number | undefined;
-    /** the alignment of the element in Google Shopping SERP possible values: left, right */
+    /** *the alignment of the element in Google Shopping SERP* possible values: `left`, `right` */
     position?: string | undefined;
-    /** XPath of the element */
+    /** *[XPath](https://en.wikipedia.org/wiki/XPath) of the element* */
     xpath?: string | undefined;
-    /** domain in SERP */
+    /** *domain in SERP* */
     domain?: string | undefined;
-    /** product title */
+    /** *product title* */
     title?: string | undefined;
-    /** Google Shopping URL forwarding to the product page on the seller’s website if you want to obtain a URL of the advertisement forwarding to the product page on the seller’s website, please refer to the Google Shopping Sellers Ad URL endpoint */
+    /** *Google Shopping URL forwarding to the product page on the seller’s website* if you want to obtain a URL of the advertisement forwarding to the product page on the seller's website, please refer to the [Google Shopping Sellers Ad URL](/v3/merchant/google/sellers/ad_url/) endpoint */
     url?: string | undefined;
-    /** details and special offers if there are no details, the value will be null */
+    /** *details and special offers* if there are no details, the value will be `null` */
     details?: string | undefined;
-    /** product price without tax and shipping */
+    /** *product price without tax and shipping* */
     base_price?: number | undefined;
-    /** the amount of tax tax is specified as the actual amount of money, not as the percentage */
+    /** *the amount of tax* tax is specified as the actual amount of money, not as the percentage */
     tax?: number | undefined;
-    /** product shipping price */
+    /** *product shipping price* */
     shipping_price?: number | undefined;
-    /** product price including tax and shipping */
+    /** *product price including tax and shipping* */
     total_price?: number | undefined;
-    /** currency in the ISO format example: USD */
+    /** *currency in the [ISO](https://en.wikipedia.org/wiki/ISO_4217) format* example: `USD` */
     currency?: string | undefined;
-    /** name of the seller the name of the company that placed a corresponding product on Google Shopping */
+    /** *name of the seller* the name of the company that placed a corresponding product on Google Shopping */
     seller_name?: string | undefined;
-    /** unique ad click referral parameter using this parameter you can get a URL of the advertisement in Google Shopping Sellers Ad URL */
+    /** *unique ad click referral parameter* using this parameter you can get a URL of the advertisement in [Google Shopping Sellers Ad URL](/v3/merchant/google/sellers/ad_url/) */
     shop_ad_aclk?: string | undefined;
     [key: string]: any;
     protected discriminator: string;
@@ -76,32 +76,32 @@ export declare class BaseMerchantGoogleShoppingSellersElementItem implements IBa
     toJSON(data?: any): any;
 }
 export interface IGoogleShoppingSellersShopsListElementItem extends IBaseMerchantGoogleShoppingSellersElementItem {
-    /** monthly price multiplier indicates the number of months covered by the monthly payment for the product */
+    /** *monthly price multiplier* indicates the number of months covered by the monthly payment for the product */
     price_multiplier?: number | undefined;
-    /** installment details as displayed in the results shows how the product price can be broken down into monthly payments, if applicable */
+    /** *installment details as displayed in the results* shows how the product price can be broken down into monthly payments, if applicable */
     displayed_payment_breakdown?: string | undefined;
-    /** shop rating the shop popularity rate based on product reviews */
+    /** *shop rating* the shop popularity rate based on product reviews */
     rating?: RatingElement | undefined;
-    /** indicated condition of the product possible values: Used, Refurbished, New, Pre-owned, null */
+    /** *indicated condition of the product* possible values: `Used`, `Refurbished`, `New`, `Pre-owned`, `null` */
     product_condition?: string | undefined;
-    /** data from annotations and badges with special offers if there is no annotation for this product, the value will be null examples: LOW PRICE, SPECIAL OFFER, SALE, PRICE DROP */
+    /** *data from annotations and badges with special offers* if there is no annotation for this product, the value will be `null` examples: `LOW PRICE`, `SPECIAL OFFER`, `SALE`, `PRICE DROP` */
     product_annotation?: string | undefined;
-    /** product availability information product availability information can take the following values: in_stock, limited_stock, out_of_stock, backordered, pre_order_available, on_display_to_order */
+    /** *product availability information* product availability information can take the following values: `in_stock`, `limited_stock`, `out_of_stock`, `backordered`, `pre_order_available`, `on_display_to_order` */
     product_availability?: string | undefined;
     [key: string]: any;
 }
 export declare class GoogleShoppingSellersShopsListElementItem extends BaseMerchantGoogleShoppingSellersElementItem implements IGoogleShoppingSellersShopsListElementItem {
-    /** monthly price multiplier indicates the number of months covered by the monthly payment for the product */
+    /** *monthly price multiplier* indicates the number of months covered by the monthly payment for the product */
     price_multiplier?: number | undefined;
-    /** installment details as displayed in the results shows how the product price can be broken down into monthly payments, if applicable */
+    /** *installment details as displayed in the results* shows how the product price can be broken down into monthly payments, if applicable */
     displayed_payment_breakdown?: string | undefined;
-    /** shop rating the shop popularity rate based on product reviews */
+    /** *shop rating* the shop popularity rate based on product reviews */
     rating?: RatingElement | undefined;
-    /** indicated condition of the product possible values: Used, Refurbished, New, Pre-owned, null */
+    /** *indicated condition of the product* possible values: `Used`, `Refurbished`, `New`, `Pre-owned`, `null` */
     product_condition?: string | undefined;
-    /** data from annotations and badges with special offers if there is no annotation for this product, the value will be null examples: LOW PRICE, SPECIAL OFFER, SALE, PRICE DROP */
+    /** *data from annotations and badges with special offers* if there is no annotation for this product, the value will be `null` examples: `LOW PRICE`, `SPECIAL OFFER`, `SALE`, `PRICE DROP` */
     product_annotation?: string | undefined;
-    /** product availability information product availability information can take the following values: in_stock, limited_stock, out_of_stock, backordered, pre_order_available, on_display_to_order */
+    /** *product availability information* product availability information can take the following values: `in_stock`, `limited_stock`, `out_of_stock`, `backordered`, `pre_order_available`, `on_display_to_order` */
     product_availability?: string | undefined;
     [key: string]: any;
     constructor(data?: IGoogleShoppingSellersShopsListElementItem);
@@ -110,12 +110,12 @@ export declare class GoogleShoppingSellersShopsListElementItem extends BaseMerch
     toJSON(data?: any): any;
 }
 export interface IGoogleShoppingSellersBuyOnGoogleElementItem extends IBaseMerchantGoogleShoppingSellersElementItem {
-    /** shop rating the shop popularity rate based on product reviews */
+    /** *shop rating* the shop popularity rate based on product reviews */
     rating?: RatingInfo | undefined;
     [key: string]: any;
 }
 export declare class GoogleShoppingSellersBuyOnGoogleElementItem extends BaseMerchantGoogleShoppingSellersElementItem implements IGoogleShoppingSellersBuyOnGoogleElementItem {
-    /** shop rating the shop popularity rate based on product reviews */
+    /** *shop rating* the shop popularity rate based on product reviews */
     rating?: RatingInfo | undefined;
     [key: string]: any;
     constructor(data?: IGoogleShoppingSellersBuyOnGoogleElementItem);

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

@@ -1,62 +1,62 @@
 export interface IBaseOnPageLinkItem {
     /** type of element */
     type?: string | undefined;
-    /** referring domain the link was found on this domain */
+    /** *referring domain* the link was found on this domain */
     domain_from?: string | undefined;
-    /** referenced domain the link is pointing to this domain */
+    /** *referenced domain* the link is pointing to this domain */
     domain_to?: string | undefined;
-    /** referring page relative URL of the page on which the link was found */
+    /** *referring page* relative URL of the page on which the link was found */
     page_from?: string | undefined;
-    /** referenced page relative URL of the page to which the link is pointing */
+    /** *referenced page* relative URL of the page to which the link is pointing */
     page_to?: string | undefined;
-    /** referring page absolute URL of the page on which the link was found */
+    /** *referring page* absolute URL of the page on which the link was found */
     link_from?: string | undefined;
-    /** referenced page absolute URL of the page to which the link is pointing */
+    /** *referenced page* absolute URL of the page to which the link is pointing */
     link_to?: string | undefined;
-    /** indicates whether the link is dofollow if the value is true, the link doesn’t have a rel='nofollow' attribute */
+    /** *indicates whether the link is dofollow* if the value is `true`, the link doesn't have a `rel='nofollow'` attribute */
     dofollow?: boolean | undefined;
-    /** url scheme of the referring page */
+    /** *[url scheme](https://en.wikipedia.org/wiki/List_of_URI_schemes) of the referring page* */
     page_from_scheme?: string | undefined;
-    /** url scheme of the referenced page */
+    /** *[url scheme](https://en.wikipedia.org/wiki/List_of_URI_schemes) of the referenced page* */
     page_to_scheme?: string | undefined;
-    /** direction of the link possible values: internal, external */
+    /** *direction of the link* possible values: `internal`, `external` */
     direction?: string | undefined;
-    /** link is broken indicates whether a link is directing to a broken page or resource */
+    /** *link is broken* indicates whether a link is directing to a broken page or resource */
     is_broken?: boolean | undefined;
-    /** indicates that the link may have a conflict with another link if true, at least one link pointing to link_to has a rel='nofollow' attribute and at least one is dofollow */
+    /** *indicates that the link may have a conflict with another link* if `true`, at least one link pointing to `link_to` has a `rel='nofollow'` attribute **and** at least one is dofollow */
     is_link_relation_conflict?: boolean | undefined;
-    /** status code of the referenced page status code of the page to which the link is pointing */
+    /** *status code of the referenced page* status code of the page to which the link is pointing */
     page_to_status_code?: number | undefined;
     [key: string]: any;
 }
 export declare class BaseOnPageLinkItem implements IBaseOnPageLinkItem {
     /** type of element */
     type?: string | undefined;
-    /** referring domain the link was found on this domain */
+    /** *referring domain* the link was found on this domain */
     domain_from?: string | undefined;
-    /** referenced domain the link is pointing to this domain */
+    /** *referenced domain* the link is pointing to this domain */
     domain_to?: string | undefined;
-    /** referring page relative URL of the page on which the link was found */
+    /** *referring page* relative URL of the page on which the link was found */
     page_from?: string | undefined;
-    /** referenced page relative URL of the page to which the link is pointing */
+    /** *referenced page* relative URL of the page to which the link is pointing */
     page_to?: string | undefined;
-    /** referring page absolute URL of the page on which the link was found */
+    /** *referring page* absolute URL of the page on which the link was found */
     link_from?: string | undefined;
-    /** referenced page absolute URL of the page to which the link is pointing */
+    /** *referenced page* absolute URL of the page to which the link is pointing */
     link_to?: string | undefined;
-    /** indicates whether the link is dofollow if the value is true, the link doesn’t have a rel='nofollow' attribute */
+    /** *indicates whether the link is dofollow* if the value is `true`, the link doesn't have a `rel='nofollow'` attribute */
     dofollow?: boolean | undefined;
-    /** url scheme of the referring page */
+    /** *[url scheme](https://en.wikipedia.org/wiki/List_of_URI_schemes) of the referring page* */
     page_from_scheme?: string | undefined;
-    /** url scheme of the referenced page */
+    /** *[url scheme](https://en.wikipedia.org/wiki/List_of_URI_schemes) of the referenced page* */
     page_to_scheme?: string | undefined;
-    /** direction of the link possible values: internal, external */
+    /** *direction of the link* possible values: `internal`, `external` */
     direction?: string | undefined;
-    /** link is broken indicates whether a link is directing to a broken page or resource */
+    /** *link is broken* indicates whether a link is directing to a broken page or resource */
     is_broken?: boolean | undefined;
-    /** indicates that the link may have a conflict with another link if true, at least one link pointing to link_to has a rel='nofollow' attribute and at least one is dofollow */
+    /** *indicates that the link may have a conflict with another link* if `true`, at least one link pointing to `link_to` has a `rel='nofollow'` attribute **and** at least one is dofollow */
     is_link_relation_conflict?: boolean | undefined;
-    /** status code of the referenced page status code of the page to which the link is pointing */
+    /** *status code of the referenced page* status code of the page to which the link is pointing */
     page_to_status_code?: number | undefined;
     [key: string]: any;
     protected discriminator: string;
@@ -66,16 +66,16 @@ export declare class BaseOnPageLinkItem implements IBaseOnPageLinkItem {
     toJSON(data?: any): any;
 }
 export interface IOnPageAnchorLinkItem extends IBaseOnPageLinkItem {
-    /** link attribute added to external link indicates link attributes added to the link_to on the page_from example: ['ugc','noopener'] */
+    /** *link attribute added to external link* indicates link attributes added to the `link_to` on the `page_from` example: `['ugc','noopener']` */
     link_attribute?: string[] | undefined;
-    /** anchor text */
+    /** *anchor text* */
     text?: string | undefined;
     [key: string]: any;
 }
 export declare class OnPageAnchorLinkItem extends BaseOnPageLinkItem implements IOnPageAnchorLinkItem {
-    /** link attribute added to external link indicates link attributes added to the link_to on the page_from example: ['ugc','noopener'] */
+    /** *link attribute added to external link* indicates link attributes added to the `link_to` on the `page_from` example: `['ugc','noopener']` */
     link_attribute?: string[] | undefined;
-    /** anchor text */
+    /** *anchor text* */
     text?: string | undefined;
     [key: string]: any;
     constructor(data?: IOnPageAnchorLinkItem);
@@ -84,24 +84,24 @@ export declare class OnPageAnchorLinkItem extends BaseOnPageLinkItem implements
     toJSON(data?: any): any;
 }
 export interface IOnPageImageLinkItem extends IBaseOnPageLinkItem {
-    /** link attribute added to external link indicates link attributes added to the link_to on the page_from example: ['ugc','noopener'] */
+    /** *link attribute added to external link* indicates link attributes added to the `link_to` on the `page_from` example: `['ugc','noopener']` */
     link_attribute?: string[] | undefined;
-    /** anchor text */
+    /** *anchor text* */
     text?: string | undefined;
-    /** alternative text for the image */
+    /** *alternative text for the image* */
     image_alt?: string | undefined;
-    /** url of the image */
+    /** *url of the image* */
     image_src?: string | undefined;
     [key: string]: any;
 }
 export declare class OnPageImageLinkItem extends BaseOnPageLinkItem implements IOnPageImageLinkItem {
-    /** link attribute added to external link indicates link attributes added to the link_to on the page_from example: ['ugc','noopener'] */
+    /** *link attribute added to external link* indicates link attributes added to the `link_to` on the `page_from` example: `['ugc','noopener']` */
     link_attribute?: string[] | undefined;
-    /** anchor text */
+    /** *anchor text* */
     text?: string | undefined;
-    /** alternative text for the image */
+    /** *alternative text for the image* */
     image_alt?: string | undefined;
-    /** url of the image */
+    /** *url of the image* */
     image_src?: string | undefined;
     [key: string]: any;
     constructor(data?: IOnPageImageLinkItem);
@@ -120,16 +120,16 @@ export declare class OnPageCanonicalLinkItem extends BaseOnPageLinkItem implemen
     toJSON(data?: any): any;
 }
 export interface IOnPageAlternateLinkItem extends IBaseOnPageLinkItem {
-    /** hreflang validity status indicates whether the hreflang attribute is correctly implemented */
+    /** *hreflang validity status* indicates whether the hreflang attribute is correctly implemented */
     is_valid_hreflang?: boolean | undefined;
-    /** hreflang attribute value language and optional country code specified in the hreflang attribute example: 'en-US', 'fr' */
+    /** *hreflang attribute value* language and optional country code specified in the hreflang attribute example: `'en-US'`, `'fr'` */
     hreflang?: string | undefined;
     [key: string]: any;
 }
 export declare class OnPageAlternateLinkItem extends BaseOnPageLinkItem implements IOnPageAlternateLinkItem {
-    /** hreflang validity status indicates whether the hreflang attribute is correctly implemented */
+    /** *hreflang validity status* indicates whether the hreflang attribute is correctly implemented */
     is_valid_hreflang?: boolean | undefined;
-    /** hreflang attribute value language and optional country code specified in the hreflang attribute example: 'en-US', 'fr' */
+    /** *hreflang attribute value* language and optional country code specified in the hreflang attribute example: `'en-US'`, `'fr'` */
     hreflang?: string | undefined;
     [key: string]: any;
     constructor(data?: IOnPageAlternateLinkItem);