Aura.Packages (Aura v0.9.0)

View Source

Service module for interacting with Hex Packages

Summary

Functions

add_package_owner(package_name, owner_email, opts \\ [])

@spec add_package_owner(
  package_name :: Aura.Common.package_name(),
  owner_email :: Aura.Common.email(),
  opts :: list()
) :: :ok | {:error, any()}

Adds a new Aura.Model.HexPackageOwner to a Aura.Model.HexPackage

get_package(name, opts \\ [])

@spec get_package(name :: Aura.Common.package_name(), opts :: list()) ::
  {:ok, Aura.Model.HexPackage.t()} | {:error, any()}

Returns a single Aura.Model.HexPackage

get_package_owner(package_name, username, opts \\ [])

@spec get_package_owner(
  package_name :: Aura.Common.package_name(),
  username :: Aura.Common.username(),
  opts :: list()
) :: {:ok, Aura.Model.HexPackageOwner.t()} | {:error, any()}

Returns a Aura.Model.HexPackageOwner for a given username / package

list_package_owners(name, opts \\ [])

@spec list_package_owners(name :: Aura.Common.package_name(), opts :: list()) ::
  {:ok, [Aura.Model.HexPackageOwner.t()]} | {:error, any()}

Returns a list of Aura.Model.HexPackageOwner

remove_package_owner(package_name, owner_email, opts \\ [])

@spec remove_package_owner(
  package_name :: Aura.Common.package_name(),
  owner_email :: Aura.Common.email(),
  opts :: list()
) :: :ok | {:error, any()}

Removes a Aura.Model.HexPackageOwner from a Aura.Model.HexPackage

stream_audit_logs(package_name, opts \\ [])

@spec stream_audit_logs(package_name :: Aura.Common.package_name(), opts :: list()) ::
  Enumerable.t()

Returns a stream of Aura.Model.HexAuditLog, scoped to a package

stream_packages(opts \\ [])

@spec stream_packages(opts :: list()) :: Enumerable.t()

Returns a stream of Aura.Model.HexPackages