Options
All
  • Public
  • Public/Protected
  • All
Menu

Class that defines input for validating a offer configuration.

extends

DigitalCommerceInput

Hierarchy

Index

Constructors

constructor

  • Constructor function for GetCatalogOffersInput class.

    Returns ValidateOfferInput

Properties

Optional accountId

accountId: string = ""

User accountId for checkout api calls - optional

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.

Optional cacheExpiration

cacheExpiration: Date

Expiration Date time of the cached item. Default is current time plus 5 minutes.

Optional cacheable

cacheable: boolean = false

Flag to indicate if the sdk call should be cached.

Optional callSecureServer

callSecureServer: boolean = false

boolean value to decide if secure server needs to be called.

catalogCode

catalogCode: string

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

Optional contentType

contentType: string = "application/json"

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 customFields

customFields: string[] = []

List of custom fields to be returned.

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 integrationProcedureKey

integrationProcedureKey: string = ""

integration procedure name - optional

Optional isLoggedIn

isLoggedIn: boolean

isLoggedIn as part of the query string of the API.

offerCode

offerCode: string

offerCode to be used in part of the path of the API to get the details of the associated product.

offerConfiguration

offerConfiguration: any

offerConfiguration JSON of the offer to be use as request body of the API for configuration, to get the resultant price.

Optional optionsMap

optionsMap: any

Options Map values for the integration procedure.

Optional reload

reload: boolean = false

Boolean flag to discard cache and call the api again. Default is false.

remoteClass

remoteClass: string = "CpqAppHandler"

Remote class that handles this request.

remoteMethod

remoteMethod: string

Remote method that handles this request.

Optional requestCredentials

requestCredentials: boolean

value indicating whether the user agent should send cookies from the other domain in the case of cross-origin requests

Optional secureServerEndPointUrl

secureServerEndPointUrl: string

optional input param used as secure Server rest URL end point when Proxy SDK is used

Optional timeoutInMillis

timeoutInMillis: number = 20000

Flag to indicate if the sdk call should be cached.

Methods

getAPIPath

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

    Returns string

getAnonymousSiteRestUrl

  • getAnonymousSiteRestUrl(): string

getAuthToken

  • Function to return authorization token

    Parameters

    Returns Promise<string>

getAuthorisationType

  • getAuthorisationType(): 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
  • Function to return VF Remoting method name.

    Returns string

getRequestCredentials

  • getRequestCredentials(): RequestCredentials
  • The credentials read-only property of the Request interface indicates whether the user agent should send cookies from the other domain in the case of cross-origin requests.

    Returns RequestCredentials

getRequestPayload

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

    Returns any

getSecureServerRestUrl

  • getSecureServerRestUrl(): string

isValidInput

  • isValidInput(): boolean
  • Returns boolean

Generated using TypeDoc