Interface Package

Encapsulates typed und untyped workflow metadata for case properties

interface Package {
    amount?: Meta<number>;
    bbox?: Bbox;
    confidence?: number;
    customsTariffNumber?: CustomsTariffNumber;
    dimensions?: Dimensions;
    display?: boolean;
    errors?: ErrorModel[];
    input?: string;
    lastChangedBy?: string;
    marks?: Meta<string>;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    netWeight?: Weight;
    options?: any[];
    packageNetWeight?: Weight;
    packageNumber?: Meta<string>;
    packageWeight?: Weight;
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    searchValue?: string;
    source?: string;
    templateValue?: string;
    type?: PackageType;
    userEdited?: boolean;
    value?: any;
    weight?: Weight;
    weightUnit?: Meta<WeightUnit>;
}

Hierarchy (view full)

Properties

amount? bbox? confidence? customsTariffNumber? dimensions? display? errors? input? lastChangedBy? marks? modifiedAt? modifiedBy? netWeight? options? packageNetWeight? packageNumber? packageWeight? reason? required? reviewNeeded? searchValue? source? templateValue? type? userEdited? value? weight? weightUnit?

Properties

Optional amount

amount?: Meta<number>

Optional bbox

bbox?: Bbox

Bounding box of extracted value

Optional confidence

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

Optional customsTariffNumber

customsTariffNumber?: CustomsTariffNumber

Optional dimensions

dimensions?: Dimensions

Optional display

display?: boolean

Optional errors

errors?: ErrorModel[]

could be validation errors

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 marks

marks?: Meta<string>

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 netWeight

netWeight?: Weight

Optional options

options?: any[]

Optional packageNetWeight

packageNetWeight?: Weight

Optional packageNumber

packageNumber?: Meta<string>

Optional packageWeight

packageWeight?: Weight

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 type

type?: PackageType

Optional userEdited

userEdited?: boolean

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

Optional value

value?: any

The current value of the property

Optional weight

weight?: Weight

Optional weightUnit

weightUnit?: Meta<WeightUnit>

Settings

Member Visibility

Theme

On This Page

amountbboxconfidencecustomsTariffNumberdimensionsdisplayerrorsinputlastChangedBymarksmodifiedAtmodifiedBynetWeightoptionspackageNetWeightpackageNumberpackageWeightreasonrequiredreviewNeededsearchValuesourcetemplateValuetypeuserEditedvalueweightweightUnit