nexmo 6.3.0 → 7.2.0

data/lib/nexmo/messages.rb

@@ -1,18 +1,23 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Messages < Namespace
+    extend T::Sig
+
     self.host = :rest_host
 
+    sig { params(id: String).returns(Nexmo::Response) }
     def get(id)
       request('/search/message', params: {id: id})
     end
 
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def search(params)
       request('/search/messages', params: params)
     end
 
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def rejections(params)
       request('/search/rejections', params: params)
     end

data/lib/nexmo/namespace.rb

@@ -46,14 +46,6 @@ module Nexmo
       @request_headers ||= {}
     end
 
-    def self.response_class
-      @response_class ||= Response
-    end
-
-    def self.response_class=(response_class)
-      @response_class = response_class
-    end
-
     protected
 
     Get = Net::HTTP::Get
@@ -61,7 +53,7 @@ module Nexmo
     Post = Net::HTTP::Post
     Delete = Net::HTTP::Delete
 
-    def request(path, params: nil, type: Get, response_class: nil, &block)
+    def request(path, params: nil, type: Get, response_class: Response, &block)
       uri = URI('https://' + @host + path)
 
       params ||= {}
@@ -97,7 +89,7 @@ module Nexmo
 
       logger.debug(response.body) if response.body
 
-      parse(response, response_class || self.class.response_class)
+      parse(response, response_class)
     end
 
     def parse(response, response_class)

data/lib/nexmo/number_insight.rb

@@ -1,10 +1,8 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo
   class NumberInsight < Namespace
-    self.response_class = Response
-
     # Provides basic number insight information about a number.
     #
     # @example
@@ -25,7 +23,11 @@ module Nexmo
     # @see https://developer.nexmo.com/api/number-insight#getNumberInsightBasic
     #
     def basic(params)
-      request('/ni/basic/json', params: params)
+      response = request('/ni/basic/json', params: params)
+
+      raise Error, response[:status_message] unless response.status.zero?
+
+      response
     end
 
     # Provides standard number insight information about a number.
@@ -53,7 +55,11 @@ module Nexmo
     # @see https://developer.nexmo.com/api/number-insight#getNumberInsightStandard
     #
     def standard(params)
-      request('/ni/standard/json', params: params)
+      response = request('/ni/standard/json', params: params)
+
+      raise Error, response[:status_message] unless response.status.zero?
+
+      response
     end
 
     # Provides advanced number insight information about a number synchronously.
@@ -85,7 +91,11 @@ module Nexmo
     # @see https://developer.nexmo.com/api/number-insight#getNumberInsightAdvanced
     #
     def advanced(params)
-      request('/ni/advanced/json', params: params)
+      response = request('/ni/advanced/json', params: params)
+
+      raise Error, response[:status_message] unless response.status.zero?
+
+      response
     end
 
     # Provides advanced number insight number information *asynchronously* using the URL specified in the callback parameter.
@@ -120,7 +130,11 @@ module Nexmo
     # @see https://developer.nexmo.com/api/number-insight#getNumberInsightAsync
     #
     def advanced_async(params)
-      request('/ni/advanced/async/json', params: params)
+      response = request('/ni/advanced/async/json', params: params)
+
+      raise Error, response[:status_message] unless response.status.zero?
+
+      response
     end
   end
 end

data/lib/nexmo/numbers.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo

data/lib/nexmo/pricing.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo

data/lib/nexmo/pricing_types.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo

data/lib/nexmo/redact.rb

@@ -1,8 +1,10 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Redact < Namespace
+    extend T::Sig
+
     self.authentication = Basic
 
     self.request_body = JSON
@@ -27,6 +29,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/redact#redact-message
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def transaction(params)
       request('/v1/redact/transaction', params: params, type: Post)
     end

data/lib/nexmo/response.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 
 module Nexmo
   class Response

data/lib/nexmo/secrets.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo

data/lib/nexmo/signature.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 require 'openssl'
 require 'digest/md5'

data/lib/nexmo/sms.rb

@@ -13,11 +13,7 @@ module Nexmo
     # @example
     #   response = client.sms.send(from: 'Ruby', to: '447700900000', text: 'Hello world')
     #
-    #   if response.success?
-    #     puts "Sent message id=#{response.messages.first.message_id}"
-    #   else
-    #     puts "Error: #{response.messages.first.error_text}"
-    #   end
+    #   puts "Sent message id=#{response.messages.first.message_id}"
     #
     # @option params [required, String] :from
     #   The name or number the message should be sent from.
@@ -96,7 +92,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/sms#send-an-sms
     #
-    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::SMS::Response) }
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def send(params)
       if unicode?(params.fetch(:text)) && params[:type] != 'unicode'
         message = 'Sending unicode text SMS without setting the type parameter to "unicode". ' \
@@ -106,14 +102,20 @@ module Nexmo
         logger.warn(message)
       end
 
-      request('/sms/json', params: hyphenate(params), type: Post, response_class: Response)
+      response = request('/sms/json', params: hyphenate(params), type: Post)
+
+      unless response.messages.first.status == '0'
+        raise Error, response.messages.first[:error_text]
+      end
+
+      response
     end
 
     private
 
     sig { params(text: String).returns(T::Boolean) }
     def unicode?(text)
-      !GSM7.encoded?(text)
+      !Nexmo::GSM7.encoded?(text)
     end
   end
 end

data/lib/nexmo/tfa.rb

@@ -1,4 +1,4 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo

data/lib/nexmo/verify.rb

@@ -1,14 +1,13 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 module Nexmo
   class Verify < Namespace
+    extend T::Sig
     alias_method :http_request, :request
 
     private :http_request
 
-    self.response_class = Response
-
     # Generate and send a PIN to your user.
     #
     # @note You can make a maximum of one Verify request per second.
@@ -16,11 +15,7 @@ module Nexmo
     # @example
     #   response = client.verify.request(number: '447700900000', brand: 'Acme Inc')
     #
-    #   if response.success?
-    #     puts "Started verification request_id=#{response.request_id}"
-    #   else
-    #     puts "Error: #{response.error_text}"
-    #   end
+    #   puts "Started verification request_id=#{response.request_id}"
     #
     # @option params [required, String] :number
     #   The mobile or landline phone number to verify.
@@ -65,8 +60,13 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyRequest
     #
-    def request(params)
-      http_request('/verify/json', params: params, type: Post)
+    sig { params(params: T.untyped, uri: T.untyped).returns(T.untyped) }
+    def request(params, uri = '/verify/json')
+      response = http_request(uri, params: params, type: Post)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
     end
 
     # Confirm that the PIN you received from your user matches the one sent by Nexmo in your verification request.
@@ -74,11 +74,7 @@ module Nexmo
     # @example
     #   response = client.verify.check(request_id: request_id, code: '1234')
     #
-    #   if response.success?
-    #     puts "Verification complete, event_id=#{response.event_id}"
-    #   else
-    #     puts "Error: #{response.error_text}"
-    #   end
+    #   puts "Verification complete, event_id=#{response.event_id}"
     #
     # @option params [required, String] :request_id
     #   The Verify request to check.
@@ -97,8 +93,13 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyCheck
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Nexmo::Response) }
     def check(params)
-      http_request('/verify/check/json', params: params, type: Post)
+      response = http_request('/verify/check/json', params: params, type: Post)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
     end
 
     # Check the status of past or current verification requests.
@@ -119,8 +120,13 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifySearch
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(T.any(T::Hash[Symbol, T.untyped], Nexmo::Response)) }
     def search(params)
-      http_request('/verify/search/json', params: params)
+      response = http_request('/verify/search/json', params: params)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
     end
 
     # Control the progress of your verification requests.
@@ -141,8 +147,13 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyControl
     #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(T.untyped) }
     def control(params)
-      http_request('/verify/control/json', params: params, type: Post)
+      response = http_request('/verify/control/json', params: params, type: Post)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
     end
 
     # Cancel an existing verification request.
@@ -156,6 +167,7 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyControl
     #
+    sig { params(id: String).returns(Nexmo::Response) }
     def cancel(id)
       control(request_id: id, cmd: 'cancel')
     end
@@ -171,8 +183,71 @@ module Nexmo
     #
     # @see https://developer.nexmo.com/api/verify#verifyControl
     #
+    sig { params(id: String).returns(Nexmo::Response) }
     def trigger_next_event(id)
       control(request_id: id, cmd: 'trigger_next_event')
     end
+
+    # Send a PSD2-compliant payment token to a user for payment authorization
+    #
+    # @example
+    #   response = client.verify.psd2(number: '447700900000', payee: 'Acme Inc', amount: 48.00)
+    #
+    # @option params [required, String] :number
+    #   The mobile or landline phone number to verify.
+    #   Unless you are setting **:country** explicitly, this number must be in E.164 format.
+    #
+    # @option params [String] :country
+    #   If you do not provide **:number** in international format or you are not sure if **:number** is correctly formatted, specify the two-character country code in **:country**.
+    #   Verify will then format the number for you.
+    #
+    # @option params [required, String] :payee
+    #   An alphanumeric string to indicate to the user the name of the recipient that they are confirming a payment to.
+    #
+    # @option params [required, Float] :amount
+    #   The decimal amount of the payment to be confirmed, in Euros
+    #
+    # @option params [Integer] :code_length
+    #   The length of the verification code.
+    #
+    # @option params [String] :lg
+    #   By default, the SMS or text-to-speech (TTS) message is generated in the locale that matches the **:number**.
+    #   For example, the text message or TTS message for a `33*` number is sent in French.
+    #   Use this parameter to explicitly control the language, accent and gender used for the Verify request.
+    #
+    # @option params [Integer] :pin_expiry
+    #   How log the generated verification code is valid for, in seconds.
+    #   When you specify both **:pin_expiry** and **:next_event_wait** then **:pin_expiry** must be an integer multiple of **:next_event_wait** otherwise **:pin_expiry** is defaulted to equal **:next_event_wait**.
+    #   See [changing the event timings](https://developer.nexmo.com/verify/guides/changing-default-timings).
+    #
+    # @option params [Integer] :next_event_wait
+    #   Specifies the wait time in seconds between attempts to deliver the verification code.
+    #
+    # @option params [Integer] :workflow_id
+    #   Selects the predefined sequence of SMS and TTS (Text To Speech) actions to use in order to convey the PIN to your user.
+    #   For example, an id of 1 identifies the workflow SMS - TTS - TTS.
+    #   For a list of all workflows and their associated ids, please visit the [developer portal](https://developer.nexmo.com/verify/guides/workflows-and-events).
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/verify#verifyRequestWithPSD2
+    #
+    sig { params(params: T.untyped, uri: T.untyped).returns(T.any(Nexmo::Error, Nexmo::Response)) }
+    def psd2(params, uri = '/verify/psd2/json')
+      response = http_request(uri, params: params, type: Post)
+
+      raise Error, response[:error_text] if error?(response)
+
+      response
+    end
+
+    private
+
+    sig { params(response: T.untyped).returns(T::Boolean) }
+    def error?(response)
+      response.respond_to?(:error_text)
+    end
   end
 end

data/lib/nexmo/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 
 module Nexmo
-  VERSION = '6.3.0'
+  VERSION = '7.2.0'
 end

data/lib/nexmo/{calls.rb → voice.rb}

@@ -1,8 +1,8 @@
-# typed: false
+# typed: true
 # frozen_string_literal: true
 
 module Nexmo
-  class Calls < Namespace
+  class Voice < Namespace
     self.authentication = BearerToken
 
     self.request_body = JSON
@@ -10,7 +10,7 @@ module Nexmo
     # Create an outbound Call.
     #
     # @example
-    #   response = client.calls.create({
+    #   response = client.voice.create({
     #     to: [{type: 'phone', number: '14843331234'}],
     #     from: {type: 'phone', number: '14843335555'},
     #     answer_url: ['https://example.com/answer']
@@ -61,7 +61,7 @@ module Nexmo
     # Get details of your calls.
     #
     # @example
-    #   response = client.calls.list
+    #   response = client.voice.list
     #   response.each do |item|
     #     puts "#{item.uuid} #{item.direction} #{item.status}"
     #   end
@@ -100,7 +100,7 @@ module Nexmo
     # Get detail of a specific call.
     #
     # @example
-    #   response = client.calls.get(id)
+    #   response = client.voice.get(id)
     #
     # @param [String] id
     #
@@ -115,7 +115,7 @@ module Nexmo
     # Modify an in progress call.
     #
     # @example
-    #   response = client.calls.update(id, action: 'hangup')
+    #   response = client.voice.update(id, action: 'hangup')
     #
     # @option params [required, String] :action
     #
@@ -136,7 +136,7 @@ module Nexmo
     # Hangup an in progress call.
     #
     # @example
-    #   response = client.calls.hangup(id)
+    #   response = client.voice.hangup(id)
     #
     # @param [String] id
     #
@@ -151,7 +151,7 @@ module Nexmo
     # Mute an in progress call.
     #
     # @example
-    #   response = client.calls.mute(id)
+    #   response = client.voice.mute(id)
     #
     # @param [String] id
     #
@@ -166,7 +166,7 @@ module Nexmo
     # Unmute an in progress call.
     #
     # @example
-    #   response = client.calls.unmute(id)
+    #   response = client.voice.unmute(id)
     #
     # @param [String] id
     #
@@ -181,7 +181,7 @@ module Nexmo
     # Earmuff an in progress call.
     #
     # @example
-    #   response = client.calls.earmuff(id)
+    #   response = client.voice.earmuff(id)
     #
     # @param [String] id
     #
@@ -196,7 +196,7 @@ module Nexmo
     # Unearmuff an in progress call.
     #
     # @example
-    #   response = client.calls.unearmuff(id)
+    #   response = client.voice.unearmuff(id)
     #
     # @param [String] id
     #
@@ -216,7 +216,7 @@ module Nexmo
     #     url: ['https://example.com/ncco.json']
     #   }
     #
-    #   response = client.calls.transfer(id, destination: destination)
+    #   response = client.voice.transfer(id, destination: destination)
     #
     # @param [String] id
     # @param [Hash] destination