RubyGems - nexmo - Versions diffs - 5.9.0 → 6.0.0 - Mend

nexmo 5.9.0 → 6.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (52) hide show

checksums.yaml +4 -4
data/README.md +35 -465
data/lib/nexmo.rb +31 -48
data/lib/nexmo/{authentication/abstract.rb → abstract_authentication.rb} +2 -2
data/lib/nexmo/account.rb +4 -2
data/lib/nexmo/alerts.rb +3 -3
data/lib/nexmo/applications.rb +45 -63
data/lib/nexmo/applications/list_response.rb +9 -0
data/lib/nexmo/{errors/authentication_error.rb → authentication_error.rb} +0 -0
data/lib/nexmo/{authentication/basic.rb → basic.rb} +1 -1
data/lib/nexmo/{authentication/bearer_token.rb → bearer_token.rb} +1 -1
data/lib/nexmo/calls.rb +18 -18
data/lib/nexmo/{call_dtmf.rb → calls/dtmf.rb} +2 -2
data/lib/nexmo/calls/list_response.rb +9 -0
data/lib/nexmo/{call_stream.rb → calls/stream.rb} +3 -3
data/lib/nexmo/{call_talk.rb → calls/talk.rb} +3 -3
data/lib/nexmo/client.rb +20 -169
data/lib/nexmo/{errors/client_error.rb → client_error.rb} +0 -0
data/lib/nexmo/config.rb +165 -0
data/lib/nexmo/conversations.rb +44 -13
data/lib/nexmo/{conversation_events.rb → conversations/events.rb} +5 -5
data/lib/nexmo/{conversation_legs.rb → conversations/legs.rb} +3 -3
data/lib/nexmo/{conversation_members.rb → conversations/members.rb} +6 -6
data/lib/nexmo/{conversation_users.rb → conversations/users.rb} +6 -6
data/lib/nexmo/entity.rb +14 -0
data/lib/nexmo/{errors/error.rb → error.rb} +0 -0
data/lib/nexmo/files.rb +1 -2
data/lib/nexmo/gsm7.rb +13 -0
data/lib/nexmo/{authentication/key_secret_params.rb → key_secret_params.rb} +2 -2
data/lib/nexmo/{authentication/key_secret_query.rb → key_secret_query.rb} +2 -2
data/lib/nexmo/keys.rb +4 -22
data/lib/nexmo/namespace.rb +22 -12
data/lib/nexmo/number_insight.rb +6 -4
data/lib/nexmo/number_insight/response.rb +5 -0
data/lib/nexmo/numbers.rb +20 -12
data/lib/nexmo/numbers/list_response.rb +9 -0
data/lib/nexmo/numbers/response.rb +7 -0
data/lib/nexmo/pricing.rb +2 -2
data/lib/nexmo/pricing_types.rb +4 -4
data/lib/nexmo/redact.rb +1 -1
data/lib/nexmo/response.rb +23 -0
data/lib/nexmo/secrets.rb +7 -7
data/lib/nexmo/secrets/list_response.rb +9 -0
data/lib/nexmo/{errors/server_error.rb → server_error.rb} +0 -0
data/lib/nexmo/sms.rb +17 -3
data/lib/nexmo/sms/response.rb +7 -0
data/lib/nexmo/verify.rb +10 -8
data/lib/nexmo/verify/response.rb +5 -0
data/lib/nexmo/version.rb +1 -1
data/nexmo.gemspec +4 -2
metadata +45 -20
data/lib/nexmo/applications_v2.rb +0 -102

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be987b38a38248e453aea6b9ea2497c90f217c28c0390660fbe662dc5d803153
-  data.tar.gz: b497634a50563e3585438756a3b49cedda24292a0c0ffc23eab44f4a88b11f1e
+  metadata.gz: 5e702df1de8b82ca41c9e2eb4c74d728dcb085bb9acfa8c5f923f4d784fae31f
+  data.tar.gz: d57281c6ca1f226264089cf7b8fb1f9225387d0e467260db4425f1ae80dbf545
 SHA512:
-  metadata.gz: 523601a55f30f41b2120447f706c3dbac0f09266af1cab4b4c0649d0007d0e811ada5e47a7e16475e8d33c8e05d5bec94bdbf7269d9fe41acd21181937e474df
-  data.tar.gz: 93d788bbe424ed9076405eec77311e2880281dcd42f68996655f94679bd76c4ce4579f1751adcfa1d31041ec4bd140ac759f9121a6a83a0425c71605132fd2dc
+  metadata.gz: 3e698a4c3111bd3617256d548ac937b63c8b7d32bc08214eaa5fa17ee5d3725a03786a45e5fb2df6ee4e85e9e3db1f3668eaac47c92aeb0f4a0cee54575cff39
+  data.tar.gz: 6c395081cef140f543c2029ccc14a6f248467db19696c0f1455013253435afd677d224570d756d07a010fef3eb37cfd561015bf200bbb94adfecb4cfdaa86dc4

data/README.md CHANGED

@@ -8,26 +8,16 @@ need a Nexmo account. Sign up [for free at nexmo.com][signup].
 * [Requirements](#requirements)
 * [Installation](#installation)
 * [Usage](#usage)
-* [SMS API](#sms-api)
-* [2FA API](#2fa-api)
-* [Voice API](#voice-api)
-* [Verify API](#verify-api)
-* [Conversation API](#conversation-api)
-* [Number Insight API](#number-insight-api)
-* [Application API](#application-api)
-* [Numbers API](#numbers-api)
-* [Secret Management API](#secret-management-api)
-* [Redact API](#redact-api)
 * [Logging](#logging)
 * [JWT authentication](#jwt-authentication)
 * [Webhook signatures](#webhook-signatures)
-* [API coverage](#api-coverage)
+* [Documentation](#documentation)
 * [License](#license)
 ## Requirements
-Nexmo Ruby supports CRuby 2.1.0+ and JRuby 9k.
+Nexmo Ruby supports MRI/CRuby (2.5 or newer), JRuby (9.2.x), and Truffleruby.
 ## Installation
@@ -55,421 +45,20 @@ Then construct a client object with your key and secret:
 client = Nexmo::Client.new(api_key: 'YOUR-API-KEY', api_secret: 'YOUR-API-SECRET')
 ```
-You can now use the client object to [send an SMS](#send-an-sms),
-[start a verification](#start-a-verification), or [create an application](#create-an-application).
-For production you can specify the `NEXMO_API_KEY` and `NEXMO_API_SECRET`
-environment variables instead of specifying the key and secret explicitly,
-keeping your credentials out of source control.
-## Credentials
-To check signatures for incoming webhook requests you'll also need to specify
-the `signature_secret` argument:
-```ruby
-client = Nexmo::Client.new(signature_secret: 'secret')
-```
-Alternatively you can set the `NEXMO_SIGNATURE_SECRET` environment variable.
-To call newer endpoints that support JWT authentication such as the Voice API you'll
-also need to specify the `application_id` and `private_key` arguments. For example:
-```ruby
-client = Nexmo::Client.new(application_id: application_id, private_key: private_key)
-```
-Both arguments should have string values corresponding to the `id` and `private_key`
-values returned in a ["create an application"](#create-an-application) response. These
-credentials can be stored in a datastore, in environment variables, on disk outside
-of source control, or in some kind of key management infrastructure.
-## SMS API
-### Send an SMS
-```ruby
-response = client.sms.send(from: 'Ruby', to: 'YOUR NUMBER', text: 'Hello world')
-if response.messages.first.status == '0'
-  puts "Sent message id=#{response.messages.first.message_id}"
-else
-  puts "Error: #{response.messages.first.error_text}"
-end
-```
-Docs: [https://developer.nexmo.com/api/sms#send-an-sms](https://developer.nexmo.com/api/sms?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#send-an-sms)
-## 2FA API
-### Send a 2FA Token
-```ruby
-response = client.tfa.send(to: 'YOUR NUMBER', pin: '12345')
-if response.messages.first.status == '0'
-  puts "Sent message id=#{response.messages.first.message_id}"
-else
-  puts "Error: #{response.messages.first.error_text}"
-end
-```
-Docs: [https://developer.nexmo.com/api/sms/us-short-codes/2fa](https://developer.nexmo.com/api/sms/us-short-codes/2fa?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
-## Voice API
-### Create an outbound call
-```ruby
-response = client.calls.create({
-  to: [{type: 'phone', number: '14843331234'}],
-  from: {type: 'phone', number: '14843335555'},
-  answer_url: ['https://example.com/answer']
-})
-```
-Docs: [https://developer.nexmo.com/api/voice#createCall](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#createCall)
-### Get details of your calls
-```ruby
-response = client.calls.list
-```
-Docs: [https://developer.nexmo.com/api/voice#getCalls](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#getCalls)
-### Get detail of a specific call
-```ruby
-response = client.calls.get(uuid)
-```
-Docs: [https://developer.nexmo.com/api/voice#getCall](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#getCall)
-### Modify an in progress call
-```ruby
-response = client.calls.hangup(uuid)
-```
-Docs: [https://developer.nexmo.com/api/voice#updateCall](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#updateCall)
-### Play an audio file into a call
-```ruby
-stream_url = 'https://nexmo-community.github.io/ncco-examples/assets/voice_api_audio_streaming.mp3'
-response = client.calls.stream.start(uuid, stream_url: [stream_url])
-```
-Docs: [https://developer.nexmo.com/api/voice#startStream](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#startStream)
-### Stop playing an audio file into a call
-```ruby
-response = client.calls.stream.stop(uuid)
-```
-Docs: [https://developer.nexmo.com/api/voice#stopStream](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#stopStream)
-### Play text to speech into a call
-```ruby
-response = client.calls.talk.start(uuid, text: 'Hello')
-```
-Docs: [https://developer.nexmo.com/api/voice#startTalk](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#startTalk)
-### Stop text to speech in a call
-```ruby
-response = client.calls.talk.stop(uuid)
-```
-Docs: [https://developer.nexmo.com/api/voice#stopTalk](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#stopTalk)
-### Play DTMF tones into a call
-```ruby
-response = client.calls.dtmf.send(uuid, digits: '1234')
-```
-Docs: [https://developer.nexmo.com/api/voice#startDTMF](https://developer.nexmo.com/api/voice?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#startDTMF)
-## Verify API
-### Start a verification
-```ruby
-response = client.verify.request(number: '441632960960', brand: 'MyApp')
-if response.status == '0'
-  puts "Started verification request_id=#{response.request_id}"
-else
-  puts "Error: #{response.error_text}"
-end
-```
-Docs: [https://developer.nexmo.com/api/verify#verify-request](https://developer.nexmo.com/api/verify?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#verify-request)
-The response contains a verification request id which you will need to store temporarily.
-### Check a verification
-```ruby
-response = client.verify.check(request_id: '00e6c3377e5348cdaf567e1417c707a5', code: '1234')
-if response.status == '0'
-  puts "Verification complete, event_id=#{response.event_id}"
-else
-  puts "Error: #{response.error_text}"
-end
-```
-Docs: [https://developer.nexmo.com/api/verify#verify-check](https://developer.nexmo.com/api/verify?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#verify-check)
-The verification request id comes from the call to `client.verify.request`.
-The PIN code is entered into your application by the user.
-### Cancel a verification
-```ruby
-client.verify.cancel('00e6c3377e5348cdaf567e1417c707a5')
-```
-Docs: [https://developer.nexmo.com/api/verify#verify-control](https://developer.nexmo.com/api/verify?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#verify-control)
-### Trigger next verification step
-```ruby
-client.verify.trigger_next_event('00e6c3377e5348cdaf567e1417c707a5')
-```
-Docs: [https://developer.nexmo.com/api/verify#verify-control](https://developer.nexmo.com/api/verify?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#verify-control)
-## Conversation API
-### Create a conversation
-```ruby
-response = client.conversations.create(name: 'Example Conversation', display_name: 'Example Display Name')
-```
-Docs: [https://developer.nexmo.com/api/conversation#createConversation](https://developer.nexmo.com/api/conversation?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#createConversation)
-### Retrieve a list of conversations
-```ruby
-response = client.conversations.list
-```
-Docs: [https://developer.nexmo.com/api/conversation#listConversations](https://developer.nexmo.com/api/conversation?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#listConversations)
-### Retrieve a single conversation
+You can now use the client object to call Nexmo APIs. For example, to send an SMS:
 ```ruby
-response = client.conversations.get(conversation_id)
+client.sms.send(from: 'Ruby', to: '447700900000', text: 'Hello world')
 ```
-Docs: [https://developer.nexmo.com/api/conversation#retrieveConversation](https://developer.nexmo.com/api/conversation?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieveConversation)
-### Update a conversation
-```ruby
-response = client.conversations.update(conversation_id, answer_method: 'PUT')
-```
-Docs: [https://developer.nexmo.com/api/conversation#replaceConversation](https://developer.nexmo.com/api/conversation?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#replaceConversation)
-### Delete a conversation
-```ruby
-response = client.conversations.delete(conversation_id)
-```
-Docs: [https://developer.nexmo.com/api/conversation#deleteConversation](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#deleteConversation)
-## Number Insight API
-### Basic Number Insight
-```ruby
-client.number_insight.basic(number: '447700900000')
-```
-Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer.nexmo.com/api/number-insight?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#request)
-### Standard Number Insight
-```ruby
-client.number_insight.standard(number: '447700900000')
-```
-Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer.nexmo.com/api/number-insight?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#request)
-### Advanced Number Insight
-```ruby
-client.number_insight.advanced(number: '447700900000')
-```
-Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer.nexmo.com/api/number-insight?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#request)
-### Advanced Number Insight Async
-```ruby
-client.number_insight.advanced_async(number: '447700900000', callback: webhook_url)
-```
-The results of the API call will be sent via HTTP POST to the webhook URL specified in the callback parameter.
-Docs: [https://developer.nexmo.com/api/number-insight#request](https://developer.nexmo.com/api/number-insight?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#request)
-## Application API
-### Create an application
-```ruby
-response = client.applications.create(name: 'Example App', type: 'voice', answer_url: answer_url, event_url: event_url)
-```
-Docs: [https://developer.nexmo.com/api/application#create-an-application](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#create-an-application)
-### Retrieve a list of applications
-```ruby
-response = client.applications.list
-```
-Docs: [https://developer.nexmo.com/api/application#retrieve-your-applications](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieve-your-applications)
-### Retrieve a single application
-```ruby
-response = client.applications.get(uuid)
-```
-Docs: [https://developer.nexmo.com/api/application#retrieve-an-application](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieve-an-application)
-### Update an application
-```ruby
-response = client.applications.update(uuid, answer_method: 'POST')
-```
-Docs: [https://developer.nexmo.com/api/application#update-an-application](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#update-an-application)
-### Delete an application
-```ruby
-response = client.applications.delete(uuid)
-```
-Docs: [https://developer.nexmo.com/api/application#destroy-an-application](https://developer.nexmo.com/api/application?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#destroy-an-application)
-## Numbers API
-### List owned numbers
-```ruby
-client.numbers.list
-```
-Docs: [https://developer.nexmo.com/api/developer/numbers#list-owned-numbers](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#list-owned-numbers)
-### Search available numbers
-```ruby
-client.numbers.search(country: 'GB')
-```
-Docs: [https://developer.nexmo.com/api/developer/numbers#search-available-numbers](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#search-available-numbers)
-### Buy a number
-```ruby
-client.numbers.buy(country: 'GB', msisdn: '447700900000')
-```
-Docs: [https://developer.nexmo.com/api/developer/numbers#buy-a-number](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#buy-a-number)
-### Cancel a number
-```ruby
-client.numbers.cancel(country: 'GB', msisdn: '447700900000')
-```
-Docs: [https://developer.nexmo.com/api/developer/numbers#cancel-a-number](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#cancel-a-number)
-### Update a number
-```ruby
-client.numbers.update(country: 'GB', msisdn: '447700900000', voice_callback_type: 'app', voice_callback_value: application_id)
-```
-Docs: [https://developer.nexmo.com/api/developer/numbers#update-a-number](https://developer.nexmo.com/api/developer/numbers?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#update-a-number)
-## Secret Management API
-### Retrieve a list of secrets
-```ruby
-client.secrets.list
-```
-Docs: [https://developer.nexmo.com/api/account/secret-management#retrieveSecrets](https://developer.nexmo.com/api/account/secret-management?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieveSecrets)
-### Create a secret
-```ruby
-client.secrets.create(secret: 't0ps3cr3t')
-```
-Docs: [https://developer.nexmo.com/api/account/secret-management#createSecret](https://developer.nexmo.com/api/account/secret-management?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#createSecret)
-### Retrieve a secret
-```ruby
-client.secrets.get(secret_id)
-```
-Docs: [https://developer.nexmo.com/api/account/secret-management#retrieveSecret](https://developer.nexmo.com/api/account/secret-management?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#retrieveSecret)
-### Revoke a secret
-```ruby
-client.secrets.revoke(secret_id)
-```
-Docs: [https://developer.nexmo.com/api/account/secret-management#revokeSecret](https://developer.nexmo.com/api/account/secret-management?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#revokeSecret)
-## Redact API
-### Redact a specific message
-```ruby
-client.redact.transaction(id: '00A0B0C0', product: 'sms')
-```
-Docs: [https://developer.nexmo.com/api/redact#transaction](https://developer.nexmo.com/api/redact?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library#transaction)
+For production you can specify the `NEXMO_API_KEY` and `NEXMO_API_SECRET`
+environment variables instead of specifying the key and secret explicitly,
+keeping your credentials out of source control.
 ## Logging
-Use the logger option or attribute writer method to specify a logger. For example:
+Use the logger option to specify a logger. For example:
 ```ruby
 require 'logger'
@@ -486,11 +75,21 @@ To disable logging set the logger to `nil`.
 ## JWT authentication
-By default the library generates a short lived JWT per request.
+To call newer endpoints that support JWT authentication such as the Voice API you'll
+also need to specify the `application_id` and `private_key` options. For example:
+```ruby
+client = Nexmo::Client.new(application_id: application_id, private_key: private_key)
+```
+Both arguments should have string values corresponding to the `id` and `private_key`
+values returned in a ["create an application"](https://developer.nexmo.com/api/application.v2#createApplication)
+response. These credentials can be stored in a datastore, in environment variables,
+on disk outside of source control, or in some kind of key management infrastructure.
-To generate a long lived JWT for multiple requests or to specify JWT claims
-directly call `Nexmo::JWT.generate` to generate a token, and set the token
-attribute on the client object. For example:
+By default the library generates a short lived JWT per request. To generate a long lived
+JWT for multiple requests or to specify JWT claims directly use `Nexmo::JWT.generate` and
+the token option. For example:
 ```ruby
 claims = {
@@ -502,12 +101,16 @@ claims = {
 private_key = File.read('path/to/private.key')
-client.token = Nexmo::JWT.generate(claims, private_key)
+token = Nexmo::JWT.generate(claims, private_key)
+client = Nexmo::Client.new(token: token)
 ````
 ## Webhook signatures
+To check webhook signatures you'll also need to specify the `signature_secret` option. For example:
 ```ruby
 client = Nexmo::Client.new(signature_secret: 'secret')
@@ -518,51 +121,18 @@ else
 end
 ```
-Docs: [https://developer.nexmo.com/concepts/guides/signing-messages](https://developer.nexmo.com/concepts/guides/signing-messages?utm_source=DEV_REL&utm_medium=github&utm_campaign=ruby-client-library)
+Alternatively you can set the `NEXMO_SIGNATURE_SECRET` environment variable.
 Note: you'll need to contact support@nexmo.com to enable message signing on your account.
-## API coverage
-* Account
-    * [X] Balance
-    * [X] Pricing
-    * [X] Settings
-    * [X] Top Up
-    * [X] Numbers
-        * [X] Search
-        * [X] Buy
-        * [X] Cancel
-        * [X] Update
-* Number Insight
-    * [X] Basic
-    * [X] Standard
-    * [X] Advanced
-    * [ ] Webhook Notification
-* Verify
-    * [X] Verify
-    * [X] Check
-    * [X] Search
-    * [X] Control
-* Messaging
-    * [X] Send
-    * [ ] Delivery Receipt
-    * [ ] Inbound Messages
-    * [X] Search
-        * [X] Message
-        * [X] Messages
-        * [X] Rejections
-    * [X] US Short Codes
-        * [X] Two-Factor Authentication
-        * [X] Event Based Alerts
-            * [X] Sending Alerts
-            * [X] Campaign Subscription Management
-* Voice
-    * [X] Outbound Calls
-    * [ ] Inbound Call
-    * [X] Text-To-Speech Call
-    * [X] Text-To-Speech Prompt
+## Documentation
+Nexmo Ruby documentation: https://www.rubydoc.info/github/nexmo/nexmo-ruby
+Nexmo Ruby code examples: https://github.com/Nexmo/nexmo-ruby-code-snippets
+Nexmo API reference: https://developer.nexmo.com/api
 ## License