Options
All
  • Public
  • Public/Protected
  • All
Menu

Class that defines input to create a actual cart with a catalogCode and accountId.

extends

DigitalCommerceInput

Hierarchy

Index

Constructors

constructor

  • Constructor function for this input class

    Returns UpdateItemsInCartInput

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 attributeCategories

attributeCategories: any

An optional parameter for attribute categories.

basketAction

basketAction: string

A required POST Body param to contain updateBasket for updating basket

basketkey

basketkey: string

Unique key for each basket

bundleContextKey

bundleContextKey: string

Unique key for each bundle in the cart

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.

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 contextkey

contextkey: string

Persisting contextkey hash key to be used in part of the path of the API to maintain existing cart.

Optional customFields

customFields: string[] = []

List of custom fields to be returned.

Optional fields

fields: string[]

List of fields to be returned.

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 integrationProcedureKey

integrationProcedureKey: string = ""

integration procedure name - optional

Optional isLoggedIn

isLoggedIn: boolean

isLoggedIn as part of the query string of the API.

lineItemKey

lineItemKey: string

Unique key for the lineItem being edited

Optional multiTransactionKey

multiTransactionKey: string

An optional POST Body parameter for adding items to cart.

Optional offer

offer: any

offer object.

Optional offerCode

offerCode: string

offer code.

offerConfigurations

offerConfigurations: any

The configured offer configurations to be added to cart.

Optional optionsMap

optionsMap: any

Options Map values for the integration procedure.

quantity

quantity: string

Updated field quantity

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. Not implemented.

    Returns string

getAnonymousSiteRestUrl

  • getAnonymousSiteRestUrl(): string
  • Function that constructs the Anonymous API path for Rest. Not implemented.

    Returns string

getAuthToken

  • Function to return authorization token

    Parameters

    Returns Promise<string>

getAuthorisationType

  • getAuthorisationType(): string

Protected getEncodedQueryString

  • getEncodedQueryString(): string
  • Function that constructs the query string for API. Not implemented.

    Returns string

getInputMap

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

    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

getSecureServerRestUrl

  • getSecureServerRestUrl(): string

Generated using TypeDoc