vonage 7.2.0

data/lib/vonage/namespace.rb

@@ -0,0 +1,118 @@
+# typed: ignore
+# frozen_string_literal: true
+require 'net/http'
+require 'json'
+
+module Vonage
+  class Namespace
+    def initialize(config)
+      @config = config
+
+      @host = self.class.host == :api_host ? @config.api_host : @config.rest_host
+
+      @http = Net::HTTP.new(@host, Net::HTTP.https_default_port, p_addr = nil)
+      @http.use_ssl = true
+
+      @config.http.set(@http) unless @config.http.nil?
+    end
+
+    def self.host
+      @host ||= :api_host
+    end
+
+    def self.host=(host)
+      raise ArgumentError unless host == :rest_host
+
+      @host = host
+    end
+
+    def self.authentication
+      @authentication ||= KeySecretParams
+    end
+
+    def self.authentication=(authentication)
+      @authentication = authentication
+    end
+
+    def self.request_body
+      @request_body ||= FormData
+    end
+
+    def self.request_body=(request_body)
+      @request_body = request_body
+    end
+
+    def self.request_headers
+      @request_headers ||= {}
+    end
+
+    protected
+
+    Get = Net::HTTP::Get
+    Put = Net::HTTP::Put
+    Post = Net::HTTP::Post
+    Delete = Net::HTTP::Delete
+
+    def request(path, params: nil, type: Get, response_class: Response, &block)
+      uri = URI('https://' + @host + path)
+
+      params ||= {}
+
+      authentication = self.class.authentication.new(@config)
+      authentication.update(params)
+
+      unless type::REQUEST_HAS_BODY || params.empty?
+        uri.query = Params.encode(params)
+      end
+
+      authentication.update(uri)
+
+      message = type.new(uri)
+
+      message['User-Agent'] = UserAgent.string(@config.app_name, @config.app_version)
+
+      self.class.request_headers.each do |key, value|
+        message[key] = value
+      end
+
+      authentication.update(message)
+
+      self.class.request_body.update(message, params) if type::REQUEST_HAS_BODY
+
+      logger.log_request_info(message)
+
+      response = @http.request(message, &block)
+
+      logger.log_response_info(response, @host)
+
+      return if block
+
+      logger.debug(response.body) if response.body
+
+      parse(response, response_class)
+    end
+
+    def parse(response, response_class)
+      case response
+      when Net::HTTPNoContent
+        response_class.new(nil, response)
+      when Net::HTTPSuccess
+        if response['Content-Type'].split(';').first == 'application/json'
+          entity = ::JSON.parse(response.body, object_class: Vonage::Entity)
+
+          response_class.new(entity, response)
+        else
+          response_class.new(nil, response)
+        end
+      else
+        raise Errors.parse(response)
+      end
+    end
+
+    def logger
+      @config.logger
+    end
+  end
+
+  private_constant :Namespace
+end

data/lib/vonage/number_insight.rb

@@ -0,0 +1,140 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class NumberInsight < Namespace
+    # Provides basic number insight information about a number.
+    #
+    # @example
+    #   response = client.number_insight.basic(number: '447700900000')
+    #
+    # @option params [required, String] :number
+    #   A single phone number that you need insight about in national or international format.
+    #
+    # @option params [String] :country
+    #   If a number does not have a country code or is uncertain, set the two-character country code.
+    #   This code must be in ISO 3166-1 alpha-2 format and in upper case. For example, GB or US.
+    #   If you set country and number is already in E.164 format, country must match the country code in number.
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/number-insight#getNumberInsightBasic
+    #
+    def basic(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.
+    #
+    # @example
+    #   response = client.number_insight.standard(number: '447700900000')
+    #
+    # @option params [required, String] :number
+    #   A single phone number that you need insight about in national or international format.
+    #
+    # @option params [String] :country
+    #   If a number does not have a country code or is uncertain, set the two-character country code.
+    #   This code must be in ISO 3166-1 alpha-2 format and in upper case. For example, GB or US.
+    #   If you set country and number is already in E.164 format, country must match the country code in number.
+    #
+    # @option params [Boolean] :cnam
+    #   Indicates if the name of the person who owns the phone number should be looked up and returned in the response.
+    #   Set to true to receive phone number owner name in the response.
+    #   This features is available for US numbers only and incurs an additional charge.
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/number-insight#getNumberInsightStandard
+    #
+    def standard(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.
+    #
+    # @example
+    #   response = client.number_insight.advanced(number: '447700900000')
+    #
+    # @option params [required, String] :number
+    #   A single phone number that you need insight about in national or international format.
+    #
+    # @option params [String] :country
+    #   If a number does not have a country code or is uncertain, set the two-character country code.
+    #   This code must be in ISO 3166-1 alpha-2 format and in upper case. For example, GB or US.
+    #   If you set country and number is already in E.164 format, country must match the country code in number.
+    #
+    # @option params [Boolean] :cnam
+    #   Indicates if the name of the person who owns the phone number should be looked up and returned in the response.
+    #   Set to true to receive phone number owner name in the response.
+    #   This features is available for US numbers only and incurs an additional charge.
+    #
+    # @option params [String] :ip
+    #   The IP address of the user.
+    #   If supplied, we will compare this to the country the user's phone is located in and return an error if it does not match.
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/number-insight#getNumberInsightAdvanced
+    #
+    def advanced(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.
+    #
+    # @example
+    #   response = client.number_insight.advanced_async(number: '447700900000', callback: webhook_url)
+    #
+    # @option params [required, String] :callback
+    #   The callback URL.
+    #
+    # @option params [required, String] :number
+    #   A single phone number that you need insight about in national or international format.
+    #
+    # @option params [String] :country
+    #   If a number does not have a country code or is uncertain, set the two-character country code.
+    #   This code must be in ISO 3166-1 alpha-2 format and in upper case. For example, GB or US.
+    #   If you set country and number is already in E.164 format, country must match the country code in number.
+    #
+    # @option params [Boolean] :cnam
+    #   Indicates if the name of the person who owns the phone number should be looked up and returned in the response.
+    #   Set to true to receive phone number owner name in the response.
+    #   This features is available for US numbers only and incurs an additional charge.
+    #
+    # @option params [String] :ip
+    #   The IP address of the user.
+    #   If supplied, we will compare this to the country the user's phone is located in and return an error if it does not match.
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/number-insight#getNumberInsightAsync
+    #
+    def advanced_async(params)
+      response = request('/ni/advanced/async/json', params: params)
+
+      raise Error, response[:status_message] unless response.status.zero?
+
+      response
+    end
+  end
+end

data/lib/vonage/numbers.rb

@@ -0,0 +1,196 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Numbers < Namespace
+    include Keys
+
+    self.host = :rest_host
+
+    # Retrieve all the inbound numbers associated with your Vonage account.
+    #
+    # @example
+    #   response = client.numbers.list
+    #   response.each do |item|
+    #     puts "#{item.msisdn} #{item.country} #{item.type}"
+    #   end
+    #
+    # @option params [String] :application_id
+    #   The application that you want to return the numbers for.
+    #
+    # @option params [Boolean] :has_application
+    #   Set this optional field to `true` to restrict your results to numbers associated with an application (any application).
+    #   Set to `false` to find all numbers not associated with any application.
+    #   Omit the field to avoid filtering on whether or not the number is assigned to an application.
+    #
+    # @option params [String] :country
+    #   The two character country code to filter on (in ISO 3166-1 alpha-2 format).
+    #
+    # @option params [String] :pattern
+    #   The number pattern you want to search for. Use in conjunction with **:search_pattern**.
+    #
+    # @option params [Integer] :search_pattern
+    #   The strategy you want to use for matching:
+    #   - `0` - Search for numbers that start with **:pattern**
+    #   - `1` - Search for numbers that contain **:pattern**
+    #   - `2` - Search for numbers that end with **:pattern**
+    #
+    # @option params [Integer] :size
+    #   Page size.
+    #
+    # @option params [Integer] :index
+    #   Page index.
+    #
+    # @param [Hash] params
+    #
+    # @return [ListResponse]
+    #
+    # @see https://developer.nexmo.com/api/developer/numbers#getOwnedNumbers
+    #
+    def list(params = nil)
+      request('/account/numbers', params: params, response_class: ListResponse)
+    end
+
+    # Retrieve inbound numbers that are available for the specified country.
+    #
+    # @example
+    #   response = client.numbers.search(country: 'GB')
+    #   response.each do |item|
+    #     puts "#{item.msisdn} #{item.type} #{item.cost}"
+    #   end
+    #
+    # @option params [required, String] :country
+    #   The two character country code in ISO 3166-1 alpha-2 format.
+    #
+    # @option params [String] :type
+    #   Set this parameter to filter the type of number, such as mobile or landline.
+    #
+    # @option params [String] :pattern
+    #   The number pattern you want to search for.
+    #   Use in conjunction with **:search_pattern**.
+    #
+    # @option params [Integer] :search_pattern
+    #   The strategy you want to use for matching:
+    #   - `0` - Search for numbers that start with **:pattern**
+    #   - `1` - Search for numbers that contain **:pattern**
+    #   - `2` - Search for numbers that end with **:pattern**
+    #
+    # @option params [String] :features
+    #   Available features are `SMS` and `VOICE`.
+    #   To look for numbers that support both, use a comma-separated value: `SMS,VOICE`.
+    #
+    # @option params [Integer] :size
+    #   Page size.
+    #
+    # @option params [Integer] :index
+    #   Page index.
+    #
+    # @param [Hash] params
+    #
+    # @return [ListResponse]
+    #
+    # @see https://developer.nexmo.com/api/developer/numbers#getAvailableNumbers
+    #
+    def search(params)
+      request('/number/search', params: params, response_class: ListResponse)
+    end
+
+    # Request to purchase a specific inbound number.
+    #
+    # @example
+    #   response = client.numbers.buy(country: 'GB', msisdn: '447700900000')
+    #
+    # @option params [required, String] :country
+    #   The two character country code in ISO 3166-1 alpha-2 format.
+    #
+    # @option params [required, String] :msisdn
+    #   An available inbound virtual number.
+    #
+    # @option params [String] :target_api_key
+    #   If you'd like to perform an action on a subaccount, provide the `api_key` of that account here.
+    #   If you'd like to perform an action on your own account, you do not need to provide this field.
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/developer/numbers#buyANumber
+    #
+    def buy(params)
+      request('/number/buy', params: params, type: Post, response_class: Response)
+    end
+
+    # Cancel your subscription for a specific inbound number.
+    #
+    # @example
+    #   response = client.numbers.cancel(country: 'GB', msisdn: '447700900000')
+    #
+    # @option params [required, String] :country
+    #   The two character country code in ISO 3166-1 alpha-2 format.
+    #
+    # @option params [required, String] :msisdn
+    #   An available inbound virtual number.
+    #
+    # @option params [String] :target_api_key
+    #   If you'd like to perform an action on a subaccount, provide the `api_key` of that account here.
+    #   If you'd like to perform an action on your own account, you do not need to provide this field.
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/developer/numbers#cancelANumber
+    #
+    def cancel(params)
+      request('/number/cancel', params: params, type: Post, response_class: Response)
+    end
+
+    # Change the behaviour of a number that you own.
+    #
+    # @example
+    #   params = {
+    #     country: 'GB',
+    #     msisdn: '447700900000',
+    #     voice_callback_type: 'app',
+    #     voice_callback_value: application_id
+    #   }
+    #
+    #   response = client.numbers.update(params)
+    #
+    # @option params [required, String] :country
+    #   The two character country code in ISO 3166-1 alpha-2 format.
+    #
+    # @option params [required, String] :msisdn
+    #   An available inbound virtual number.
+    #
+    # @option params [String] :mo_http_url
+    #   An URL-encoded URI to the webhook endpoint that handles inbound messages.
+    #   Your webhook endpoint must be active before you make this request.
+    #   Vonage makes a `GET` request to the endpoint and checks that it returns a `200 OK` response.
+    #   Set this parameter's value to an empty string to remove the webhook.
+    #
+    # @option params [String] :mo_smpp_sys_type
+    #   The associated system type for your SMPP client.
+    #
+    # @option params [String] :voice_callback_type
+    #   Specify whether inbound voice calls on your number are handled by your Application configuration, or forwarded to a SIP or a telephone number.
+    #   Must be used with the **:voice_callback_value** option.
+    #
+    # @option params [String] :voice_callback_value
+    #   A SIP URI, telephone number or Application ID.
+    #   Must be used with the **:voice_callback_type** option.
+    #
+    # @option params [String] :voice_status_callback
+    #   A webhook URI for Vonage to send a request to when a call ends.
+    #
+    # @param [Hash] params
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/developer/numbers#updateANumber
+    #
+    def update(params)
+      request('/number/update', params: camelcase(params), type: Post, response_class: Response)
+    end
+  end
+end