https://github.com/didww/didww-v3-ruby
Ruby client for DIDWW API v3
https://github.com/didww/didww-v3-ruby
api-client didww json-api voip
Last synced: 4 months ago
JSON representation
Ruby client for DIDWW API v3
- Host: GitHub
- URL: https://github.com/didww/didww-v3-ruby
- Owner: didww
- License: mit
- Created: 2018-01-30T23:23:28.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2026-02-23T09:50:28.000Z (4 months ago)
- Last Synced: 2026-02-23T18:16:30.841Z (4 months ago)
- Topics: api-client, didww, json-api, voip
- Language: Ruby
- Size: 314 KB
- Stars: 8
- Watchers: 7
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Ruby client for DIDWW API v3.
[](https://badge.fury.io/rb/didww-v3)
About DIDWW API v3
-----
The DIDWW API provides a simple yet powerful interface that allows you to fully integrate your own applications with DIDWW services. An extensive set of actions may be performed using this API, such as ordering and configuring phone numbers, setting capacity, creating SIP trunks and retrieving CDRs and other operational data.
The DIDWW API v3 is a fully compliant implementation of the [JSON API specification](http://jsonapi.org/format/).
Read more https://doc.didww.com/api
Gem Versions **4.X.X** and branch [master](https://github.com/didww/didww-v3-ruby) are intended to use with DIDWW API 3 version [2022-05-10](https://doc.didww.com/api3/2022-05-10/index.html).
Gem Versions **3.X.X** and branch [release-3](https://github.com/didww/didww-v3-ruby/tree/release-3) are intended to use with DIDWW API 3 version [2021-12-15](https://doc.didww.com/api3/2021-12-15/index.html).
Gem Versions **2.X.X** and branch [release-2](https://github.com/didww/didww-v3-ruby/tree/release-2) are intended to use with DIDWW API 3 version [2021-04-19](https://doc.didww.com/api3/2021-04-19/index.html).
Gem Versions **1.X.X** and branch [release-1](https://github.com/didww/didww-v3-ruby/tree/release-1) are intended to use with DIDWW API 3 version [2017-09-18](https://doc.didww.com/api3/2017-09-18/index.html).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'didww-v3'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install didww-v3
## Usage
```ruby
require 'didww'
client = DIDWW::Client.configure do |config|
config.api_key = '34ffe988432b980f4ba19432539b704f'
config.api_mode = :sandbox
end
client.balance
```
For details on obtaining your API key please visit https://doc.didww.com/api#introduction-api-keys
See integration example at https://github.com/didww/didww-v3-rails-sample
## Resource Relationships
See [docs/resource_relationships.md](docs/resource_relationships.md) for a Mermaid ER diagram showing all `has_one`, `has_many`, and `belongs_to` relationships between resources.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/didww/didww-v3-ruby.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).