usps v0.1.0 Usps.Configuration View Source

Configurations used to make HTTP(S) requests to the USPS API.

Configurations can be set via the project configs, directly using the Configuration.new/1 function, or some combination of the two.

# config.exs
import Config

config :usps,
url: "secure.shippingapis.com",
path: "/shippingapi.dll",
user_id: "USER123"

# direclty using new/1
config = Configuration.new(url: "https://example.com")

Configuration options passed as arguments to new/1 will always override configurations in config.exs.

Link to this section Summary

Types

t()

Functions

new(overrides \\ [])

Returns a new Configuration struct with the given overrides applied.

Link to this section Types

t()

t() :: %Usps.Configuration{
  client: nil | module(),
  path: nil | binary(),
  url: nil | binary(),
  user_id: nil | binary()
}

Link to this section Functions

new(overrides \\ [])

new(overrides :: keyword()) :: t()

Returns a new Configuration struct with the given overrides applied.