@type dso_uuid() :: binary()

Represents a "DSpace Object" UUID.

Most repository entities (community, collection, item, user, user group, file, etc.) called "objects" in DSpace-speak will have such a UUID.

@type preferred_language() ::
  :all
  | atom()
  | binary()
  | [atom() | binary()]
  | %{required(atom()) => [binary()]}
  | nil

Represents the preferred language for metadata when retrieving a resource.

Note that if the preferred language is not available for a given metadata value, all language variants of that value will be returned by the server.

Can be either

• :all - Returns all language variants (default)
• a language tag as an atom or string (e.g. :en).
• a list of language tags as atoms or strings (e.g. [:en, :de_AT]). This will send an Accept-Language header with quality values derived from list order
• an Accept-Language header value as a string (e.g.en-US,en;q=0.9,zh-CN;q=0.8,zh;q=0.7).
• an Accept-Language header (e.g. %{:accept_language => ["fr-CH,fr;q=0.9,en;q=0.8,de;q=0.7"]}})
• nil - Returns the server default

@type update() ::
  DSpace.API.Model.ResourceUpdate.t() | %{required(binary()) => binary() | nil}

Represents a single metadata update to a resource.

Can be either

• a DSpace.API.Model.ResourceUpdate.t/0
• a plain string-keyed map

Examples

%DSpace.API.Resource{
  op: :replace,
  path: "/metadata/dc.title/0/value",
  value: "New Title"
}

%{
  "op" => "replace",
  "path" => "/metadata/dc.title/0/value",
  "value" => "New Title"
}