GameServer.Accounts (game_server_sdk v0.1.0)

The Accounts context.

Usage

# Lookup by id or email
user = GameServer.Accounts.get_user(123)
user = GameServer.Accounts.get_user_by_email("me@example.com")

# Update a user
{:ok, user} = GameServer.Accounts.update_user(user, %{display_name: "NewName"})

# Search (paginated) and count
users = GameServer.Accounts.search_users("bob", page: 1, page_size: 25)
count = GameServer.Accounts.count_search_users("bob")

Note: This is an SDK stub. Calling these functions will raise an error. The actual implementation runs on the GameServer.

Summary

Functions

get_user(id)

Gets a single user by ID.

get_user_by_email(email)

Gets a user by email.

register_user(attrs)

Registers a user.

search_users(query, opts)

Search users by email or display name (case-insensitive, partial match).

update_user(user, attrs)

Updates a user with the given attributes.

Functions

get_user(id)

@spec get_user(integer()) :: GameServer.Accounts.User.t() | nil

Gets a single user by ID.

Returns nil if the User does not exist.

## Examples

  iex> get_user(123)
  %User{}

  iex> get_user(456)
  nil

get_user_by_email(email)

@spec get_user_by_email(String.t()) :: GameServer.Accounts.User.t() | nil

Gets a user by email.

## Examples

  iex> get_user_by_email("foo@example.com")
  %User{}

  iex> get_user_by_email("unknown@example.com")
  nil

register_user(attrs)

@spec register_user(GameServer.Types.user_registration_attrs()) ::
  {:ok, GameServer.Accounts.User.t()} | {:error, Ecto.Changeset.t()}

Registers a user.

## Attributes

See GameServer.Types.user_registration_attrs/0 for available fields.

## Examples

  iex> register_user(%{email: "user@example.com", password: "secret123"})
  {:ok, %User{}}

  iex> register_user(%{email: "invalid"})
  {:error, %Ecto.Changeset{}}

search_users(query, opts)

@spec search_users(String.t(), GameServer.Types.pagination_opts()) :: [
  GameServer.Accounts.User.t()
]

Search users by email or display name (case-insensitive, partial match).

Returns a list of User structs.

## Options

See GameServer.Types.pagination_opts/0 for available options.

update_user(user, attrs)

@spec update_user(GameServer.Accounts.User.t(), GameServer.Types.user_update_attrs()) ::
  {:ok, GameServer.Accounts.User.t()} | {:error, Ecto.Changeset.t()}

Updates a user with the given attributes.

This function applies the User.admin_changeset/2 then updates the user and broadcasts the update on success. It returns the same tuple shape as Repo.update/1 so callers can pattern-match as before.

## Attributes

See GameServer.Types.user_update_attrs/0 for available fields.

## Examples

  iex> update_user(user, %{display_name: "NewName"})
  {:ok, %User{}}

  iex> update_user(user, %{metadata: %{level: 5}})
  {:ok, %User{}}