Aura.Model.HexOrgMember (Aura v1.0.1)

View Source

Struct defining a member of a Hex organization

Examples

%Aura.Model.HexOrgMember{
 email: "hello@hello.com",
 role: "admin",
 url: "http://localhost:4000/api/users/hello",
 username: "hello"
}

Resources

See Also

Summary

Types

role()

Permission level of the org member

t()

Type describing an org member

Functions

build(m)

Builds a HexOrgMember from a map

Types

role()

@type role() :: :admin | :read | :write

Permission level of the org member

Examples

:admin

See Also

t()

@type t() :: %Aura.Model.HexOrgMember{
  email: Aura.Common.email(),
  role: role(),
  url: Aura.Model.Common.url(),
  username: Aura.Common.username()
}

Type describing an org member

Keys

Examples

%Aura.Model.HexOrgMember{
 email: "hello@hello.com",
 role: "admin",
 url: "http://localhost:4000/api/users/hello",
 username: "hello"
}

See Also

Functions

build(m)

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

Builds a HexOrgMember from a map

Parameters

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