Sprites.Client (Sprites v0.2.0)

@type t() :: %Sprites.Client{
  base_url: String.t(),
  control_mode: boolean(),
  req: Req.Request.t(),
  timeout: non_neg_integer(),
  token: String.t()
}

Functions

create_sprite(client, name, opts \\ [])

@spec create_sprite(t(), String.t(), keyword()) ::
  {:ok, Sprites.Sprite.t()} | {:error, term()}

Creates a new sprite.

Options

:config - Sprite configuration map

delete_sprite(client, name)

@spec delete_sprite(t(), String.t()) :: :ok | {:error, term()}

Deletes a sprite.

get_sprite(client, name)

@spec get_sprite(t(), String.t()) :: {:ok, map()} | {:error, term()}

Gets detailed information about a sprite.

list_sprites(client, opts \\ [])

@spec list_sprites(
  t(),
  keyword()
) :: {:ok, [map()]} | {:error, term()}

Lists sprites.

Options

:prefix - Filter by name prefix

new(token, opts \\ [])

@spec new(
  String.t(),
  keyword()
) :: t()

Creates a new client.

Options

:base_url - API base URL (default: "https://api.sprites.dev")
:timeout - HTTP timeout in milliseconds (default: 30_000)
:control_mode - Enable control mode for multiplexed exec over a single WebSocket (default: false)

update_url_settings(client, name, settings)

@spec update_url_settings(t(), String.t(), map()) :: :ok | {:error, term()}

Updates URL settings for a sprite.

Options

:auth - Authentication mode for the URL (e.g., "bearer", "none")

upgrade_sprite(client, name)

@spec upgrade_sprite(t(), String.t()) :: :ok | {:error, term()}

Triggers an upgrade for a sprite.