Interface CustomsOffice

Encapsulates typed und untyped workflow metadata for case properties

interface CustomsOffice {
    address?: AddressModel;
    bbox?: Bbox;
    code?: Meta<string>;
    conditional?: {
        meanOfTransportationMode: MeanOfTransportationMode;
    };
    confidence?: number;
    display?: boolean;
    email?: Meta<string>;
    errors?: ErrorModel[];
    faxNumber?: Meta<string>;
    input?: string;
    lastChangedBy?: string;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    name?: Meta<string>;
    officeType?: CustomsOfficeType;
    options?: string[];
    phone?: Meta<string>;
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    searchValue?: string;
    source?: string;
    templateValue?: string;
    userEdited?: boolean;
    value?: string;
}

Hierarchy (view full)

  • Meta<string>
    • CustomsOffice

Properties

address? bbox? code? conditional? confidence? display? email? errors? faxNumber? input? lastChangedBy? modifiedAt? modifiedBy? name? officeType? options? phone? reason? required? reviewNeeded? searchValue? source? templateValue? userEdited? value?

Properties

Optional address

address?: AddressModel

Optional bbox

bbox?: Bbox

Bounding box of extracted value

Optional code

code?: Meta<string>

Optional conditional

conditional?: {
    meanOfTransportationMode: MeanOfTransportationMode;
}

Type declaration

Optional confidence

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

Optional display

display?: boolean

Optional email

email?: Meta<string>

Optional errors

errors?: ErrorModel[]

could be validation errors

Optional faxNumber

faxNumber?: Meta<string>

Optional input

input?: string

The input value which was initially supplied for the property

Optional lastChangedBy

lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

Optional modifiedAt

modifiedAt?: number

Last modification date (user or machine), as a UTC unix timestamp

Optional modifiedBy

modifiedBy?: {
    displayName?: string;
    id?: string;
}

Field last changed by

Type declaration

  • Optional displayName?: string
  • Optional id?: string

Optional name

name?: Meta<string>

Optional officeType

officeType?: CustomsOfficeType

Optional options

options?: string[]

Optional phone

phone?: Meta<string>

Optional reason

reason?: any

Optional required

required?: boolean

Optional reviewNeeded

reviewNeeded?: boolean

Optional searchValue

searchValue?: string

Normalized searchValue, for any related queries. Needs to be a string, even if value is of a different type.

Optional source

source?: string

Optional templateValue

templateValue?: string

Template value which was used to generate the value

Optional userEdited

userEdited?: boolean

Mark this property as user-edited (as opposed to machine-generated)

Optional value

value?: string

The current value of the property

Settings

Member Visibility

Theme

On This Page

addressbboxcodeconditionalconfidencedisplayemailerrorsfaxNumberinputlastChangedBymodifiedAtmodifiedBynameofficeTypeoptionsphonereasonrequiredreviewNeededsearchValuesourcetemplateValueuserEditedvalue