Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Offer

Class that defines each offer.

Hierarchy

  • Offer

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional attachments

attachments: any[] = []

media url's of an offer

Optional attributes

attributes: any

it holds various attribute types of an offer.

Optional childProducts

childProducts: any[]

product child addons for an offer.

Optional customFields

customFields: any = {}

custom attributes for an offer

Optional description

description: string

description of the offer.

Optional groupMaxQuantity

groupMaxQuantity: number

groupMaxQuantity of the offer.

Optional groupMinQuantity

groupMinQuantity: number

groupMinQuantity of the offer.

id

id: string

unique ID for each offer.

Optional maxQuantity

maxQuantity: number

maxQuantity of the offer.

Optional minQuantity

minQuantity: number

minQuantity of the offer.

name

name: string

name of the offer.

Optional navigationInfo

navigationInfo: string

Route url for deep linking for an offer.

Optional offerCode

offerCode: string

offercode.

offerType

offerType: string

type of offer i.e. product or promotion

Optional priceInfo

priceInfo: PriceInfo

prices information for an offer.

Optional productGroups

productGroups: any[]

product addons bundles for an offer.

Optional productHierarchyPath

productHierarchyPath: string

heirarchy path to identify child-product from offer bundle.

Optional products

products: Offer[]

list of products having same promotions

Optional promoCode

promoCode: any

promocode applicable to the offer.

Optional promoDescription

promoDescription: string

promo description.

Optional promoName

promoName: string

promotion name.

Optional promoProducts

promoProducts: any[]

promo products.

Optional quantity

quantity: number

quantity of the offer.

Optional seoMetaData

seoMetaData: any = {}

seoMetaData - It contains all meta data needed for SEO.

  1. Meta Data Page Title - Name
  2. Meta Data description - Description
  3. Meta Data Key words - Name

Methods

Static parse

  • parse(offerResponse: any, input?: any): any

  • This function parse the offer information.

    Parameters

    • offerResponse: any
    • Optional input: any

    Returns any

    Offer

Static updateOffer

  • updateOffer(updatedFields: any, productConfiguration: any): any

  • This function updates the original object with updated values

    Parameters

    • updatedFields: any

      Fields updated in the web components

    • productConfiguration: any

      Original product copy

    Returns any

    • Original product with updated fields.

Generated using TypeDoc