Aura.Model.HexPackageOwner (Aura v1.0.2)

View Source

A struct describing an owner of a Aura.Model.HexPackage

Examples

%Aura.Model.HexPackageOwner{
 email: "cam.cook.codes@gmail.com",
 full_name: "Cam Cook",
 handles: %{
   elixir_forum: "https://elixirforum.com/u/camatcode",
   git_hub: "https://github.com/camatcode"
 },
 inserted_at: ~U[2025-05-01 19:45:03.289458Z],
 level: :full,
 updated_at: ~U[2025-06-01 15:40:38.852881Z],
 url: "https://hex.pm/api/users/camatcode",
 username: "camatcode"
}

Resources

See Also

Summary

Types

full_name()

The user's full name

level()

The user's administration level for this package

social_handles()

A map of social media handles owned by this user

t()

Type describing an owner of a Aura.Model.HexPackage

Functions

build(m)

Builds a HexPackageOwner from a map

Types

full_name()

@type full_name() :: String.t()

The user's full name

Examples

"Jane Smith"

See Also

level()

@type level() :: :full | :maintainer

The user's administration level for this package

See Also

social_handles()

@type social_handles() :: %{
  elixir_form: URI.t(),
  git_hub: URI.t(),
  twitter: URI.t(),
  slack: URI.t(),
  libera: String.t()
}

A map of social media handles owned by this user

Examples

%{
   git_hub: "https://github.com/michalmuskala",
   twitter: "https://twitter.com/michalmuskala",
   slack: "https://elixir-slackin.herokuapp.com/",
   libera: "irc://irc.libera.chat/elixir",
   elixir_forum: "https://elixirforum.com/u/michalmuskala"
}

See Also

t()

@type t() :: %Aura.Model.HexPackageOwner{
  email: Aura.Common.email(),
  full_name: full_name(),
  handles: social_handles(),
  inserted_at: Aura.Model.Common.inserted_at(),
  level: level(),
  updated_at: Aura.Model.Common.updated_at(),
  url: Aura.Model.Common.url(),
  username: Aura.Common.username()
}

Type describing an owner of a Aura.Model.HexPackage

Keys

Examples

%Aura.Model.HexPackageOwner{
 email: "cam.cook.codes@gmail.com",
 full_name: "Cam Cook",
 handles: %{
   elixir_forum: "https://elixirforum.com/u/camatcode",
   git_hub: "https://github.com/camatcode"
 },
 inserted_at: ~U[2025-05-01 19:45:03.289458Z],
 level: :full,
 updated_at: ~U[2025-06-01 15:40:38.852881Z],
 url: "https://hex.pm/api/users/camatcode",
 username: "camatcode"
}

See Also

Functions

build(m)

@spec build(m :: map()) :: t()

Builds a HexPackageOwner from a map

Parameters

ParameterDescription
mA map to build into a Aura.Model.HexPackageOwner.t/0