Packages

nuon

0.19.138
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.

HexDocs

Current section

Files

Jump to
Readme
103 Versions
2 Dependencies
Dependants
Files
Activity
nuon lib nuon api general.ex
Raw

lib/nuon/api/general.ex 

# NOTE: This file is auto generated by OpenAPI Generator 7.6.0 (https://openapi-generator.tech).

# Do not edit this file manually.



defmodule Nuon.Api.General do

  @moduledoc """

  API calls for all endpoints tagged `General`.

  """



  alias Nuon.Connection

  import Nuon.RequestBuilder



  @doc """

  Get config for cli



  ### Parameters



  - `connection` (Nuon.Connection): Connection to server

  - `opts` (keyword): Optional parameters



  ### Returns



  - `{:ok, Nuon.Model.ServiceCliConfig.t}` on success

  - `{:error, Tesla.Env.t}` on failure

  """

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

  def get_cli_config(connection, _opts \\ []) do

    request =

      %{}

      |> method(:get)

      |> url("/v1/general/cli-config")

      |> Enum.into([])



    connection

    |> Connection.request(request)

    |> evaluate_response([

      {200, Nuon.Model.ServiceCliConfig},

      {400, Nuon.Model.StderrErrResponse},

      {401, Nuon.Model.StderrErrResponse},

      {403, Nuon.Model.StderrErrResponse},

      {404, Nuon.Model.StderrErrResponse},

      {500, Nuon.Model.StderrErrResponse}

    ])

  end



  @doc """

  Get regions for a cloud platform

  Return region metadata for the Nuon supported cloud platforms. 



  ### Parameters



  - `connection` (Nuon.Connection): Connection to server

  - `cloud_platform` (String.t): cloud platform

  - `opts` (keyword): Optional parameters



  ### Returns



  - `{:ok, [%AppCloudPlatformRegion{}, ...]}` on success

  - `{:error, Tesla.Env.t}` on failure

  """

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

  def get_cloud_platform_regions(connection, cloud_platform, _opts \\ []) do

    request =

      %{}

      |> method(:get)

      |> url("/v1/general/cloud-platform/#{cloud_platform}/regions")

      |> Enum.into([])



    connection

    |> Connection.request(request)

    |> evaluate_response([

      {200, Nuon.Model.AppCloudPlatformRegion},

      {400, Nuon.Model.StderrErrResponse},

      {401, Nuon.Model.StderrErrResponse},

      {403, Nuon.Model.StderrErrResponse},

      {404, Nuon.Model.StderrErrResponse},

      {500, Nuon.Model.StderrErrResponse}

    ])

  end



  @doc """

  Get current user



  ### Parameters



  - `connection` (Nuon.Connection): Connection to server

  - `opts` (keyword): Optional parameters



  ### Returns



  - `{:ok, Nuon.Model.AppUserToken.t}` on success

  - `{:error, Tesla.Env.t}` on failure

  """

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

  def get_current_user(connection, _opts \\ []) do

    request =

      %{}

      |> method(:get)

      |> url("/v1/general/current-user")

      |> Enum.into([])



    connection

    |> Connection.request(request)

    |> evaluate_response([

      {200, Nuon.Model.AppUserToken},

      {400, Nuon.Model.StderrErrResponse},

      {401, Nuon.Model.StderrErrResponse},

      {403, Nuon.Model.StderrErrResponse},

      {404, Nuon.Model.StderrErrResponse},

      {500, Nuon.Model.StderrErrResponse}

    ])

  end



  @doc """

  Publish a metric from different Nuon clients for telemetry purposes.



  ### Parameters



  - `connection` (Nuon.Connection): Connection to server

  - `service_publish_metric_input` ([Nuon.Model.ServicePublishMetricInput.t]): Input

  - `opts` (keyword): Optional parameters



  ### Returns



  - `{:ok, String.t}` on success

  - `{:error, Tesla.Env.t}` on failure

  """

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

  def publish_metrics(connection, service_publish_metric_input, _opts \\ []) do

    request =

      %{}

      |> method(:post)

      |> url("/v1/general/metrics")

      |> add_param(:body, :body, service_publish_metric_input)

      |> 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

end