Packages
nuon
0.19.83
0.19.138
0.19.137
0.19.136
0.19.135
0.19.134
0.19.133
0.19.132
0.19.123
0.19.122
0.19.121
0.19.119
0.19.113
0.19.112
0.19.111
0.19.110
0.19.109
0.19.108
0.19.106
0.19.105
0.19.104
0.19.103
0.19.102
0.19.101
0.19.100
0.19.99
0.19.98
0.19.97
0.19.96
0.19.95
0.19.94
0.19.93
0.19.92
0.19.91
0.19.90
0.19.88
0.19.87
0.19.86
0.19.85
0.19.84
0.19.83
0.19.81
0.19.80
0.19.79
0.19.78
0.19.77
0.19.76
0.19.75
0.19.73
0.19.72
0.19.71
0.19.70
0.19.69
0.19.68
0.19.67
0.19.66
0.19.65
0.19.64
0.19.63
0.19.62
0.19.61
0.19.60
0.19.59
0.19.58
0.19.57
0.19.52
0.19.51
0.19.50
0.19.49
0.19.48
0.19.47
0.19.46
0.19.45
0.19.44
0.19.43
0.19.42
0.19.41
0.19.40
0.19.39
0.19.38
0.19.37
0.19.36
0.19.35
0.19.34
0.19.33
0.19.32
0.19.31
0.19.30
0.19.29
0.19.28
0.19.27
0.19.26
0.19.25
0.19.24
0.19.23
0.19.22
0.19.21
0.19.20
0.19.19
0.19.18
0.19.17
0.19.16
0.19.15
0.19.14
API for managing nuon apps, components, and installs.
Current section
Files
Jump to
Current section
Files
lib/nuon/api/apps.ex
# NOTE: This file is auto generated by OpenAPI Generator 7.4.0-SNAPSHOT (https://openapi-generator.tech).
# Do not edit this file manually.
defmodule Nuon.Api.Apps do
@moduledoc """
API calls for all endpoints tagged `Apps`.
"""
alias Nuon.Connection
import Nuon.RequestBuilder
@doc """
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
"""
@spec create_app(Tesla.Env.client, Nuon.Model.ServiceCreateAppRequest.t, keyword()) :: {:ok, Nuon.Model.AppApp.t} | {:ok, Nuon.Model.StderrErrResponse.t} | {:error, Tesla.Env.t}
def create_app(connection, service_create_app_request, _opts \\ []) do
request =
%{}
|> method(:post)
|> url("/v1/apps")
|> add_param(:body, :body, service_create_app_request)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{201, Nuon.Model.AppApp},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@spec create_app_config(Tesla.Env.client, String.t, Nuon.Model.ServiceCreateAppConfigRequest.t, keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t} | {:ok, Nuon.Model.AppAppConfig.t} | {:error, Tesla.Env.t}
def create_app_config(connection, app_id, service_create_app_config_request, _opts \\ []) do
request =
%{}
|> method(:post)
|> url("/v1/apps/#{app_id}/config")
|> add_param(:body, :body, service_create_app_config_request)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{201, Nuon.Model.AppAppConfig},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
### 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
"""
@spec create_app_input_config(Tesla.Env.client, String.t, Nuon.Model.ServiceCreateAppInputConfigRequest.t, keyword()) :: {:ok, Nuon.Model.AppAppInputConfig.t} | {:ok, Nuon.Model.StderrErrResponse.t} | {:error, Tesla.Env.t}
def create_app_input_config(connection, app_id, service_create_app_input_config_request, _opts \\ []) do
request =
%{}
|> method(:post)
|> url("/v1/apps/#{app_id}/input-config")
|> add_param(:body, :body, service_create_app_input_config_request)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{201, Nuon.Model.AppAppInputConfig},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@spec create_app_runner_config(Tesla.Env.client, String.t, Nuon.Model.ServiceCreateAppRunnerConfigRequest.t, keyword()) :: {:ok, Nuon.Model.AppAppRunnerConfig.t} | {:ok, Nuon.Model.StderrErrResponse.t} | {:error, Tesla.Env.t}
def create_app_runner_config(connection, app_id, service_create_app_runner_config_request, _opts \\ []) do
request =
%{}
|> method(:post)
|> url("/v1/apps/#{app_id}/runner-config")
|> add_param(:body, :body, service_create_app_runner_config_request)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{201, Nuon.Model.AppAppRunnerConfig},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@spec create_app_sandbox_config(Tesla.Env.client, String.t, Nuon.Model.ServiceCreateAppSandboxConfigRequest.t, keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t} | {:ok, Nuon.Model.AppAppSandboxConfig.t} | {:error, Tesla.Env.t}
def create_app_sandbox_config(connection, app_id, service_create_app_sandbox_config_request, _opts \\ []) do
request =
%{}
|> method(:post)
|> url("/v1/apps/#{app_id}/sandbox-config")
|> add_param(:body, :body, service_create_app_sandbox_config_request)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{201, Nuon.Model.AppAppSandboxConfig},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@spec delete_app(Tesla.Env.client, String.t, keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t} | {:ok, boolean()} | {:error, Tesla.Env.t}
def delete_app(connection, app_id, _opts \\ []) do
request =
%{}
|> method(:delete)
|> url("/v1/apps/#{app_id}")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, false},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@spec get_app(Tesla.Env.client, String.t, keyword()) :: {:ok, Nuon.Model.AppApp.t} | {:ok, Nuon.Model.StderrErrResponse.t} | {:error, Tesla.Env.t}
def get_app(connection, app_id, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps/#{app_id}")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Nuon.Model.AppApp},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@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}
def get_app_config(connection, app_id, app_config_id, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps/#{app_id}/config/#{app_config_id}")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Nuon.Model.AppAppConfig},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@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}
def get_app_config_template(connection, app_id, type, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps/#{app_id}/template-config")
|> add_param(:query, :type, type)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{201, Nuon.Model.ServiceAppConfigTemplate},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@spec get_app_configs(Tesla.Env.client, String.t, keyword()) :: {:ok, list(Nuon.Model.AppAppConfig.t)} | {:ok, Nuon.Model.StderrErrResponse.t} | {:error, Tesla.Env.t}
def get_app_configs(connection, app_id, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps/#{app_id}/configs")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Nuon.Model.AppAppConfig},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@spec get_app_input_configs(Tesla.Env.client, String.t, keyword()) :: {:ok, list(Nuon.Model.AppAppInputConfig.t)} | {:ok, Nuon.Model.StderrErrResponse.t} | {:error, Tesla.Env.t}
def get_app_input_configs(connection, app_id, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps/#{app_id}/input-configs")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Nuon.Model.AppAppInputConfig},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@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}
def get_app_input_latest_config(connection, app_id, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps/#{app_id}/input-latest-config")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Nuon.Model.AppAppInputConfig},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@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}
def get_app_latest_config(connection, app_id, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps/#{app_id}/latest-config")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Nuon.Model.AppAppConfig},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@spec get_app_runner_configs(Tesla.Env.client, String.t, keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t} | {:ok, list(Nuon.Model.AppAppRunnerConfig.t)} | {:error, Tesla.Env.t}
def get_app_runner_configs(connection, app_id, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps/#{app_id}/runner-configs")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Nuon.Model.AppAppRunnerConfig},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@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}
def get_app_runner_latest_config(connection, app_id, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps/#{app_id}/runner-latest-config")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Nuon.Model.AppAppRunnerConfig},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@spec get_app_sandbox_configs(Tesla.Env.client, String.t, keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t} | {:ok, list(Nuon.Model.AppAppSandboxConfig.t)} | {:error, Tesla.Env.t}
def get_app_sandbox_configs(connection, app_id, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps/#{app_id}/sandbox-configs")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Nuon.Model.AppAppSandboxConfig},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@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}
def get_app_sandbox_latest_config(connection, app_id, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps/#{app_id}/sandbox-latest-config")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Nuon.Model.AppAppSandboxConfig},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@spec get_apps(Tesla.Env.client, keyword()) :: {:ok, Nuon.Model.StderrErrResponse.t} | {:ok, list(Nuon.Model.AppApp.t)} | {:error, Tesla.Env.t}
def get_apps(connection, _opts \\ []) do
request =
%{}
|> method(:get)
|> url("/v1/apps")
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Nuon.Model.AppApp},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
@doc """
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
"""
@spec update_app(Tesla.Env.client, String.t, Nuon.Model.ServiceUpdateAppRequest.t, keyword()) :: {:ok, Nuon.Model.AppApp.t} | {:ok, Nuon.Model.StderrErrResponse.t} | {:error, Tesla.Env.t}
def update_app(connection, app_id, service_update_app_request, _opts \\ []) do
request =
%{}
|> method(:patch)
|> url("/v1/apps/#{app_id}")
|> add_param(:body, :body, service_update_app_request)
|> Enum.into([])
connection
|> Connection.request(request)
|> evaluate_response([
{200, Nuon.Model.AppApp},
{400, Nuon.Model.StderrErrResponse},
{401, Nuon.Model.StderrErrResponse},
{403, Nuon.Model.StderrErrResponse},
{404, Nuon.Model.StderrErrResponse},
{500, Nuon.Model.StderrErrResponse}
])
end
end