Options
All
  • Public
  • Public/Protected
  • All
Menu

Class that defines input to get cart summary

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.

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.

cartId

cartId: string

Cart Id (Salesforce Id).Opportunity, Quote or Order Id. - Required

Optional chainable

chainable: boolean

execute Integration Procedure as chainable.

Optional contentType

contentType: string = "application/json"

Optional customFields

customFields: string[] = []

List of custom fields to be returned.

Optional fields

fields: string[]

List of fields to be returned.

fieldsToInclude

fieldsToInclude: string[] = ...

Fields to include as query parameters in api path

Optional headerFieldSet

headerFieldSet: string = ""

Name of a Salesforce Field Set defined for the given cart object (Opportunity, Quote, Order) which identifies the fields to return in the response. Omitting this parameter will return all fields from the cart object except the following fields: IsDeleted, CreatedDate, CreatedById, LastModifiedDate, LastModifiedById, SystemModstamp, LastActivityDate, CleanStatus.

Optional inputMap

inputMap: any

Input Map values for the dataraptor procedure.

Optional integrationProcedureKey

integrationProcedureKey: string = ""

integration procedure name - optional

ipMethod

ipMethod: string = "CPQ_GetCartSummary"

Name of Integration Procedure (IP) to get cart summary ipMethod = Type of IP_Subtype of IP

Optional optionsMap

optionsMap: any

Options Map values for the integration procedure.

Optional price

price: string = "true"

Flag to indicate whether pricing engine to be run.

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 = "getCarts"

Remote method which is used to get cart summary

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 timeoutInMillis

timeoutInMillis: number = 20000

Flag to indicate if the sdk call should be cached.

Optional translation

translation: string = "true"

Flag to indicate whether translated labels to be included in the response.

Optional validate

validate: string = "true"

Flag to indicate whether validation messages to be included in the response.

Methods

getAPIPath

  • getAPIPath(): string
  • Function that constructs the API path for ApexRest Handles scenerio when input parameters are not provided

    Returns string

getAnonymousSiteRestUrl

  • getAnonymousSiteRestUrl(): string
  • Function that constructs the API path for Rest call

    Returns string

Protected getEncodedQueryString

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

    Returns string

getInputMap

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

    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 input parameters are not provided

    Returns any

Private validateParams

  • validateParams(): void
  • Function that validate GetCartSummaryInput object to have required params

    Returns void

Generated using TypeDoc