https://github.com/seven-io/ruby-client
Official Ruby API Client for the seven.io SMS Gateway
https://github.com/seven-io/ruby-client
api-client cnam hlr mnp ruby sdk sms text2speech tts
Last synced: 2 months ago
JSON representation
Official Ruby API Client for the seven.io SMS Gateway
- Host: GitHub
- URL: https://github.com/seven-io/ruby-client
- Owner: seven-io
- License: mit
- Created: 2020-09-27T14:02:40.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-07T10:47:53.000Z (8 months ago)
- Last Synced: 2025-04-03T01:51:11.854Z (3 months ago)
- Topics: api-client, cnam, hlr, mnp, ruby, sdk, sms, text2speech, tts
- Language: Ruby
- Homepage: https://rubygems.org/gems/seven_api
- Size: 240 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Official Ruby Client for [seven.io](https://www.seven.io/)
This gem requires Ruby >= 3.1.0.
## Installation
```gem install seven_api```
### Usage
#### Retrieve balance
```ruby
require 'seven_api/client'
api_key = ENV['SEVEN_API_KEY']
# retrieve balance
puts SevenApi::Resources::Balance.new(api_key).retrieve
# send SMS
puts SevenApi::Resources::Sms.new(api_key).retrieve
```
#### Testing
```shell
SEVEN_API_KEY=MySevenApiKey bundle exec rspec
```
*Optional environment variables*
Setting ```SEVEN_DEBUG=1``` prints details to stdout.
Setting ```SEVEN_TEST_HTTP=1``` enables live testing with actual API requests.
##### Support
Need help? Feel free to [contact us](https://www.seven.io/en/company/contact/).
[](LICENSE)