@type access_tags() :: %{
  required(attribute :: :all | String.t() | [String.t()]) =>
    Runbox.Scenario.OutputAction.access_tag()
    | [Runbox.Scenario.OutputAction.access_tag()]
}

Attribute - access tag mapping.

Access tags are defined as map where keys are attributes and values are tags of these attributes.

Attributes (keys) can be defined as:

• :all - all attributes in this upsert share the same access tags
• String.t() - single attribute access tags definition
• [String.t()] - list of attributes that share the same access tags

Access tags (values) can be defined by single access tag or list of access tags.

Using this map structure we can define shared access tag for multiple attributes as well as multiple access tag for single attribute (or combination of both).

Attributes can be defined with dot syntax (e.g. user.contact.address.street) where nested attributes are separated by .. We can use this syntax to define access tags for group of nested attributes - access tags defined for user.contact.address will be used for all nested attributes such as user.contact.address.city and user.contact.address.street.

Overlapping access tags definitions are concatenated. For example access tags defined as:

%UpsertAssetAttributes{
  ...
  access_tags: %{
    all: ["tag1"],
    "user.contact" => ["tag2"],
    ["user.contact.address", "user.contact.phone"] => ["tag3"],
    "user.contact.address.street" => "tag4"
  }
}copy

would mean that:

• "user.contact" has these tags defined ["tag1", "tag2"]
• "user.contact.address.phone" has these tags defined ["tag1", "tag2", "tag3"]
• "user.contact.address.street" has these tags defined ["tag1", "tag2", "tag3", "tag4"]

@type t() :: %Runbox.Scenario.OutputAction.UpsertAssetAttributes{
  access_tags: access_tags(),
  attributes: map(),
  id: Runbox.Scenario.OutputAction.asset_id(),
  type: Runbox.Scenario.OutputAction.asset_type()
}

Upsert Asset Attributes

• :type - asset type (for more information, see t:asset_type/0)
• :id - asset ID (for more information, see t:asset_id/0)
• :attributes - a map of attributes in format %{"name" => value} to be inserted or updated
• :access_tags - a map of attributes mapped to its access tags (for more information, see access_tags/0)