Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeliveryCustomer

Hierarchy

  • Customer
    • DeliveryCustomer

Implements

Index

Constructors

constructor

Properties

Optional accountId

accountId: string | undefined

The customer account id (if the customer has one)

Optional contactFree

contactFree: boolean | undefined

Contact-Free (not supported by all markets)

Optional deliveryAddress

deliveryAddress: Address | undefined
deprecated

Moving forward, new services will not understand the deliveryAddress field. Please use deliveryLocation instead

Optional deliveryLocation

deliveryLocation: Place | undefined

deliveryLocation is required, but for a transition period for backward compatibility it is defined as being optional

Optional email

email: string | undefined

The email address of the customer, if it is not known then leave as undefined

Optional familyName

familyName: string | undefined

The family name of the customer

Optional firstName

firstName: string | undefined

The first name of the customer

deprecated

Optional givenName

givenName: string | undefined

The given name of the customer

Optional instructions

instructions: string | undefined

Special instructions to pass through to the driver (not supported by all markets)

Optional lastName

lastName: string | undefined

The second name of the customer

deprecated

Optional marketing

marketing: undefined | { all: boolean }

The marketing opt-in for the customer

name

name: string

The combined first and last name of the customer

phone

phone: string

The phone number of the customer

Optional selectedLanguage

selectedLanguage: string | undefined

Selected Language (not supported by all markets)

Static schema

schema: ObjectSchema = baseSchema.keys({deliveryAddress: Address.schema.optional(),deliveryLocation: Place.schema.optional(),instructions: Joi.string().optional().allow(''),})

Generated using TypeDoc