ExBifrost.Api.Configuration (ex_bifrost v0.1.0)

API calls for all endpoints tagged Configuration.

Summary

Functions

force_sync_pricing(connection, opts \\ [])

Force pricing sync Triggers an immediate pricing sync and resets the pricing sync timer.

Get configuration Retrieves the current Bifrost configuration including client config, framework config, auth config, and connection status for various stores.

get_proxy_config(connection, opts \\ [])

Get proxy configuration Retrieves the current global proxy configuration.

get_version(connection, opts \\ [])

Get version Returns the current Bifrost version information.

update_config(connection, update_config_request, opts \\ [])

Update configuration Updates the Bifrost configuration. Supports hot-reloading of certain settings like drop_excess_requests. Some settings may require a restart to take effect.

update_proxy_config(connection, get_proxy_config200_response, opts \\ [])

Update proxy configuration Updates the global proxy configuration.

Functions

force_sync_pricing(connection, opts \\ [])

@spec force_sync_pricing(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, ExBifrost.Model.SuccessResponse.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Force pricing sync Triggers an immediate pricing sync and resets the pricing sync timer.

Parameters

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

Returns

{:ok, ExBifrost.Model.SuccessResponse.t} on success
{:error, Tesla.Env.t} on failure

get_config(connection, opts \\ [])

@spec get_config(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, ExBifrost.Model.GetConfigResponse.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Get configuration Retrieves the current Bifrost configuration including client config, framework config, auth config, and connection status for various stores.

Parameters

connection (ExBifrost.Connection): Connection to server
opts (keyword): Optional parameters
- :from_db (String.t): If true, fetch configuration directly from the database

Returns

{:ok, ExBifrost.Model.GetConfigResponse.t} on success
{:error, Tesla.Env.t} on failure

get_proxy_config(connection, opts \\ [])

@spec get_proxy_config(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, ExBifrost.Model.GetProxyConfig200Response.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Get proxy configuration Retrieves the current global proxy configuration.

Parameters

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

Returns

{:ok, ExBifrost.Model.GetProxyConfig200Response.t} on success
{:error, Tesla.Env.t} on failure

get_version(connection, opts \\ [])

@spec get_version(
  Tesla.Env.client(),
  keyword()
) :: {:ok, String.t()} | {:error, Tesla.Env.t()}

Get version Returns the current Bifrost version information.

Parameters

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

Returns

{:ok, String.t} on success
{:error, Tesla.Env.t} on failure

update_config(connection, update_config_request, opts \\ [])

@spec update_config(
  Tesla.Env.client(),
  ExBifrost.Model.UpdateConfigRequest.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.SuccessResponse.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Update configuration Updates the Bifrost configuration. Supports hot-reloading of certain settings like drop_excess_requests. Some settings may require a restart to take effect.

Parameters

connection (ExBifrost.Connection): Connection to server
update_config_request (UpdateConfigRequest):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.SuccessResponse.t} on success
{:error, Tesla.Env.t} on failure

update_proxy_config(connection, get_proxy_config200_response, opts \\ [])

@spec update_proxy_config(
  Tesla.Env.client(),
  ExBifrost.Model.GetProxyConfig200Response.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.SuccessResponse.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Update proxy configuration Updates the global proxy configuration.

Parameters

connection (ExBifrost.Connection): Connection to server
get_proxy_config200_response (GetProxyConfig200Response):
opts (keyword): Optional parameters

Returns

{:ok, ExBifrost.Model.SuccessResponse.t} on success
{:error, Tesla.Env.t} on failure