braze_ex v1.0.22

BrazeEx.Connection (braze_ex v1.0.22)

Handle Tesla connections for BrazeEx.

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

config :tesla, BrazeEx.Connection,
  base_url: "https://rest.iad-01.braze.com",
  adapter: Tesla.Adapter.Hackney

The default base URL can also be set as:

config :braze_ex,
  :base_url, "https://rest.iad-01.braze.com"

Link to this section Summary

Types

options()

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

Functions

adapter()

Returns the default adapter for this API.

middleware(options \\ [])

Returns fully configured middleware for passing to Tesla.client/2.

new()

Configure a client with no authentication.

new(options)

Configure a client that may have authentication.

request(client, options)

Forward requests to Tesla.

Link to this section Types

Link to this type

options()

@type options() :: [base_url: String.t(), user_agent: String.t()]

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.

Link to this section Functions

Link to this function

adapter()

Returns the default adapter for this API.

Link to this function

middleware(options \\ [])

@spec middleware(options()) :: [Tesla.Client.middleware()]

Returns fully configured middleware for passing to Tesla.client/2.

Link to this function

new()

@spec new() :: Tesla.Env.client()

Configure a client with no authentication.

returns

 Returns

Tesla.Env.client

Link to this function

new(options)

@spec new(options()) :: Tesla.Env.client()

Configure a client that may have authentication.

parameters

 Parameters

  • options: a keyword list of OpenAPIPetstore.Connection.options.

returns

 Returns

Tesla.Env.client

Link to this function

request(client, options)

@spec request(Tesla.Client.t(), [Tesla.option()]) :: Tesla.Env.result()

Forward requests to Tesla.