Main Navigation Guide API Reference

Appearance

Sidebar Navigation

@rule/client

Overview

Classes

RuleApiError

RuleClient

RuleClientError

Functions

emailThemeFromBrandStyle

findTemplateOwner

formatDateForRule

markTagDirection

parseWebhookEvent

resolveBrandTheme

resolvePreferredBrandStyle

Interfaces

AccountSenderDetails

AddSubscriberTagsOptions

AnalyticsDateRangeParams

AnalyticsMetricValue

AnalyticsQueryParams

AnalyticsResult

AnalyticsStat

ApiKey

AutomailSetting

Automation

AutomationTemplateOwner

AutomationTrigger

BrandStyle

BrandStyleColour

BrandStyleColourEntry

BrandStyleFont

BrandStyleFontEntry

BrandStyleImage

BrandStyleImageEntry

BrandStyleLink

BrandStyleLinkEntry

BrandStyleListItem

BrandThemeResolverClient

BulkCreateSubscriberEntry

BulkCreateSubscriberField

BulkCreateSubscribersPayload

BulkCreateSubscribersResult

BulkTagsPayload

Campaign

CampaignLinkClickedEvent

CampaignOpenedEvent

CampaignRecipientSegment

CampaignRecipientSubscriber

CampaignRecipientTag

CampaignRecipients

CampaignSentEvent

CampaignStatus

CampaignTemplateOwner

CreateApiKeyPayload

CreateAutomationEmailConfig

CreateAutomationEmailResult

CreateBrandStyleFromDomainPayload

CreateBrandStylePayload

CreateCampaignEmailConfig

CreateCampaignEmailResult

CreateCustomFieldEntry

CreateDefaultCampaignResult

CreateDefaultEmailCampaignParams

CreateDefaultSmsCampaignParams

CreateDynamicSetPayload

CreateEmailAutomationMessagePayload

CreateEmailAutomationPayload

CreateEmailCampaignMessagePayload

CreateEmailCampaignPayload

CreateEmailTemplatePayload

CreateSmsAutomationMessagePayload

CreateSmsCampaignMessagePayload

CreateSmsTemplatePayload

CreateSubscriberPayload

CustomFieldData

CustomFieldDataByGroupFilters

CustomFieldDataFilters

CustomFieldDataListResult

CustomFieldDataResult

CustomFieldDefinition

CustomFieldEntry

CustomFieldGroup

CustomFieldGroupData

CustomFieldGroupDataRecord

CustomFieldGroupEntry

CustomFieldValueEntry

DynamicSet

DynamicSetSender

DynamicSetTrigger

ExportDateRange

ExportDispatcherRecord

ExportStatisticObject

ExportStatisticRecord

ExportStatisticsParams

ExportStatisticsResult

ExportSubscriberRecord

FindTemplateOwnerOptions

FindTemplateOwnerResult

ImportFinishedEvent

ListAllCustomFieldDataByGroupParams

ListAllCustomFieldDataParams

ListAllSubscribersByTagIdsParams

ListAutomationsParams

ListCampaignsParams

ListCustomFieldDataByGroupParams

ListCustomFieldDataParams

ListCustomFieldGroupsParams

ListRecipientsParams

ListSubscribersByTagIdsParams

ListSubscribersByTagIdsResult

ListTagsParams

ListTemplatesParams

Message

MessageDispatcher

PagePaginationParams

PartialScanError

PatchCustomFieldDataPayload

RateLimitOptions

RecipientSegment

RecipientSubscriber

RecipientTag

RenderTemplateParams

ResolvePreferredBrandStyleResult

ResolvedBrandTheme

RetryInfo

RuleApiResponse

RuleClientConfig

RuleListResponse

RulePaginationParams

ScheduleCampaignPayload

SearchCustomFieldDataParams

SetEmailAutomationPayload

SetEmailCampaignPayload

Subscriber

SubscriberAddedToSegmentEvent

SubscriberAddedToTagEvent

SubscriberBouncedEvent

SubscriberOptedInEvent

SubscriberRemovedFromTagEvent

SubscriberResubscribedEvent

SubscriberSegment

SubscriberSuppressedEvent

SubscriberSyncPayload

SubscriberTag

SubscriberTagChangedEvent

SuppressOptions

Tag

TagDetail

Template

TransactionLinkClickedEvent

TransactionOpenedEvent

TransactionSentEvent

UpdateApiKeyPayload

UpdateBrandStylePayload

UpdateDynamicSetPayload

UpdateEmailAutomationMessagePayload

UpdateEmailAutomationPayload

UpdateEmailCampaignMessagePayload

UpdateEmailCampaignPayload

UpdateEmailTemplatePayload

UpdateSmsAutomationMessagePayload

UpdateSmsCampaignMessagePayload

UpdateSmsTemplatePayload

UpdateTagPayload

WebhookAccount

WebhookBounceInfo

WebhookCampaignRef

WebhookImportSummary

WebhookSegmentRef

WebhookSubscriber

WebhookTagRef

WebhookTransactionMessage

WebhookTransactionRef

WriteCustomFieldDataPayload

Type Aliases

AnalyticsMessageType

AnalyticsMetric

AnalyticsObjectType

AnalyticsParams

AutomationSendoutType

BrandStyleColourType

BrandStyleFontOrigin

BrandStyleFontType

BrandStyleImageType

BrandStyleLinkType

BulkCreateAutomationMode

CampaignMessageType

CampaignSendoutType

CreateSmsAutomationPayload

CreateSmsCampaignPayload

CustomFieldDataInput

CustomFieldDataValue

CustomFieldDataWriteResult

CustomFieldValue

CustomFieldValueType

EmailAutomationMessage

EmailCampaignMessage

EmailTemplate

ExportDispatchersParams

ExportStatisticFilterType

ExportStatisticObjectType

ExportStatisticType

ExportSubscribersParams

ResolvePreferredBrandStyleSource

RuleTag

RuleValidationErrors

SetSmsAutomationPayload

SetSmsCampaignPayload

SmsAutomationMessage

SmsCampaignMessage

SmsTemplate

SubscriberIdentifier

TagAutomationMode

TagRef

TemplateOwner

UpdateSmsAutomationPayload

UpdateSmsCampaignPayload

WebhookEvent

Variables

AnalyticsMessageTypes

AnalyticsMetrics

AnalyticsObjectTypes

RULE_API_V2_BASE_URL

RULE_API_V3_BASE_URL

RuleTags

@rule/rcml

Overview

Classes

EmailTemplateValidationError

EmailThemeApplyError

JsonParseError

RcmlElementBuildError

RcmlXmlParseError

SmsContentParseError

SmsDocumentBuildError

SmsDocumentValidationError

SmsXmlParseError

Enumerations

DefaultFontFamily

EmailThemeColorType

EmailThemeFontStyleType

EmailThemeImageType

SmsTagNamesEnum

Functions

applyTheme

assertJsonSemantics

createAttributesElement

createBodyElement

createBrandStyleElement

createButtonElement

createCaseElement

createClassElement

createColumnElement

createDividerElement

createEmailTheme

createFontElement

createGroupElement

createHeadElement

createHeadingElement

createImageElement

createInlineContent

createLogoElement

createLoopElement

createLoopValueNode

createPlaceholderNode

createPlainTextElement

createPreviewElement

createRawElement

createRcmlDocumentElement

createSectionElement

createSmsDocument

createSocialChildElement

createSocialElement

createSpacerElement

createSwitchElement

createTextContent

createTextElement

createTextNode

createVideoElement

createWrapperElement

emailInlineRfmToJson

emailRfmToJson

getConfiguredSocialLinks

getFallbackFontFamily

getTheme

jsonToEmailInlineRfm

jsonToEmailRfm

jsonToSmsRfm

normalizeJson

rcmlToXml

safeParseJson

safeParseSmsJson

safeValidateEmailTemplate

safeValidateSmsDocument

safeXmlToRcml

safeXmlToSms

smsRfmToJson

smsToXml

validateEmailTemplate

validateJson

validateJsonSemantics

validateSmsDocument

validateSmsJson

xmlToRcml

xmlToSms

Interfaces

AttributesElementOptions

BodyElementOptions

BrandStyleElementOptions

ButtonElementOptions

CaseElementOptions

ClassElementOptions

ColumnElementOptions

CreateSmsContentOptions

CreateSmsCustomFieldPlaceholderOptions

CreateSmsDatePlaceholderOptions

CreateSmsDocumentOptions

CreateSmsLinkMarkOptions

CreateSmsLinkPlaceholderOptions

CreateSmsParagraphNodeOptions

CreateSmsPlaceholderNodeOptions

CreateSmsRemoteContentPlaceholderOptions

CreateSmsSubscriberPlaceholderOptions

CreateSmsTextNodeOptions

CreateSmsUserPlaceholderOptions

DividerElementOptions

EmailRfmAttrSpec

EmailRfmFlavorSpec

EmailRfmMarkSpec

EmailRfmNodeSpec

EmailRfmSpec

EmailTheme

EmailThemeColor

EmailThemeFont

EmailThemeFontStyle

EmailThemeImage

EmailThemePatch

EmailThemeSocialLink

FlavorConfig

FontElementOptions

GroupElementOptions

HeadElementOptions

HeadingElementOptions

ImageElementOptions

LogoElementOptions

LoopElementOptions

PlaceholderParamSpec

PlaceholderSpec

PlaceholderTokenSpec

PlainTextElementOptions

PreviewElementOptions

RCMLDocumentRoot

RawElementOptions

RcmlAttributes

RcmlBody

RcmlBrandStyle

RcmlButton

RcmlCase

RcmlClass

RcmlColumn

RcmlDivider

RcmlDocument

RcmlDocumentElementOptions

RcmlElementBuildIssue

RcmlFont

RcmlGroup

RcmlHead

RcmlHeading

RcmlImage

RcmlLogo

RcmlLoop

RcmlPlainText

RcmlPreview

RcmlPublicAttrSpec

RcmlPublicTagSpec

RcmlRaw

RcmlSection

RcmlSocial

RcmlSocialElement

RcmlSpacer

RcmlSpec

RcmlSwitch

RcmlText

RcmlVideo

RcmlWrapper

SectionElementOptions

SmsDocument

SmsDocumentBuildIssue

SmsNodeSpec

SmsPublicTagSpec

SmsRfmAttrSpec

SmsRfmFlavorSpec

SmsRfmMarkSpec

SmsRfmNodeSpec

SmsRfmSpec

SmsSpec

SocialChildElementOptions

SocialElementOptions

SpacerElementOptions

SwitchElementOptions

TextElementOptions

VideoElementOptions

WrapperElementOptions

Type Aliases

AlignNode

AttrValueOf

AttrsFor

BlockNode

BodyElementAttrs

BrandStyleElementAttrs

BulletListNode

ButtonElementAttrs

CaseElementAttrs

ClassElementAttrs

ColumnElementAttrs

DividerElementAttrs

EmailTemplateErrorCode

EmailTemplateValidationIssue

EmailThemeBrandStyleId

EmailThemeSocialLinkType

FontElementAttrs

FontMark

HardbreakNode

HeadingElementAttrs

ImageElementAttrs

InlineNode

Json

JsonValidationError

LinkMark

ListItemNode

LogoElementAttrs

LoopElementAttrs

LoopValueNode

Mark

OrderedListNode

ParagraphNode

PlaceholderNode

RcmlAttributesChild

RcmlBodyChild

RcmlColumnChild

RcmlContentSpec

RcmlElementBuildErrorCode

RcmlHeadChild

RcmlTagCategory

RcmlToXmlOptions

RcmlWrapperChild

RcmlXmlErrorCode

RcmlXmlParseIssue

SafeParseResult

SafeValidateResult

SafeValidateSmsResult

SafeXmlToRcmlResult

SafeXmlToSmsResult

SectionElementAttrs

SemanticIssue

SemanticValidationResult

SmsContentJson

SmsContentSafeParseResult

SmsContentSpec

SmsContentValidationError

SmsDateFormat

SmsDateSource

SmsDocumentBuildErrorCode

SmsDocumentErrorCode

SmsDocumentValidationIssue

SmsHardbreakNode

SmsInlineNode

SmsLinkMark

SmsMark

SmsParagraphNode

SmsPlaceholderNode

SmsPlaceholderTokenType

SmsPlaceholderType

SmsSystemLinkType

SmsTagName

SmsTextNode

SmsToXmlOptions

SmsXmlErrorCode

SmsXmlParseIssue

SocialChildElementAttrs

SocialElementAttrs

SpacerElementAttrs

TextElementAttrs

TextNode

VideoElementAttrs

WrapperElementAttrs

Variables

DEFAULT_COLORS_MAP

DEFAULT_FALLBACK_FONT_FAMILIES_MAP

DEFAULT_FONT_STYLES_MAP

DEFAULT_FONT_STYLE_BASE

DEFAULT_LINKS_MAP

DEFAULT_MAIN_FONT_FAMILIES_MAP

EmailTemplateErrorCodes

RcmlElementBuildErrorCodes

RcmlXmlErrorCodes

SMS_SCHEMA_SPEC

SmsDocumentBuildErrorCodes

SmsDocumentErrorCodes

SmsXmlErrorCodes

email

emailRfmSpec

placeholderSpec

rcmlSpec

sms

smsPlaceholderSpec

smsRfmSpec

smsSpec

@rule/sdk

Overview

On this page

Rule.io SDK

Rule.io SDK

Modules

client/src
rcml/src
sdk/src

Pager

Next pageOverview

Rule.io SDK

Modules ​

Modules