Skip to content

Delivery Definition

Title: Delivery Definition
Type object
Required No
Additional properties Any type allowed

Description: Voluptuous validation schema for Delivery_Definition

Property Pattern Type Deprecated
- action No string No
- debug No boolean No
- options No object No
- data No object No
- target No Combination No
- target_required No Combination No
- target_usage No enum (of string) No
- selection No array of enum (of string) No
- priority No array of enum (of string) No
- selection_rank No enum (of string) No
- alias No string No
+ transport No enum (of string) No
- template No string No
- message No string No
- title No string No
- enabled No boolean No
- occupancy No enum (of string) No
- condition No string No

Property Delivery Definition > action
Type string
Required No

Property Delivery Definition > debug
Type boolean
Required No

Property Delivery Definition > options
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No

Property Delivery Definition > data
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- No object No

Property Delivery Definition > target
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1
item 2
item 3
item 4

Property Delivery Definition > target > anyOf > item 0
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No array of string No

Property Delivery Definition > target > anyOf > item 0 > additionalProperties
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
additionalProperties items -
Delivery Definition > target > anyOf > item 0 > additionalProperties > additionalProperties items
Type string
Required No

Property Delivery Definition > target > anyOf > item 1
Type object
Required No
Additional properties Each additional property must conform to the schema
Property Pattern Type Deprecated
- No string No

Property Delivery Definition > target > anyOf > item 1 > additionalProperties
Type string
Required No

Property Delivery Definition > target > anyOf > item 2
Type string
Required No

Property Delivery Definition > target > anyOf > item 3
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
item 3 items -

Delivery Definition > target > anyOf > item 3 > item 3 items
Type string
Required No

Property Delivery Definition > target > anyOf > item 4
Type object
Required No
Additional properties Any type allowed
Property Pattern Type Deprecated
- entity_id No array of string No
- device_id No array of string No
- area_id No array of string No
- floor_id No array of string No
- label_id No array of string No

Property Delivery Definition > target > anyOf > item 4 > entity_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
entity_id items -
Delivery Definition > target > anyOf > item 4 > entity_id > entity_id items
Type string
Required No

Property Delivery Definition > target > anyOf > item 4 > device_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
device_id items -
Delivery Definition > target > anyOf > item 4 > device_id > device_id items
Type string
Required No

Property Delivery Definition > target > anyOf > item 4 > area_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
area_id items -
Delivery Definition > target > anyOf > item 4 > area_id > area_id items
Type string
Required No

Property Delivery Definition > target > anyOf > item 4 > floor_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
floor_id items -
Delivery Definition > target > anyOf > item 4 > floor_id > floor_id items
Type string
Required No

Property Delivery Definition > target > anyOf > item 4 > label_id
Type array of string
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
label_id items -
Delivery Definition > target > anyOf > item 4 > label_id > label_id items
Type string
Required No

Property Delivery Definition > target_required
Type combining
Required No
Additional properties Any type allowed
Any of(Option)
item 0
item 1

Property Delivery Definition > target_required > anyOf > item 0
Type object
Required No
Additional properties Any type allowed

Property Delivery Definition > target_required > anyOf > item 1
Type enum (of string)
Required No

Must be one of: * "always" * "never" * "optional"

Property Delivery Definition > target_usage
Type enum (of string)
Required No

Must be one of: * "no_delivery" * "no_action" * "merge_delivery" * "merge_always" * "fixed"

Property Delivery Definition > selection
Type array of enum (of string)
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
selection items -

Delivery Definition > selection > selection items
Type enum (of string)
Required No

Must be one of: * "fallback_on_error" * "scenario" * "default" * "fallback"

Property Delivery Definition > priority
Type array of enum (of string)
Required No
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be Description
priority items -

Delivery Definition > priority > priority items
Type enum (of string)
Required No

Must be one of: * "low" * "medium" * "high" * "critical"

Property Delivery Definition > selection_rank
Type enum (of string)
Required No

Must be one of: * "ANY" * "FIRST" * "LAST"

Property Delivery Definition > alias
Type string
Required No

Property Delivery Definition > transport
Type enum (of string)
Required Yes

Must be one of: * "sms" * "mqtt" * "alexa_devices" * "alexa_media_player" * "mobile_push" * "chime" * "email" * "media" * "persistent" * "generic" * "notify_entity"

Property Delivery Definition > template
Type string
Required No

Property Delivery Definition > message
Type string
Required No

Property Delivery Definition > title
Type string
Required No

Property Delivery Definition > enabled
Type boolean
Required No

Property Delivery Definition > occupancy
Type enum (of string)
Required No
Default "all"

Must be one of: * "all_in" * "all_out" * "any_in" * "any_out" * "only_in" * "only_out" * "all" * "none"

Property Delivery Definition > condition
Type string
Required No

Generated using json-schema-for-humans on 2025-11-21 at 23:32:28 +0000