nexmo 5.8.0 → 5.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a8fa58dc0863e21f46d996987b49b60b6963db2ea256bdc6c9066fb3101b5f4
-  data.tar.gz: 7d34456fd79e02c343bd8560672f12f2ce5d20a4d9a62544d3681acc1125c03e
+  metadata.gz: be987b38a38248e453aea6b9ea2497c90f217c28c0390660fbe662dc5d803153
+  data.tar.gz: b497634a50563e3585438756a3b49cedda24292a0c0ffc23eab44f4a88b11f1e
 SHA512:
-  metadata.gz: 5df6af3604e8d560de92e971e8e120cea313dbf8b174887ae267ad521426af78f9e1b9c294f207978cad193f90c2c439c4207d44a72b2f689a15cdb1fde55c0b
-  data.tar.gz: 705e44a45ae5459c9ad7eb973becd2e487d4fce45d19c9fa03d67ce7f454b02d836a8bb692288e19e69c383aa194ac31c9367bc88c5d3a96af3e570dbac2e920
+  metadata.gz: 523601a55f30f41b2120447f706c3dbac0f09266af1cab4b4c0649d0007d0e811ada5e47a7e16475e8d33c8e05d5bec94bdbf7269d9fe41acd21181937e474df
+  data.tar.gz: 93d788bbe424ed9076405eec77311e2880281dcd42f68996655f94679bd76c4ce4579f1751adcfa1d31041ec4bd140ac759f9121a6a83a0425c71605132fd2dc

data/README.md

@@ -1,6 +1,6 @@
 # Nexmo Client Library for Ruby
 
-[![Gem Version](https://badge.fury.io/rb/nexmo.svg)](https://badge.fury.io/rb/nexmo) [![Build Status](https://api.travis-ci.org/Nexmo/nexmo-ruby.svg?branch=master)](https://travis-ci.org/Nexmo/nexmo-ruby)
+[![Gem Version](https://badge.fury.io/rb/nexmo.svg)](https://badge.fury.io/rb/nexmo) [![Build Status](https://api.travis-ci.org/Nexmo/nexmo-ruby.svg?branch=master)](https://travis-ci.org/Nexmo/nexmo-ruby) [![Coverage Status](https://coveralls.io/repos/github/Nexmo/nexmo-ruby/badge.svg?branch=coveralls)](https://coveralls.io/github/Nexmo/nexmo-ruby?branch=master)
 
 This is the Ruby client library for Nexmo's API. To use it you'll
 need a Nexmo account. Sign up [for free at nexmo.com][signup].

data/lib/nexmo.rb

@@ -8,7 +8,7 @@ require 'nexmo/signature'
 require 'nexmo/user_agent'
 require 'nexmo/keys'
 require 'nexmo/entity'
-require 'nexmo/problem'
+require 'nexmo/errors'
 require 'nexmo/errors/error'
 require 'nexmo/errors/client_error'
 require 'nexmo/errors/server_error'

data/lib/nexmo/account.rb

@@ -2,16 +2,51 @@
 
 module Nexmo
   class Account < Namespace
+    include Keys
+
     self.host = 'rest.nexmo.com'
 
+    # Retrieve your account balance.
+    #
+    # @return [Entity]
+    #
+    # @see https://developer.nexmo.com/api/developer/account#get-balance
+    #
     def balance
       request('/account/get-balance')
     end
 
+    # Update the default callback URLs (where the webhooks are sent to) associated with your account.
+    #
+    # @note The URLs you provide must be valid and active. Nexmo will check that they return a 200 OK response before the setting is saved.
+    #
+    # @option params [String] :mo_call_back_url
+    #   The URL where Nexmo will send a webhook when an SMS is received to a Nexmo number that does not have SMS handling configured.
+    #   Send an empty string to unset this value.
+    #
+    # @option params [String] :dr_call_back_url
+    #   The URL where Nexmo will send a webhook when an delivery receipt is received without a specific callback URL configured.
+    #   Send an empty string to unset this value.
+    #
+    # @param [Hash] params
+    #
+    # @return [Entity]
+    #
+    # @see https://developer.nexmo.com/api/developer/account#settings
+    #
     def update(params)
-      request('/account/settings', params: params, type: Post)
+      request('/account/settings', params: camelcase(params), type: Post)
     end
 
+    # Top-up your account balance.
+    #
+    # @option params [required, String] :trx
+    #   The ID associated with your original auto-reload transaction.
+    #
+    # @param [Hash] params
+    #
+    # @see https://developer.nexmo.com/api/developer/account#top-up
+    #
     def topup(params)
       request('/account/top-up', params: params, type: Post)
     end

data/lib/nexmo/alerts.rb

@@ -4,16 +4,62 @@ module Nexmo
   class Alerts < Namespace
     self.host = 'rest.nexmo.com'
 
+    # Request the list of phone numbers opted out from your campaign.
+    #
+    # @see https://developer.nexmo.com/api/sms/us-short-codes/alerts/subscription
+    #
+    # @return [Entity]
+    #
     def list
       request('/sc/us/alert/opt-in/query/json')
     end
 
+    # Remove a phone number from the opt-out list.
+    #
+    # @option params [required, String] :msisdn
+    #   The phone number to resubscribe to your campaign and remove from the opt-out list.
+    #
+    # @param [Hash] params
+    #
+    # @return [Entity]
+    #
+    # @see https://developer.nexmo.com/api/sms/us-short-codes/alerts/subscription
+    #
     def remove(params)
       request('/sc/us/alert/opt-in/manage/json', params: params, type: Post)
     end
 
     alias_method :resubscribe, :remove
 
+    # Send an alert to your user.
+    #
+    # @option params [required, String] :to
+    #   The single phone number to send pin to.
+    #   Mobile number in US format and one recipient per request.
+    #
+    # @option params [Integer] :status_report_req
+    #   Set to 1 to receive a delivery receipt.
+    #   To receive the delivery receipt, you have to configure a webhook endpoint in Dashboard.
+    #
+    # @option params [String] :client_ref
+    #   A 40 character reference string for your internal reporting.
+    #
+    # @option params [Integer] :template
+    #   If you have multiple templates, this is the index of the template to call.
+    #   The default template starts is 0, each Event Based Alert campaign can have up to 6 templates.
+    #   If you have one template only it is the default. That is, template=0.
+    #   If you create a request with template=1 the API call will default, template=0 instead.
+    #   After you add a valid campaign alert for 2FA, the request will call template 1 instead of template 0.
+    #
+    # @option params [String] :type
+    #   Default value is `text`. Possible values are: `text` for plain text SMS or `unicode` only use this when your SMS must contain special characters.
+    #
+    # @param [Hash] params
+    #
+    # @return [Entity]
+    #
+    # @see https://developer.nexmo.com/api/sms/us-short-codes/alerts/sending
+    #
     def send(params)
       request('/sc/us/alert/json', params: params, type: Post)
     end

data/lib/nexmo/applications.rb

@@ -4,22 +4,140 @@ module Nexmo
   class Applications < Namespace
     self.request_body = JSON
 
+    # Create a new application.
+    #
+    # @example
+    #   params = {
+    #     name: 'Example App',
+    #     type: 'voice',
+    #     answer_url: answer_url,
+    #     event_url: event_url
+    #   }
+    #
+    #   response = client.applications.create(params)
+    #
+    # @option params [required, String] :name
+    #   The name of your application.
+    #
+    # @option params [required, String] :type
+    #   The Nexmo product or products that you access with this application.
+    #   Currently only `voice` and `messages` are supported.
+    #
+    # @option params [required, String] :answer_url
+    #   The URL where your webhook delivers the Nexmo Call Control Object that governs this call.
+    #   As soon as your user answers a call Nexmo makes a request to answer_url.
+    #
+    # @option params [String] :answer_method
+    #   The HTTP method used to make the request to answer_url.
+    #   The default value is GET.
+    #
+    # @option params [required, String] :event_url
+    #   Nexmo sends event information asynchronously to this URL when status changes.
+    #
+    # @option params [String] :event_method
+    #   The HTTP method used to send event information to event_url.
+    #   The default value is POST.
+    #
+    # @param [Hash] params
+    #
+    # @return [Entity]
+    #
+    # @see https://developer.nexmo.com/api/application#create-an-application
+    #
     def create(params)
       request('/v1/applications', params: params, type: Post)
     end
 
+    # Retrieve details of all applications associated with your account.
+    #
+    # @example
+    #   response = client.applications.list
+    #   response._embedded.applications.each do |item|
+    #     puts "#{item.id} #{item.name}"
+    #   end
+    #
+    # @option params [Integer] :page_size
+    #   Set the number of items returned on each call to this endpoint.
+    #   The default is 10 records.
+    #
+    # @option params [Integer] :page_index
+    #   Set the offset from the first page.
+    #   The default value is 0.
+    #
+    # @param [Hash, nil] params
+    #
+    # @return [Entity]
+    #
+    # @see https://developer.nexmo.com/api/application#retrieve-your-applications
+    #
     def list(params = nil)
       request('/v1/applications', params: params)
     end
 
+    # Retrieve details about a single application.
+    #
+    # @example
+    #   response = client.applications.get(id)
+    #
+    # @param [String] id
+    #
+    # @return [Entity]
+    #
+    # @see https://developer.nexmo.com/api/application#retrieve-an-application
+    #
     def get(id)
       request('/v1/applications/' + id)
     end
 
+    # Update an existing application.
+    #
+    # @example
+    #   response = client.applications.update(id, answer_method: 'POST')
+    #
+    # @option params [required, String] :name
+    #   The name of your application.
+    #
+    # @option params [required, String] :type
+    #   The Nexmo product or products that you access with this application.
+    #   Currently only `voice` and `messages` are supported.
+    #
+    # @option params [required, String] :answer_url
+    #   The URL where your webhook delivers the Nexmo Call Control Object that governs this call.
+    #   As soon as your user answers a call Nexmo makes a request to answer_url.
+    #
+    # @option params [String] :answer_method
+    #   The HTTP method used to make the request to answer_url.
+    #   The default value is GET.
+    #
+    # @option params [required, String] :event_url
+    #   Nexmo sends event information asynchronously to this URL when status changes.
+    #
+    # @option params [String] :event_method
+    #   The HTTP method used to send event information to event_url.
+    #   The default value is POST.
+    #
+    # @param [String] id
+    # @param [Hash] params
+    #
+    # @return [Entity]
+    #
+    # @see https://developer.nexmo.com/api/application#update-an-application
+    #
     def update(id, params)
       request('/v1/applications/' + id, params: params, type: Put)
     end
 
+    # Delete a single application.
+    #
+    # @example
+    #   response = client.applications.delete(id)
+    #
+    # @param [String] id
+    #
+    # @return [:no_content]
+    #
+    # @see https://developer.nexmo.com/api/application#destroy-an-application
+    #
     def delete(id)
       request('/v1/applications/' + id, type: Delete)
     end

data/lib/nexmo/applications_v2.rb

@@ -8,22 +8,93 @@ module Nexmo
 
     self.request_headers['Content-Type'] = 'application/json'
 
+    # Create an application.
+    #
+    # @option params [required, String] :name
+    #   Application name.
+    #
+    # @option params [Hash] :keys
+    #   - **:public_key** (String) Public key
+    #
+    # @option params [Hash] :capabilities
+    #   Your application can use multiple products.
+    #   This contains the configuration for each product.
+    #   This replaces the application `type` from version 1 of the Application API.
+    #
+    # @param [Hash] params
+    #
+    # @return [Entity]
+    #
+    # @see https://developer.nexmo.com/api/application.v2#createApplication
+    #
     def create(params)
       request('/v2/applications', params: params, type: Post)
     end
 
+    # List available applications.
+    #
+    # @option params [Integer] :page_size
+    #   The number of applications per page.
+    #
+    # @option params [Integer] :page
+    #   The current page number (starts at 1).
+    #
+    # @param [Hash] params
+    #
+    # @return [Entity]
+    #
+    # @see https://developer.nexmo.com/api/application.v2#listApplication
+    #
     def list(params = nil)
       request('/v2/applications', params: params)
     end
 
+    # Get an application.
+    #
+    # @param [String] id
+    #
+    # @return [Entity]
+    #
+    # @see https://developer.nexmo.com/api/application.v2#getApplication
+    #
     def get(id)
       request('/v2/applications/' + id)
     end
 
+    # Update an application.
+    #
+    # @option params [required, String] :name
+    #   Application name.
+    #
+    # @option params [Hash] :keys
+    #   - **:public_key** (String) Public key
+    #
+    # @option params [Hash] :capabilities
+    #   Your application can use multiple products.
+    #   This contains the configuration for each product.
+    #   This replaces the application `type` from version 1 of the Application API.
+    #
+    # @param [String] id
+    # @param [Hash] params
+    #
+    # @return [Entity]
+    #
+    # @see https://developer.nexmo.com/api/application.v2#updateApplication
+    #
     def update(id, params)
       request('/v2/applications/' + id, params: params, type: Put)
     end
 
+    # Delete an application.
+    #
+    # @note Deleting an application cannot be undone.
+    #
+    # @param [String] id
+    #
+    # @return [Entity]
+    #
+    # @see https://developer.nexmo.com/api/application.v2#deleteApplication
+    #
     def delete(id)
       request('/v2/applications/' + id, type: Delete)
     end

data/lib/nexmo/authentication/abstract.rb

@@ -1,7 +1,9 @@
 module Nexmo
-  class AbstractAuthentication # :nodoc:
+  class AbstractAuthentication
     def initialize(client)
       @client = client
     end
   end
+
+  private_constant :AbstractAuthentication
 end

data/lib/nexmo/authentication/basic.rb

@@ -1,9 +1,11 @@
 module Nexmo
-  class Basic < AbstractAuthentication # :nodoc:
+  class Basic < AbstractAuthentication
     def update(object)
       return unless object.is_a?(Net::HTTPRequest)
 
       object.basic_auth(@client.api_key, @client.api_secret)
     end
   end
+
+  private_constant :Basic
 end

data/lib/nexmo/authentication/bearer_token.rb

@@ -1,11 +1,13 @@
 # frozen_string_literal: true
 
 module Nexmo
-  class BearerToken < AbstractAuthentication # :nodoc:
+  class BearerToken < AbstractAuthentication
     def update(object)
       return unless object.is_a?(Net::HTTPRequest)
 
       object['Authorization'] = 'Bearer ' + @client.token
     end
   end
+
+  private_constant :BearerToken
 end

data/lib/nexmo/authentication/key_secret_params.rb

@@ -1,5 +1,5 @@
 module Nexmo
-  class KeySecretParams < AbstractAuthentication # :nodoc:
+  class KeySecretParams < AbstractAuthentication
     def update(object)
       return unless object.is_a?(Hash)
 
@@ -7,4 +7,6 @@ module Nexmo
       object[:api_secret] = @client.api_secret
     end
   end
+
+  private_constant :KeySecretParams
 end

data/lib/nexmo/authentication/key_secret_query.rb

@@ -1,5 +1,5 @@
 module Nexmo
-  class KeySecretQuery < AbstractAuthentication # :nodoc:
+  class KeySecretQuery < AbstractAuthentication
     def update(object)
       return unless object.is_a?(URI)
 
@@ -15,4 +15,6 @@ module Nexmo
       }
     end
   end
+
+  private_constant :KeySecretQuery
 end