Options
All
  • Public
  • Public/Protected
  • All
Menu

Class that defines input to create an basket from an asset operations.

Hierarchy

Index

Constructors

constructor

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.

basketAction

basketAction: string

A required POST Body param that the action to be performed: AssetToBasket - while passing list of root asset ids to be converted to basket, ; requires input param 'accountId'.

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 canCreateBasket

canCreateBasket: boolean

canCreateBasket as part of the query string of the API. By default its false, when canCreateBasket=true is passed, it includes the canCreateFDO step in case of cacheMiss.

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"

context

context: any

context param as part of the query string of the API to define which offers qualify in returning result set. Since this api is for known user only, hence context is a required parameter. accountId is mandatory context parameter

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 the basket response.

Optional inputMap

inputMap: any = {}

Input Map values for the dataraptor procedure.

Optional integrationProcedureKey

integrationProcedureKey: string = ""

integration procedure name - optional

isLoggedIn

isLoggedIn: boolean = true

isLoggedIn as part of the query string of the API. By default this isLoggedIn value is set to true.

Optional multiTransactionKey

multiTransactionKey: string

An optional POST Body parameter for adding items to cart.

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

requestDateTime

requestDateTime: string

POST Body parameter for to create an basket from an asset. date or date time in UTC format

rootAssetIds

rootAssetIds: any

POST Body parameter for to create an basket from an asset. list of root asset ids to be converted to basket, forex:"02i4P000009ion5QAA,02i4P000009ion6QAA"

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. optional parameter (By default its true, when validateAction=false is passed, the validation rules are not run on the orderitems)

Optional validatePrice

validatePrice: boolean = true

validatePrice is part of the query string of the API. optional parameter (By default its true, when price=false is passed, the pricing is not run on the orderitems)

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

getSecureServerRestUrl

  • getSecureServerRestUrl(): string

Generated using TypeDoc