Nuon.Api.Installers (nuon v0.19.90)

API calls for all endpoints tagged Installers.

Summary

Functions

Link to this function

create_installer(connection, service_create_app_installer_request, opts \\ [])

create an app installer

Parameters

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

Returns

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

delete_installer(connection, installer_id, opts \\ [])

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

delete an installer

Parameters

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

Returns

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

get_installer(connection, installer_id, opts \\ [])

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

get an installer

Parameters

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

Returns

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

get_installer_install(connection, installer_slug, install_id, opts \\ [])

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

render an installer install

Parameters

  • connection (Nuon.Connection): Connection to server
  • installer_slug (String.t): installer slug or ID
  • install_id (String.t): install id
  • opts (keyword): Optional parameters

Returns

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

get_installers(connection, opts \\ [])

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

get installers for current org Return all installers for the current org.

Parameters

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

Returns

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

installer_create_install(connection, installer_slug, service_create_install_request, opts \\ [])

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

create an app install from an installer

Parameters

  • connection (Nuon.Connection): Connection to server
  • installer_slug (String.t): installer slug or ID
  • service_create_install_request (ServiceCreateInstallRequest): Input
  • opts (keyword): Optional parameters

Returns

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

render_installer(connection, installer_slug, opts \\ [])

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

render an installer

Parameters

  • connection (Nuon.Connection): Connection to server
  • installer_slug (String.t): installer slug or ID
  • opts (keyword): Optional parameters

Returns

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

render_installer_install(connection, installer_slug, install_id, opts \\ [])

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

render an installer install Render an install in the context of an installer.

Parameters

  • connection (Nuon.Connection): Connection to server
  • installer_slug (String.t): installer slug or ID
  • install_id (String.t): install id
  • opts (keyword): Optional parameters

Returns

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

update_installer(connection, installer_id, service_update_installer_request, opts \\ [])

update an installer

Parameters

  • connection (Nuon.Connection): Connection to server
  • installer_id (String.t): installer ID
  • service_update_installer_request (ServiceUpdateInstallerRequest): Input
  • opts (keyword): Optional parameters

Returns

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