Diffo.Provider.PartyRef (Diffo v0.4.0)

Copy Markdown View Source

Ash Resource for a TMF PartyRef

An Ash Resource for a TMF Party Reference

Summary

Types

t()

Functions

default_short_name()
id(result, record)

Assists in encoding party ref id

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.PartyRef{
  __lateral_join_source__: term(),
  __meta__: term(),
  __metadata__: term(),
  __order__: term(),
  aggregates: term(),
  calculations: term(),
  created_at: term(),
  id: term(),
  instance: term(),
  instance_id: term(),
  party: term(),
  party_id: term(),
  place: term(),
  place_id: term(),
  role: term(),
  source_party: term(),
  source_party_id: term(),
  updated_at: term()
}

Functions

default_short_name()

id(result, record)

Assists in encoding party ref id

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)