Models: the messenger, tickets and help

The messenger’s, tickets’ and help center’s models, from package:crm_sdk/wire.dart.

import 'package:crm_sdk/wire.dart';

Name	What it is
`Article`	One published article, whole.
`ArticleRatingBody`	The guest saying whether an article helped.
`ArticleSummary`	An article in a list.
`Articles`	The answer to a search: the best matches first; with nothing searched for, the featured articles.
`Attachment`	A picture in a part.
`AttachmentBody`	Asks for somewhere to upload a picture.
`AttachmentUpload`	Where to upload a picture: a form POST to `url` with `fields` first and the file last, as a field named “file”.
`Author`	Who wrote a part, as the guest is shown it: a member of staff by their first name, never their account or their address.
`BotButton`	One of a bot part’s buttons.
`BotPart`	What a help-bot part asks of the guest, beside its words.
`BotReplyBody`	The guest’s answer to the bot part `partId`: one of its buttons, or the data it asked for.
`Collection`	A group of help articles.
`CollectionArticles`	One collection and its articles, in staff’s order.
`Collections`	Every collection with an article in it, in staff’s order.
`Conversation`	One conversation, with every part the guest sees, oldest first.
`ConversationPage`	A page of the guest’s conversations, the most recently changed first.
`ConversationSummary`	A conversation in a list.
`ConversationUpdate`	The answer to a wait: the parts after the one asked after that the guest sees, and the conversation as it is now. `parts` is empty when the wait ran out with nothing new.
`CrmUnreadCount`	PurrCRM’s answer to a `ReadBody`: how many staff parts are still unread across every one of the guest’s conversations.
`ExportArticleRating`	The guest saying whether an article helped, in their export.
`ExportConversation`	One of the guest’s conversations, in their export: every part they could see, and their rating.
`ExportPart`	One part of an exported conversation.
`ExportTicket`	One of the guest’s tickets, in their export.
`HomeCard`	One card of the messenger’s home.
`MessageBody`	The guest writing: in a new conversation, in one of theirs, or on a ticket.
`MessengerHome`	The messenger’s first screen.
`MessengerLayout`	The messenger’s home as the app’s staff published it, for one guest at one moment: the greeting with their name in it, the faces, what it says about a reply, the cards they are to see now, in order (those not for them, a status out of its dates and the help center’s while it is off already left out by PurrCRM), and what they may do.
`MessengerOpening`	A help bot’s first words to a new conversation, as the guest would be shown them now: the bot’s `parts` up to its first question, numbered from 1 like a conversation’s, and nothing kept.
`OpeningRef`	Names a `MessengerOpening` in a `StartBody`: its workflow, and the version it was worked out from.
`Part`	One part of a conversation: a message, a reply or a change.
`RatingBody`	The guest’s answer to a rating request.
`ReadBody`	The guest has seen a conversation up to a part.
`ReplyExpectation`	How soon the guest can expect an answer.
`StartBody`	The guest starting a conversation: what they wrote (`text` and `attachmentIds`, as a `MessageBody`), or, under the help bot’s `opening`, a tap on one of its question’s buttons (`button`) instead.
`SupportTicket`	One of the guest’s tickets: the fields staff let the guest see, and the conversation about it, oldest first.
`SupportTicketPage`	The guest’s tickets, the most recently changed first.
`SupportTicketSummary`	A ticket in a list.
`TicketField`	One field of a ticket and its value: `text` for a text or a list field, `number`, `boolean` or `date` (YYYY-MM-DD).
`attachmentTypes`	The only content types a picture may be.
`checkCollected`	What the bot would take for `field`, as the service reads it (CheckCollected): trimmed, an email lower-cased, an order reference as the app’s `orderRef` keeps it; null when it would refuse it.
`maxAttachmentBytes`	The largest picture: five megabytes.
`maxAttachments`	The most pictures one message carries.
`maxCollectRunes`	The longest answer the help bot collects.
`maxMessageRunes`	The longest message a guest may write.
`maxRating`	The best rating; 1 is the worst.
`maxRemarkRunes`	The longest remark with a rating.
`messengerWait`	The longest a wait is held open with nothing new.
`validEmail`	Whether `s` is an email address the service takes (ValidEmail).

Article

class Article

One published article, whole.

Members of Article

Article.fromJson()

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

Article()

const Article({required String id, required String slug, required String title, required List<ContentBlock> blocks, required DateTime updatedAt, String summary = '', Collection? collection, List<ArticleSummary> related = const <ArticleSummary>[], String language = '', List<String> languages = const <String>[]})

blocks

final List<ContentBlock> blocks

collection

final Collection? collection

The collection it is in, when it is in one.

id

final String id

language

final String language

The language it is in (a BCP 47 tag): PurrCRM picked it for the guest, their own where the article is written in it and the app’s default where it is not. The package shows what it is given; the tag is for a host that says so.

languages

final List<String> languages

Every language it is written in, the app’s default first.

final List<ArticleSummary> related

Other articles in the same collection, at most three.

slug

final String slug

summary

final String summary

title

final String title

updatedAt

final DateTime updatedAt

ArticleRatingBody

class ArticleRatingBody

The guest saying whether an article helped. Asked again, the newer answer is kept.

Members of ArticleRatingBody

ArticleRatingBody.fromJson()

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

ArticleRatingBody()

const ArticleRatingBody({required bool helpful})

helpful

final bool helpful

toJson

Map<String, Object?> toJson()

ArticleSummary

class ArticleSummary

An article in a list.

Members of ArticleSummary

ArticleSummary.fromJson()

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

ArticleSummary()

const ArticleSummary({required String id, required String slug, required String title, required DateTime updatedAt, String summary = '', String collection = ''})

collection

final String collection

The slug of the collection it is in; empty for none.

id

final String id

slug

final String slug

summary

final String summary

title

final String title

updatedAt

final DateTime updatedAt

Articles

class Articles

The answer to a search: the best matches first; with nothing searched for, the featured articles.

Members of Articles

Articles.fromJson()

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

Articles()

const Articles({required List<ArticleSummary> items})

items

final List<ArticleSummary> items

Attachment

class Attachment

A picture in a part.

Members of Attachment

Attachment.fromJson()

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

Attachment()

const Attachment({required String id, required String contentType, required int bytes, required String url, required DateTime expiresAt})

bytes

final int bytes

contentType

final String contentType

expiresAt

final DateTime expiresAt

id

final String id

url

final String url

Where to fetch it, until expiresAt; the conversation asked for again has a new one after that.

AttachmentBody

class AttachmentBody

Asks for somewhere to upload a picture.

Members of AttachmentBody

AttachmentBody.fromJson()

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

AttachmentBody()

const AttachmentBody({required String contentType, required int bytes})

bytes

final int bytes

The picture’s size, at most maxAttachmentBytes.

contentType

final String contentType

One of attachmentTypes.

toJson

Map<String, Object?> toJson()

AttachmentUpload

class AttachmentUpload

Where to upload a picture: a form POST to url with fields first and the file last, as a field named “file”. The picture is sent by naming id in a MessageBody before expiresAt.

Members of AttachmentUpload

AttachmentUpload.fromJson()

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

AttachmentUpload()

const AttachmentUpload({required String id, required String url, required Map<String, String> fields, required int maxBytes, required DateTime expiresAt})

expiresAt

final DateTime expiresAt

fields

final Map<String, String> fields

id

final String id

maxBytes

final int maxBytes

url

final String url

Author

class Author

Who wrote a part, as the guest is shown it: a member of staff by their first name, never their account or their address.

Members of Author

Author.fromJson()

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

Author()

const Author({required AuthorKind kind, String name = ''})

kind

final AuthorKind kind

name

final String name

A teammate’s first name or the bot’s name; empty for the guest and the messenger.

isGuest

bool get isGuest

Written by the guest, rather than by staff, the bot or the messenger.

BotButton

class BotButton

One of a bot part’s buttons.

Members of BotButton

BotButton.fromJson()

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

BotButton()

const BotButton({required String id, required String label})

id

final String id

What the answer names.

label

final String label

What the guest reads, and what their answer says they said.

BotPart

class BotPart

What a help-bot part asks of the guest, beside its words.

Members of BotPart

BotPart.fromJson()

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

BotPart()

const BotPart({required BotKind kind, List<BotButton> buttons = const <BotButton>[], CollectField collect = CollectField.unknown, List<ArticleSummary> articles = const <ArticleSummary>[], ReplyExpectation? reply, CrmOrderRef? orderRef})

articles

final List<ArticleSummary> articles

A suggestion’s, each opened in the help center.

buttons

final List<BotButton> buttons

An ask’s, and a suggestion’s yes and no.

collect

final CollectField collect

What a collecting part asks for.

kind

final BotKind kind

orderRef

final CrmOrderRef? orderRef

reply

final ReplyExpectation? reply

A hand-off’s: how soon a person answers.

BotReplyBody

class BotReplyBody

The guest’s answer to the bot part partId: one of its buttons, or the data it asked for. Exactly one of button and value.

Members of BotReplyBody

BotReplyBody.fromJson()

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

BotReplyBody()

const BotReplyBody({required String partId, String button = '', String value = ''})

button

final String button

partId

final String partId

value

final String value

toJson

Map<String, Object?> toJson()

Collection

class Collection

A group of help articles.

Members of Collection

Collection.fromJson()

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

Collection()

const Collection({required String id, required String slug, required String title, required int articles, String description = ''})

articles

final int articles

How many published articles the guest can read in it.

description

final String description

id

final String id

slug

final String slug

title

final String title

CollectionArticles

class CollectionArticles

One collection and its articles, in staff’s order.

Members of CollectionArticles

CollectionArticles.fromJson()

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

CollectionArticles()

const CollectionArticles({required Collection collection, required List<ArticleSummary> articles})

articles

final List<ArticleSummary> articles

collection

final Collection collection

Collections

class Collections

Every collection with an article in it, in staff’s order.

Members of Collections

Collections.fromJson()

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

Collections()

const Collections({required List<Collection> items})

items

final List<Collection> items

Conversation

class Conversation

One conversation, with every part the guest sees, oldest first.

Members of Conversation

Conversation.fromJson()

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

Conversation()

const Conversation({required String id, required ConversationState state, required List<Part> parts, required int lastSeq, required int unread, required ReplyExpectation reply, required DateTime createdAt, required DateTime updatedAt, Author? assignee, String ticketId = '', String awaiting = ''})

assignee

final Author? assignee

The member of staff answering, when one is.

awaiting

final String awaiting

The bot part the help bot waits on the guest to answer; empty when it waits on nothing. Only that part’s buttons or box are live.

createdAt

final DateTime createdAt

id

final String id

lastSeq

final int lastSeq

The newest part’s seq, including those the guest is not shown, so that a wait asked after it waits for the next.

parts

final List<Part> parts

reply

final ReplyExpectation reply

state

final ConversationState state

Open or closed; snoozed is shown as open.

ticketId

final String ticketId

The ticket this conversation is about; empty when there is none.

unread

final int unread

How many staff parts the guest has not read.

updatedAt

final DateTime updatedAt

ConversationPage

class ConversationPage

A page of the guest’s conversations, the most recently changed first.

Members of ConversationPage

ConversationPage.fromJson()

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

ConversationPage()

const ConversationPage({required List<ConversationSummary> items, String nextBefore = ''})

items

final List<ConversationSummary> items

nextBefore

final String nextBefore

The conversation to ask for older ones before; empty when there are none.

ConversationSummary

class ConversationSummary

A conversation in a list.

Members of ConversationSummary

ConversationSummary.fromJson()

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

ConversationSummary()

const ConversationSummary({required String id, required ConversationState state, required String preview, required Author previewAuthor, required int unread, required DateTime createdAt, required DateTime updatedAt})

createdAt

final DateTime createdAt

id

final String id

preview

final String preview

The newest part the guest sees, as a line of text.

previewAuthor

final Author previewAuthor

state

final ConversationState state

unread

final int unread

updatedAt

final DateTime updatedAt

ConversationUpdate

class ConversationUpdate

The answer to a wait: the parts after the one asked after that the guest sees, and the conversation as it is now. parts is empty when the wait ran out with nothing new.

Members of ConversationUpdate

ConversationUpdate.fromJson()

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

ConversationUpdate()

const ConversationUpdate({required List<Part> parts, required ConversationState state, required int lastSeq, required int unread, String awaiting = ''})

awaiting

final String awaiting

The bot part the help bot waits on now (Conversation.awaiting).

lastSeq

final int lastSeq

parts

final List<Part> parts

state

final ConversationState state

unread

final int unread

CrmUnreadCount

class CrmUnreadCount

PurrCRM’s answer to a ReadBody: how many staff parts are still unread across every one of the guest’s conversations. PurrCRM answers with the guest routes’ own unread count, which a host’s own bell can show too; the Dart name is the package’s, so that a host with a bell of its own keeps its name for it.

Members of CrmUnreadCount

CrmUnreadCount.fromJson()

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

CrmUnreadCount()

const CrmUnreadCount({required int unread})

unread

final int unread

ExportArticleRating

class ExportArticleRating

The guest saying whether an article helped, in their export.

Members of ExportArticleRating

ExportArticleRating.fromJson()

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

ExportArticleRating()

const ExportArticleRating({required String article, required bool helpful, required DateTime ratedAt})

article

final String article

The article’s title, as it was when rated.

helpful

final bool helpful

ratedAt

final DateTime ratedAt

ExportConversation

class ExportConversation

One of the guest’s conversations, in their export: every part they could see, and their rating.

Members of ExportConversation

ExportConversation.fromJson()

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

ExportConversation()

const ExportConversation({required String id, required ConversationState state, required List<ExportPart> parts, required DateTime createdAt, int? rating, String remark = ''})

createdAt

final DateTime createdAt

id

final String id

parts

final List<ExportPart> parts

rating

final int? rating

remark

final String remark

state

final ConversationState state

ExportPart

class ExportPart

One part of an exported conversation. A picture is named by its content type and size: the file is sent on request, not in the export.

Members of ExportPart

ExportPart.fromJson()

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

ExportPart()

const ExportPart({required PartKind kind, required Author author, required DateTime createdAt, String text = '', List<ContentBlock> blocks = const <ContentBlock>[], List<String> attachments = const <String>[]})

attachments

final List<String> attachments

author

final Author author

blocks

final List<ContentBlock> blocks

createdAt

final DateTime createdAt

kind

final PartKind kind

text

final String text

ExportTicket

class ExportTicket

One of the guest’s tickets, in their export.

Members of ExportTicket

ExportTicket.fromJson()

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

ExportTicket()

const ExportTicket({required String ref, required String title, required String type, required TicketState state, required List<TicketField> fields, required DateTime createdAt, DateTime? resolvedAt})

createdAt

final DateTime createdAt

fields

final List<TicketField> fields

ref

final String ref

resolvedAt

final DateTime? resolvedAt

state

final TicketState state

title

final String title

type

final String type

HomeCard

class HomeCard

One card of the messenger’s home. Only what its kind draws is set: a link card’s title, text and link; a status card’s text, and its title and link when it has them; an articles card’s articles.

Members of HomeCard

HomeCard.fromJson()

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

HomeCard()

const HomeCard({required String id, required HomeCardKind kind, String title = '', String text = '', String link = '', List<ArticleSummary> articles = const <ArticleSummary>[]})

articles

final List<ArticleSummary> articles

id

final String id

The card’s own, the same on every read.

kind

final HomeCardKind kind

link

final String link

A path in the app or an https link; empty for none.

text

final String text

title

final String title

MessageBody

class MessageBody

The guest writing: in a new conversation, in one of theirs, or on a ticket. Text, pictures, or both.

Members of MessageBody

MessageBody.fromJson()

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

MessageBody()

const MessageBody({required String text, List<String> attachmentIds = const []})

attachmentIds

final List<String> attachmentIds

Pictures uploaded through an AttachmentUpload and not yet sent.

text

final String text

toJson

Map<String, Object?> toJson()

MessengerHome

class MessengerHome

The messenger’s first screen.

Members of MessengerHome

MessengerHome.fromJson()

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

MessengerHome()

const MessengerHome({required List<ConversationSummary> open, required int unread, required ReplyExpectation reply, List<ArticleSummary> articles = const <ArticleSummary>[], List<SupportTicketSummary> tickets = const <SupportTicketSummary>[], MessengerOpening? opening, MessengerLayout? layout})

articles

final List<ArticleSummary> articles

The help center’s featured articles; empty while it is off.

layout

final MessengerLayout? layout

The home as the app’s staff published it, worked out for this guest now; null until they publish one (and from a CRM before 0.4.0’s), when the messenger draws the home it always drew.

open

final List<ConversationSummary> open

The guest’s open conversations, the most recently changed first, at most three.

opening

final MessengerOpening? opening

What the help bot says to a new conversation before the guest writes; null when no help bot greets them first (it then speaks once they have written), when they may not start one now, and from a CRM before openings.

reply

final ReplyExpectation reply

tickets

final List<SupportTicketSummary> tickets

The guest’s tickets not yet resolved, and those resolved in the last week.

unread

final int unread

Every staff part the guest has not read, in every conversation.

picturesAllowed

bool get picturesAllowed

Whether the guest may send pictures: as the published home says, and yes without one.

MessengerLayout

class MessengerLayout

The messenger’s home as the app’s staff published it, for one guest at one moment: the greeting with their name in it, the faces, what it says about a reply, the cards they are to see now, in order (those not for them, a status out of its dates and the help center’s while it is off already left out by PurrCRM), and what they may do. The help bot’s opening is not part of it: the home greets, and the bot speaks first in the conversation the send card starts.

Members of MessengerLayout

MessengerLayout.fromJson()

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

MessengerLayout()

const MessengerLayout({String greeting = '', String intro = '', TeamFaces faces = TeamFaces.auto, List<Author> team = const <Author>[], bool names = false, String replyText = '', String awayText = '', List<HomeCard> cards = const <HomeCard>[], NewConversations newConversation = NewConversations.always, bool attachments = true, bool helpCenter = true})

attachments

final bool attachments

The guest may send pictures.

awayText

final String awayText

Said instead while the team is away; empty for “We’re back …”.

cards

final List<HomeCard> cards

The guest’s cards, in order, those of a kind this version does not know left out.

faces

final TeamFaces faces

greeting

final String greeting

The heading, personalised; empty for the package’s own words.

helpCenter

final bool helpCenter

The home points to the help center.

intro

final String intro

A line under it; empty for none.

names

final bool names

Write the chosen teammates’ names under their faces.

newConversation

final NewConversations newConversation

replyText

final String replyText

How soon a reply comes, in staff’s words; empty for the line worked out from the reply expectation.

team

final List<Author> team

The teammates to show when faces is chosen, by first name.

MessengerOpening

class MessengerOpening

A help bot’s first words to a new conversation, as the guest would be shown them now: the bot’s parts up to its first question, numbered from 1 like a conversation’s, and nothing kept. A new-chat screen shows them as the bot’s; the conversation is made when the guest taps one of the awaiting part’s buttons or writes, with MessengerApi.start given this opening, and its parts then are the conversation’s own, with ids of their own.

Members of MessengerOpening

MessengerOpening.fromJson()

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

MessengerOpening()

const MessengerOpening({required String workflow, required int version, required List<Part> parts, String awaiting = ''})

awaiting

final String awaiting

The id of the part whose question the bot waits on, as Conversation.awaiting: its buttons are live, or the composer asks for what it collects. Empty when it asks nothing.

parts

final List<Part> parts

The bot’s parts, oldest first.

version

final int version

workflow

final String workflow

The help bot’s workflow, and the version the opening is of.

question

Part? get question

The part the bot waits on, when it waits on one.

OpeningRef

class OpeningRef

Names a MessengerOpening in a StartBody: its workflow, and the version it was worked out from.

Members of OpeningRef

OpeningRef.fromJson()

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

OpeningRef()

const OpeningRef({required String workflow, required int version})

OpeningRef.of()

OpeningRef.of(MessengerOpening o)

The opening o names.

version

final int version

workflow

final String workflow

toJson

Map<String, Object?> toJson()

Part

class Part

One part of a conversation: a message, a reply or a change. Only the fields its kind names are set.

Members of Part

Part.fromJson()

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

Part()

const Part({required String id, required int seq, required PartKind kind, required Author author, required DateTime createdAt, String text = '', List<ContentBlock> blocks = const <ContentBlock>[], List<Attachment> attachments = const <Attachment>[], ConversationState state = ConversationState.unknown, int? rating, BotPart? bot})

attachments

final List<Attachment> attachments

author

final Author author

blocks

final List<ContentBlock> blocks

A reply’s or the bot’s words.

bot

final BotPart? bot

What a help-bot part asks of the guest; null for any other part.

createdAt

final DateTime createdAt

id

final String id

kind

final PartKind kind

rating

final int? rating

The guest’s answer to a rating request, 1 to maxRating, once given.

seq

final int seq

Orders the conversation’s parts, from 1; what a wait is asked after.

state

final ConversationState state

Where a state part moved the conversation to.

text

final String text

What the guest wrote, as they wrote it.

RatingBody

class RatingBody

The guest’s answer to a rating request.

Members of RatingBody

RatingBody.fromJson()

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

RatingBody()

const RatingBody({required int rating, String remark = ''})

rating

final int rating

1 (bad) to maxRating (great).

remark

final String remark

Anything they want to add; at most maxRemarkRunes.

toJson

Map<String, Object?> toJson()

ReadBody

class ReadBody

The guest has seen a conversation up to a part.

Members of ReadBody

ReadBody.fromJson()

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

ReadBody()

const ReadBody({required int seq})

seq

final int seq

toJson

Map<String, Object?> toJson()

ReplyExpectation

class ReplyExpectation

How soon the guest can expect an answer.

Members of ReplyExpectation

ReplyExpectation.fromJson()

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

ReplyExpectation()

const ReplyExpectation({required ReplyTime within, required bool open, DateTime? opensAt})

open

final bool open

Staff are at work now, by the team’s office hours.

opensAt

final DateTime? opensAt

When they are next at work, when they are not now.

within

final ReplyTime within

StartBody

class StartBody

The guest starting a conversation: what they wrote (text and attachmentIds, as a MessageBody), or, under the help bot’s opening, a tap on one of its question’s buttons (button) instead.

With an opening the bot’s parts come first in the conversation, and the tap or the words are its answer; without one the guest’s words come first, and the bot after them.

Members of StartBody

StartBody.fromJson()

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

StartBody.message()

StartBody.message(MessageBody body, {OpeningRef? opening})

The guest’s words under opening (or with none), as written.

StartBody()

const StartBody({String text = '', List<String> attachmentIds = const [], OpeningRef? opening, String button = ''})

attachmentIds

final List<String> attachmentIds

Pictures uploaded through an AttachmentUpload and not yet sent.

button

final String button

The id of the opening’s button the guest tapped, with no words or pictures; empty when they wrote.

opening

final OpeningRef? opening

The opening the guest was shown when they wrote or tapped; null for none.

text

final String text

toJson

Map<String, Object?> toJson()

SupportTicket

class SupportTicket

One of the guest’s tickets: the fields staff let the guest see, and the conversation about it, oldest first.

Members of SupportTicket

SupportTicket.fromJson()

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

SupportTicket()

const SupportTicket({required String id, required String ref, required String title, required String type, required TicketState state, required DateTime createdAt, required DateTime updatedAt, List<ContentBlock> description = const <ContentBlock>[], List<TicketField> fields = const <TicketField>[], String conversationId = '', List<Part> parts = const <Part>[], DateTime? resolvedAt})

conversationId

final String conversationId

The conversation the ticket’s parts are in; empty when there is none.

createdAt

final DateTime createdAt

description

final List<ContentBlock> description

What staff wrote the ticket is for.

fields

final List<TicketField> fields

id

final String id

parts

final List<Part> parts

ref

final String ref

resolvedAt

final DateTime? resolvedAt

state

final TicketState state

title

final String title

type

final String type

updatedAt

final DateTime updatedAt

SupportTicketPage

class SupportTicketPage

The guest’s tickets, the most recently changed first.

Members of SupportTicketPage

SupportTicketPage.fromJson()

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

SupportTicketPage()

const SupportTicketPage({required List<SupportTicketSummary> items})

items

final List<SupportTicketSummary> items

SupportTicketSummary

class SupportTicketSummary

A ticket in a list.

Members of SupportTicketSummary

SupportTicketSummary.fromJson()

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

SupportTicketSummary()

const SupportTicketSummary({required String id, required String ref, required String title, required String type, required TicketState state, required DateTime updatedAt})

id

final String id

ref

final String ref

How the guest and staff name it: “T-1042”.

state

final TicketState state

title

final String title

type

final String type

The ticket’s kind, in staff’s words (“Order issue”).

updatedAt

final DateTime updatedAt

TicketField

class TicketField

One field of a ticket and its value: text for a text or a list field, number, boolean or date (YYYY-MM-DD). A field with no value has none of them.

Members of TicketField

TicketField.fromJson()

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

TicketField()

const TicketField({required String key, required String label, required FieldType type, String text = '', double? number, bool? boolean, String date = ''})

boolean

final bool? boolean

date

final String date

key

final String key

label

final String label

number

final double? number

text

final String text

type

final FieldType type

hasValue

bool get hasValue

Whether the field has a value to show.

attachmentTypes

const List<String> attachmentTypes

The only content types a picture may be. The Go variable is AttachmentTypes.

checkCollected

String? checkCollected(CollectField field, String value, [CrmOrderRef? orderRef])

What the bot would take for field, as the service reads it (CheckCollected): trimmed, an email lower-cased, an order reference as the app’s orderRef keeps it; null when it would refuse it. With no order reference on the collecting part, any words are taken as they are and PurrCRM decides: the package has no format of its own to hold them to.

maxAttachmentBytes

const int maxAttachmentBytes

The largest picture: five megabytes. The Go constant is MaxAttachmentBytes.

maxAttachments

const int maxAttachments

The most pictures one message carries. The Go constant is MaxAttachments.

maxCollectRunes

const int maxCollectRunes

The longest answer the help bot collects. The Go constant is MaxCollectRunes.

maxMessageRunes

const int maxMessageRunes

The longest message a guest may write. The Go constant is MaxMessageRunes.

maxRating

const int maxRating

The best rating; 1 is the worst. The Go constant is MaxRating.

maxRemarkRunes

const int maxRemarkRunes

The longest remark with a rating. The Go constant is MaxRemarkRunes.

messengerWait

const Duration messengerWait

The longest a wait is held open with nothing new. The Go constant is MessengerWait.

validEmail

bool validEmail(String s)

Whether s is an email address the service takes (ValidEmail).