vonage 7.20.0 → 8.0.0.beta

data/lib/vonage/users.rb

@@ -1,156 +0,0 @@
-# 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/verify2/channels/email.rb

@@ -1,36 +0,0 @@
-# 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

@@ -1,45 +0,0 @@
-# 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
-
-    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

@@ -1,53 +0,0 @@
-# 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)
-      @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
-  end
-end

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

@@ -1,32 +0,0 @@
-# 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

@@ -1,38 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-require 'phonelib'
-
-module Vonage
-  class Verify2::Channels::WhatsApp
-
-    attr_reader :channel, :to, :from
-
-    def initialize(to:, from: nil)
-      self.channel = 'whatsapp'
-      self.to = to
-      self.from = from unless from.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 from=(from)
-      raise ArgumentError, "Invalid 'from' value #{from}. Expected to be in E.164 format" unless Phonelib.parse(from.to_i).valid?
-      @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/whats_app_interactive.rb

@@ -1,32 +0,0 @@
-# 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

@@ -1,62 +0,0 @@
-# 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 = [60, 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)
-      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/workflow.rb

@@ -1,39 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class Verify2::Workflow
-    CHANNELS = {
-      sms: Verify2::Channels::SMS,
-      whatsapp: Verify2::Channels::WhatsApp,
-      whatsapp_interactive: Verify2::Channels::WhatsAppInteractive,
-      voice: Verify2::Channels::Voice,
-      email: Verify2::Channels::Email,
-      silent_auth: Verify2::Channels::SilentAuth
-    }
-
-    CHANNELS.keys.each do |method|
-      define_method method do |attributes|
-        CHANNELS[method].new(**attributes)
-      end
-    end
-
-    def self.method_missing(method)
-      raise ClientError.new("Workflow channel must be one of the valid options. Please refer to https://developer.vonage.com/en/api/verify.v2#newRequest for a complete list.")
-    end
-
-    attr_reader :list
-
-    def initialize
-      @list = []
-    end
-
-    def <<(workflow)
-      list << workflow
-    end
-
-    def hashified_list
-      list.map(&:to_h)
-    end
-  end
-end

data/lib/vonage/verify2/workflow_builder.rb

@@ -1,25 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class Verify2::WorkflowBuilder
-
-    def self.build
-      builder = self.new
-      yield builder if block_given?
-      builder.workflow
-    end
-
-    attr_reader :workflow
-
-    def initialize
-      @workflow = Vonage::Verify2::Workflow.new
-    end
-
-    Vonage::Verify2::Workflow::CHANNELS.keys.each do |channel|
-      define_method "add_#{channel.to_s}" do |args|
-        workflow << workflow.send(channel, **args)
-      end
-    end
-  end
-end

data/lib/vonage/verify2.rb

@@ -1,93 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-module Vonage
-  class Verify2 < Namespace
-    self.authentication = BearerToken
-
-    self.request_body = JSON
-
-    # Request a verification be sent to a user.
-    #
-    # @example
-    #   verification_request = client.verify2.start_verification(
-    #     brand: 'Acme',
-    #     workflow: [{channel: 'sms', to: '447000000000'}],
-    #     code_length: 6
-    #   )
-    #
-    # @param [required, String] :brand The brand that is sending the verification request
-    #
-    # @param [required, Array<Hash>] :workflow An array of hashes for channels in the workflow
-    #
-    # @param [optional, Hash] opts the options for the verification request.
-    #   @option opts [Integer] :code_length The length of the one-time code provided to the end-user
-    #   @option opts [String] :code An optional alphanumeric custom code to use instead of an auto-generated code
-    #   @option opts [String] :locale The language to use for the verification message (where applicable)
-    #   @option opts [Integer] :channel_timeout Wait time in seconds before trying the next channel in the workflow
-    #   @option opts [String] :client_ref Reference to be included in callbacks
-    #   @option opts [Boolean] If used, must be set to `false`. Will bypass a network block for a single Verify V2 request
-    #
-    # @return Vonage::Response
-    # @see https://developer.vonage.com/en/api/verify.v2#newRequest
-    #
-    def start_verification(brand:, workflow:, **opts)
-      raise ArgumentError, ':workflow must be an Array' unless workflow.is_a?(Array)
-      raise ArgumentError, ':workflow must not be empty' if workflow.empty?
-
-      request('/v2/verify/', params: opts.merge(brand: brand, workflow: workflow), type: Post)
-    end
-
-    # Check a supplied code against a request to see if it is valid.
-    #
-    # @example
-    #   code_check = client.verify2.check_code(request_id: '7e8c5965-0a3f-44df-8a14-f1486209d8a2', code: '1234')
-    #
-    # @param [required, String] :request_id The request_id of the verification request being checked
-    #
-    # @param [required, String] :code The code supplied to the end-user by the verification request
-    #
-    # @see https://developer.vonage.com/en/api/verify.v2#checkCode
-    #
-    def check_code(request_id:, code:)
-      request('/v2/verify/' + request_id, params: {code: code}, type: Post)
-    end
-
-    # Cancel a verifiction. If a verification request is still active, calling this method aborts the workflow.
-    #
-    # @example
-    #   client.verify2.cancel_verification_request(request_id: '7e8c5965-0a3f-44df-8a14-f1486209d8a2')
-    #
-    # @param [required, String] :request_id The request_id of the verification request to be cancelled
-    #
-    # @see https://developer.vonage.com/en/api/verify.v2#cancelRequest
-    #
-    def cancel_verification_request(request_id:)
-      request('/v2/verify/' + request_id, type: Delete)
-    end
-
-    # Instantiate a new Vonage::Verify2::StartVerificationOptions object
-    #
-    # @param [optional, Hash] opts the options for the verification request.
-    #   @option opts [Integer] :code_length The length of the one-time code provided to the end-user
-    #   @option opts [String] :code An optional alphanumeric custom code to use instead of an auto-generated code
-    #   @option opts [String] :locale The language to use for the verification message (where applicable)
-    #   @option opts [Integer] :channel_timeout Wait time in seconds before trying the next channel in the workflow
-    #   @option opts [String] :client_ref Reference to be included in callbacks
-    #   @option opts [Boolean] If used, must be set to `false`. Will bypass a network block for a single Verify V2 request
-    #
-    def start_verification_options(**opts)
-      StartVerificationOptions.new(**opts)
-    end
-
-    # Instantiate a new Vonage::Verify2::Workflow object
-    def workflow
-      Workflow.new
-    end
-
-    # Return the Vonage::Verify2::WorkflowBuilder class
-    def workflow_builder
-      WorkflowBuilder.itself
-    end
-  end
-end

data/lib/vonage/video/archives/list_response.rb

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

data/lib/vonage/video/broadcasts/list_response.rb

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