vonage 7.12.0 → 7.14.0

data/lib/vonage/meetings.rb

@@ -0,0 +1,38 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vonage
+  class Meetings < Namespace
+    extend T::Sig
+    
+    sig { returns(T.nilable(Vonage::Meetings::Rooms)) }
+    def rooms
+      @rooms ||= Rooms.new(@config)
+    end
+
+    sig { returns(T.nilable(Vonage::Meetings::Recordings)) }
+    def recordings
+      @recordings ||= Recordings.new(@config)
+    end
+
+    sig { returns(T.nilable(Vonage::Meetings::Sessions)) }
+    def sessions
+      @sessions ||= Sessions.new(@config)
+    end
+
+    sig { returns(T.nilable(Vonage::Meetings::Themes)) }
+    def themes
+      @themes ||= Themes.new(@config)
+    end
+
+    sig { returns(T.nilable(Vonage::Meetings::Applications)) }
+    def applications
+      @applications ||= Applications.new(@config)
+    end
+
+    sig { returns(T.nilable(Vonage::Meetings::DialInNumbers)) }
+    def dial_in_numbers
+      @dial_in_numbers ||= DialInNumbers.new(@config)
+    end
+  end
+end

data/lib/vonage/namespace.rb

@@ -1,6 +1,8 @@
 # typed: true
 # frozen_string_literal: true
+
 require 'net/http'
+require 'net/http/post/multipart'
 require 'json'
 
 module Vonage
@@ -8,7 +10,7 @@ module Vonage
     def initialize(config)
       @config = config
 
-      @host = self.class.host == :api_host ? @config.api_host : @config.rest_host
+      @host = set_host
 
       @http = Net::HTTP.new(@host, Net::HTTP.https_default_port, p_addr = nil)
       @http.use_ssl = true
@@ -21,7 +23,7 @@ module Vonage
     end
 
     def self.host=(host)
-      raise ArgumentError unless host == :rest_host
+      raise ArgumentError unless %i[rest_host vonage_host].include?(host)
 
       @host = host
     end
@@ -47,6 +49,7 @@ module Vonage
     end
 
     protected
+
     # :nocov:
 
     Get = Net::HTTP::Get
@@ -59,7 +62,7 @@ module Vonage
       authentication = self.class.authentication.new(@config)
       authentication.update(params)
 
-      uri = URI('https://' + @host + path)
+      uri = URI("https://" + @host + path)
       unless type.const_get(:REQUEST_HAS_BODY) || params.empty?
         uri.query = Params.encode(params)
       end
@@ -71,17 +74,20 @@ module Vonage
       request = type.new(uri)
 
       # set headers
-      request['User-Agent'] = UserAgent.string(@config.app_name, @config.app_version)
-      request['Accept'] = 'application/json'
-      self.class.request_headers.each do |key, value|
-        request[key] = value
-      end
+      request["User-Agent"] = UserAgent.string(
+        @config.app_name,
+        @config.app_version
+      )
+      request["Accept"] = "application/json"
+      self.class.request_headers.each { |key, value| request[key] = value }
 
       # Set BearerToken if needed
       authentication.update(request)
 
       # set body
-      self.class.request_body.update(request, params) if type.const_get(:REQUEST_HAS_BODY)
+      if type.const_get(:REQUEST_HAS_BODY)
+        self.class.request_body.update(request, params)
+      end
 
       request
     end
@@ -101,16 +107,31 @@ module Vonage
     end
 
     def request(path, params: nil, type: Get, response_class: Response, &block)
-      auto_advance = !params.nil? && params.key?(:auto_advance) ? params[:auto_advance] : false
-
-      params = params.tap { |params| params.delete(:auto_advance) } if !params.nil? && params.key?(:auto_advance)
+      auto_advance =
+        (
+          if !params.nil? && params.key?(:auto_advance)
+            params[:auto_advance]
+          else
+            false
+          end
+        )
+
+      params =
+        params.tap { |params| params.delete(:auto_advance) } if !params.nil? &&
+        params.key?(:auto_advance)
 
       request = build_request(path: path, params: params || {}, type: type)
 
       response = make_request!(request, &block)
 
       if auto_advance
-        iterable_request(path, response: response, response_class: response_class, params: params, &block)
+        iterable_request(
+          path,
+          response: response,
+          response_class: response_class,
+          params: params,
+          &block
+        )
       else
         return if block
 
@@ -118,22 +139,59 @@ module Vonage
       end
     end
 
+    def multipart_post_request(path, filepath:, file_name:, mime_type:, params: {}, override_uri: nil, no_auth: false, response_class: Response, &block)
+      authentication = self.class.authentication.new(@config) unless no_auth
+
+      uri = override_uri ? URI(override_uri) : URI('https://' + @host + path)
+
+      http = override_uri ? Net::HTTP.new(uri.host, Net::HTTP.https_default_port, p_addr = nil) : @http
+      http.use_ssl = true
+      http.set_debug_output($stdout)
+
+      response = File.open(filepath) do |file|
+        request = Net::HTTP::Post::Multipart.new(
+          uri,
+          params.merge(file: Multipart::Post::UploadIO.new(file, mime_type, file_name))
+        )
+
+        request['User-Agent'] = UserAgent.string(@config.app_name, @config.app_version)
+
+        # Set BearerToken if needed
+        authentication.update(request) unless no_auth
+
+        logger.log_request_info(request)
+
+        http.request(request, &block)
+      end
+
+      logger.log_response_info(response, @host)
+
+      return if block
+
+      logger.debug(response.body) if response.body
+
+      parse(response, response_class)
+    end
+
     def iterable_request(path, response: nil, response_class: nil, params: {}, &block)
       json_response = ::JSON.parse(response.body)
       response = parse(response, response_class)
       remainder = remaining_count(json_response)
 
       while remainder > 0
-        params = { page_size: json_response['page_size'] }
-
-        if json_response['record_index'] && json_response['record_index'] == 0
-          params[:record_index] = json_response['page_size']
-        elsif json_response['record_index'] && json_response['record_index'] != 0
-          params[:record_index] = (json_response['record_index'] + json_response['page_size'])
+        params = { page_size: json_response["page_size"] }
+
+        if json_response["record_index"] && json_response["record_index"] == 0
+          params[:record_index] = json_response["page_size"]
+        elsif json_response["record_index"] &&
+              json_response["record_index"] != 0
+          params[:record_index] = (
+            json_response["record_index"] + json_response["page_size"]
+          )
         end
 
-        if json_response['total_pages']
-          params[:page] = json_response['page'] + 1
+        if json_response["total_pages"]
+          params[:page] = json_response["page"] + 1
         end
 
         request = build_request(path: path, type: Get, params: params)
@@ -144,11 +202,15 @@ module Vonage
         json_response = ::JSON.parse(paginated_response.body)
         remainder = remaining_count(json_response)
 
-        if response.respond_to?('_embedded')
-          collection_name = collection_name(response['_embedded'])
-          response['_embedded'][collection_name].push(*next_response['_embedded'][collection_name])
+        if response.respond_to?("_embedded")
+          collection_name = collection_name(response["_embedded"])
+          response["_embedded"][collection_name].push(
+            *next_response["_embedded"][collection_name]
+          )
         else
-          response[collection_name(response)].push(*next_response[collection_name(next_response)])
+          response[collection_name(response)].push(
+            *next_response[collection_name(next_response)]
+          )
         end
       end
 
@@ -156,43 +218,51 @@ module Vonage
     end
 
     def remaining_count(params)
-      if params.key?('total_pages')
-        params['total_pages'] - params['page']
-      elsif params.key?('count')
-        params['count'] - (params['record_index'] == 0 ? params['page_size'] : (params['record_index'] + params['page_size']))
+      if params.key?("total_pages")
+        params["total_pages"] - params["page"]
+      elsif params.key?("count")
+        params["count"] -
+          (
+            if params["record_index"] == 0
+              params["page_size"]
+            else
+              (params["record_index"] + params["page_size"])
+            end
+          )
       else
         0
       end
     end
 
     def collection_name(params)
-      @collection_name ||= case
-        when params.respond_to?('calls')
-          'calls'
-        when params.respond_to?('users')
-          'users'
-        when params.respond_to?('legs')
-          'legs'
-        when params.respond_to?('data')
-          'data'
-        when params.respond_to?('conversations')
-          'conversations'
-        when params.respond_to?('applications')
-          'applications'
-        when params.respond_to?('records')
-          'records'
-        when params.respond_to?('reports')
-          'reports'
-        when params.respond_to?('networks')
-          'networks'
-        when params.respond_to?('countries')
-          'countries'
-        when params.respond_to?('media')
-          'media'
-        when params.respond_to?('numbers')
-          'numbers'
-        when params.respond_to?('events')
-          'events'
+      @collection_name ||=
+        case
+        when params.respond_to?("calls")
+          "calls"
+        when params.respond_to?("users")
+          "users"
+        when params.respond_to?("legs")
+          "legs"
+        when params.respond_to?("data")
+          "data"
+        when params.respond_to?("conversations")
+          "conversations"
+        when params.respond_to?("applications")
+          "applications"
+        when params.respond_to?("records")
+          "records"
+        when params.respond_to?("reports")
+          "reports"
+        when params.respond_to?("networks")
+          "networks"
+        when params.respond_to?("countries")
+          "countries"
+        when params.respond_to?("media")
+          "media"
+        when params.respond_to?("numbers")
+          "numbers"
+        when params.respond_to?("events")
+          "events"
         else
           params.entity.attributes.keys[0].to_s
         end
@@ -218,6 +288,19 @@ module Vonage
     def logger
       @config.logger
     end
+
+    private
+
+    def set_host
+      case self.class.host
+      when :rest_host
+        @config.rest_host
+      when :vonage_host
+        @config.vonage_host
+      else
+        @config.api_host
+      end
+    end
   end
 
   private_constant :Namespace

data/lib/vonage/proactive_connect/events/list_response.rb

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

data/lib/vonage/proactive_connect/events.rb

@@ -0,0 +1,68 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class ProactiveConnect::Events < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.host = :vonage_host
+
+    # Find all events
+    #
+    # @example
+    #   response = proactive_connect.events.list
+    #
+    # @param [optional, String] :page
+    #   Page of results to jump to
+    #
+    # @param [optional, String] :page_size
+    #   Number of results per page
+    #
+    # @param [optional, String] order
+    #   Sort in either ascending (asc, the default) or descending (desc) order
+    #
+    # @param [optional, String] :run_id
+    #   Run IDs to filter by, if not specified, returns events for any run id
+    #
+    # @param [optional, String] :type
+    #   Event types to filter by
+    #
+    # @param [optional, String] action_id
+    #   Action IDs to filter by.
+    #
+    # @param [optional, String] :invocation_id
+    #   Invocation IDs to filter by
+    #
+    # @param [optional, String] :recipient_id
+    #   Recipient IDs to filter by
+    #
+    # @param [optional, String] :run_item_id
+    #   Run item IDs to filter by
+    #
+    # @param [optional, String] src_ctx
+    #   The name of the segment / matcher the item / event to filter by (exact string)
+    #
+    # @param [optional, String] :src_type
+    #   Source types to filter by
+    #
+    # @param [optional, String] :trace_id
+    #   Trace IDs to filter events by
+    #
+    # @param [optional, String] date_start
+    #   ISO-8601 formatted date for when to begin events filter
+    #
+    # @param [optional, String] :date_end
+    #   ISO-8601 formatted date for when to end events filter
+    #
+    # @see https://developer.vonage.com/en/api/proactive-connect#eventsFindAll
+    #
+    def list(**params)
+      path = "/v0.1/bulk/events"
+      path += "?#{Params.encode(params)}" unless params.empty?
+
+      request(path, response_class: ListResponse)
+    end
+  end
+end

data/lib/vonage/proactive_connect/item.rb

@@ -0,0 +1,104 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class ProactiveConnect::Item < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.host = :vonage_host
+
+    self.request_body = JSON
+
+    # Create a list item
+    #
+    # @example
+    #   response = proactive_connect.item.create(list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865', data: {name: 'Joe Bloggs', email: 'joe@email.com'})
+    #
+    # @param [required, String] :list_id
+    #   Unique identifier for the list
+    #
+    # @param [required, Hash] :data
+    #   A hash of data containing the item's data attributes and values
+    #
+    # @see https://developer.vonage.com/en/api/proactive-connect#itemsCreate
+    #
+    def create(list_id:, data:)
+      raise ArgumentError.new(":data must be a Hash") unless data.is_a? Hash
+      request(
+        "/v0.1/bulk/lists/#{list_id}/items",
+        params: { data: data },
+        type: Post
+      )
+    end
+
+    # Get list item by id
+    #
+    # @example
+    #   response = proactive_connect.item.find(list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865', item_id: 'd97ebf20-e4de-4e50-921a-7bb4dceb373a')
+    #
+    # @param [required, String] :list_id
+    #   Unique identifier for the list
+    #
+    # @param [required, String] :item_id
+    #   Unique identifier for the item
+    #
+    # @see https://developer.vonage.com/en/api/proactive-connect#itemsGet
+    #
+    def find(list_id:, item_id:)
+      request("/v0.1/bulk/lists/#{list_id}/items/#{item_id}")
+    end
+
+    # Update list item
+    #
+    # @example
+    #   response = proactive_connect.item.create(
+    #     list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865',
+    #     item_id: 'd97ebf20-e4de-4e50-921a-7bb4dceb373a',
+    #     data: {name: 'Jane Bloggs', email: 'joe@email.com'}
+    #   )
+    #
+    # @param [required, String] :list_id
+    #   Unique identifier for the list
+    #
+    # @param [required, String] :item_id
+    #   Unique identifier for the item
+    #
+    # @param [required, Hash] :data
+    #   A hash of data containing the item's data attributes and values
+    #   All attributes for the item must be passed, even ones for which the value is not changing.
+    #     If an attribute is omitted, existing data for that attribute will be deleted.
+    #
+    # @see https://developer.vonage.com/en/api/proactive-connect#itemsUpdate
+    #
+    def update(list_id:, item_id:, data:)
+      raise ArgumentError.new(":data must be a Hash") unless data.is_a? Hash
+      request(
+        "/v0.1/bulk/lists/#{list_id}/items/#{item_id}",
+        params: { data: data },
+        type: Put
+      )
+    end
+
+    #  Delete list item
+    #
+    # @example
+    #   response = proactive_connect.item.delete(list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865', item_id: 'd97ebf20-e4de-4e50-921a-7bb4dceb373a')
+    #
+    # @param [required, String] :list_id
+    #   Unique identifier for the list
+    #
+    # @param [required, String] :item_id
+    #   Unique identifier for the item
+    #
+    # @see https://developer.vonage.com/en/api/proactive-connect#itemsDelete
+    #
+    def delete(list_id:, item_id:)
+      request(
+        "/v0.1/bulk/lists/#{list_id}/items/#{item_id}",
+        type: Delete
+      )
+    end
+  end
+end

data/lib/vonage/proactive_connect/items/file_response.rb

@@ -0,0 +1,32 @@
+# typed: true
+
+class Vonage::ProactiveConnect::Items::FileResponse < Vonage::Response
+  DEFAULT_FILENAME = 'vonage-proactive-connect-list-items.csv'
+
+  attr_accessor :filename
+
+  def initialize(entity=nil, http_response=nil)
+    super
+    self.filename = initial_filename
+  end
+
+  def save(filepath:)
+    pn = Pathname.new(filepath)
+    raise ArgumentError, ':filepath not a directory' unless pn.directory?
+    raise ArgumentError, ':filepath not absolute' unless pn.absolute?
+    raise ArgumentError, ':filepath not writable' unless pn.writable?
+
+    File.open("#{pn.cleanpath}/#{filename}", 'w') {|f| f.write(http_response.body) }
+  end
+
+  def data
+    http_response ? http_response.body : nil
+  end
+
+  private
+
+  def initial_filename
+    match_data = http_response['Content-Disposition'].match(/filename=(\"?)(.+)\1/)
+    match_data ? match_data[2] : DEFAULT_FILENAME
+  end
+end

data/lib/vonage/proactive_connect/items/list_response.rb

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

data/lib/vonage/proactive_connect/items.rb

@@ -0,0 +1,107 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class ProactiveConnect::Items < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.host = :vonage_host
+
+    # Find all list items
+    #
+    # @example
+    #   response = proactive_connect.items.list(list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865')
+    #
+    # @param [required, String] :list_id
+    #   Unique identifier for the list
+    #
+    # @param [optional, String] :page
+    #   Page of results to jump to
+    #
+    # @param [optional, String] :page_size
+    #   Number of results per page
+    #
+    # @param [optional, String] order
+    #   Sort in either ascending (asc, the default) or descending (desc) order
+    #
+    # @see https://developer.vonage.com/en/api/proactive-connect#itemsFindAll
+    #
+    def list(list_id:, **params)
+      path = "/v0.1/bulk/lists/#{list_id}/items"
+      path += "?#{Params.encode(params)}" unless params.empty?
+
+      request(path, response_class: ListResponse)
+    end
+
+    # Download list items as a CSV file format
+    #
+    # @example
+    #   response = proactive_connect.items.download_csv(list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865')
+    #
+    # @param [required, String] :list_id
+    #   ID for the list to download
+    #
+    # @param [optional, String] order
+    #   Sort in either ascending (asc, the default) or descending (desc) order
+    #
+    # @param [optional, String] :filename
+    #   A name to set for the returned File object. If not set, the File object will use the actual filename (if available)
+    #     or a default of `download.csv` if the actual filename is not available.
+    #
+    # @param [optional, String] :filepath
+    #   A filepath to a directory where the file should be written.
+    #   If not set, the file is not written, though the the file can be written at any time by calling `save` on the returned
+    #     object and passing in `:filepath` as an argument to the `save` method, for example:
+    #       response = proactive_connect.items.download_csv(list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865')
+    #       response.save('/files/downloads/')
+    #   If set, the filepath must be:
+    #     - An absolute path
+    #     - For a valid directory
+    #     - The directory must be writable
+    #
+    # @see https://developer.vonage.com/en/api/proactive-connect#itemsDownload
+    #
+    def download_csv(list_id:, order: 'asc', **params)
+      response = request("/v0.1/bulk/lists/#{list_id}/items/download?order=#{order}", response_class: FileResponse)
+
+      response.filename = params[:filename] if params[:filename]
+      response.save(filepath: params[:filepath]) if params[:filepath]
+
+      response
+    end
+
+    # Import list items from a CSV file
+    #
+    # @example
+    #   response = proactive_connect.items.upload_csv(list_id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865', filepath: '/files/import.csv')
+    #
+    # @param [required, String] :list_id
+    #   ID for the list to download
+    #
+    # @param [optional, String] order
+    #   Sort in either ascending (asc, the default) or descending (desc) order
+    #
+    # @param [optional, String] :filename
+    #   A name to set for the returned File object. If not set, the File object will use the actual filename (if available)
+    #     or a default of `download.csv` if the actual filename is not available.
+    #
+    # @param [required, String] :filepath
+    #   A filepath for the file to import. The file must be:
+    #     - A valid file
+    #     - Readable
+    #     - Must have a `.csv` extension
+    #
+    # @see https://developer.vonage.com/en/api/proactive-connect#itemsImport
+    #
+    def upload_csv(list_id:, filepath:)
+      pn = Pathname.new(filepath)
+      raise ArgumentError, ':filepath not for a file' unless pn.file?
+      raise ArgumentError, 'file at :filepath not readable' unless pn.readable?
+      raise ArgumentError, 'file at :filepath not csv' unless pn.extname == '.csv'
+
+      multipart_post_request("/v0.1/bulk/lists/#{list_id}/items/import", filepath: filepath, file_name: pn.basename, mime_type: 'text/csv')
+    end
+  end
+end