https://github.com/fbettag/placetel_api.ex

Elixir Wrapper for the Placetel API
https://github.com/fbettag/placetel_api.ex

Last synced: about 1 month ago
JSON representation

Elixir Wrapper for the Placetel API

• Host: GitHub
• URL: https://github.com/fbettag/placetel_api.ex
• Owner: fbettag
• License: mit
• Created: 2022-11-13T15:08:20.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-14T16:14:20.000Z (about 2 years ago)
• Last Synced: 2024-09-28T11:16:15.454Z (3 months ago)
• Language: Elixir
• Size: 41 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PlacetelAPI

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

## Building

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

```console

mix local.hex --force

mix do deps.get, compile

```

## Installation

If [available in Hex][], the package can be installed by adding `placetel_api` to

your list of dependencies in `mix.exs`:

```elixir

def deps do

  [{:placetel_api, "~> 2.0.0"}]

end

```

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

[https://hexdocs.pm/placetel_api][docs].

## Configuration

You can override the URL of your server (e.g. if you have a separate development and production server in your

configuration files).

```elixir

config :placetel_api, base_url: "https://api.placetel.de/v2"

```

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

`PlacetelAPI.Connection.new/1`:

```elixir

client = PlacetelAPI.Connection.new(base_url: "https://api.placetel.de/v2")

```

[exdoc]: https://github.com/elixir-lang/ex_doc

[hexdocs]: https://hexdocs.pm

[available in hex]: https://hex.pm/docs/publish

[docs]: https://hexdocs.pm/placetel_api