Miosa.Sandbox.Previews (Miosa v1.0.1)

Preview URL management for a sandbox.

Wraps /sandboxes/:id/previews/* — list, create, get, delete, share (mint token), and revoke share tokens.

Summary

Create a new preview for a port (POST /sandboxes/:sandbox_id/previews).

Delete a preview (DELETE /sandboxes/:sandbox_id/previews/:preview_id).

Get a preview by ID (GET /sandboxes/:sandbox_id/previews/:preview_id).

List preview records for a sandbox (GET /sandboxes/:sandbox_id/previews).

Invalidate every share token for a preview (DELETE /sandboxes/:sandbox_id/previews/:preview_id/share).

Mint a share token for a preview (POST /sandboxes/:sandbox_id/previews/:preview_id/share).

@spec create(Miosa.Client.t(), String.t(), pos_integer(), map()) ::
  Miosa.Client.result(map())

Create a new preview for a port (POST /sandboxes/:sandbox_id/previews).

port is required. Additional opts are merged into the body.

@spec delete(Miosa.Client.t(), String.t(), String.t()) ::
  :ok | {:error, Miosa.Error.t()}

Delete a preview (DELETE /sandboxes/:sandbox_id/previews/:preview_id).

@spec get(Miosa.Client.t(), String.t(), String.t()) :: Miosa.Client.result(map())

Get a preview by ID (GET /sandboxes/:sandbox_id/previews/:preview_id).

@spec list(Miosa.Client.t(), String.t()) :: Miosa.Client.result(list())

List preview records for a sandbox (GET /sandboxes/:sandbox_id/previews).

@spec revoke_share(Miosa.Client.t(), String.t(), String.t()) ::
  :ok | {:error, Miosa.Error.t()}

Invalidate every share token for a preview (DELETE /sandboxes/:sandbox_id/previews/:preview_id/share).