vonage 7.2.0

data/lib/vonage/alerts.rb

@@ -0,0 +1,72 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vonage
+  class Alerts < Namespace
+    extend T::Sig
+    self.host = :rest_host
+
+    # Request the list of phone numbers opted out from your campaign.
+    #
+    # @see https://developer.nexmo.com/api/sms/us-short-codes/alerts/subscription
+    #
+    # @return [Response]
+    #
+    sig { returns(Vonage::Response) }
+    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 [Response]
+    #
+    # @see https://developer.nexmo.com/api/sms/us-short-codes/alerts/subscription
+    #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Vonage::Response) }
+    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 [Response]
+    #
+    # @see https://developer.nexmo.com/api/sms/us-short-codes/alerts/sending
+    #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Vonage::Response) }
+    def send(params)
+      request('/sc/us/alert/json', params: params, type: Post)
+    end
+  end
+end

data/lib/vonage/applications.rb

@@ -0,0 +1,148 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vonage
+  class Applications < Namespace
+    extend T::Sig
+    self.authentication = Basic
+
+    self.request_body = JSON
+
+    self.request_headers['Content-Type'] = 'application/json'
+
+    # Create an application.
+    #
+    # @example
+    #   params = {
+    #     name: 'Example App',
+    #     capabilities: {
+    #       'messages': {
+    #         'webhooks': {
+    #           'inbound_url': {
+    #             'address': 'https://example.com/webhooks/inbound',
+    #             'http_method': 'POST'
+    #           },
+    #           'status_url': {
+    #             'address': 'https://example.com/webhooks/status',
+    #             'http_method': 'POST'
+    #           }
+    #         }
+    #       }
+    #     }
+    #   }
+    #
+    #   response = client.applications.create(params)
+    #
+    # @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 [Response]
+    #
+    # @see https://developer.nexmo.com/api/application.v2#createApplication
+    #
+    sig { params(params: T::Hash[Symbol, T.untyped]).returns(Vonage::Response) }
+    def create(params)
+      request('/v2/applications', params: params, type: Post)
+    end
+
+    # List available applications.
+    #
+    # @example
+    #   response = client.applications.list
+    #   response.each do |item|
+    #     puts "#{item.id} #{item.name}"
+    #   end
+    #
+    # @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 [ListResponse]
+    #
+    # @see https://developer.nexmo.com/api/application.v2#listApplication
+    #
+    sig { params(params: T.nilable(T::Hash[Symbol, Integer])).returns(Vonage::Response) }
+    def list(params = nil)
+      request('/v2/applications', params: params, response_class: ListResponse)
+    end
+
+    # Get an application.
+    #
+    # @example
+    #   response = client.applications.get(id)
+    #
+    # @param [String] id
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/application.v2#getApplication
+    #
+    sig { params(id: String).returns(Vonage::Response) }
+    def get(id)
+      request('/v2/applications/' + id)
+    end
+
+    # Update an application.
+    #
+    # @example
+    #   response = client.applications.update(id, answer_method: 'POST')
+    #
+    # @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 [Response]
+    #
+    # @see https://developer.nexmo.com/api/application.v2#updateApplication
+    #
+    sig { params(
+      id: String,
+      params: T::Hash[Symbol, T.untyped]
+    ).returns(Vonage::Response) }
+    def update(id, params)
+      request('/v2/applications/' + id, params: params, type: Put)
+    end
+
+    # Delete an application.
+    #
+    # @example
+    #   response = client.applications.delete(id)
+    #
+    # @note Deleting an application cannot be undone.
+    #
+    # @param [String] id
+    #
+    # @return [Response]
+    #
+    # @see https://developer.nexmo.com/api/application.v2#deleteApplication
+    #
+    sig { params(id: String).returns(Vonage::Response) }
+    def delete(id)
+      request('/v2/applications/' + id, type: Delete)
+    end
+  end
+end

data/lib/vonage/applications/list_response.rb

@@ -0,0 +1,11 @@
+# typed: ignore
+
+class Vonage::Applications::ListResponse < Vonage::Response
+  include Enumerable
+
+  def each
+    return enum_for(:each) unless block_given?
+
+    @entity._embedded.applications.each { |item| yield item }
+  end
+end

data/lib/vonage/authentication_error.rb

@@ -0,0 +1,6 @@
+# typed: strong
+
+module Vonage
+  class AuthenticationError < ClientError
+  end
+end

data/lib/vonage/basic.rb

@@ -0,0 +1,13 @@
+# typed: ignore
+
+module Vonage
+  class Basic < AbstractAuthentication
+    def update(object)
+      return unless object.is_a?(Net::HTTPRequest)
+
+      object.basic_auth(@config.api_key, @config.api_secret)
+    end
+  end
+
+  private_constant :Basic
+end

data/lib/vonage/bearer_token.rb

@@ -0,0 +1,14 @@
+# typed: ignore
+# frozen_string_literal: true
+
+module Vonage
+  class BearerToken < AbstractAuthentication
+    def update(object)
+      return unless object.is_a?(Net::HTTPRequest)
+
+      object['Authorization'] = 'Bearer ' + @config.token
+    end
+  end
+
+  private_constant :BearerToken
+end

data/lib/vonage/client.rb

@@ -0,0 +1,134 @@
+# typed: strict
+
+module Vonage
+  class Client
+    extend T::Sig
+
+    sig { returns(Vonage::Config) }
+    attr_reader :config
+
+    sig { params(options: T.nilable(T::Hash[Symbol, T.untyped])).void }
+    def initialize(options = nil)
+      @config = T.let(Vonage.config.merge(options), Vonage::Config)
+    end
+
+    # @return [Signature]
+    #
+    sig { returns(T.nilable(Vonage::Signature)) }
+    def signature
+      @signature ||= T.let(Signature.new(config), T.nilable(Vonage::Signature))
+    end
+
+    # @return [Account]
+    #
+    sig { returns(T.nilable(Vonage::Account)) }
+    def account
+      @account ||= T.let(Account.new(config), T.nilable(Vonage::Account))
+    end
+
+    # @return [Alerts]
+    #
+    sig { returns(T.nilable(Vonage::Alerts)) }
+    def alerts
+      @alerts ||= T.let(Alerts.new(config), T.nilable(Vonage::Alerts))
+    end
+
+    # @return [Applications]
+    #
+    sig { returns(T.nilable(Vonage::Applications)) }
+    def applications
+      @applications ||= T.let(Applications.new(config), T.nilable(Vonage::Applications))
+    end
+
+    # @return [Conversations]
+    #
+    sig { returns(T.nilable(Vonage::Conversations)) }
+    def conversations
+      @conversations ||= T.let(Conversations.new(config), T.nilable(Vonage::Conversations))
+    end
+
+    # @return [Conversions]
+    #
+    sig { returns(T.nilable(Vonage::Conversions)) }
+    def conversions
+      @conversions ||= T.let(Conversions.new(config), T.nilable(Vonage::Conversions))
+    end
+
+    # @return [Files]
+    #
+    sig { returns(T.nilable(Vonage::Files)) }
+    def files
+      @files ||= T.let(Files.new(config), T.nilable(Vonage::Files))
+    end
+
+    # @return [Messages]
+    #
+    sig { returns(T.nilable(Vonage::Messages)) }
+    def messages
+      @messages ||= T.let(Messages.new(config), T.nilable(Vonage::Messages))
+    end
+
+    # @return [NumberInsight]
+    #
+    sig { returns(T.nilable(Vonage::NumberInsight)) }
+    def number_insight
+      @number_insight ||= T.let(NumberInsight.new(config), T.nilable(Vonage::NumberInsight))
+    end
+
+    # @return [Numbers]
+    #
+    sig { returns(T.nilable(Vonage::Numbers)) }
+    def numbers
+      @numbers ||= T.let(Numbers.new(config), T.nilable(Vonage::Numbers))
+    end
+
+    # @return [PricingTypes]
+    #
+    sig { returns(T.nilable(Vonage::PricingTypes)) }
+    def pricing
+      @pricing ||= T.let(PricingTypes.new(config), T.nilable(Vonage::PricingTypes))
+    end
+
+    # @return [Redact]
+    #
+    sig { returns(T.nilable(Vonage::Redact)) }
+    def redact
+      @redact ||= T.let(Redact.new(config), T.nilable(Vonage::Redact))
+    end
+
+    # @return [Secrets]
+    #
+    sig { returns(T.nilable(Vonage::Secrets)) }
+    def secrets
+      @secrets ||= T.let(Secrets.new(config), T.nilable(Vonage::Secrets))
+    end
+
+    # @return [SMS]
+    #
+    sig { returns(T.nilable(Vonage::SMS)) }
+    def sms
+      @sms ||= T.let(SMS.new(config), T.nilable(Vonage::SMS))
+    end
+
+    # @return [TFA]
+    #
+    sig { returns(T.nilable(Vonage::TFA)) }
+    def tfa
+      @tfa ||= T.let(TFA.new(config), T.nilable(Vonage::TFA))
+    end
+
+    # @return [Verify]
+    #
+    sig { returns(T.nilable(Vonage::Verify)) }
+    def verify
+      @verify ||= T.let(Verify.new(config), T.nilable(Vonage::Verify))
+    end
+
+    # @return [Voice]
+    #
+    sig { returns(T.nilable(Vonage::Voice)) }
+    def voice
+      @voice ||= T.let(Voice.new(config), T.nilable(Vonage::Voice))
+    end
+  end
+end

data/lib/vonage/client_error.rb

@@ -0,0 +1,6 @@
+# typed: strong
+
+module Vonage
+  class ClientError < Error
+  end
+end

data/lib/vonage/config.rb

@@ -0,0 +1,208 @@
+# typed: true
+# frozen_string_literal: true
+require 'logger'
+
+module Vonage
+  class Config
+    extend T::Sig
+
+    sig { void }
+    def initialize
+      self.api_host = 'api.nexmo.com'
+      self.api_key = T.let(ENV['VONAGE_API_KEY'], T.nilable(String))
+      self.api_secret = T.let(ENV['VONAGE_API_SECRET'], T.nilable(String))
+      self.application_id = ENV['VONAGE_APPLICATION_ID']
+      self.logger = (defined?(::Rails.logger) && ::Rails.logger) || Vonage::Logger.new(nil)
+      self.private_key = ENV['VONAGE_PRIVATE_KEY_PATH'] ? File.read(T.must(ENV['VONAGE_PRIVATE_KEY_PATH'])) : ENV['VONAGE_PRIVATE_KEY']
+      self.rest_host = 'rest.nexmo.com'
+      self.signature_secret = ENV['VONAGE_SIGNATURE_SECRET']
+      self.signature_method = ENV['VONAGE_SIGNATURE_METHOD'] || 'md5hash'
+      self.token = T.let(nil, T.nilable(String))
+    end
+
+    # Merges the config with the given options hash.
+    #
+    # @return [Vonage::Config]
+    #
+    sig { params(options: T.nilable(T::Hash[Symbol, T.untyped])).returns(Vonage::Config) }
+    def merge(options)
+      return self if options.nil? || options.empty?
+
+      options.each_with_object(dup) do |(name, value), config|
+        config.write_attribute(name, value)
+      end
+    end
+
+    sig { returns(String) }
+    attr_accessor :api_host
+
+    # Returns the value of attribute api_key.
+    #
+    # @return [String]
+    #
+    # @raise [AuthenticationError]
+    #
+    sig { returns(T.nilable(String)) }
+    def api_key
+      @api_key = T.let(@api_key, T.nilable(String))
+      unless @api_key
+        raise AuthenticationError.new('No API key provided. ' \
+          'See https://developer.nexmo.com/concepts/guides/authentication for details, ' \
+          'or email support@nexmo.com if you have any questions.')
+      end
+
+      @api_key
+    end
+
+    sig { params(api_key: T.nilable(String)).returns(T.nilable(String)) }
+    attr_writer :api_key
+
+    # Returns the value of attribute api_secret.
+    #
+    # @return [String]
+    #
+    # @raise [AuthenticationError]
+    #
+    sig { returns(T.nilable(String)) }
+    def api_secret
+      @api_secret = T.let(@api_secret, T.nilable(String))
+      unless @api_secret
+        raise AuthenticationError.new('No API secret provided. ' \
+          'See https://developer.nexmo.com/concepts/guides/authentication for details, ' \
+          'or email support@nexmo.com if you have any questions.')
+      end
+
+      @api_secret
+    end
+
+    sig { params(api_secret: T.nilable(String)).returns(T.nilable(String)) }
+    attr_writer :api_secret
+
+    # Returns the value of attribute application_id.
+    #
+    # @return [String]
+    #
+    # @raise [AuthenticationError]
+    #
+    sig { returns(T.nilable(String)) }
+    def application_id
+      @application_id = T.let(@application_id, T.nilable(String))
+      unless @application_id
+        raise AuthenticationError.new('No application_id provided. ' \
+          'Either provide an application_id, or set an auth token. ' \
+          'You can add new applications from the Vonage dashboard. ' \
+          'See https://developer.nexmo.com/concepts/guides/applications for details, ' \
+          'or email support@nexmo.com if you have any questions.')
+      end
+
+      @application_id
+    end
+
+    sig { params(application_id: T.nilable(String)).returns(T.nilable(String)) }
+    attr_writer :application_id
+
+    sig { returns(T.nilable(String)) }
+    attr_accessor :app_name
+
+    sig { returns(T.nilable(String)) }
+    attr_accessor :app_version
+
+    # Returns the value of attribute http.
+    #
+    # @return [Vonage::HTTP::Options]
+    #
+    sig { returns(T.nilable(Vonage::HTTP::Options)) }
+    attr_reader :http
+
+    sig { params(hash: T::Hash[T.untyped, T.untyped]).returns(T.nilable(Vonage::HTTP::Options)) }
+    def http=(hash)
+      @http = T.let(nil, T.nilable(Vonage::HTTP::Options))
+      @http = Vonage::HTTP::Options.new(hash)
+    end
+
+    # Returns the value of attribute logger.
+    #
+    # @return [Vonage::Logger]
+    #
+    sig { returns(T.nilable(Vonage::Logger)) }
+    attr_reader :logger
+
+    # @return [Vonage::Logger]
+    #
+    sig { params(logger: T.nilable(T.any(::Logger, Vonage::Logger))).returns(T.nilable(Vonage::Logger)) }
+    def logger=(logger)
+      @logger = T.let(Logger.new(logger), T.nilable(Vonage::Logger))
+    end
+
+    # Returns the value of attribute private_key.
+    #
+    # @return [String]
+    #
+    # @raise [AuthenticationError]
+    #
+    sig { returns(T.nilable(String)) }
+    def private_key
+      @private_key = T.let(@private_key, T.nilable(String))
+      unless @private_key
+        raise AuthenticationError.new('No private_key provided. ' \
+          'Either provide a private_key, or set an auth token. ' \
+          'You can add new applications from the Vonage dashboard. ' \
+          'See https://developer.nexmo.com/concepts/guides/applications for details, ' \
+          'or email support@nexmo.com if you have any questions.')
+      end
+
+      @private_key
+    end
+
+    sig { params(private_key: T.nilable(String)).returns(T.nilable(String)) }
+    attr_writer :private_key
+
+    sig { returns(String) }
+    attr_accessor :rest_host
+
+    # Returns the value of attribute signature_secret.
+    #
+    # @return [String]
+    #
+    # @raise [AuthenticationError]
+    #
+    sig { returns(T.nilable(String)) }
+    def signature_secret
+      @signature_secret = T.let(@signature_secret, T.nilable(String))
+      unless @signature_secret
+        raise AuthenticationError.new('No signature_secret provided. ' \
+          'You can find your signature secret in the Vonage dashboard. ' \
+          'See https://developer.nexmo.com/concepts/guides/signing-messages for details, ' \
+          'or email support@nexmo.com if you have any questions.')
+      end
+
+      @signature_secret
+    end
+
+    sig { params(signature_secret: T.nilable(String)).returns(T.nilable(String)) }
+    attr_writer :signature_secret
+
+    sig { returns(String) }
+    attr_accessor :signature_method
+
+    # Returns the value of attribute token, or a temporary short lived token.
+    #
+    # @return [String]
+    #
+    sig { returns(T.nilable(String)) }
+    def token
+      @token = T.let(nil, T.nilable(String))
+      @token || JWT.generate({application_id: application_id}, T.must(private_key))
+    end
+
+    sig { params(token: T.nilable(String)).returns(T.nilable(String)) }
+    attr_writer :token
+
+    protected
+
+    sig { params(name: Symbol, value: T.nilable(T.untyped)).void }
+    def write_attribute(name, value)
+      public_send(:"#{name}=", value)
+    end
+  end
+end