vonage 7.11.0 → 7.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95210747eb477199b15e3e5349e2bddfe7650928e8caae6a0275dde92381b835
-  data.tar.gz: '00917603bc90d21275328916969cd1af6b5925e6d034aa557705027ae514f7f8'
+  metadata.gz: 7ab386887cbecc55b2e4c2fe915edb4ec7cac9bfc62d7205d577daf2f451b443
+  data.tar.gz: ba606e264741711abdc23d3109b9a741efd8e6848e0743e48719c7414478d10e
 SHA512:
-  metadata.gz: 523f1f2cb099dfe781a065eb538fd45fd5d06bdb1b71156f10e119c3d4890f1df1c86ce29bfa17a3fb28231d8906deec0a2a66d41b8780e1fe5a892be6bea5b8
-  data.tar.gz: ecbfe4149f794e02ab6835de0fee165bc708036cb8ff4e672d77437e94bda0a4a1fef836eddc4ba0583b6058a2f8cc7ee81a5c29b0f28dad84416ccd8b694e09
+  metadata.gz: e3d11a57f0782eff2acc885e8edc0243f5acb6f93e27c54dc3ff057a15b3b82c413fb24deda53519e5d3d7b109e22de21244eed798ef8c5cb8abb070117bdac5
+  data.tar.gz: b199fe7cc3e00eb2a7bb13e62f2448c3cda49dfe7c7b476825872074fe71e89d7f930778d75f83f8b1204c6429155bc363e85468a5c71b89849a8037fb37220a

data/lib/vonage/client.rb

@@ -96,6 +96,13 @@ module Vonage
       @pricing ||= T.let(PricingTypes.new(config), T.nilable(Vonage::PricingTypes))
     end
 
+    # @return [ProactiveConnect]
+    #
+    sig { returns(T.nilable(Vonage::ProactiveConnect)) }
+    def proactive_connect
+      @proactive_connect ||= T.let(ProactiveConnect.new(config), T.nilable(Vonage::ProactiveConnect))
+    end
+
     # @return [Redact]
     #
     sig { returns(T.nilable(Vonage::Redact)) }
@@ -117,6 +124,13 @@ module Vonage
       @sms ||= T.let(SMS.new(config), T.nilable(Vonage::SMS))
     end
 
+    # @return [Subaccounts]
+    #
+    sig { returns(T.nilable(Vonage::Subaccounts)) }
+    def subaccounts
+      @subaccounts ||= T.let(Subaccounts.new(config), T.nilable(Vonage::Subaccounts))
+    end
+
     # @return [TFA]
     #
     sig { returns(T.nilable(Vonage::TFA)) }

data/lib/vonage/config.rb

@@ -18,6 +18,7 @@ module Vonage
       self.signature_secret = ENV['VONAGE_SIGNATURE_SECRET']
       self.signature_method = ENV['VONAGE_SIGNATURE_METHOD'] || 'md5hash'
       self.token = T.let(nil, T.nilable(String))
+      self.vonage_host = 'api-eu.vonage.com'
     end
 
     # Merges the config with the given options hash.
@@ -198,6 +199,9 @@ module Vonage
     sig { params(token: T.nilable(String)).returns(T.nilable(String)) }
     attr_writer :token
 
+    sig { returns(String) }
+    attr_accessor :vonage_host
+
     protected
 
     sig { params(name: Symbol, value: T.untyped).void }

data/lib/vonage/namespace.rb

@@ -1,6 +1,7 @@
 # typed: true
 # frozen_string_literal: true
 require 'net/http'
+require 'net/http/post/multipart'
 require 'json'
 
 module Vonage
@@ -8,7 +9,8 @@ module Vonage
     def initialize(config)
       @config = config
 
-      @host = self.class.host == :api_host ? @config.api_host : @config.rest_host
+      # @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
@@ -51,6 +53,7 @@ module Vonage
 
     Get = Net::HTTP::Get
     Put = Net::HTTP::Put
+    Patch = Net::HTTP::Patch
     Post = Net::HTTP::Post
     Delete = Net::HTTP::Delete
 
@@ -117,6 +120,36 @@ module Vonage
       end
     end
 
+    def multipart_post_request(path, filepath:, file_name:, mime_type:, response_class: Response, &block)
+      authentication = self.class.authentication.new(@config)
+
+      uri = URI('https://' + @host + path)
+
+      response = File.open(filepath) do |file|
+        request = Net::HTTP::Post::Multipart.new(
+          uri,
+          {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)
+
+        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)
@@ -217,6 +250,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

data/lib/vonage/proactive_connect/list.rb

@@ -0,0 +1,168 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class ProactiveConnect::List < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.host = :vonage_host
+
+    self.request_body = JSON
+
+    # Create list
+    #
+    # @example
+    #   response = proactive_connect.list.create(name: 'List Number 1')
+    #
+    # @param [required, String] :name
+    #   A name for the list
+    #
+    # @param [optional, String] :description
+    #   A description of the list
+    #
+    # @param [optional, Array] :tags
+    #   An Array of up to 10 Strings assigining tags to the list. Each String must be between 1 and 15 characters
+    #
+    # @param [optional, Array] :attributes
+    #   Array of Hash objects. Each Hash represents an attribute for the list.
+    #
+    # @option attributes [required, String] :name
+    #   The name of the attribute
+    #
+    # @option attributes [optional, String] :alias
+    #   Alternative name to use for this attribute.
+    #   Use when you wish to correlate between 2 or more list that are using different attribute names for the same semantic data
+    #
+    # @option attributes [optional, Boolean] :key
+    #   Set to `true` if this attribute should be used to correlate between 2 or more lists. Default is `false`
+    #
+    # @param [optional, Hash] :datasource
+    #   Datasource for the list
+    #
+    # @option datasource [required, String] :type
+    #   Must be set to `manual`, which is the default
+    #
+    # @see https://developer.vonage.com/en/api/proactive-connect#listsCreate
+    #
+    def create(name:, **params)
+      request(
+        "/v0.1/bulk/lists",
+        params: params.merge({ name: name }),
+        type: Post
+      )
+    end
+
+    # Get list by id
+    #
+    # @example
+    #   response = proactive_connect.list.find(id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865')
+    #
+    # @param [required, String] :id
+    #   Unique identifier for the list
+    #
+    # @see https://developer.vonage.com/en/api/proactive-connect#listsGet
+    #
+    def find(id:)
+      request("/v0.1/bulk/lists/#{id}")
+    end
+
+    # Update list
+    #
+    # @example
+    #   response = proactive_connect.list.update(name: 'List Number 1')
+    #
+    # @param [required, String] :id
+    #   The id of the list to update
+    #
+    # @param [required, String] :name
+    #   The name of the list
+    #
+    # @param [optional, String] :description
+    #   A description of the list
+    #
+    # @param [optional, Array] :tags
+    #   An Array of up to 10 Strings assigining tags to the list. Each String must be between 1 and 15 characters
+    #
+    # @param [optional, Array] :attributes
+    #   Array of Hash objects. Each Hash represents an attribute for the list.
+    #
+    # @option attributes [required, String] :name
+    #   The name of the attribute
+    #
+    # @option attributes [optional, String] :alias
+    #   Alternative name to use for this attribute.
+    #   Use when you wish to correlate between 2 or more list that are using different attribute names for the same semantic data
+    #
+    # @option attributes [optional, Boolean] :key
+    #   Set to `true` if this attribute should be used to correlate between 2 or more lists. Default is `false`
+    #
+    # @param [optional, Hash] :datasource
+    #   Datasource for the list
+    #
+    # @option datasource [required, String] :type
+    #   Must be set to `manual`, which is the default
+    #
+    # @see https://developer.vonage.com/en/api/proactive-connect#listsUpdate
+    #
+    def update(id:, name:, **params)
+      request(
+        "/v0.1/bulk/lists/#{id}",
+        params: params.merge({ name: name }),
+        type: Put
+      )
+    end
+
+    # Delete a list by id
+    #
+    # @example
+    #   response = proactive_connect.list.delete(id: '74ea1ecf-06c9-4072-a285-61677bd353e8')
+    #
+    # @param [required, String] :id
+    #   Unique identifier for the list
+    #
+    # @see https://developer.vonage.com/en/api/proactive-connect#listsDelete
+    #
+    def delete(id:)
+      request(
+        "/v0.1/bulk/lists/#{id}",
+        type: Delete
+      )
+    end
+
+    # Clear list by deleting all items
+    #
+    # @example
+    #   response = proactive_connect.list.clear_items(id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865')
+    #
+    # @param [required, String] :id
+    #   Unique identifier for the list
+    #
+    # @see https://developer.vonage.com/en/api/proactive-connect#listsClear
+    #
+    def clear_items(id:)
+      request(
+        "/v0.1/bulk/lists/#{id}/clear",
+        type: Post
+      )
+    end
+
+    # Fetch and replace all items from datasource
+    #
+    # @example
+    #   response = proactive_connect.list.fetch_and_replace_items(id: 'e546eebe-8e23-4e4d-bb7c-29d4700c9865')
+    #
+    # @param [required, String] :id
+    #   Unique identifier for the list
+    #
+    # @see https://developer.vonage.com/en/api/proactive-connect#listsFetch
+    #
+    def fetch_and_replace_items(id:)
+      request(
+        "/v0.1/bulk/lists/#{id}/fetch",
+        type: Post
+      )
+    end
+  end
+end

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

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

data/lib/vonage/proactive_connect/lists.rb

@@ -0,0 +1,35 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class ProactiveConnect::Lists < Namespace
+    extend T::Sig
+
+    self.authentication = BearerToken
+
+    self.host = :vonage_host
+
+    # Find all lists
+    #
+    # @example
+    #   response = proactive_connect.lists.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#listsFindAll
+    #
+    def list(**params)
+      path = "/v0.1/bulk/lists"
+      path += "?#{Params.encode(params)}" unless params.empty?
+
+      request(path, response_class: ListResponse)
+    end
+  end
+end

data/lib/vonage/proactive_connect.rb

@@ -0,0 +1,33 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class ProactiveConnect < Namespace
+    extend T::Sig
+
+    sig { returns(T.nilable(Vonage::ProactiveConnect::Lists)) }
+    def lists
+      @lists ||= Lists.new(@config)
+    end
+
+    sig { returns(T.nilable(Vonage::ProactiveConnect::List)) }
+    def list
+      @list ||= List.new(@config)
+    end
+
+    sig { returns(T.nilable(Vonage::ProactiveConnect::Items)) }
+    def items
+      @items ||= Items.new(@config)
+    end
+
+    sig { returns(T.nilable(Vonage::ProactiveConnect::Item)) }
+    def item
+      @item ||= Item.new(@config)
+    end
+
+    sig { returns(T.nilable(Vonage::ProactiveConnect::Events)) }
+    def events
+      @events ||= Events.new(@config)
+    end
+  end
+end

data/lib/vonage/subaccounts/balance_transfers/list_response.rb

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

data/lib/vonage/subaccounts/credit_transfers/list_response.rb

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

data/lib/vonage/subaccounts/list_response.rb

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

data/lib/vonage/subaccounts.rb

@@ -0,0 +1,203 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Vonage
+  class Subaccounts < Namespace
+    self.authentication = Basic
+
+    self.request_body = JSON
+
+    # Retrieve list of subaccounts.
+    #
+    # @example
+    #   response = client.subaccounts.list
+    #
+    # @see https://developer.vonage.com/en/api/subaccounts#retrieveSubaccountsList
+    #
+    def list
+      request("/accounts/#{@config.api_key}/subaccounts", response_class: ListResponse)
+    end
+
+    # Retrieve a subaccount.
+    #
+    # @example
+    #   response = client.subaccounts.find(subaccount_key: 'abc123')
+    #
+    # @option params [required, String] :subaccount_key
+    #   The API key for the subaccount you want to retrieve
+    #
+    # @see https://developer.vonage.com/en/api/subaccounts#retrieveSubaccount
+    #
+    def find(subaccount_key:)
+      request("/accounts/#{@config.api_key}/subaccounts/#{subaccount_key}")
+    end
+
+    # Create a subaccount.
+    #
+    # @example
+    #   response = client.subaccounts.create(name: 'Foo')
+    #
+    # @option params [required, String] :name
+    #   The name of the subaccount
+    #
+    # @option params [optional, String] :secret
+    #   An account secret for use by the subaccount. Can be used in combination with your API key to authenticate your API requests.
+    #   Requirements:
+    #     - 8 characters and no more than 25
+    #     - 1 lower-case letter
+    #     - 1 capital letter
+    #     - 1 digit
+    #     - must be unique
+    #
+    # @option params [optional, Boolean] :use_primary_account_balance
+    #   Whether the subaccount uses the primary account balance (true, the default) or has its own balance (false).
+    #   Once set to `false` cannot be changed back to `true`
+    #
+    # @see https://developer.vonage.com/en/api/subaccounts#createSubAccount
+    #
+    def create(name:, **params)
+      request("/accounts/#{@config.api_key}/subaccounts", params: params.merge(name: name), type: Post)
+    end
+
+    # Modify a subaccount.
+    #
+    # @example
+    #   response = client.subaccounts.update(name: 'Bar')
+    #
+    # @option params [required, String] :subaccount_key
+    #   The API key for the subaccount you want to modify
+    #
+    # @option params [optional, String] :name
+    #   The name of the subaccount
+    #
+    # @option params [optional, Boolean] :use_primary_account_balance
+    #   Whether the subaccount uses the primary account balance (true, the default) or has its own balance (false).
+    #   Once set to `false` cannot be changed back to `true`
+    #
+    # @option params [optional, String] :suspended
+    #   Whether the subaccount is suspended (true) or not (false, the default)
+    #
+    # @see https://developer.vonage.com/en/api/subaccounts#modifySubaccount
+    #
+    def update(subaccount_key:, **params)
+      request("/accounts/#{@config.api_key}/subaccounts/#{subaccount_key}", params: params, type: Patch)
+    end
+
+    # Retrieve list of credit transfers.
+    #
+    # @example
+    #   response = client.subaccounts.list_credit_transfers(start_date: "2023-06-15T15:53:50Z")
+    #
+    # @option params [optional, String] :start_date
+    #   The ISO format datetime from which to list transfers. Example: 2019-03-02T16:34:49Z.
+    #   Defaults to "1970-01-01T00:00:00Z" if omitted
+    #
+    # @option params [optional, String] :end_date
+    #   The ISO format datetime to which to list transfers. Example: 2019-03-02T16:34:49Z.
+    #   If absent then all transfers until now is returned.
+    #
+    # @option params [optional, String] :subaccount
+    #   Subaccount to filter by.
+    #
+    # @see https://developer.vonage.com/en/api/subaccounts#retrieveCreditTransfers
+    #
+    def list_credit_transfers(start_date: "1970-01-01T00:00:00Z", **params)
+      path = "/accounts/#{@config.api_key}/credit-transfers?#{Params.encode(params.merge(start_date: start_date))}"
+
+      request(path, response_class: CreditTransfers::ListResponse)
+    end
+
+    # Transfer credit.
+    #
+    # @example
+    #   response = client.subaccounts.transfer_credit(from: 'abc123', to: 'def456', amount: 10.00)
+    #
+    # @option params [required, String] :from
+    #   The API key of the account or subaccount to transfer credit from.
+    #
+    # @option params [required, String] :to
+    #   The API key of the account or subaccount to transfer credit to.
+    #
+    # @option params [required, Number] :amount
+    #   The amount to transfer
+    #
+    # @option params [optional, String] :reference
+    #   A reference for the transfer.
+    #
+    # @see https://developer.vonage.com/en/api/subaccounts#transferCredit
+    #
+    def transfer_credit(from:, to:, amount:, **params)
+      request("/accounts/#{@config.api_key}/credit-transfers", params: params.merge(from: from, to: to, amount: amount), type: Post)
+    end
+
+    # Retrieve list of balance transfers.
+    #
+    # @example
+    #   response = client.subaccounts.list_balance_transfers(start_date: "2023-06-15T15:53:50Z")
+    #
+    # @option params [optional, String] :start_date
+    #   The ISO format datetime from which to list transfers. Example: 2019-03-02T16:34:49Z.
+    #   Defaults to "1970-01-01T00:00:00Z" if omitted
+    #
+    # @option params [optional, String] :end_date
+    #   The ISO format datetime to which to list transfers. Example: 2019-03-02T16:34:49Z.
+    #   If absent then all transfers until now is returned.
+    #
+    # @option params [optional, String] :subaccount
+    #   Subaccount to filter by.
+    #
+    # @see https://developer.vonage.com/en/api/subaccounts#retrieveBalanceTransfers
+    #
+    def list_balance_transfers(start_date: "1970-01-01T00:00:00Z", **params)
+      path = "/accounts/#{@config.api_key}/balance-transfers?#{Params.encode(params.merge(start_date: start_date))}"
+
+      request(path, response_class: BalanceTransfers::ListResponse)
+    end
+
+    # Transfer balance.
+    #
+    # @example
+    #   response = client.subaccounts.transfer_balance(from: 'abc123', to: 'def456', amount: 10.00)
+    #
+    # @option params [required, String] :from
+    #   The API key of the account or subaccount to transfer balance from.
+    #
+    # @option params [required, String] :to
+    #   The API key of the account or subaccount to transfer balance to.
+    #
+    # @option params [required, Number] :amount
+    #   The amount to transfer
+    #
+    # @option params [optional, String] :reference
+    #   A reference for the transfer.
+    #
+    # @see https://developer.vonage.com/en/api/subaccounts#transferBalance
+    #
+    def transfer_balance(from:, to:, amount:, **params)
+      request("/accounts/#{@config.api_key}/balance-transfers", params: params.merge(from: from, to: to, amount: amount), type: Post)
+    end
+
+    # Transfer number.
+    #
+    # @example
+    #   response = client.subaccounts.transfer_number(from: 'abc123', to: 'def456', number: 447900000000, country: 'GB')
+    #
+    # @option params [required, String] :from
+    #   The API key of the account or subaccount to transfer the number from.
+    #
+    # @option params [required, String] :to
+    #   The API key of the account or subaccount to transfer the number to.
+    #
+    # @option params [required, Number] :number
+    #   The number to transfer
+    #
+    # @option params [required, String] :country
+    #   An ISO-3166-1 alpha 2 code representing the country for the number, e.g. GB.
+    #
+    # @see https://developer.vonage.com/en/api/subaccounts#transferNumber
+    #
+    def transfer_number(from:, to:, number:, country:)
+      request("/accounts/#{@config.api_key}/transfer-number", params: {from: from, to: to, number: number, country: country}, type: Post)
+    end
+  end
+end

data/lib/vonage/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 
 module Vonage
-  VERSION = "7.11.0"
+  VERSION = "7.13.0"
 end

data/vonage.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
   s.add_dependency('vonage-jwt', '~> 0.1.0')
   s.add_dependency('zeitwerk', '~> 2', '>= 2.2')
   s.add_dependency('sorbet-runtime', '~> 0.5')
+  s.add_dependency('multipart-post', '~> 2.0')
   s.add_runtime_dependency('rexml')
   s.add_runtime_dependency('phonelib')
   s.require_path = 'lib'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vonage
 version: !ruby/object:Gem::Version
-  version: 7.11.0
+  version: 7.13.0
 platform: ruby
 authors:
 - Vonage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-16 00:00:00.000000000 Z
+date: 2023-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vonage-jwt
@@ -58,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: multipart-post
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +155,16 @@ files:
 - lib/vonage/params.rb
 - lib/vonage/pricing.rb
 - lib/vonage/pricing_types.rb
+- lib/vonage/proactive_connect.rb
+- lib/vonage/proactive_connect/events.rb
+- lib/vonage/proactive_connect/events/list_response.rb
+- lib/vonage/proactive_connect/item.rb
+- lib/vonage/proactive_connect/items.rb
+- lib/vonage/proactive_connect/items/file_response.rb
+- lib/vonage/proactive_connect/items/list_response.rb
+- lib/vonage/proactive_connect/list.rb
+- lib/vonage/proactive_connect/lists.rb
+- lib/vonage/proactive_connect/lists/list_response.rb
 - lib/vonage/redact.rb
 - lib/vonage/response.rb
 - lib/vonage/secrets.rb
@@ -149,6 +173,10 @@ files:
 - lib/vonage/service_error.rb
 - lib/vonage/signature.rb
 - lib/vonage/sms.rb
+- lib/vonage/subaccounts.rb
+- lib/vonage/subaccounts/balance_transfers/list_response.rb
+- lib/vonage/subaccounts/credit_transfers/list_response.rb
+- lib/vonage/subaccounts/list_response.rb
 - lib/vonage/tfa.rb
 - lib/vonage/user_agent.rb
 - lib/vonage/verify.rb