Nuon.Api.Sandboxes (nuon v0.19.100)

API calls for all endpoints tagged Sandboxes.

Summary

Functions

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

get a sandbox

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

get sandbox releases

get_sandboxes(connection, opts \\ [])

get all sandboxes

Functions

Link to this function

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

@spec get_sandbox(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Nuon.Model.AppSandbox.t()}
  | {:ok, Nuon.Model.StderrErrResponse.t()}
  | {:error, Tesla.Env.t()}

get a sandbox

Parameters

  • connection (Nuon.Connection): Connection to server
  • sandbox_id (String.t): sandbox ID
  • opts (keyword): Optional parameters

Returns

  • {:ok, Nuon.Model.AppSandbox.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

@spec get_sandbox_releases(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Nuon.Model.StderrErrResponse.t()}
  | {:ok, [Nuon.Model.AppSandboxRelease.t()]}
  | {:error, Tesla.Env.t()}

get sandbox releases

Parameters

  • connection (Nuon.Connection): Connection to server
  • sandbox_id (String.t): sandbox ID
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%AppSandboxRelease{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_sandboxes(connection, opts \\ [])

@spec get_sandboxes(
  Tesla.Env.client(),
  keyword()
) :: {:ok, [Nuon.Model.AppSandbox.t()]} | {:error, Tesla.Env.t()}

get all sandboxes

Parameters

  • connection (Nuon.Connection): Connection to server
  • opts (keyword): Optional parameters

Returns

  • {:ok, [%AppSandbox{}, ...]} on success
  • {:error, Tesla.Env.t} on failure