SDK API Reference
Enumerations
Classes
- CASSDK
- ConnectionSDK
- DeliverySDK
- EngageSDK
- JobSDK
- JourneySDK
- LLMSDK
- Logger
- P13nStudioSDK
- PersonalizationSDK
- PolicySDK
- QuerySDK
- RawAPI
- RealtimeSDK
- ScheduleSDK
- SDKError
- SegmentSDK
- TDX
- UserSDK
- WorkflowSDK
- WorkspaceSDK
Interfaces
- ActivationResponse
- Agent
- AggregatedJourneyStats
- AggregatedStageStats
- AttributePreviewResult
- AttributeRequest
- AudienceFilter
- BehaviorPreviewResult
- BehaviorRequest
- BehaviorSchemaItem
- CampaignInfo
- CASActivationDef
- CASPullFile
- CASPullOptions
- CASPullResult
- CASPushOptions
- CASPushResult
- CASSegmentDef
- Chat
- ChatContentEvent
- ChatErrorEvent
- ChatHistoryResponse
- ChatImageEvent
- ChatInputEvent
- ChatOptions
- ChatOutputEvent
- ChatReasoningEvent
- ChatSessionMetadata
- ChatToolCallEvent
- ChatToolResultEvent
- ColumnInfo
- ComposableAudienceDef
- ComposableDispatchErrorOptions
- Connection
- CreateAgentParams
- CreateLandingPageInput
- CreateParentSegmentRequest
- CreateParentSegmentResponse
- CreateProjectParams
- CreateSegmentFolderRequest
- CreateSegmentFolderResponse
- CreateSegmentRequest
- CreateSegmentResponse
- CreateUploadAttemptInput
- CreateWebDomainInput
- CustomerGroupAttribute
- CustomerGroupBehavior
- CustomerGroupBehaviorSchemaItem
- CustomerGroupRequest
- DatabaseInfo
- EmailDomainAttributes
- EmailDomainInfo
- EmailSenderAttributes
- EmailSenderDomainAssignment
- EmailSenderInfo
- EmailTemplateInfo
- GetCampaignDetailOptions
- Job
- JobInfo
- Journey
- JourneyBranch
- JourneyCriteria
- JourneyExecution
- JourneyListItem
- JourneyStage
- JourneyStageStatistics
- JourneyStatistics
- JourneyStep
- JourneyVariant
- JourneyVersionItem
- LandingPageAttributes
- LandingPageInfo
- LineContent
- LineImagemapArea
- LineImagemapMessage
- LineTextV2Message
- ListEmailDomainsOptions
- ListLandingPagesOptions
- ListWebDomainsOptions
- LLMProject
- MasterPreviewResult
- ModelInfo
- P13nCampaignDetailResult
- ParentSegment
- ParentSegmentField
- PermissionOperation
- PersonalizationService
- PersonalizationServicePatchRequest
- PersonalizationServiceToken
- PersonalizationTokenCreateRequest
- Policy
- PolicyPermissions
- PolicyUser
- PresignedUploadUrl
- PreviewColumnInfo
- PreviewOptions
- PreviewResult
- PullFile
- PullSegmentsOptions
- PullSegmentsResult
- PushParentYamlResult
- RawAPIRequestOptions
- RawAPIResult
- RealtimePersonalization
- RealtimePersonalizationCreateRequest
- RealtimePersonalizationPatchRequest
- RealtimePersonalizationSection
- ResolvedAudience
- ResolvedEntity
- ResolvedSegmentPath
- RTAttributeValidateResult
- RTConfig
- RTEventValidateResult
- RTListItem
- RTStatus
- RTValidateResult
- SDKConfig
- SDKContext
- SDKQueryOptions
- SegmentCondition
- SegmentFolder
- SegmentFolderDetails
- SegmentLeftValue
- SegmentOperator
- SegmentResponse
- SegmentRule
- SegmentTreeNode
- TableInfo
- UpdateAgentParams
- UpdateLandingPageInput
- UpdateSegmentRequest
- UpdateSegmentResponse
- UpdateWebDomainInput
- UploadAttemptAttributes
- UploadAttemptFileDeclaration
- UploadAttemptInfo
- UploadAttemptWebAsset
- UserAccessControlResponse
- UserInfo
- ValidateOptions
- WebDomainAttributes
- WebDomainDeploymentEvent
- WebDomainDnsRecord
- WebDomainInfo
- Workflow
- WorkflowAttempt
WorkflowLogEntry- WorkflowProject
- WorkflowSession
- WorkflowTask
- WorkspaceInfo
Type Aliases
- APIType
- AudienceKind
- Campaign
- CampaignStatus
- CampaignType
- ChatEvent
- ChatStreamEvent
- CompleteQueryResult
- EmailDomain
- EmailSender
- EmailTemplate
- HTTPMethod
- JourneyReentryMode
- JourneyState
- JourneyStepType
- JourneyWaitUnit
- LandingPage
- LandingPageStatus
- LineImagemapAction
- LineMessage
- PermissionsMap
- PreviewProgressCallback
- QueryStage
- QueryStats
- ResourceType
- SessionStatus
- TDSite
- TrinoColumn
- UploadAttempt
- WebDomain
- Workspace
Variables
- COMPOSABLE_DISPATCH_DISABLED_MESSAGE
- COMPOSABLE_DISPATCH_MAYBE_DISABLED_MESSAGE
- COMPOSABLE_JOURNEY_UNSUPPORTED_HINT
- COMPOSABLE_SEGMENT_TYPE_JOURNEY
- DEFAULT_SAMPLE_LIMIT
- DEFAULT_TIME_RANGE
- LLM_PROXY_ENDPOINTS
- SAFE_INTEGRATION_TYPES
- SUPPORTED_MEDIA_EXTENSIONS
Functions
- aggregateJourneyHistory
- aggregateStageHistory
- assembleJourneyStats
- buildStageNameMap
- composableSegmentToSegmentResponse
- deduplicateJourneysByBundle
- entityToJourneyListItem
- errorContains
- findAttributeByName
- findBehaviorByName
- flattenJourneyActivation
- formatVersionsFromBundle
- generateAttributeCoverageSQL
- generateAttributeSampleSQL
- generateAttributeSchemaSQL
- generateBehaviorSampleSQL
- generateBehaviorSchemaSQL
- generateBehaviorStatsSQL
- generateColumnMapping
- generateEnrichedSQL
- generateMasterCountSQL
- generateMasterSampleSQL
- generateSchemaValidationSQL
- getAttributeColumns
- getBehaviorColumns
- getCampaignUrl
- getConsoleUrl
- getEndpoint
- getErrorCategory
- getErrorMessage
- getInBrowserMessageUrl
- getLLMProxyEndpoint
- getTemplateUrl
- getWorkspaceUrl
- hasHttpStatus
- isEmptyCreativeAssetCreate
- isEmptyCreativeAssetUpdate
- isHttp400Error
- isHttp404Error
- isJourneyLocalComposableSegment
- isRetryableError
- journeySegmentRequestToComposable
- mapComposableDispatchError
- mapComposableJourneyWriteError
- normalizeListCampaign
- normalizeListCampaignFilters
- parseJourneyState
- resolveEmailDomain
- resolveWorkspacePath
- synthesizePreBundleVersion
- updateApplicableWebDomains
- validateMediaListOptions
- validateMediaUploadExtension
- withAudienceName
- withComposableDispatchErrors