NuonAPI.Api.Apps (nuon v0.19.90)
API calls for all endpoints tagged Apps
.
Summary
Functions
Parameters
connection
(NuonAPI.Connection): Connection to serverapp_id
(String.t): app IDservice_create_app_input_config_request
(ServiceCreateAppInputConfigRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppAppInputConfig.t}
on success{:error, Tesla.Env.t}
on failure
create an app installer
create_app_sandbox_config(connection, app_id, service_create_app_sandbox_config_request, opts \\ [])
create an app sandbox config
delete an app
delete an app installer
get an app
get app input configs
get latest app input config
get an app installer
get app sandbox configs
get latest app sandbox config
get all apps for the current org
render an app installer
update an app installer
Functions
Link to this function
create_app(connection, service_create_app_request, opts \\ [])
@spec create_app( Tesla.Env.client(), NuonAPI.Model.ServiceCreateAppRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:ok, NuonAPI.Model.AppApp.t()} | {:error, Tesla.Env.t()}
create an app
Parameters
connection
(NuonAPI.Connection): Connection to serverservice_create_app_request
(ServiceCreateAppRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppApp.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 \\ [])
@spec create_app_input_config( Tesla.Env.client(), String.t(), NuonAPI.Model.ServiceCreateAppInputConfigRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.AppAppInputConfig.t()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
Parameters
connection
(NuonAPI.Connection): Connection to serverapp_id
(String.t): app IDservice_create_app_input_config_request
(ServiceCreateAppInputConfigRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppAppInputConfig.t}
on success{:error, Tesla.Env.t}
on failure
Link to this function
create_app_installer(connection, app_id, service_create_app_installer_request, opts \\ [])
@spec create_app_installer( Tesla.Env.client(), String.t(), NuonAPI.Model.ServiceCreateAppInstallerRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:ok, NuonAPI.Model.AppAppInstaller.t()} | {:error, Tesla.Env.t()}
create an app installer
Parameters
connection
(NuonAPI.Connection): Connection to serverapp_id
(String.t): app IDservice_create_app_installer_request
(ServiceCreateAppInstallerRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppAppInstaller.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 \\ [])
@spec create_app_sandbox_config( Tesla.Env.client(), String.t(), NuonAPI.Model.ServiceCreateAppSandboxConfigRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.AppAppSandboxConfig.t()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
create an app sandbox config
Parameters
connection
(NuonAPI.Connection): Connection to serverapp_id
(String.t): app IDservice_create_app_sandbox_config_request
(ServiceCreateAppSandboxConfigRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.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, boolean()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
delete an app
Parameters
connection
(NuonAPI.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, boolean()}
on success{:error, Tesla.Env.t}
on failure
Link to this function
delete_app_installer(connection, installer_id, opts \\ [])
@spec delete_app_installer(Tesla.Env.client(), String.t(), keyword()) :: {:ok, boolean()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
delete an app installer
Parameters
connection
(NuonAPI.Connection): Connection to serverinstaller_id
(String.t): installer IDopts
(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, NuonAPI.Model.StderrErrResponse.t()} | {:ok, NuonAPI.Model.AppApp.t()} | {:error, Tesla.Env.t()}
get an app
Parameters
connection
(NuonAPI.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppApp.t}
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, NuonAPI.Model.StderrErrResponse.t()} | {:ok, [NuonAPI.Model.AppAppInputConfig.t()]} | {:error, Tesla.Env.t()}
get app input configs
Parameters
connection
(NuonAPI.Connection): Connection to serverapp_id
(String.t): app IDopts
(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, NuonAPI.Model.AppAppInputConfig.t()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get latest app input config
Parameters
connection
(NuonAPI.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppAppInputConfig.t}
on success{:error, Tesla.Env.t}
on failure
Link to this function
get_app_installer(connection, installer_id, opts \\ [])
@spec get_app_installer(Tesla.Env.client(), String.t(), keyword()) :: {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:ok, NuonAPI.Model.AppAppInstaller.t()} | {:error, Tesla.Env.t()}
get an app installer
Parameters
connection
(NuonAPI.Connection): Connection to serverinstaller_id
(String.t): installer IDopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppAppInstaller.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, [NuonAPI.Model.AppAppSandboxConfig.t()]} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get app sandbox configs
Parameters
connection
(NuonAPI.Connection): Connection to serverapp_id
(String.t): app IDopts
(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, NuonAPI.Model.AppAppSandboxConfig.t()} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get latest app sandbox config
Parameters
connection
(NuonAPI.Connection): Connection to serverapp_id
(String.t): app IDopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.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, [NuonAPI.Model.AppApp.t()]} | {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:error, Tesla.Env.t()}
get all apps for the current org
Parameters
connection
(NuonAPI.Connection): Connection to serveropts
(keyword): Optional parameters
Returns
{:ok, [%AppApp{}, ...]}
on success{:error, Tesla.Env.t}
on failure
Link to this function
render_app_installer(connection, installer_slug, opts \\ [])
@spec render_app_installer(Tesla.Env.client(), String.t(), keyword()) :: {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:ok, NuonAPI.Model.ServiceAppInstaller.t()} | {:error, Tesla.Env.t()}
render an app installer
Parameters
connection
(NuonAPI.Connection): Connection to serverinstaller_slug
(String.t): installer slug or IDopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.ServiceAppInstaller.t}
on success{:error, Tesla.Env.t}
on failure
Link to this function
update_app(connection, app_id, service_update_app_request, opts \\ [])
@spec update_app( Tesla.Env.client(), String.t(), NuonAPI.Model.ServiceUpdateAppRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:ok, NuonAPI.Model.AppApp.t()} | {:error, Tesla.Env.t()}
update an app
Parameters
connection
(NuonAPI.Connection): Connection to serverapp_id
(String.t): app IDservice_update_app_request
(ServiceUpdateAppRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppApp.t}
on success{:error, Tesla.Env.t}
on failure
Link to this function
update_app_installer(connection, installer_id, service_update_app_installer_request, opts \\ [])
@spec update_app_installer( Tesla.Env.client(), String.t(), NuonAPI.Model.ServiceUpdateAppInstallerRequest.t(), keyword() ) :: {:ok, NuonAPI.Model.StderrErrResponse.t()} | {:ok, NuonAPI.Model.AppAppInstaller.t()} | {:error, Tesla.Env.t()}
update an app installer
Parameters
connection
(NuonAPI.Connection): Connection to serverinstaller_id
(String.t): installer IDservice_update_app_installer_request
(ServiceUpdateAppInstallerRequest): Inputopts
(keyword): Optional parameters
Returns
{:ok, NuonAPI.Model.AppAppInstaller.t}
on success{:error, Tesla.Env.t}
on failure