Models: events, content and the app

Events, content blocks and the app’s public face, from package:crm_sdk/wire.dart.

import 'package:crm_sdk/wire.dart';

Name	What it is
`ContentBlock`	One block of content.
`CrmPublicLinkApp`	An app’s public face for its links: what the page a link lands on without the app shows.
`CrmPublicRatingBody`	Whether a public help article helped a reader of the web’s help center (POST /public/v1/help/articles/{slug}/rating), who has no account.
`EventBody`	One thing the guest did in the product.
`EventRejected`	One event of a batch PurrCRM refused, by its place in the batch.
`EventsAccepted`	The answer to a batch.
`EventsBody`	A batch of events, oldest first, with what every event in it shares.
`ExportAttribute`	One attribute and its value, in the guest’s export.
`ExportCollected`	One thing the help bot kept from a conversation.
`ExportContact`	What the PurrCRM service keeps about the guest, in their export.
`ExportEvent`	One event recorded about the guest, in their export.
`ExportNote`	One note staff wrote about the guest, in their export.
`ExportWorkflowRun`	One run of a workflow the guest was in.
`ListItem`	One item of a list.
`Span`	A run of text with one style.
`crmAppKeyHeader`	The header a product’s app key travels in on every request (CrmConfig.appKey): which of PurrCRM’s apps the guest is in.
`crmSdkVersionHeader`	The header the package’s version travels in on every request, so that PurrCRM knows which SDK a guest is on.
`crmTestAppKeyPrefix`	What a test app’s public key begins with: the key of a live app’s test test app, which a staging build sends and whose data is kept apart from the live app’s.
`crmUserIdHeader`	The header a guest’s id travels in instead of a token, for an app that takes unverified guests.
`maxEventAge`	How old an event may be when it arrives.
`maxEventBatch`	The most events one batch carries.
`maxEventPropRunes`	The longest a prop’s value may be.
`maxEventProps`	The most props one event carries.

ContentBlock

class ContentBlock

One block of content. Only the fields its type names are set.

The formatting fields (size to style) are a carousel’s and a post’s alone: PurrCRM refuses them anywhere else. Each is optional, and empty (or unknown) is the renderer’s default for where the block is, which carousel_style.json gives.

Members of ContentBlock

ContentBlock.fromJson()

factory ContentBlock.fromJson(Map<String, Object?> json)

ContentBlock()

const ContentBlock({required BlockType type, int level = 0, List<Span> spans = const <Span>[], List<ListItem> items = const <ListItem>[], String imageUrl = '', String alt = '', String label = '', String link = '', String size = '', String color = '', ContentAlign align = ContentAlign.unknown, TextWeight weight = TextWeight.unknown, CalloutTone tone = CalloutTone.unknown, String emoji = '', ImageAspect aspect = ImageAspect.unknown, ImageFit fit = ImageFit.unknown, ImageShape shape = ImageShape.unknown, ContentButtonStyle style = ContentButtonStyle.unknown})

align

final ContentAlign align

A text block’s or an emoji’s alignment; unknown for the screen’s.

alt

final String alt

What a picture shows, for a guest who cannot see it.

aspect

final ImageAspect aspect

A picture’s aspect, fit and shape, as a carousel’s hero’s.

color

final String color

A text block’s colour, or a callout’s tint: a ColorToken’s word or a fixed #rrggbb; empty for the screen’s text colour.

emoji

final String emoji

An emoji block’s emoji, or the one before a callout’s words.

fit

final ImageFit fit

imageUrl

final String imageUrl

items

final List<ListItem> items

label

final String label

level

final int level

A heading’s level, 1 to 3.

link

final String link

Where a button or a picture goes: a path in the product, opened only when its allow-list names it, or an https URL, opened in the browser.

shape

final ImageShape shape

size

final String size

A word of the block’s own: a TextSize for a paragraph, a heading or a list (textSize), an ImageSize for a picture (imageSize), a SpacerSize for a spacer (spacerSize). Empty for the default.

spans

final List<Span> spans

style

final ContentButtonStyle style

A button’s style; unknown is primary.

tone

final CalloutTone tone

A callout’s tint when it has no color; unknown is info.

type

final BlockType type

weight

final TextWeight weight

A paragraph’s or a heading’s weight; unknown for the default.

imageSize

ImageSize get imageSize

size as a picture’s.

spacerSize

SpacerSize get spacerSize

size as a spacer’s.

CrmPublicLinkApp

class CrmPublicLinkApp

An app’s public face for its links: what the page a link lands on without the app shows. The package reads none of it; it is here so that every fixture of the CRM’s contract has its model.

Members of CrmPublicLinkApp

CrmPublicLinkApp.fromJson()

factory CrmPublicLinkApp.fromJson(Map<String, Object?> json)

CrmPublicLinkApp()

const CrmPublicLinkApp({required String key, required String name, required CrmPublicBrand brand, String linkBase = '', String appStoreUrl = '', String playStoreUrl = ''})

appStoreUrl

final String appStoreUrl

brand

final CrmPublicBrand brand

key

final String key

linkBase

final String linkBase

Where the app’s links are (CrmPublicApp.linkBase).

name

final String name

playStoreUrl

final String playStoreUrl

CrmPublicRatingBody

class CrmPublicRatingBody

Whether a public help article helped a reader of the web’s help center (POST /public/v1/help/articles/{slug}/rating), who has no account. The web’s, not the package’s: an app’s guest rates with ArticleRatingBody.

Members of CrmPublicRatingBody

CrmPublicRatingBody.fromJson()

factory CrmPublicRatingBody.fromJson(Map<String, Object?> json)

CrmPublicRatingBody()

const CrmPublicRatingBody({required bool helpful, required String visitor})

helpful

final bool helpful

visitor

final String visitor

EventBody

class EventBody

One thing the guest did in the product.

Members of EventBody

EventBody.fromJson()

factory EventBody.fromJson(Map<String, Object?> json)

EventBody()

const EventBody({required String id, required String name, required DateTime occurredAt, Map<String, String> props = const <String, String>{}})

id

final String id

A UUID drawn when it happened, so a batch sent twice is kept once.

name

final String name

The event’s name as the word PurrCRM knows it by: a CrmEvent’s, or one the product declared. PurrCRM refuses a batch that names one it does not know, so the tracker sends no other.

occurredAt

final DateTime occurredAt

toJson

Map<String, Object?> toJson()

EventRejected

class EventRejected

One event of a batch PurrCRM refused, by its place in the batch.

Members of EventRejected

EventRejected.fromJson()

factory EventRejected.fromJson(Map<String, Object?> json)

EventRejected()

const EventRejected({required int index, required String id, required String reason})

id

final String id

index

final int index

reason

final String reason

toJson

Map<String, Object?> toJson()

EventsAccepted

class EventsAccepted

The answer to a batch.

Members of EventsAccepted

EventsAccepted.fromJson()

factory EventsAccepted.fromJson(Map<String, Object?> json)

EventsAccepted()

const EventsAccepted({required int accepted, List<EventRejected> rejected = const []})

accepted

final int accepted

How many were kept: fewer than were sent when some were sent before, were too old, were refused, or the guest has turned product events off.

rejected

final List<EventRejected> rejected

The events PurrCRM refused, each alone: a name the app does not define (the app defines its own events on PurrCRM’s site). The rest of the batch was kept.

EventsBody

class EventsBody

A batch of events, oldest first, with what every event in it shares.

Members of EventsBody

EventsBody.fromJson()

factory EventsBody.fromJson(Map<String, Object?> json)

EventsBody()

const EventsBody({required List<EventBody> events, required String appVersion, required CrmPlatform platform, String timeZone = '', DateTime? sentAt})

appVersion

final String appVersion

events

final List<EventBody> events

platform

final CrmPlatform platform

sentAt

final DateTime? sentAt

Null leaves it out.

timeZone

final String timeZone

The phone’s IANA zone name, for the guest’s quiet hours; empty when the phone does not say.

toJson

Map<String, Object?> toJson()

ExportAttribute

class ExportAttribute

One attribute and its value, in the guest’s export.

Members of ExportAttribute

ExportAttribute.fromJson()

factory ExportAttribute.fromJson(Map<String, Object?> json)

ExportAttribute()

const ExportAttribute({required String name, required String value})

name

final String name

value

final String value

ExportCollected

class ExportCollected

One thing the help bot kept from a conversation.

Members of ExportCollected

ExportCollected.fromJson()

factory ExportCollected.fromJson(Map<String, Object?> json)

ExportCollected()

const ExportCollected({required String conversationId, required String key, required String value})

conversationId

final String conversationId

key

final String key

What it is: order_ref, email, or the name staff gave it.

value

final String value

ExportContact

class ExportContact

What the PurrCRM service keeps about the guest, in their export.

Members of ExportContact

ExportContact.fromJson()

factory ExportContact.fromJson(Map<String, Object?> json)

ExportContact()

const ExportContact({List<ExportAttribute> attributes = const <ExportAttribute>[], List<String> tags = const <String>[], List<ExportNote> notes = const <ExportNote>[], List<ExportEvent> events = const <ExportEvent>[], bool eventsTruncated = false, List<ExportConversation> conversations = const <ExportConversation>[], List<ExportTicket> tickets = const <ExportTicket>[], List<ExportArticleRating> articleRatings = const <ExportArticleRating>[], List<ExportReceipt> receipts = const <ExportReceipt>[], List<ExportSurveyResponse> surveyResponses = const <ExportSurveyResponse>[], List<ExportWorkflowRun> workflows = const <ExportWorkflowRun>[], List<ExportCollected> collected = const <ExportCollected>[], ExportTestPhone? testPhone, List<ExportTestSend> testSends = const <ExportTestSend>[], List<CrmExportDevice> devices = const <CrmExportDevice>[], List<CrmExportNotice> notices = const <CrmExportNotice>[], List<CrmExportSubscription> subscriptions = const <CrmExportSubscription>[], List<CrmExportConsentChange> consentHistory = const <CrmExportConsentChange>[]})

articleRatings

final List<ExportArticleRating> articleRatings

attributes

final List<ExportAttribute> attributes

The guest’s attributes by name, each value as a string.

collected

final List<ExportCollected> collected

consentHistory

final List<CrmExportConsentChange> consentHistory

conversations

final List<ExportConversation> conversations

The guest’s conversations in the messenger, their tickets, and what they said about help articles; empty from a PurrCRM older than them.

devices

final List<CrmExportDevice> devices

The devices the guest registered for PurrCRM’s pushes, without their tokens, and the inbox of notices it keeps; empty from a PurrCRM older than them.

events

final List<ExportEvent> events

The events recorded about the guest, newest first.

eventsTruncated

final bool eventsTruncated

Only the newest events are here: there were more.

notes

final List<ExportNote> notes

What staff wrote about the guest.

notices

final List<CrmExportNotice> notices

receipts

final List<ExportReceipt> receipts

The messages staff sent or showed the guest, and their answers to surveys; empty from a PurrCRM older than them.

subscriptions

final List<CrmExportSubscription> subscriptions

The guest’s choices about the app’s topics, and every change of them and of their channels’ own switches; empty from a PurrCRM older than topics.

surveyResponses

final List<ExportSurveyResponse> surveyResponses

testPhone

final ExportTestPhone? testPhone

The guest’s account being a test phone, and the tests staff sent it; null and empty when it is not one, or from a PurrCRM older than them.

testSends

final List<ExportTestSend> testSends

tickets

final List<ExportTicket> tickets

workflows

final List<ExportWorkflowRun> workflows

The runs of workflows the guest was in, and what the help bot kept from their conversations; empty from a PurrCRM older than them.

ExportEvent

class ExportEvent

One event recorded about the guest, in their export.

Members of ExportEvent

ExportEvent.fromJson()

factory ExportEvent.fromJson(Map<String, Object?> json)

ExportEvent()

const ExportEvent({required String name, required DateTime occurredAt, Map<String, String> props = const <String, String>{}})

name

final String name

An app event’s name or a server event’s, kept as the word: the guest reads it, and an event the package does not know is still theirs.

occurredAt

final DateTime occurredAt

ExportNote

class ExportNote

One note staff wrote about the guest, in their export.

Members of ExportNote

ExportNote.fromJson()

factory ExportNote.fromJson(Map<String, Object?> json)

ExportNote()

const ExportNote({required String body, required DateTime createdAt})

body

final String body

createdAt

final DateTime createdAt

ExportWorkflowRun

class ExportWorkflowRun

One run of a workflow the guest was in.

Members of ExportWorkflowRun

ExportWorkflowRun.fromJson()

factory ExportWorkflowRun.fromJson(Map<String, Object?> json)

ExportWorkflowRun()

const ExportWorkflowRun({required String workflow, required String state, required DateTime startedAt, String outcome = '', DateTime? endedAt})

endedAt

final DateTime? endedAt

outcome

final String outcome

How it ended, once it has.

startedAt

final DateTime startedAt

state

final String state

Where the run is, as PurrCRM says it (active, waiting, parked, ended).

workflow

final String workflow

ListItem

class ListItem

One item of a list.

Members of ListItem

ListItem.fromJson()

factory ListItem.fromJson(Map<String, Object?> json)

ListItem()

const ListItem({required List<Span> spans})

spans

final List<Span> spans

Span

class Span

A run of text with one style.

Members of Span

Span.fromJson()

factory Span.fromJson(Map<String, Object?> json)

Span()

const Span({required String text, bool bold = false, bool italic = false, String link = '', bool underline = false, bool strike = false, bool highlight = false, String color = ''})

bold

final bool bold

color

final String color

highlight

final bool highlight

italic

final bool italic

link

final String link

Makes the run a link, as ContentBlock.link.

strike

final bool strike

text

final String text

underline

final bool underline

The formatting marks, a carousel’s and a post’s alone: underlined, struck through, on a wash of the accent, and the run’s own colour (a ColorToken’s word or #rrggbb) over the block’s.

crmAppKeyHeader

const String crmAppKeyHeader

The header a product’s app key travels in on every request (CrmConfig.appKey): which of PurrCRM’s apps the guest is in.

crmSdkVersionHeader

const String crmSdkVersionHeader

The header the package’s version travels in on every request, so that PurrCRM knows which SDK a guest is on.

crmTestAppKeyPrefix

const String crmTestAppKeyPrefix

What a test app’s public key begins with: the key of a live app’s test test app, which a staging build sends and whose data is kept apart from the live app’s. A live app’s key never begins with it, so the key alone says which mode a build is in, before PurrCRM answers (CrmPublicApp.mode).

crmUserIdHeader

const String crmUserIdHeader

The header a guest’s id travels in instead of a token, for an app that takes unverified guests.

maxEventAge

const Duration maxEventAge

How old an event may be when it arrives. The Go constant is MaxEventAge: the tracker drops what it has kept for longer than this rather than send it to be dropped.

maxEventBatch

const int maxEventBatch

The most events one batch carries. The Go constant is MaxEventBatch.

maxEventPropRunes

const int maxEventPropRunes

The longest a prop’s value may be. The Go constant is MaxEventPropRunes.

maxEventProps

const int maxEventProps

The most props one event carries. The Go constant is MaxEventProps.