Options
All
  • Public
  • Public/Protected
  • All
Menu

Class that defines input for getting product and promotions associated with a catalogCode.

extends

DigitalCommerceInput

Hierarchy

Index

Constructors

constructor

  • Constructor function for GetOffersInput class

    Returns GetOffersInput

Properties

actionObj

actionObj: Action

Action object json.

anonymousSiteUrl

anonymousSiteUrl: string

anonymousSiteUrl as the prefix of the API url for Off-Platform deployments.

apiNamespace

apiNamespace: string

API namespace.

catalogCode

catalogCode: string

catalogCode to be used in part of the query string of the API to get associated products and promotions.

Optional contains

contains: string

contains as part of the query string of the API to get related offers.

Optional context

context: string

context params as part of the query string of the API to define which offers qualify in returning result set.

Optional fields

fields: string[]

List of fields to be returned.

Optional forceInvalidateCache

forceInvalidateCache: boolean

forceInvalidateCache as part of the query string of the API to refresh the cache for a particular catalog.

Optional isLoggedIn

isLoggedIn: boolean

isLoggedIn as part of the query string of the API.

Optional offset

offset: number

offset as part of the query string of the API for pagination.

Optional pageSize

pageSize: number

pageSize as part of the query string of the API for pagination.

remoteClass

remoteClass: string = "CpqAppHandler"

Remote class that handles this request.

remoteMethod

remoteMethod: string

Remote method that handles this request.

Optional sortBy

sortBy: string

sortBy as part of the query string of the API to specify sorting field.

Methods

getAPIPath

  • getAPIPath(): string
  • Function that constructs the API path for ApexRest Handles scenerio when namespace is null

    Returns string

getAnonymousSiteRestUrl

  • getAnonymousSiteRestUrl(): string

Protected getEncodedQueryString

  • getEncodedQueryString(): string

getInputMap

  • getInputMap(): any
  • Function that constructs the input map object containing all query parameters for API

    Returns any

getRemoteMethod

  • getRemoteMethod(): string

getRequestPayload

  • getRequestPayload(): string
  • Function that constructs the Request body json for ApexRest Handles scenerio when JSONResult, accountId and catalogCode is null

    Returns string

Generated using TypeDoc