# `DiffoExample.Nbn.Location`
[🔗](https://github.com/diffo-dev/diffo_example/blob/v0.4.0/lib/nbn/resources/location.ex#L5)

Diffo - TMF Service and Resource Management with a difference

Location - a premises with a street address.

The postal/street identity of a place (a TMF675 GeographicAddress). The
property name is carried in `name` (e.g. "Stirling Hotel"); the street
parts are the address attributes. A `LocationPoint` (lat/long) geo-locates
a Location via a PlaceRef (role `:geo_locates`) — the point is what service
qualification runs against, the Location is the human-readable premises.

In the NBN domain so it can carry consumer-specific richness later.

A Location — a premises with a street address

# `t`

```elixir
@type t() :: %DiffoExample.Nbn.Location{
  __lateral_join_source__: term(),
  __meta__: term(),
  __metadata__: term(),
  __order__: term(),
  aggregates: term(),
  bounds: term(),
  calculations: term(),
  country: term(),
  created_at: term(),
  href: term(),
  id: term(),
  locality: term(),
  location: term(),
  name: term(),
  place_refs: term(),
  postcode: term(),
  referred_type: term(),
  state_or_province: term(),
  street_name: term(),
  street_nr: term(),
  type: term(),
  updated_at: term()
}
```

# `default_short_name`

# `input`

```elixir
@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

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

# `input`

```elixir
@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?`

---

*Consult [api-reference.md](api-reference.md) for complete listing*