vonage 7.8.2 → 7.36.0

data/lib/vonage/numbers.rb

@@ -5,6 +5,8 @@ module Vonage
   class Numbers < Namespace
     include Keys
 
+    self.authentication = Basic
+
     self.host = :rest_host
 
     # Retrieve all the inbound numbers associated with your Vonage account.
@@ -15,6 +17,8 @@ module Vonage
     #     puts "#{item.msisdn} #{item.country} #{item.type}"
     #   end
     #
+    # @param [Hash] params
+    #
     # @option params [String] :application_id
     #   The application that you want to return the numbers for.
     #
@@ -45,14 +49,12 @@ module Vonage
     #   Set this to `true` to auto-advance through all the pages in the record
     #   and collect all the data. The default is `false`.
     #
-    # @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)
+      request("/account/numbers", params: params, response_class: ListResponse)
     end
 
     # Retrieve inbound numbers that are available for the specified country.
@@ -63,6 +65,8 @@ module Vonage
     #     puts "#{item.msisdn} #{item.type} #{item.cost}"
     #   end
     #
+    # @param [Hash] params
+    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -80,7 +84,7 @@ module Vonage
     #   - `2` - Search for numbers that end with **:pattern**
     #
     # @option params [String] :features
-    #   Available features are `SMS` and `VOICE`.
+    #   Available features are `SMS`, `MMS`, and `VOICE`.
     #   To look for numbers that support both, use a comma-separated value: `SMS,VOICE`.
     #
     # @option params [Integer] :size
@@ -93,14 +97,12 @@ module Vonage
     #   Set this to `true` to auto-advance through all the pages in the record
     #   and collect all the data. The default is `false`.
     #
-    # @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)
+      request("/number/search", params: params, response_class: ListResponse)
     end
 
     # Request to purchase a specific inbound number.
@@ -108,6 +110,8 @@ module Vonage
     # @example
     #   response = client.numbers.buy(country: 'GB', msisdn: '447700900000')
     #
+    # @param [Hash] params
+    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -118,14 +122,17 @@ module Vonage
     #   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)
+      request(
+        "/number/buy",
+        params: params,
+        type: Post,
+        response_class: Response
+      )
     end
 
     # Cancel your subscription for a specific inbound number.
@@ -133,6 +140,8 @@ module Vonage
     # @example
     #   response = client.numbers.cancel(country: 'GB', msisdn: '447700900000')
     #
+    # @param [Hash] params
+    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -143,14 +152,17 @@ module Vonage
     #   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)
+      request(
+        "/number/cancel",
+        params: params,
+        type: Post,
+        response_class: Response
+      )
     end
 
     # Change the behaviour of a number that you own.
@@ -165,6 +177,8 @@ module Vonage
     #
     #   response = client.numbers.update(params)
     #
+    # @param [Hash] params
+    #
     # @option params [required, String] :country
     #   The two character country code in ISO 3166-1 alpha-2 format.
     #
@@ -191,21 +205,30 @@ module Vonage
     # @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)
+      request(
+        "/number/update",
+        params: camelcase(params),
+        type: Post,
+        response_class: Response
+      )
     end
 
     private
 
     # A specific implementation of iterable_request for Numbers, because the Numbers API
     # handles pagination differently to other Vonage APIs
-    def iterable_request(path, response: nil, response_class: nil, params: {}, &block)
+    def iterable_request(
+      path,
+      response: nil,
+      response_class: nil,
+      params: {},
+      &block
+    )
       response = parse(response, response_class)
       params[:index] = 1 unless params.has_key?(:index)
       size = params.fetch(:size, 10)

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,71 @@
+# 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
+    #
+    # @deprecated
+    #
+    # @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)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      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,116 @@
+# 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
+    #
+    # @deprecated
+    #
+    # @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:)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      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
+    #
+    # @deprecated
+    #
+    # @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:)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      request("/v0.1/bulk/lists/#{list_id}/items/#{item_id}")
+    end
+
+    # Update list item
+    #
+    # @deprecated
+    #
+    # @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:)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      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
+    #
+    # @deprecated
+    #
+    # @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:)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      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,116 @@
+# 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
+    #
+    # @deprecated
+    #
+    # @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)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      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
+    #
+    # @deprecated
+    #
+    # @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)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      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
+    #
+    # @deprecated
+    #
+    # @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:)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      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