Interface CatalogEntry

interface CatalogEntry {
    authoredMessage?: string;
    canonicalMeaning: string;
    code: string;
    codeType: CodeType;
    errorClass?: DarajaErrorClassName;
    proof: ProofRef[];
    retriable: boolean;
    scope: DarajaScope;
    success: boolean;
    terminal: boolean;
}

Index

Properties

authoredMessage? canonicalMeaning code codeType errorClass? proof retriable scope success terminal

Properties

`Optional`authoredMessage

authoredMessage?: string

Actionable, human message. Present only when proven.

canonicalMeaning

canonicalMeaning: string

Short factual meaning.

code

code: string

Always a string ('0', '00', '1037', 'SFC_IC0003', 'C2B00012', '1000').

codeType

codeType: CodeType

`Optional`errorClass

errorClass?: DarajaErrorClassName

proof

proof: ProofRef[]

retriable

retriable: boolean

scope

scope: DarajaScope

success

success: boolean

terminal

terminal: boolean