@salesforce/b2c-tooling-sdk / scapi / ScapiRequestOptions
Interface: ScapiRequestOptions
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:41
Properties
auth
auth:
AuthStrategy| () =>AuthStrategy
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:46
Account Manager auth for operations declaring AmOAuth2.
confirm()?
optionalconfirm: (request,signal) =>Promise<void>
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:53
Resolve only after user approval; reject on decline/cancellation. Omit to block confirmations.
Parameters
request
signal
AbortSignal
Returns
Promise<void>
documents
documents:
ScapiSchemaDocument[]
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:50
middlewareRegistry?
optionalmiddlewareRegistry:MiddlewareRegistry
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:51
onDispatch()?
optionalonDispatch: () =>void
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:55
Called immediately before network dispatch, for tracking potentially applied writes.
Returns
void
onSchema()?
optionalonSchema: (document,full) =>void
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:57
Called with each contract fetched from the Schemas API; full reports tenant custom properties and operation prose (expand=all).
Parameters
document
full
boolean
Returns
void
safety
safety:
SafetyConfig
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:49
shopperAuth?
optionalshopperAuth:ScapiShopperAuth
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:48
Guest shopper auth for operations declaring ShopperToken. Omit to reject Shopper operations.
shortCode
shortCode:
string
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:42
siteId?
optionalsiteId:string
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:44
tenantId
tenantId:
string
Defined in: packages/b2c-tooling-sdk/src/scapi/request.ts:43