Words: the values the API uses

The fixed values requests and answers use, from package:crm_sdk/wire.dart (some are also in crm_sdk.dart).

import 'package:crm_sdk/wire.dart';

Name	What it is
AuthorKind	authorKinds as a type.
BackgroundKind	backgroundKinds as a type.
BannerStyle	bannerStyles as a type.
BlockType	blockTypes as a type.
BotKind	botKinds as a type.
CalloutTone	calloutTones as a type.
CarouselButtonAction	buttonActions as a type.
CarouselButtonShape	carouselButtonShapes as a type.
CarouselCorner	carouselCorners as a type.
CarouselLayout	carouselLayouts as a type.
CarouselPermission	carouselPermissions as a type.
CarouselPresentation	carouselPresentations as a type.
CarouselProgress	carouselProgresses as a type.
CarouselScrim	carouselScrims as a type.
CarouselTextScale	carouselTextScales as a type.
CollectField	collectFields as a type.
ColorToken	colorTokens as a type.
ContentAlign	contentAligns as a type.
ContentButtonStyle	contentButtonStyles as a type.
ContentVAlign	contentVAligns as a type.
ConversationState	conversationStates as a type.
CrmPreferenceChannel	crmPreferenceChannels as a type.
FieldType	fieldTypes as a type.
HomeCardKind	homeCardKinds as a type.
ImageAspect	imageAspects as a type.
ImageFit	imageFits as a type.
ImageShape	imageShapes as a type.
ImageSize	imageSizes as a type.
MessageKind	messageKinds as a type.
NewConversations	newConversationsWords as a type.
PartKind	partKinds as a type.
QuestionType	questionTypes as a type.
ReceiptAction	receiptActions as a type.
ReplyTime	replyTimes as a type.
SpacerSize	spacerSizes as a type.
SurveyFormat	surveyFormats as a type.
SurveyStepKind	surveyStepKinds as a type.
TeamFaces	teamFacesWords as a type.
TextSize	textSizes as a type.
TextWeight	textWeights as a type.
TicketState	ticketStates as a type.

AuthorKind

enum AuthorKind implements WireWord

authorKinds as a type.

Value	Meaning
guest
teammate	A member of the app’s staff, shown by their first name.
bot
system	The messenger itself: a conversation closed, a rating asked for.
unknown

Members of AuthorKind

AuthorKind()

const AuthorKind(String word)

parse (static)

static AuthorKind parse(String word)

The kind word names, or unknown.

BackgroundKind

enum BackgroundKind implements WireWord

backgroundKinds as a type.

Value	Meaning
plain	The sheet’s own colour.
color
gradient
image
unknown

Members of BackgroundKind

BackgroundKind()

const BackgroundKind(String word)

parse (static)

static BackgroundKind parse(String word)

The word’s value, or unknown.

BannerStyle

enum BannerStyle implements WireWord

bannerStyles as a type.

Value	Meaning
inline	A strip the width of the screen across its top, pushing it down.
floating	A card across the top of the screen, pushing it down as inline does.
unknown

Members of BannerStyle

BannerStyle()

const BannerStyle(String word)

parse (static)

static BannerStyle parse(String word)

The style word names, or unknown.

BlockType

enum BlockType implements WireWord

blockTypes as a type. A block the package does not know is unknown, and is not drawn.

Value	Meaning
paragraph
heading
bullets
numbers
image
button
divider
eyebrow	The formatting blocks, a carousel’s and a post’s alone: a small capitals label, a tinted box, a list with ticks, empty space and one big emoji.
callout
checklist
spacer
emoji
unknown

Members of BlockType

BlockType()

const BlockType(String word)

parse (static)

static BlockType parse(String word)

The block type word names, or unknown.

BotKind

enum BotKind implements WireWord

botKinds as a type. A kind the package does not know is drawn as the bot saying its words, and asks nothing.

Value	Meaning
says	Asks nothing: its words.
asks	A tap on one of its buttons.
collects	A piece of data: CollectField.
suggests	Articles, then whether they helped: yes or no.
handsOff	The guest handed to a person, with when to expect them.
resolves	The conversation closed, the guest helped.
unknown

Members of BotKind

BotKind()

const BotKind(String word)

parse (static)

static BotKind parse(String word)

The kind word names, or unknown.

CalloutTone

enum CalloutTone implements WireWord

calloutTones as a type.

Values: info, good, warn, unknown.

Members of CalloutTone

CalloutTone()

const CalloutTone(String word)

parse (static)

static CalloutTone parse(String word)

The word’s value, or unknown.

CarouselButtonAction

enum CarouselButtonAction implements WireWord

buttonActions as a type.

Value	Meaning
next	Where the screen’s next goes.
screen	To the button’s screen.
back	To the screen seen before this one.
end	Ends the carousel, completed.
link	Opens the button’s link, and ends the carousel, completed.
permission	Asks the phone, then goes on whatever the answer.
unknown

Members of CarouselButtonAction

CarouselButtonAction()

const CarouselButtonAction(String word)

parse (static)

static CarouselButtonAction parse(String word)

The word’s value, or unknown.

CarouselButtonShape

enum CarouselButtonShape implements WireWord

carouselButtonShapes as a type.

Values: pill, rounded, unknown.

Members of CarouselButtonShape

CarouselButtonShape()

const CarouselButtonShape(String word)

parse (static)

static CarouselButtonShape parse(String word)

The word’s value, or unknown.

CarouselCorner

enum CarouselCorner implements WireWord

carouselCorners as a type.

Values: soft, round, square, unknown.

Members of CarouselCorner

CarouselCorner()

const CarouselCorner(String word)

parse (static)

static CarouselCorner parse(String word)

The word’s value, or unknown.

CarouselLayout

enum CarouselLayout implements WireWord

carouselLayouts as a type.

Value	Meaning
centred	The words in the middle, a small picture above them.
imageTop	A hero picture over the words.
imageFull	The picture filling the screen behind a scrim, light words at the bottom.
text	Words alone, from the top.
unknown

Members of CarouselLayout

CarouselLayout()

const CarouselLayout(String word)

parse (static)

static CarouselLayout parse(String word)

The word’s value, or unknown.

CarouselPermission

enum CarouselPermission implements WireWord

carouselPermissions as a type.

Values: notifications, location, unknown.

Members of CarouselPermission

CarouselPermission()

const CarouselPermission(String word)

parse (static)

static CarouselPermission parse(String word)

The permission word names, or unknown.

CarouselPresentation

enum CarouselPresentation implements WireWord

carouselPresentations as a type.

Value	Meaning
sheet	A tall modal sheet, dragged down to close.
card	A centred card.
full	The whole screen.
unknown

Members of CarouselPresentation

CarouselPresentation()

const CarouselPresentation(String word)

parse (static)

static CarouselPresentation parse(String word)

The word’s value, or unknown.

CarouselProgress

enum CarouselProgress implements WireWord

carouselProgresses as a type.

Values: dots, bar, none, unknown.

Members of CarouselProgress

CarouselProgress()

const CarouselProgress(String word)

parse (static)

static CarouselProgress parse(String word)

The word’s value, or unknown.

CarouselScrim

enum CarouselScrim implements WireWord

carouselScrims as a type.

Values: none, light, dark, unknown.

Members of CarouselScrim

CarouselScrim()

const CarouselScrim(String word)

parse (static)

static CarouselScrim parse(String word)

The word’s value, or unknown.

CarouselTextScale

enum CarouselTextScale implements WireWord

carouselTextScales as a type.

Values: compact, regular, large, unknown.

Members of CarouselTextScale

CarouselTextScale()

const CarouselTextScale(String word)

parse (static)

static CarouselTextScale parse(String word)

The word’s value, or unknown.

CollectField

enum CollectField implements WireWord

collectFields as a type.

Value	Meaning
text
email
orderRef	An order’s reference, in the app’s own format (CrmPublicApp.orderRef).
unknown

Members of CollectField

CollectField()

const CollectField(String word)

parse (static)

static CollectField parse(String word)

The field word names, or unknown.

ColorToken

enum ColorToken implements WireWord

colorTokens as a type.

Value	Meaning
accent	The carousel’s accent: its style’s, or the app’s brand.
ink	The text colour.
muted	The quieter text beside ink.
surface	The sheet’s background.
wash	A faint tint of surface.
good
warn
bad
unknown

Members of ColorToken

ColorToken()

const ColorToken(String word)

parse (static)

static ColorToken parse(String word)

The word’s value, or unknown.

ContentAlign

enum ContentAlign implements WireWord

contentAligns as a type.

Values: start, center, end, unknown.

Members of ContentAlign

ContentAlign()

const ContentAlign(String word)

parse (static)

static ContentAlign parse(String word)

The word’s value, or unknown.

ContentButtonStyle

enum ContentButtonStyle implements WireWord

contentButtonStyles as a type.

Values: primary, secondary, text, unknown.

Members of ContentButtonStyle

ContentButtonStyle()

const ContentButtonStyle(String word)

parse (static)

static ContentButtonStyle parse(String word)

The word’s value, or unknown.

ContentVAlign

enum ContentVAlign implements WireWord

contentVAligns as a type.

Values: top, center, bottom, unknown.

Members of ContentVAlign

ContentVAlign()

const ContentVAlign(String word)

parse (static)

static ContentVAlign parse(String word)

The word’s value, or unknown.

ConversationState

enum ConversationState implements WireWord

conversationStates as a type.

Value	Meaning
open	Waiting on staff, or on the guest.
snoozed	Put aside by staff; shown to the guest as open.
closed	Done with.
unknown

Members of ConversationState

ConversationState()

const ConversationState(String word)

isClosed

bool get isClosed

Closed, as the guest is shown it: snoozed and a word the package does not know are open.

parse (static)

static ConversationState parse(String word)

The state word names, or unknown.

CrmPreferenceChannel

enum CrmPreferenceChannel implements WireWord

crmPreferenceChannels as a type.

Values: email, push, inApp, chat, unknown.

Members of CrmPreferenceChannel

CrmPreferenceChannel()

const CrmPreferenceChannel(String word)

parse (static)

static CrmPreferenceChannel parse(String word)

The channel word names, or unknown: one a newer CRM added.

FieldType

enum FieldType implements WireWord

fieldTypes as a type.

Value	Meaning
text
list	One option of a list, chosen: its text.
number
boolean
date	A day, YYYY-MM-DD.
unknown

Members of FieldType

FieldType()

const FieldType(String word)

parse (static)

static FieldType parse(String word)

The type word names, or unknown.

HomeCardKind

enum HomeCardKind implements WireWord

homeCardKinds as a type. A card of a kind this version does not know is unknown, and left out of the home.

Value	Meaning
send	“Send us a message”: starts a conversation.
searchHelp	Opens the help center’s search.
articles	A few articles, and a way to browse the rest.
conversations	The guest’s open conversations, to carry on.
tickets	The guest’s tickets.
link	A title, a line and a link.
status	An announcement: a line, perhaps a title and a link.
unknown

Members of HomeCardKind

HomeCardKind()

const HomeCardKind(String word)

parse (static)

static HomeCardKind parse(String word)

The kind word names, or unknown.

ImageAspect

enum ImageAspect implements WireWord

imageAspects as a type.

Values: auto, square, fourByThree, wide, portrait, unknown.

Members of ImageAspect

ImageAspect()

const ImageAspect(String word)

parse (static)

static ImageAspect parse(String word)

The word’s value, or unknown.

ImageFit

enum ImageFit implements WireWord

imageFits as a type.

Values: cover, contain, unknown.

Members of ImageFit

ImageFit()

const ImageFit(String word)

parse (static)

static ImageFit parse(String word)

The word’s value, or unknown.

ImageShape

enum ImageShape implements WireWord

imageShapes as a type.

Value	Meaning
rounded	The carousel’s corner radius.
circle
square
unknown

Members of ImageShape

ImageShape()

const ImageShape(String word)

parse (static)

static ImageShape parse(String word)

The word’s value, or unknown.

ImageSize

enum ImageSize implements WireWord

imageSizes as a type.

Value	Meaning
small
medium
large
full	The whole width, edge to edge.
unknown

Members of ImageSize

ImageSize()

const ImageSize(String word)

parse (static)

static ImageSize parse(String word)

The word’s value, or unknown.

MessageKind

enum MessageKind implements WireWord

messageKinds as a type.

Value	Meaning
chat
post	A full-screen message, one a session at most.
banner	A strip at the top of the screen.
carousel	A few full screens the guest swipes through.
survey
push
email
unknown

Members of MessageKind

MessageKind()

const MessageKind(String word)

parse (static)

static MessageKind parse(String word)

The kind word names, or unknown.

NewConversations

enum NewConversations implements WireWord

newConversationsWords as a type.

Value	Meaning
always
whenNoneOpen	Only while none of theirs is open: they carry on in the one that is.
never	Never: the messenger is help only.
unknown

Members of NewConversations

NewConversations()

const NewConversations(String word)

parse (static)

static NewConversations parse(String word)

The choice word names, or unknown.

PartKind

enum PartKind implements WireWord

partKinds as a type. A kind the package does not know is not drawn.

Value	Meaning
message	The guest writing: text, and any pictures.
reply	A member of staff answering: blocks, and any pictures.
note	Staff writing to each other.
bot	The help bot: blocks.
assignment	The conversation given to someone.
state	The conversation closed, or opened again.
ratingRequest	Asking the guest how it went, once; its rating is their answer.
unknown

Members of PartKind

PartKind()

const PartKind(String word)

guestSees

bool get guestSees

Whether a part of this kind is ever shown to a guest.

parse (static)

static PartKind parse(String word)

The kind word names, or unknown.

QuestionType

enum QuestionType implements WireWord

questionTypes as a type.

Value	Meaning
nps	0 to 10.
numeric	The question’s own min to max.
stars	1 to 5.
emoji	1 to 5, drawn as faces.
dropdown
shortText
longText
singleChoice
multiChoice
unknown

Members of QuestionType

QuestionType()

const QuestionType(String word)

choice

bool get choice

Answered with options.

scaled

bool get scaled

Answered with a number.

parse (static)

static QuestionType parse(String word)

The type word names, or unknown.

ReceiptAction

enum ReceiptAction implements WireWord

receiptActions as a type.

Value	Meaning
seen
clicked
dismissed
completed	Read to its end: a carousel’s last screen.
answered	A carousel’s choice answered: the screen and the options picked.
unknown

Members of ReceiptAction

ReceiptAction()

const ReceiptAction(String word)

parse (static)

static ReceiptAction parse(String word)

The action word names, or unknown.

ReplyTime

enum ReplyTime implements WireWord

replyTimes as a type.

Values: minutes, hours, day, unknown.

Members of ReplyTime

ReplyTime()

const ReplyTime(String word)

parse (static)

static ReplyTime parse(String word)

The time word names, or unknown.

SpacerSize

enum SpacerSize implements WireWord

spacerSizes as a type.

Values: small, medium, large, unknown.

Members of SpacerSize

SpacerSize()

const SpacerSize(String word)

parse (static)

static SpacerSize parse(String word)

The word’s value, or unknown.

SurveyFormat

enum SurveyFormat implements WireWord

surveyFormats as a type.

Value	Meaning
small	A sheet over the bottom of the screen.
large	The whole screen, with an introduction.
unknown

Members of SurveyFormat

SurveyFormat()

const SurveyFormat(String word)

parse (static)

static SurveyFormat parse(String word)

The format word names, or unknown.

SurveyStepKind

enum SurveyStepKind implements WireWord

surveyStepKinds as a type.

Value	Meaning
questions
thankYou	The end: words, and nothing to answer.
unknown

Members of SurveyStepKind

SurveyStepKind()

const SurveyStepKind(String word)

parse (static)

static SurveyStepKind parse(String word)

The kind word names, or unknown.

TeamFaces

enum TeamFaces implements WireWord

teamFacesWords as a type.

Value	Meaning
auto	The product’s, and the teammates who last answered the guest.
chosen	The product’s, and the teammates staff chose.
none	No faces.
unknown

Members of TeamFaces

TeamFaces()

const TeamFaces(String word)

parse (static)

static TeamFaces parse(String word)

The choice word names, or unknown.

TextSize

enum TextSize implements WireWord

textSizes as a type.

Value	Meaning
display	A screen’s first, largest words.
title
body
small	A footnote.
unknown

Members of TextSize

TextSize()

const TextSize(String word)

parse (static)

static TextSize parse(String word)

The word’s value, or unknown.

TextWeight

enum TextWeight implements WireWord

textWeights as a type.

Values: regular, medium, bold, unknown.

Members of TextWeight

TextWeight()

const TextWeight(String word)

parse (static)

static TextWeight parse(String word)

The word’s value, or unknown.

TicketState

enum TicketState implements WireWord

ticketStates as a type.

Value	Meaning
submitted
inProgress
waitingOnGuest	Staff need something from the guest.
resolved
unknown

Members of TicketState

TicketState()

const TicketState(String word)

parse (static)

static TicketState parse(String word)

The state word names, or unknown.