Options
All
  • Public
  • Public/Protected
  • All
Menu

Class that defines input for cart operations.

Hierarchy

Index

Constructors

constructor

Properties

Optional accountId

accountId: string = ""

User accountId for checkout api calls - optional

actionObj

actionObj: Action

Action object json.

Optional actionParams

actionParams: any

An POST Body object for the api requests.

anonymousSiteUrl

anonymousSiteUrl: string

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

apiNamespace

apiNamespace: string

API namespace.

basketAction

basketAction: string

A required POST Body param to provide one of the three possible actions for the underlying API: AddWithNoConfig - if adding directly from offerCode; requires POST Body param 'offer'. AddAfterConfig - if adding from configured offerDetails; requires POST Body param 'productConfig' DeleteFromBasket - if deleting a bundle; srequires POST Body param 'deleteBundleNumber'

Optional cacheExpiration

cacheExpiration: Date

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

Optional cacheType

cacheType: string

Flag to indicate where the data to be cached. Supported types are "INDEXEDDB, SESSIONSTORAGE and LOCALSTORAGE"

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.

Optional cartContextKey

cartContextKey: string

Persisting cartContext hash key to be used in part of the path of the API to maintain existing cart. For fresh cart, no need to pass this.

catalogCode

catalogCode: string

catalogCode to be used in part of the path of the API.

Optional chainable

chainable: boolean

execute Integration Procedure as chainable.

Optional contentType

contentType: string = "application/json"

Optional context

context: string

context param 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 includeAttachment

includeAttachment: boolean = false

An optional POST Body parameter for fetching the attachments.

Optional inputMap

inputMap: any = {}

Input Map values for the dataraptor procedure.

Optional integrationProcedureKey

integrationProcedureKey: string = ""

integration procedure name - optional

Optional isLoggedIn

isLoggedIn: boolean

isLoggedIn as part of the query string of the API.

Optional multiTransactionKey

multiTransactionKey: string

An optional POST Body parameter for adding items to cart.

Optional offerCode

offerCode: string

An optional POST Body param to specify offer code to be added to cart; only needed if offer is being added without any configuration, in which case basketAction is "AddWithNoConfig".

Optional offerConfiguration

offerConfiguration: any

An optional POST Body param to provide configured offer details taken from response of configure API to add configured offer to cart, in which case basketAction is "AddAfterConfig". This can be provided as a Map (direct response of configure API) or as a stringified version of the Map.

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.

Optional transactionKey

transactionKey: string

An optional POST Body object to store offer into cart for the further api requests.

Optional validateAction

validateAction: boolean = true

validateAction is part of the query string of the API todo context rule validation check.

Optional validatePrice

validatePrice: boolean = true

validatePrice is part of the query string of the API todo price validation check.

Methods

getAPIPath

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

    Returns string

getAnonymousSiteRestUrl

  • getAnonymousSiteRestUrl(): string

getAuthToken

  • getAuthToken(context?: default): Promise<string>
  • Function to return authorization token

    Parameters

    • Optional context: default

      optional param.

    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

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 and Rest

    Returns any

getSecureServerRestUrl

  • getSecureServerRestUrl(): string

Generated using TypeDoc