ExDaytona.Api.Preview (ex_daytona v0.1.0)

API calls for all endpoints tagged Preview.

Summary

Functions

get_sandbox_id_from_signed_preview_url_token(connection, signed_preview_token, port, opts \\ [])

Get sandbox ID from signed preview URL token

get_signing_key(connection, sandbox_id, opts \\ [])

Get the signing key for a sandbox

has_sandbox_access(connection, sandbox_id, opts \\ [])

Check if user has access to the sandbox

is_preview_warning_enabled(connection, sandbox_id, opts \\ [])

Check if the preview warning page is enabled for the sandbox

is_sandbox_public(connection, sandbox_id, opts \\ [])

Check if sandbox is public

is_valid_auth_token(connection, sandbox_id, auth_token, opts \\ [])

Check if sandbox auth token is valid

Functions

get_sandbox_id_from_signed_preview_url_token(connection, signed_preview_token, port, opts \\ [])

@spec get_sandbox_id_from_signed_preview_url_token(
  Tesla.Env.client(),
  String.t(),
  number(),
  keyword()
) ::
  {:ok, String.t()} | {:error, Tesla.Env.t()}

Get sandbox ID from signed preview URL token

Parameters

connection (ExDaytona.Connection): Connection to server
signed_preview_token (String.t): Signed preview URL token
port (number()): Port number to get sandbox ID from signed preview URL token
opts (keyword): Optional parameters

Returns

{:ok, String.t} on success
{:error, Tesla.Env.t} on failure

get_signing_key(connection, sandbox_id, opts \\ [])

@spec get_signing_key(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, String.t()} | {:error, Tesla.Env.t()}

Get the signing key for a sandbox

Parameters

connection (ExDaytona.Connection): Connection to server
sandbox_id (String.t): ID of the sandbox
opts (keyword): Optional parameters

Returns

{:ok, String.t} on success
{:error, Tesla.Env.t} on failure

has_sandbox_access(connection, sandbox_id, opts \\ [])

@spec has_sandbox_access(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, boolean()} | {:error, Tesla.Env.t()}

Check if user has access to the sandbox

Parameters

connection (ExDaytona.Connection): Connection to server
sandbox_id (String.t):
opts (keyword): Optional parameters

Returns

{:ok, boolean()} on success
{:error, Tesla.Env.t} on failure

is_preview_warning_enabled(connection, sandbox_id, opts \\ [])

@spec is_preview_warning_enabled(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, ExDaytona.Model.PreviewWarning.t()} | {:error, Tesla.Env.t()}

Check if the preview warning page is enabled for the sandbox

Parameters

connection (ExDaytona.Connection): Connection to server
sandbox_id (String.t): ID of the sandbox, or a signed preview URL token (requires the port query param)
opts (keyword): Optional parameters
- :port (number()): Port the signed preview URL token was issued for. Required when sandboxId is a signed token.

Returns

{:ok, ExDaytona.Model.PreviewWarning.t} on success
{:error, Tesla.Env.t} on failure

is_sandbox_public(connection, sandbox_id, opts \\ [])

@spec is_sandbox_public(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, boolean()} | {:error, Tesla.Env.t()}

Check if sandbox is public

Parameters

connection (ExDaytona.Connection): Connection to server
sandbox_id (String.t): ID of the sandbox
opts (keyword): Optional parameters

Returns

{:ok, boolean()} on success
{:error, Tesla.Env.t} on failure

is_valid_auth_token(connection, sandbox_id, auth_token, opts \\ [])

@spec is_valid_auth_token(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, boolean()} | {:error, Tesla.Env.t()}

Check if sandbox auth token is valid

Parameters

connection (ExDaytona.Connection): Connection to server
sandbox_id (String.t): ID of the sandbox
auth_token (String.t): Auth token of the sandbox
opts (keyword): Optional parameters

Returns

{:ok, boolean()} on success
{:error, Tesla.Env.t} on failure