Nuon.Api.Apps (nuon v0.19.90)

API calls for all endpoints tagged Apps.

Summary

Functions

Create an app config, by pushing the contents of a config file. The API will automatically configure the app according to the config file in the background.

Parameters

  • connection (Nuon.Connection): Connection to server
  • app_id (String.t): app ID
  • service_create_app_input_config_request (ServiceCreateAppInputConfigRequest): Input
  • opts (keyword): Optional parameters

Returns

  • {:ok, Nuon.Model.AppAppInputConfig.t} on success
  • {:error, Tesla.Env.t} on failure

get an app config Fetch an app config by id.

get an app config template Create an application template which provides a fully rendered config that can be modified and used to kickstart any application.

get app configs Returns all configs for the app.

get latest app config Returns the most recent config for the provided app.

get all apps for the current org

Functions

Link to this function

create_app(connection, service_create_app_request, opts \\ [])

create an app

Parameters

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

Returns

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

create_app_config(connection, app_id, service_create_app_config_request, opts \\ [])

Create an app config, by pushing the contents of a config file. The API will automatically configure the app according to the config file in the background.

Parameters

  • connection (Nuon.Connection): Connection to server
  • app_id (String.t): app ID
  • service_create_app_config_request (ServiceCreateAppConfigRequest): Input
  • opts (keyword): Optional parameters

Returns

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

create_app_input_config(connection, app_id, service_create_app_input_config_request, opts \\ [])

Parameters

  • connection (Nuon.Connection): Connection to server
  • app_id (String.t): app ID
  • service_create_app_input_config_request (ServiceCreateAppInputConfigRequest): Input
  • opts (keyword): Optional parameters

Returns

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

create_app_runner_config(connection, app_id, service_create_app_runner_config_request, opts \\ [])

create an app runner config

Parameters

  • connection (Nuon.Connection): Connection to server
  • app_id (String.t): app ID
  • service_create_app_runner_config_request (ServiceCreateAppRunnerConfigRequest): Input
  • opts (keyword): Optional parameters

Returns

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

create_app_sandbox_config(connection, app_id, service_create_app_sandbox_config_request, opts \\ [])

create an app sandbox config

Parameters

  • connection (Nuon.Connection): Connection to server
  • app_id (String.t): app ID
  • service_create_app_sandbox_config_request (ServiceCreateAppSandboxConfigRequest): Input
  • opts (keyword): Optional parameters

Returns

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

delete_app(connection, app_id, opts \\ [])

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

delete an app

Parameters

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

Returns

  • {:ok, boolean()} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_app(connection, app_id, opts \\ [])

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

get an app

Parameters

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

Returns

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

get_app_config(connection, app_id, app_config_id, opts \\ [])

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

get an app config Fetch an app config by id.

Parameters

  • connection (Nuon.Connection): Connection to server
  • app_id (String.t): app ID
  • app_config_id (String.t): app config ID
  • opts (keyword): Optional parameters

Returns

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

get_app_config_template(connection, app_id, type, opts \\ [])

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

get an app config template Create an application template which provides a fully rendered config that can be modified and used to kickstart any application.

Parameters

  • connection (Nuon.Connection): Connection to server
  • app_id (String.t): app ID
  • type (String.t): app template type
  • opts (keyword): Optional parameters

Returns

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

get_app_configs(connection, app_id, opts \\ [])

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

get app configs Returns all configs for the app.

Parameters

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

Returns

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

get_app_input_configs(connection, app_id, opts \\ [])

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

get app input configs

Parameters

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

Returns

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

get_app_input_latest_config(connection, app_id, opts \\ [])

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

get latest app input config

Parameters

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

Returns

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

get_app_latest_config(connection, app_id, opts \\ [])

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

get latest app config Returns the most recent config for the provided app.

Parameters

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

Returns

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

get_app_runner_configs(connection, app_id, opts \\ [])

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

get app runner configs

Parameters

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

Returns

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

get_app_runner_latest_config(connection, app_id, opts \\ [])

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

get latest app runner config

Parameters

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

Returns

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

get_app_sandbox_configs(connection, app_id, opts \\ [])

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

get app sandbox configs

Parameters

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

Returns

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

get_app_sandbox_latest_config(connection, app_id, opts \\ [])

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

get latest app sandbox config

Parameters

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

Returns

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

get_apps(connection, opts \\ [])

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

get all apps for the current org

Parameters

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

Returns

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

update_app(connection, app_id, service_update_app_request, opts \\ [])

update an app

Parameters

  • connection (Nuon.Connection): Connection to server
  • app_id (String.t): app ID
  • service_update_app_request (ServiceUpdateAppRequest): Input
  • opts (keyword): Optional parameters

Returns

  • {:ok, Nuon.Model.AppApp.t} on success
  • {:error, Tesla.Env.t} on failure