lib/spatio/connection.ex

# NOTE: This file is auto generated by OpenAPI Generator 7.22.0 (https://openapi-generator.tech).
# Do not edit this file manually.

defmodule Spatio.Connection do
  @moduledoc """
  Handle Tesla connections for Spatio.

  Additional middleware can be set in the compile-time or runtime configuration:

      config :tesla, Spatio.Connection,
        base_url: "https://api.spatio.app",
        adapter: Tesla.Adapter.Hackney

  The default base URL can also be set as:

      config :spatio_sdk,
        :base_url, "https://api.spatio.app"
  """

  @default_base_url Application.compile_env(
                      :spatio_sdk,
                      :base_url,
                      "https://api.spatio.app"
                    )


  @typedoc """
  The list of options that can be passed to new/1.

  - `base_url`: Overrides the base URL on a per-client basis.
  - `user_agent`: Overrides the User-Agent header.
  - `bearer_token`: A bearer token for bearer authentication.
  """
  @type options :: [
          {:base_url, String.t()},
          {:user_agent, String.t()},
          {:bearer_token, String.t() | nil},
        ]

  @doc "Forward requests to Tesla."
  @spec request(Tesla.Client.t(), [Tesla.option()]) :: Tesla.Env.result()
  defdelegate request(client, options), to: Tesla

  @doc """
  Configure a Spatio client.

  ### Parameters

  - `options`: an optional keyword list of Spatio.Connection.options.

  ### Returns

  Tesla.Env.client
  """
  @spec new(options) :: Tesla.Env.client()
  def new(options \\ []) do
    options
    |> middleware()
    |> Tesla.client(adapter())
  end

  @doc """
  Returns fully configured middleware for passing to Tesla.client/2.
  """
  @spec middleware(options) :: [Tesla.Client.middleware()]
  def middleware(options \\ []) do
    base_url =
      Keyword.get(
        options,
        :base_url,
        Application.get_env(:spatio_sdk, :base_url, @default_base_url)
      )

    tesla_options = Application.get_env(:tesla, __MODULE__, [])
    middleware = Keyword.get(tesla_options, :middleware, [])
    json_engine = Keyword.get(tesla_options, :json, JSON)

    user_agent =
      Keyword.get(
        options,
        :user_agent,
        Keyword.get(
          tesla_options,
          :user_agent,
          "openapi-generator - Spatio 1.0.0 - elixir"
        )
      )


    bearer_token = Keyword.get(options, :bearer_token)
    middleware = [{Tesla.Middleware.BearerAuth, token: bearer_token} | middleware]


    [
      {Tesla.Middleware.BaseUrl, base_url},
      {Tesla.Middleware.Headers, [{"user-agent", user_agent}]},
      {Tesla.Middleware.EncodeJson, engine: json_engine}
      | middleware
    ]
  end


  @doc """
  Returns the default adapter for this API.
  """
  def adapter do
    :tesla
    |> Application.get_env(__MODULE__, [])
    |> Keyword.get(:adapter, nil)
  end
end