BrazeEx
Braze HTTP API (generated from Braze Postman Collection)
building
Building
To install the required dependencies and to build the elixir project, run:
mix local.hex --force
mix do deps.get, compile
installation
Installation
If available in Hex, the package can be installed by adding braze_ex to
your list of dependencies in mix.exs:
def deps do
[{:braze_ex, "~> 1.0.22"}]
endDocumentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/braze_ex.
configuration
Configuration
You can override the URL of your server (e.g. if you have a separate development and production server in your configuration files).
config :braze_ex, base_url: "https://rest.iad-01.braze.com"Multiple clients for the same API with different URLs can be created passing different base_urls when calling
BrazeEx.Connection.new/1:
client = BrazeEx.Connection.new(base_url: "https://rest.iad-01.braze.com")
usage
Usage
TODO .. examples of usage to come as we use this internally
Development
This API is generated using OpenApiGenerator from the Braze Postman Collection.
Requirements:
- asdf, which installs all of the necessary tools and versions
- just, which runs the build scripts from the justfile
To Rebuild the API using the latest postman collection revision run just build