vonage 7.8.2 → 7.36.0

data/lib/vonage/users.rb

@@ -0,0 +1,156 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vonage
+  class Users < Namespace
+    extend T::Sig
+    self.authentication = BearerToken
+
+    self.request_body = JSON
+
+    # Get a list of Users associated with the Vonage Application.
+    #
+    # @param [optional, Integer] :page_size
+    #   Specifies the number of records to be returned in the response.
+    #
+    # @param [optional, String] :order
+    #   Specifies the order in which the records should be returned.
+    #   Must be one of `asc`, `ASC`, `desc`, or `DESC`
+    #
+    # @param [optional, String] :cursor
+    #   Specficy a cursor point from which to start returning results, for example the values of the `next` or `prev`
+    #   `_links` contained in a response.
+    #
+    # @param [optional, String] :name
+    #   Specify a user name with which to filter results
+    #
+    # @return [ListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/application.v2#getUsers
+    #
+    def list(**params)
+      request('/v1/users', params: params, response_class: ListResponse)
+    end
+
+    # Get a specified User associated with the Vonage Application.
+    #
+    # @param [required, String] :id
+    #   The unique ID or name for the user.
+    #
+    # @return [Vonage::Response]
+    #
+    # @see https://developer.vonage.com/en/api/application.v2#getUser
+    #
+    def find(id:)
+      request("/v1/users/#{id}")
+    end
+
+    # Create a new User associated with the Vonage Application.
+    #
+    # @param [optional, String] :name
+    #   A unique name for the user. If not provided, a name will be auto-generated.
+    #
+    # @param [optional, String] :display_name
+    #   A string to be displayed as user name. It does not need to be unique.
+    #
+    # @param [optional, String] :image_url
+    #   A publicly accessible URL to an image file for an image to be associated with the user.
+    #
+    # @param [optional, Hash] :properties A hash defining properties for the User.
+    #   @option properties [Hash] :custom_data A hash of custom data as key/value pairs.
+    #
+    # @param [optional, Hash] :channels A hash defining details of various channels.
+    #   @option channels [Array] :pstn An array containing a Hash which defines data for the pstn channel.
+    #     @option pstn [Integer] :number The pstn number.
+    #   @option channels [Array] :sip An array containing a Hash which defines data for the sip channel.
+    #     @option sip [String] :uri The sip uri.
+    #     @option sip [String] :username The sip username.
+    #     @option sip [String] :password The sip password.
+    #   @option channels [Array] :vbc An array containing a Hash which defines data for the vbc channel.
+    #     @option vbc [String] :extension The vbc extension.
+    #   @option channels [Array] :websocket An array containing a Hash which defines data for the websocket channel.
+    #     @option websocket [String] :uri The websocket uri.
+    #     @option websocket [String] :content-type The websocket audio type. Must be one of: `audio/l16;rate=8000`, `audio/l16;rate=16000`.
+    #     @option websocket [Hash] :headers A hash of custom websocket headers provided as key/value pairs.
+    #   @option channels [Array] :sms An array containing a Hash which defines data for the sms channel.
+    #     @option sms [Integer] :number The sms number.
+    #   @option channels [Array] :mms An array containing a Hash which defines data for the mms channel.
+    #     @option mms [Integer] :number The mms number.
+    #   @option channels [Array] :whatsapp An array containing a Hash which defines data for the whatsapp channel.
+    #     @option whatsapp [Integer] :number The whatsapp number.
+    #   @option channels [Array] :viber An array containing a Hash which defines data for the sms channel.
+    #     @option viber [Integer] :number The viber number.
+    #   @option channels [Array] :messenger An array containing a Hash which defines data for the messenger channel.
+    #     @option messenger [Integer] :id The messenger id.
+    #
+    # @return [Vonage::Response]
+    #
+    # @see https://developer.vonage.com/en/api/application.v2#createUser
+    #
+    def create(**params)
+      request('/v1/users', params: params, type: Post)
+    end
+
+    # Update an existing User associated with the Vonage Application.
+    #
+    # @param [required, String] :id
+    #   The unique ID or name for the user to be updated.
+    #
+    # @param [optional, String] :name
+    #   A unique name for the user.
+    #
+    # @param [optional, String] :display_name
+    #   A string to be displayed as user name. It does not need to be unique.
+    #
+    # @param [optional, String] :image_url
+    #   A publicly accessible URL to an image file for an image to be associated with the user.
+    #
+    # @param [optional, Hash] :properties A hash defining properties for the User.
+    #   @option properties [Hash] :custom_data A hash of custom data as key/value pairs.
+    #
+    # @param [optional, Hash] :channels A hash defining details of various channels.
+    #   @option channels [Array] :pstn An array containing a Hash which defines data for the pstn channel.
+    #     @option pstn [Integer] :number The pstn number.
+    #   @option channels [Array] :sip An array containing a Hash which defines data for the sip channel.
+    #     @option sip [String] :uri The sip uri.
+    #     @option sip [String] :username The sip username.
+    #     @option sip [String] :password The sip password.
+    #   @option channels [Array] :vbc An array containing a Hash which defines data for the vbc channel.
+    #     @option vbc [String] :extension The vbc extension.
+    #   @option channels [Array] :websocket An array containing a Hash which defines data for the websocket channel.
+    #     @option websocket [String] :uri The websocket uri.
+    #     @option websocket [String] :content-type The websocket audio type. Must be one of: `audio/l16;rate=8000`, `audio/l16;rate=16000`.
+    #     @option websocket [Hash] :headers A hash of custom websocket headers provided as key/value pairs.
+    #   @option channels [Array] :sms An array containing a Hash which defines data for the sms channel.
+    #     @option sms [Integer] :number The sms number.
+    #   @option channels [Array] :mms An array containing a Hash which defines data for the mms channel.
+    #     @option mms [Integer] :number The mms number.
+    #   @option channels [Array] :whatsapp An array containing a Hash which defines data for the whatsapp channel.
+    #     @option whatsapp [Integer] :number The whatsapp number.
+    #   @option channels [Array] :viber An array containing a Hash which defines data for the sms channel.
+    #     @option viber [Integer] :number The viber number.
+    #   @option channels [Array] :messenger An array containing a Hash which defines data for the messenger channel.
+    #     @option messenger [Integer] :id The messenger id.
+    #
+    # @return [Vonage::Response]
+    #
+    # @see https://developer.vonage.com/en/api/application.v2#createUser
+    #
+    def update(id:, **params)
+      request("/v1/users/#{id}", params: params, type: Patch)
+    end
+
+    # Delete a specified User associated with the Vonage Application.
+    #
+    # @param [required, String] :id
+    #   The unique ID or name for the user.
+    #
+    # @return [Vonage::Response]
+    #
+    # @see https://developer.vonage.com/en/api/application.v2#deleteUser
+    #
+    def delete(id:)
+      request("/v1/users/#{id}", type: Delete)
+    end
+  end
+end

data/lib/vonage/verify.rb

@@ -8,6 +8,8 @@ module Vonage
 
     private :http_request
 
+    self.authentication = Basic
+
     # Generate and send a PIN to your user.
     #
     # @note You can make a maximum of one Verify request per second.

data/lib/vonage/verify2/channels/email.rb

@@ -0,0 +1,36 @@
+# typed: true
+# frozen_string_literal: true
+require 'phonelib'
+
+module Vonage
+  class Verify2::Channels::Email
+
+    attr_reader :channel, :to, :from
+
+    def initialize(to:, from: nil)
+      self.channel = 'email'
+      self.to = to
+      self.from = from unless from.nil?
+    end
+
+    def to=(to)
+      @to = to
+    end
+
+    def from=(from)
+      @from = from
+    end
+
+    def to_h
+      hash = Hash.new
+      self.instance_variables.each do |ivar|
+        hash[ivar.to_s.delete("@").to_sym] = self.instance_variable_get(ivar)
+      end
+      hash
+    end
+
+    private
+
+    attr_writer :channel
+  end
+end

data/lib/vonage/verify2/channels/silent_auth.rb

@@ -0,0 +1,46 @@
+# typed: true
+# frozen_string_literal: true
+require 'phonelib'
+require 'uri'
+
+module Vonage
+  class Verify2::Channels::SilentAuth
+
+    attr_reader :channel, :to, :sandbox, :redirect_url
+
+    def initialize(to:, redirect_url: nil, sandbox: nil)
+      self.channel = 'silent_auth'
+      self.to = to
+      self.redirect_url = redirect_url unless redirect_url.nil?
+      self.sandbox = sandbox unless sandbox.nil?
+    end
+
+    def to=(to)
+      raise ArgumentError, "Invalid 'to' value #{to}. Expected to be in E.164 format" unless Phonelib.parse(to.to_i).valid?
+      @to = to
+    end
+
+    def redirect_url=(redirect_url)
+      raise ArgumentError, "Invalid 'to' value #{redirect_url}. Expected to be a valid URL" unless URI.parse(redirect_url).is_a?(URI::HTTP)
+      @redirect_url = redirect_url
+    end
+
+    # @deprecated: This method is deprecated and will be removed in a future release.
+    def sandbox=(sandbox)
+      raise ArgumentError, "Invalid 'sandbox' value #{sandbox}. Expected to be boolean value" unless [true, false].include? sandbox
+      @sandbox = sandbox
+    end
+
+    def to_h
+      hash = Hash.new
+      self.instance_variables.each do |ivar|
+        hash[ivar.to_s.delete("@").to_sym] = self.instance_variable_get(ivar)
+      end
+      hash
+    end
+
+    private
+
+    attr_writer :channel
+  end
+end

data/lib/vonage/verify2/channels/sms.rb

@@ -0,0 +1,63 @@
+# typed: true
+# frozen_string_literal: true
+require 'phonelib'
+
+module Vonage
+  class Verify2::Channels::SMS
+    APP_HASH_LENGTH = 11
+
+    attr_reader :channel, :to, :from, :entity_id, :content_id, :app_hash
+
+    def initialize(to:, app_hash: nil)
+      self.channel = 'sms'
+      self.to = to
+      self.app_hash = app_hash unless app_hash.nil?
+    end
+
+    def to=(to)
+      raise ArgumentError, "Invalid 'to' value #{to}. Expected to be in E.164 format" unless Phonelib.parse(to).valid?
+      @to = to
+    end
+
+    def from=(from)
+      validate_from(from)
+      @from = from
+    end
+
+    def entity_id=(entity_id)
+      raise ArgumentError, "Invalid 'entity_id' value #{entity_id}. Length must be between 1 and 20 characters." unless entity_id.length.between?(1, 20)
+      @entity_id = entity_id
+    end
+
+    def content_id=(content_id)
+      raise ArgumentError, "Invalid 'content_id' value #{content_id}. Length must be between 1 and 20 characters ." unless content_id.length.between?(1, 20)
+      @content_id = content_id
+    end
+
+    def app_hash=(app_hash)
+      raise ArgumentError, "Invalid 'app_hash' value #{app_hash}. Length must be #{APP_HASH_LENGTH}" unless app_hash.length == APP_HASH_LENGTH
+      @app_hash = app_hash
+    end
+
+    def to_h
+      hash = Hash.new
+      self.instance_variables.each do |ivar|
+        hash[ivar.to_s.delete("@").to_sym] = self.instance_variable_get(ivar)
+      end
+      hash
+    end
+
+    private
+
+    attr_writer :channel
+
+    def validate_from(from)
+      if from.match?(/\D/)
+        raise ArgumentError, "Invalid alpha-numeric 'from' value #{from}. Length must be between 3 and 11 characters." unless from.length.between?(3, 11)
+      else
+        raise ArgumentError, "Invalid numeric 'from' value #{from}. Length must be between 11 and 15 characters." unless from.length.between?(11, 15)
+        raise ArgumentError, "Invalid 'from' value #{from}. Expected to be in E.164 format" unless Phonelib.parse(from).valid?
+      end
+    end
+  end
+end

data/lib/vonage/verify2/channels/voice.rb

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+require 'phonelib'
+
+module Vonage
+  class Verify2::Channels::Voice
+
+    attr_reader :channel, :to
+
+    def initialize(to:)
+      self.channel = 'voice'
+      self.to = to
+    end
+
+    def to=(to)
+      raise ArgumentError, "Invalid 'to' value #{to}. Expected to be in E.164 format" unless Phonelib.parse(to.to_i).valid?
+      @to = to
+    end
+
+    def to_h
+      hash = Hash.new
+      self.instance_variables.each do |ivar|
+        hash[ivar.to_s.delete("@").to_sym] = self.instance_variable_get(ivar)
+      end
+      hash
+    end
+
+    private
+
+    attr_writer :channel
+  end
+end

data/lib/vonage/verify2/channels/whats_app.rb

@@ -0,0 +1,45 @@
+# typed: true
+# frozen_string_literal: true
+require 'phonelib'
+
+module Vonage
+  class Verify2::Channels::WhatsApp
+
+    attr_reader :channel, :to, :from
+
+    def initialize(to:, from:)
+      self.channel = 'whatsapp'
+      self.to = to
+      self.from = from
+    end
+
+    def to=(to)
+      raise ArgumentError, "Invalid 'to' value #{to}. Expected to be in E.164 format" unless Phonelib.parse(to.to_i).valid?
+      @to = to
+    end
+
+    def from=(from)
+      raise ArgumentError, "Invalid 'from' value #{from}. Length must be between 11 and 15 characters." unless from.length.between?(11, 15)
+      raise ArgumentError, "Invalid 'from' value #{from}. Expected to be in E.164 format" unless Phonelib.parse(from.to_i).valid?
+      @from = from
+    end
+
+    def mode=(mode)
+      valid_modes = ['otp_code', 'zero_tap']
+      raise ArgumentError, "Invalid 'mode' value #{mode}. Expected to be one of #{valid_modes.join(', ')}" unless valid_modes.include?(mode)
+      @mode = mode
+    end
+
+    def to_h
+      hash = Hash.new
+      self.instance_variables.each do |ivar|
+        hash[ivar.to_s.delete("@").to_sym] = self.instance_variable_get(ivar)
+      end
+      hash
+    end
+
+    private
+
+    attr_writer :channel
+  end
+end

data/lib/vonage/verify2/channels/whats_app_interactive.rb

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+require 'phonelib'
+
+module Vonage
+  class Verify2::Channels::WhatsAppInteractive
+
+    attr_reader :channel, :to
+
+    def initialize(to:)
+      self.channel = 'whatsapp_interactive'
+      self.to = to
+    end
+
+    def to=(to)
+      raise ArgumentError, "Invalid 'to' value #{to}. Expected to be in E.164 format" unless Phonelib.parse(to.to_i).valid?
+      @to = to
+    end
+
+    def to_h
+      hash = Hash.new
+      self.instance_variables.each do |ivar|
+        hash[ivar.to_s.delete("@").to_sym] = self.instance_variable_get(ivar)
+      end
+      hash
+    end
+
+    private
+
+    attr_writer :channel
+  end
+end

data/lib/vonage/verify2/start_verification_options.rb

@@ -0,0 +1,63 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Verify2::StartVerificationOptions
+    VALID_OPTS = [:locale, :channel_timeout, :client_ref, :code_length, :code, :fraud_check].freeze
+
+    MIN_CHANNEL_TIMEOUT, MAX_CHANNEL_TIMEOUT = [15, 900]
+
+    MIN_CODE_LENGTH, MAX_CODE_LENGTH = [4, 10]
+
+    attr_reader(*VALID_OPTS)
+
+    def initialize(**opts)
+      VALID_OPTS.each do |opt|
+        send("#{opt}=", opts[opt]) unless opts[opt].nil?
+      end
+    end
+
+    def locale=(locale)
+      @locale = locale
+    end
+
+    def channel_timeout=(channel_timeout)
+      raise ArgumentError, "Invalid 'channel_timeout' #{channel_timeout}. Must be an integer" unless channel_timeout.is_a?(Integer)
+      unless channel_timeout.between?(MIN_CHANNEL_TIMEOUT, MAX_CHANNEL_TIMEOUT)
+        raise ArgumentError, "Invalid 'channel_timeout' #{channel_timeout}. Must be between #{MIN_CHANNEL_TIMEOUT} and #{MAX_CHANNEL_TIMEOUT} (inclusive)"
+      end
+
+      @channel_timeout = channel_timeout
+    end
+
+    def client_ref=(client_ref)
+      @client_ref = client_ref
+    end
+
+    def code_length=(code_length)
+      unless code_length.between?(MIN_CODE_LENGTH, MAX_CODE_LENGTH)
+        raise ArgumentError, "Invalid 'code_length' #{code_length}. Must be between #{MIN_CODE_LENGTH} and #{MAX_CODE_LENGTH} (inclusive)"
+      end
+
+      @code_length = code_length
+    end
+
+    def code=(code)
+      @code = code
+    end
+
+    def fraud_check=(fraud_check)
+      raise ArgumentError, "Invalid 'fraud_check' #{fraud_check}. Must be `false`" unless fraud_check == false
+
+      @fraud_check = fraud_check
+    end
+
+    def to_h
+      hash = Hash.new
+      self.instance_variables.each do |ivar|
+        hash[ivar.to_s.delete("@").to_sym] = self.instance_variable_get(ivar)
+      end
+      hash
+    end
+  end
+end

data/lib/vonage/verify2/template_fragments/list_response.rb

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

data/lib/vonage/verify2/template_fragments.rb

@@ -0,0 +1,125 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class Verify2::TemplateFragments < Namespace
+    CHANNELS = ['sms', 'voice'].freeze
+
+    self.authentication = BasicAndBearerToken
+
+    self.request_body = JSON
+
+    # Get a list of of template fragments for a specific template.
+    #
+    # @example
+    #   template_fragment_list = client.verify2.template_fragments.list(template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9')
+    #
+    # @param [required, String] :template_id. The ID of the template for which to retreive the fragments
+    #
+    # @param [optional, Integer] :page_size. The amount of template fragments to list per page
+    #
+    # @param [optional, Integer] :page. The page number to retrieve
+    #
+    # @return [ListResponse]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#listTemplateFragments
+    def list(template_id:, **params)
+      request("/v2/verify/templates/#{template_id}/template_fragments", params: params, response_class: ListResponse)
+    end
+
+    # Get details of a specific template fragment.
+    #
+    # @example
+    #   template_fragment = client.verify2.template_fragments.info(
+    #                         template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9',
+    #                         template_fragment_id: 'c70f446e-997a-4313-a081-60a02a31dc19'
+    #                       )
+    #
+    # @param [required, String] :template_id. The ID of the template for which to retreive the fragment
+    #
+    # @param [required, String] :template_fragment_id. The ID of the fragment to be retreived
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#getTemplateFragment
+    def info(template_id:, template_fragment_id:)
+      request("/v2/verify/templates/#{template_id}/template_fragments/#{template_fragment_id}")
+    end
+
+    # Create a new template fragment.
+    #
+    # @example
+    #   client.verify2.template_fragments.create(
+    #                         template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9',
+    #                         channel: 'sms',
+    #                         locale: 'en-gb',
+    #                         text: 'Your code is: ${code}'
+    #                       )
+    #
+    # @param [required, String] :template_id. The ID of the template for which to create the fragment
+    #
+    # @param [required, String] :channel. The verification channel for which to create the fragment. Must be one of 'sms' or 'voice'
+    #
+    # @param [required, String] :locale. The locale for which to create the fragment.
+    #
+    # @param [required, String] :text. The text to be used in the template fragment.
+    #   There are 4 reserved variables available to use as part of the text: ${code}, ${brand}, ${time-limit} and ${time-limit-unit}
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#addTemplateFragmentToTemplate
+    def create(template_id:, channel:, locale:, text:)
+      raise ArgumentError, "Invalid 'channel' #{channel}. Must be one of #{CHANNELS.join(', ')}" unless CHANNELS.include?(channel)
+      request(
+        "/v2/verify/templates/#{template_id}/template_fragments",
+        params: {
+          channel: channel,
+          locale: locale,
+          text: text
+        },
+        type: Post)
+    end
+
+    # Update an existing template fragment.
+    #
+    # @example
+    #   client.verify2.template_fragments.update(
+    #                         template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9',
+    #                         template_fragment_id: 'c70f446e-997a-4313-a081-60a02a31dc19',
+    #                         text: 'Your one-time code is: ${code}'
+    #                       )
+    #
+    # @param [required, String] :template_id. The ID of the template with which the fragment to be updated is associated
+    #
+    # @param [required, String] :template_fragment_id. The ID of the fragment to be updated
+    #
+    # @param [required, String] :text. The text to be used in the template fragment.
+    #   There are 4 reserved variables available to use as part of the text: ${code}, ${brand}, ${time-limit} and ${time-limit-unit}
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#updateTemplateFragment
+    def update(template_id:, template_fragment_id:, text:)
+      request("/v2/verify/templates/#{template_id}/template_fragments/#{template_fragment_id}", params: {text: text}, type: Patch)
+    end
+
+    # Delete a template fragment.
+    #
+    # @example
+    #   client.verify2.template_fragments.delete(
+    #                         template_id: '8f35a1a7-eb2f-4552-8fdf-fffdaee41bc9',
+    #                         template_fragment_id: 'c70f446e-997a-4313-a081-60a02a31dc19'
+    #                       )
+    #
+    # @param [required, String] :template_id. The ID of the template with which the fragment to be deleted is associated
+    #
+    # @param [required, String] :template_fragment_id. The ID of the fragment to be deleted
+    #
+    # @return [Response]
+    #
+    # @see https://developer.vonage.com/en/api/verify.v2#deleteTemplateFragment
+    def delete(template_id:, template_fragment_id:)
+      request("/v2/verify/templates/#{template_id}/template_fragments/#{template_fragment_id}", type: Delete)
+    end
+  end
+end

data/lib/vonage/verify2/templates/list_response.rb

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