# `Stancer.API.Addresses`

# `create`

```elixir
@spec create(map()) :: {:ok, map()} | {:error, term()}
```

POST `/v2/addresses/`

## Parameters

  * `city` (string (1-50 chars), optional)
  * `country` (string (2-2 chars), optional)
  * `line1` (string (1-50 chars), optional)
  * `line2` (string (1-50 chars), optional)
  * `line3` (string (1-50 chars), optional)
  * `metadata` (object, optional)
  * `state` (string (1-3 chars), optional)
  * `zip_code` (string (2-16 chars), optional)

# `delete`

```elixir
@spec delete(String.t()) :: {:ok, map()} | {:error, term()}
```

DELETE `/v2/addresses/{id}`

# `get`

```elixir
@spec get(String.t()) :: {:ok, map()} | {:error, term()}
```

GET `/v2/addresses/{id}`

# `list`

```elixir
@spec list() :: {:ok, map()} | {:error, term()}
```

GET `/v2/addresses/`

---

*Consult [api-reference.md](api-reference.md) for complete listing*