Deputy (Deputy v0.0.0-dev)

View Source

Deputy is an Elixir client for the Deputy API.

Configuration

You can configure the Deputy client with:

client = Deputy.new(
  base_url: "https://your-subdomain.deputy.com",
  api_key: "your-api-key"
)

Usage Example 

# Create a client
client = Deputy.new(
  base_url: "https://your-subdomain.deputy.com",
  api_key: "your-api-key"
)

# Get locations
{:ok, locations} = Deputy.Locations.get_locations(client)

Summary

Types

t()

Functions

new(opts)

Creates a new Deputy client with the given configuration.

request(client, method, path, opts \\ [])

Makes a HTTP request to the Deputy API.

Types

t()

@type t() :: %Deputy{api_key: String.t(), base_url: String.t(), http_client: module()}

Functions

new(opts)

@spec new(Keyword.t()) :: t()

Creates a new Deputy client with the given configuration.

Options

  • :base_url - Required. The base URL for the Deputy API.
  • :api_key - Required. The API key for authentication.
  • :http_client - Optional. Module implementing the HTTPClient behavior. Defaults to Deputy.HTTPClient.Req.

Examples 

iex> Deputy.new(base_url: "https://your-subdomain.deputy.com", api_key: "your-api-key")
%Deputy{base_url: "https://your-subdomain.deputy.com", api_key: "your-api-key", http_client: Deputy.HTTPClient.Req}

request(client, method, path, opts \\ [])

@spec request(t(), atom(), String.t(), keyword()) :: {:ok, map()} | {:error, any()}

Makes a HTTP request to the Deputy API.

This is used internally by the API module functions.