Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GetPromotionsInput

Hierarchy

  • GetPromotionsInput

Index

Properties

Methods

Properties

anonymousSiteUrl

anonymousSiteUrl: string = ""

Anonymous site URL. e.g. https://guidedselling102-developer-edition.na35.force.com

apiNamespace

apiNamespace: string = ""

API Namespace to be used in Rest API call. e.g. h_cpq_promotion

cartId

cartId: string

The cart Id to be used for getting a list of promotions. It may be the regular cart id or the anonymous cart id.

Optional fields

fields: string[]

List of fields to be returned, separated by commas.

Optional filters

filters: Map<string, string>

Filter to be used on the product result. Filter must be in name and value pair where name is the SObject.fieldname and value will be used for matching. eg. Product2.Name:Product1_Product2 (means Product2.Name = Product1 OR Product2)

Optional id

id: string[]

Comma separated list of productIds

Optional include

include: Set<string>

List of nodes to indicate what to include in the product results. Valid values: attributes, attachments, ineligible

todo

we can use enum here.

Optional pageSize

pageSize: number

The number of top level products or offers to be returned. Default is 20.

remoteClass

remoteClass: string = "CpqAppHandler"

Remote class to handle get products.

remoteMethod

remoteMethod: string = "getCartsPromotions"

Remote method in the boave Remote Class to handle get products.

Static Private CustomProcessQueryNames

CustomProcessQueryNames: Set<string> = new Set(["include","cartId","id","filters","fields","remoteClass","remoteMethod","loginUserRestPath","anonymousRestUrl"])

Query Names that needs to be skipped and may require custom processing. If custom processing is needed, these query names will be flattened out into URL Get parameters.

Methods

anonymousRestUrl

  • anonymousRestUrl(urlparams: any): string

getAnonymousRestUrl

  • getAnonymousRestUrl(params?: object): string

  • Apply the given params value of matching in rest URL.

    Parameters

    • Optional params: object

      parameters to be applied in the Rest Url excluding the query string.

    Returns string

getLoginUserRestPath

  • getLoginUserRestPath(params?: object): string

  • Apply the given params value of matching in rest path.

    Parameters

    • Optional params: object

      parameters to be applied in the Rest Url excluding the query string.

    Returns string

inputMap

  • inputMap(): object

  • Returns object

loginUserRestPath

  • loginUserRestPath(urlparams: any): string

  • Rest URL for login user to get promotions.

    Parameters

    • urlparams: any

    Returns string

setInclude

  • setInclude(params: string[]): void

  • Add params as Set object

    Parameters

    • params: string[]

    Returns void

urlEncodedQuery

  • urlEncodedQuery(): string

  • Return the encoded query of a URI that contains the properties in this class. Undefined properties will not be included in the encoded query.

    scheme:[//[user[:password]@]host[:port]][/path][?query][#fragment]

    Returns string

Generated using TypeDoc