vonage 7.8.2 → 7.36.0

data/lib/vonage/proactive_connect/list.rb

@@ -0,0 +1,186 @@
+# 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
+    #
+    # @deprecated
+    #
+    # @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)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      request(
+        "/v0.1/bulk/lists",
+        params: params.merge({ name: name }),
+        type: Post
+      )
+    end
+
+    # Get list by id
+    #
+    # @deprecated
+    #
+    # @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:)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      request("/v0.1/bulk/lists/#{id}")
+    end
+
+    # Update list
+    #
+    # @deprecated
+    #
+    # @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)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      request(
+        "/v0.1/bulk/lists/#{id}",
+        params: params.merge({ name: name }),
+        type: Put
+      )
+    end
+
+    # Delete a list by id
+    #
+    # @deprecated
+    #
+    # @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:)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      request(
+        "/v0.1/bulk/lists/#{id}",
+        type: Delete
+      )
+    end
+
+    # Clear list by deleting all items
+    #
+    # @deprecated
+    #
+    # @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:)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      request(
+        "/v0.1/bulk/lists/#{id}/clear",
+        type: Post
+      )
+    end
+
+    # Fetch and replace all items from datasource
+    #
+    # @deprecated
+    #
+    # @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:)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      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,38 @@
+# 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
+    #
+    # @deprecated
+    #
+    # @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)
+      logger.info('This method is deprecated and will be removed in a future release.')
+      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,43 @@
+# typed: true
+# frozen_string_literal: true
+
+module Vonage
+  class ProactiveConnect < Namespace
+    extend T::Sig
+
+    # @deprecated
+    sig { returns(T.nilable(Vonage::ProactiveConnect::Lists)) }
+    def lists
+      logger.info('This method is deprecated and will be removed in a future release.')
+      @lists ||= Lists.new(@config)
+    end
+
+    # @deprecated
+    sig { returns(T.nilable(Vonage::ProactiveConnect::List)) }
+    def list
+      logger.info('This method is deprecated and will be removed in a future release.')
+      @list ||= List.new(@config)
+    end
+
+    # @deprecated
+    sig { returns(T.nilable(Vonage::ProactiveConnect::Items)) }
+    def items
+      logger.info('This method is deprecated and will be removed in a future release.')
+      @items ||= Items.new(@config)
+    end
+
+    # @deprecated
+    sig { returns(T.nilable(Vonage::ProactiveConnect::Item)) }
+    def item
+      logger.info('This method is deprecated and will be removed in a future release.')
+      @item ||= Item.new(@config)
+    end
+
+    # @deprecated
+    sig { returns(T.nilable(Vonage::ProactiveConnect::Events)) }
+    def events
+      logger.info('This method is deprecated and will be removed in a future release.')
+      @events ||= Events.new(@config)
+    end
+  end
+end

data/lib/vonage/server_error.rb

@@ -1,6 +1,6 @@
 # typed: strong
 
 module Vonage
-  class ServerError < Error
+  class ServerError < APIError
   end
 end

data/lib/vonage/signature.rb

@@ -10,6 +10,29 @@ module Vonage
       @config = config
     end
 
+    # Generate a request signature.
+    #
+    # @example
+    #   client = Vonage::Client.new
+    #   client.config.signature_secret = 'secret'
+    #   client.config.signature_method = 'sha512'
+    #   params = {
+    #     'api_key' => 'abc123',
+    #     'to' => '447900000000',
+    #     'from' => '447900000001',
+    #     'text' => 'Hello World',
+    #     'timestamp' => '1385047698'
+    #   }
+    #
+    #   sig = client.signature.generate(params)
+    #
+    # @param [Hash] params
+    #
+    # @see https://developer.nexmo.com/concepts/guides/signing-messages
+    def generate(params, signature_secret: @config.signature_secret, signature_method: @config.signature_method)
+      digest(params, signature_secret, signature_method)
+    end
+    
     # Check webhook request signature.
     #
     # @example
@@ -27,24 +50,24 @@ module Vonage
     #
     # @see https://developer.nexmo.com/concepts/guides/signing-messages
     #
-    def check(params, signature_method: @config.signature_method)
+    def check(params, signature_secret: @config.signature_secret, signature_method: @config.signature_method)
       params = params.dup
 
       signature = params.delete('sig')
 
-      ::JWT::Algos::Hmac::SecurityUtils.secure_compare(signature, digest(params, signature_method))
+      ::JWT::JWA::Hmac::SecurityUtils.secure_compare(signature, digest(params, signature_secret, signature_method))
     end
 
     private
 
-    def digest(params, signature_method)
-      digest_string = params.sort.map { |k, v| "&#{k}=#{v.tr('&=', '_')}" }.join
+    def digest(params, signature_secret, signature_method)
+      digest_string = params.sort.map { |k, v| "&#{k}=#{v.to_s.tr('&=', '_')}" }.join
 
       case signature_method
       when 'md5', 'sha1', 'sha256', 'sha512'
-        OpenSSL::HMAC.hexdigest(signature_method, @config.signature_secret, digest_string).upcase
+        OpenSSL::HMAC.hexdigest(signature_method, signature_secret, digest_string).upcase
       when 'md5hash'
-        Digest::MD5.hexdigest("#{digest_string}#{@config.signature_secret}")
+        Digest::MD5.hexdigest("#{digest_string}#{signature_secret}")
       else
         raise ArgumentError, "Unknown signature algorithm: #{signature_method}. Expected: md5hash, md5, sha1, sha256, or sha512."
       end

data/lib/vonage/sms.rb

@@ -6,6 +6,8 @@ module Vonage
     extend T::Sig
     include Keys
 
+    self.authentication = BasicAndSignature
+
     self.host = :rest_host
 
     # Send an outbound SMS from your Vonage account.
@@ -66,6 +68,9 @@ module Vonage
     #   An optional string used to identify separate accounts using the SMS endpoint for billing purposes.
     #   To use this feature, please email [support@nexmo.com](mailto:support@nexmo.com).
     #
+    # @option params [String] :trusted_number
+    #   Setting this parameter to true overrides, on a per-message basis, any protections set up via Fraud Defender (Traffic Rules, SMS Burst Protection, AIT Protection).
+    #
     # @param [Hash] params
     #
     # @return [Response]
@@ -91,11 +96,31 @@ module Vonage
       response
     end
 
+    # Validate a Signature from an SMS API Webhook.
+    #
+    # @param [Hash, required] :webhook_params The parameters from the webhook request body
+    # @param [String, optional] :signature_secret The account signature secret. Required, unless `signature_secret`
+    #   is set in `Config`
+    # @param [String, optional] :signature_method The account signature method. Required, unless `signature_method`
+    #   is set in `Config`
+    #
+    # @return [Boolean] true, if the JWT is verified, false otherwise
+    def verify_webhook_sig(webhook_params:, signature_secret: @config.signature_secret, signature_method: @config.signature_method)
+      signature.check(webhook_params, signature_secret: signature_secret, signature_method: signature_method)
+    end
+
     private
 
     sig { params(text: String).returns(T::Boolean) }
     def unicode?(text)
       !Vonage::GSM7.encoded?(text)
     end
+
+    # @return [Signature]
+    #
+    sig { returns(T.nilable(Vonage::Signature)) }
+    def signature
+      @signature ||= T.let(Signature.new(@config), T.nilable(Vonage::Signature))
+    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/users/list_response.rb

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