Options
All
  • Public
  • Public/Protected
  • All
Menu

This class defines an input for creating a promotion.

Hierarchy

Index

Constructors

constructor

  • The constructor function that initializes the params to create the body of the PUT request.

    Parameters

    • params: NewPromotionItemObject

      defines the new promotion item. For example: params = { promotionId : "a2tf2000001c5BM", actionType : "Add", cardinalityCheckScope : null, contextEntityFilterId : null, contextProductId : null, description : "Quad Play Fall Promo", effectiveFromDate : "2018-01-01T08:00:00.000+0000", effectiveUntilDate : "2025-12-31T08:00:00.000+0000", isActive : true, isUndoable : false, maxQuantity : 2.0, minQuantity : 1.0, offerId : null, productId : "01tf2000007Mmu4AAC", quantity : 1.0, undoableMessage : null, updateScope : "Update Item Only" }

    Returns CreatePromotionItemInput

Properties

apexRestUrl

apexRestUrl: string

Apex Rest URL that handles this request.

apexRestUrlAWS

apexRestUrlAWS: string

apiNamespace

apiNamespace: string = SalesForceNamespace.restAPIPrefix

Salesforce organization.

params

The parameters required to create a promotion item. The params object should look like below: params = { promotionId : "a2tf2000001c5BM", actionType : "Add", cardinalityCheckScope : null, contextEntityFilterId : null, contextProductId : null, description : "Quad Play Fall Promo", effectiveFromDate : "2018-01-01T08:00:00.000+0000", effectiveUntilDate : "2025-12-31T08:00:00.000+0000", isActive : true, isUndoable : false, maxQuantity : 2.0, minQuantity : 1.0, offerId : null, productId : "01tf2000007Mmu4AAC", quantity : 1.0, undoableMessage : null, updateScope : "Update Item Only" }

remoteClass

remoteClass: string

Remote class that handles this request.

remoteMethod

remoteMethod: string

Remote method that handles this request.

restUrl

restUrl: string

Rest URL that handles this request.

Methods

getApexRestEndPoint

  • getApexRestEndPoint(): string
  • A method that returns the end point with apex rest url with namepsace if defined.

    Returns string

    • endpoint with apex rest url with apiNamespace if defined.

getEndPointWithNamespace

  • getEndPointWithNamespace(): string
  • A method that returns the end point with rest url and or namepsace.

    Returns string

    • endpoint with rest url and or apiNamespace.

getNewPromotionItemInputString

  • getNewPromotionItemInputString(): object
  • Returns object

paramsArray

  • paramsArray(): string[]
  • Constructs the paramsArray for ApexRemote call.

    Returns string[]

    array of args to be supplied to ApexRemote Call. The sequence of the element corresponds to the arguments of the Apex @RemoteAction method.

Generated using TypeDoc