# BrazeEx

Braze HTTP API (generated from Braze Postman Collection)

## Building

To install the required dependencies and to build the elixir project, run:

mix local.hex --force
mix do deps.get, compile

## 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.3"}]

Documentation can be generated with [ExDoc][] and published on [HexDocs][]. Once published, the docs can be found at

## 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://}"

Multiple clients for the same API with different URLs can be created passing different `base_url`s when calling

client = "https://}")

[available in hex]:

## Usage

TODO .. examples of usage to come as we use this internally

# Development

This API is generated using [OpenApiGenerator]( from the [Braze Postman Collection](


- [asdf](, which installs all of the necessary tools and versions
- [just](, which runs the build scripts from the [justfile](justfile)

To Rebuild the API using the latest postman collection revision run `just build`