SDK API Reference / CASPushOptions
Interface: CASPushOptions
Options for the push workflow
Properties
connectionMaps?
optionalconnectionMaps?:ConnectionMaps
Pre-resolved connection maps, reused instead of calling connection.list() again. Intended for read-only, no-write call pairs with no user-interaction gap between them (e.g. pre-flight validation immediately followed by the dry-run preview) — NOT for reuse across the confirmation prompt into a real write. Callers should let the real-write call fetch its own fresh copy, same standard as the audience existence/drift check: a stale map at write time fails loud (CONNECTION_NOT_FOUND / CAS_UNSUPPORTED_CONNECTION_TYPE / CAS_MISSING_CATALOG) rather than silently deleting data, but "fails loud on a live write" is still worse than just refetching, and there's no principled reason to treat the write phase specially only for one kind of stale data.
deleteDrift?
optionaldeleteDrift?:boolean
Allow a push to actually remove attributes/behaviors that exist on the server but aren't in the local YAML (mirrors tdx sg push's --delete). Without this, a detected removal bails before any write — see computeAudienceDrift.
dryRun?
optionaldryRun?:boolean
progress?
optionalprogress?:ProgressReporter
resolvedAudienceId?
optionalresolvedAudienceId?:string
Pre-resolved parent audience ID, for a standalone segment push that has no co-located audience.yml in files to resolve the ID from (e.g. tdx cas sg push <segment.yml>, which resolves the parent by --audience <name> or session context instead). Ignored if files contains an audience definition — that push still takes priority and sets its own result.audienceId normally.
verbose?
optionalverbose?:boolean