https://github.com/midas/click_send
API Facade for ClickSend REST v3.
https://github.com/midas/click_send
Last synced: 4 months ago
JSON representation
API Facade for ClickSend REST v3.
- Host: GitHub
- URL: https://github.com/midas/click_send
- Owner: midas
- License: mit
- Created: 2019-01-12T18:12:32.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-31T14:35:11.000Z (over 2 years ago)
- Last Synced: 2025-10-21T18:51:43.738Z (8 months ago)
- Language: Elixir
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ClickSend
API Facade for ClickSend REST v3.
## Examples
### Account
#### Show
```elixir
ClickSend.Account.show()
```
### Account Recharge
#### List Packages
```elixir
ClickSend.AccountRecharge.list_packages("USA")
```
#### Purchase a Package
```elixir
ClickSend.AccountRecharge.purchase_package(1)
```
### Email
#### Send
```elixir
ClickSend.EmailMessage.new(
"test1@test.com",
"John Doe",
1111,
"My App Registrations",
"Your account needs verification",
"Please go to https://cool-app.com/account/4b787ca2-15cc-11e9-9330-c48e8ff5e241/verify to verify your account"
)
|> ClickSend.Email.send()
```
### SMS
#### Send
```elixir
ClickSend.SmsMessage.new("+14055555555", "Hello world!")
|> ClickSend.Sms.send()
```
## Installation
1. Add `click_send` to your list of dependencies in `mix.exs`
```elixir
def deps do
[
{:click_send, "~> 0.5.0"}
]
end
```
1. Setup your configuration
```elixir
config :click_send,
api_key: "F0E14CF8-1691-11E9-9019-C48E8FF5E241",
username: "my_username",
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/click_send](https://hexdocs.pm/click_send).