Diffo.Provider.Organization (Diffo v0.7.0)

Copy Markdown View Source

Ash Resource for a TMF632 Organization.

Out-of-the-box concrete leaf derived from BaseParty + BaseOrganization. Sets type: :Organization on the :build action; accepts the union of base Party + organization-specific fields.

See Diffo.Provider.BaseOrganization for the attribute set and TMF wire shape. See Diffo.Provider.BaseParty for the base attributes, validations, and Neo4j wiring inherited via fragment composition.

Cross-world consumers

Domain extenders compose the same two fragments on their own leaf rather than extending this one — Ash resources are leaves, not hierarchies. See the BaseOrganization docstring for an example.

An Ash Resource for a TMF632 Organization

Summary

Types

t()

Functions

default_short_name()
input(opts)

Validates that the keys in the provided input are valid for at least one action on the resource.

input(opts, action)

Same as input/1, except restricts the keys to values accepted by the action provided.

primary_key_matches?(left, right)

Types

t()

@type t() :: %Diffo.Provider.Organization{
  __lateral_join_source__: term(),
  __meta__: term(),
  __metadata__: term(),
  __order__: term(),
  aggregates: term(),
  calculations: term(),
  created_at: term(),
  external_identifiers: term(),
  href: term(),
  id: term(),
  is_head_office: term(),
  is_legal_entity: term(),
  name: term(),
  name_type: term(),
  notes: term(),
  organization_type: term(),
  party_refs: term(),
  referred_type: term(),
  trading_name: term(),
  type: term(),
  updated_at: term()
}

Functions

default_short_name()

input(opts)

@spec input(values :: map() | Keyword.t()) :: map() | no_return()

Validates that the keys in the provided input are valid for at least one action on the resource.

Raises a KeyError error at compile time if not. This exists because generally a struct should only ever be created by Ash as a result of a successful action. You should not be creating records manually in code, e.g %MyResource{value: 1, value: 2}. Generally that is fine, but often with embedded resources it is nice to be able to validate the keys that are being provided, e.g

Resource
|> Ash.Changeset.for_create(:create, %{embedded: EmbeddedResource.input(foo: 1, bar: 2)})
|> Ash.create()

input(opts, action)

@spec input(values :: map() | Keyword.t(), action :: atom()) :: map() | no_return()

Same as input/1, except restricts the keys to values accepted by the action provided.

primary_key_matches?(left, right)