vonage 7.10.0 → 7.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc021f5f0b897743382fe24b1973b1fa1ffa57086b590577d9f794a3fbef5355
-  data.tar.gz: 500df71d3f79eb6c8de37f5dc694d705526eab298f92cec34e90420290aa8e00
+  metadata.gz: 42d5bfc879e0b399da415f92a0f65313c3aa3f22760945c7832996290e7cbebb
+  data.tar.gz: be7e53025cad9a1fa877d9749e82ff22fa4c6ec4cb2da63ecefef136269fc810
 SHA512:
-  metadata.gz: '049c59c41953de3695a71b722adf03e868bae4edb4f36f145a0e03b61859f512ed508ca3f1e8b1eee54200d058a55265858b9be4f8449c9ea68e60b274ed7282'
-  data.tar.gz: 57fcf30de159323ef20feee16dec66f1eab1b7360e2b75e17a96f368f54c3015db4f83bd4d9b51c1b69739e5c762d25131e0d66bbd1cd09ec14325bfa5f8daae
+  metadata.gz: 29f033e6795e3d52bdef207656a7230925037b04dbdbd57bbdbce4cf74b91842cb9cfcd7e04b9061a5267210905d14b68961dc4daab26bf349dff0ece9a6e659
+  data.tar.gz: 43c52d578923fd7a5a7b04b243b040df2ba1cef5dd0c38c37007820207a5ab411a9976a0b42a2dff653b19d6e856ade248163a8856ac93c88dd49209d4cd6b4f

data/lib/vonage/client.rb

@@ -117,6 +117,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/namespace.rb

@@ -51,6 +51,7 @@ module Vonage
 
     Get = Net::HTTP::Get
     Put = Net::HTTP::Put
+    Patch = Net::HTTP::Patch
     Post = Net::HTTP::Post
     Delete = Net::HTTP::Delete
 

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.10.0"
+  VERSION = "7.12.0"
 end

data/lib/vonage/voice/actions/connect.rb

@@ -2,9 +2,9 @@
 # frozen_string_literal: true
 require 'phonelib'
 
-module Vonage  
+module Vonage
   class Voice::Actions::Connect
-    attr_accessor :endpoint, :from, :eventType, :timeout, :limit, :machineDetection, :eventUrl, :eventMethod, :ringbackTone
+    attr_accessor :endpoint, :from, :eventType, :timeout, :limit, :machineDetection, :advanced_machine_detection, :eventUrl, :eventMethod, :ringbackTone
 
     def initialize(attributes = {})
       @endpoint = attributes.fetch(:endpoint)
@@ -13,6 +13,7 @@ module Vonage
       @timeout = attributes.fetch(:timeout, nil)
       @limit = attributes.fetch(:limit, nil)
       @machineDetection = attributes.fetch(:machineDetection, nil)
+      @advanced_machine_detection = attributes.fetch(:advanced_machine_detection, nil)
       @eventUrl = attributes.fetch(:eventUrl, nil)
       @eventMethod = attributes.fetch(:eventMethod, nil)
       @ringbackTone = attributes.fetch(:ringbackTone, nil)
@@ -39,6 +40,10 @@ module Vonage
         verify_machine_detection
       end
 
+      if self.advanced_machine_detection
+        verify_advanced_machine_detection
+      end
+
       if self.eventUrl
         verify_event_url
       end
@@ -82,6 +87,25 @@ module Vonage
       raise ClientError.new("Invalid 'machineDetection' value, must be either: 'continue' or 'hangup' if defined") unless self.machineDetection == 'continue' || self.machineDetection == 'hangup'
     end
 
+    def verify_advanced_machine_detection
+      raise ClientError.new("Invalid 'advanced_machine_detection' value, must be a Hash") unless self.advanced_machine_detection.is_a?(Hash)
+      verify_advanced_machine_detection_behavior if self.advanced_machine_detection[:behavior]
+      verify_advanced_machine_detection_mode if self.advanced_machine_detection[:mode]
+      verify_advanced_machine_detection_beep_timeout if self.advanced_machine_detection[:beep_timeout]
+    end
+
+    def verify_advanced_machine_detection_behavior
+      raise ClientError.new("Invalid 'advanced_machine_detection[:behavior]' value, must be a `continue` or `hangup`") unless ['continue', 'hangup'].include?(self.advanced_machine_detection[:behavior])
+    end
+
+    def verify_advanced_machine_detection_mode
+      raise ClientError.new("Invalid 'advanced_machine_detection[:mode]' value, must be a `detect` or `detect_beep`") unless ['detect', 'detect_beep'].include?(self.advanced_machine_detection[:mode])
+    end
+
+    def verify_advanced_machine_detection_beep_timeout
+      raise ClientError.new("Invalid 'advanced_machine_detection[:beep_timeout]' value, must be between 45 and 120") unless self.advanced_machine_detection[:beep_timeout].between?(45, 120)
+    end
+
     def verify_event_url
       uri = URI.parse(self.eventUrl)
 
@@ -196,4 +220,4 @@ module Vonage
       }
     end
   end
-end
+end

data/lib/vonage/voice/actions/talk.rb

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 module Vonage
   class Voice::Actions::Talk
-    attr_accessor :text, :bargeIn, :loop, :level, :language, :style
+    attr_accessor :text, :bargeIn, :loop, :level, :language, :style, :premium
 
     def initialize(attributes= {})
       @text = attributes.fetch(:text)
@@ -11,6 +11,7 @@ module Vonage
       @level = attributes.fetch(:level, nil)
       @language = attributes.fetch(:language, nil)
       @style = attributes.fetch(:style, nil)
+      @premium = attributes.fetch(:premium, nil)
 
       after_initialize!
     end
@@ -31,6 +32,10 @@ module Vonage
       if self.style
         verify_style
       end
+
+      if self.premium
+        verify_premium
+      end
     end
 
     def verify_barge_in
@@ -49,6 +54,10 @@ module Vonage
       raise ClientError.new("Expected 'style' value to be an Integer") unless self.style.is_a?(Integer)
     end
 
+    def verify_premium
+      raise ClientError.new("Expected 'premium' value to be a Boolean") unless self.premium == true || self.premium == false
+    end
+
     def action
       create_talk!(self)
     end
@@ -70,4 +79,4 @@ module Vonage
       ncco
     end
   end
-end
+end

data/lib/vonage/voice/talk.rb

@@ -12,8 +12,18 @@ module Vonage
     # @option params [required, String] :text
     #   The text to read.
     #
+    # @option params [String] :language
+    #   The language to use. See {https://developer.vonage.com/en/api/voice#startTalk-req-body} for a list of valid language codes.
+    #
+    # @option params [Integer] :style
+    #   The vocal style, as identified by an assigned integer.
+    #     See {https://developer.vonage.com/en/voice/voice-api/concepts/text-to-speech#supported-languages} for a list of available styles.
+    #
+    # @option params [Boolean] :premium
+    #   Set to `true` to use the premium version of the specified style if available, otherwise the standard version will be used.
+    #
     # @option params [String] :voice_name
-    #   The voice & language to use.
+    #   The voice & language to use. [DEPRECATED: use `language` and `style` instead].
     #
     # @option params [Integer] :loop
     #   The number of times to repeat the text the file, 0 for infinite.

data/lib/vonage/voice.rb

@@ -48,6 +48,17 @@ module Vonage
     # @option params [String] :machine_detection
     #   Configure the behavior when Vonage detects that the call is answered by voicemail.
     #
+    # @option params [Hash] :advanced_machine_detection
+    #   Configure the behavior of Vonage's advanced machine detection. Overrides machine_detection if both are set.
+    #   Hash with three possible properties:
+    #     - :behavior [String]: Must be one of `continue` or `hangup`. When hangup is used, the call will be terminated if a
+    #         machine is detected. When continue is used, the call will continue even if a machine is detected.
+    #     - :mode [String]: Must be one of `detect` or `detect_beep`. Detect if machine answered and sends a human or
+    #         machine status in the webhook payload. When set to `detect_beep`, the system also attempts to detect
+    #         voice mail beep and sends an additional parameter `sub_state` in the webhook with the value `beep_start`.
+    #     - :beep_timeout [Integer]: Min: 45, Max: 120. Maximum time in seconds Vonage should wait for a machine beep
+    #         to be detected. A machine event with `sub_state` set to `beep_timeout` will be sent if the timeout is exceeded.
+    #
     # @option params [Integer] :length_timer
     #   Set the number of seconds that elapse before Vonage hangs up after the call state changes to in_progress.
     #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vonage
 version: !ruby/object:Gem::Version
-  version: 7.10.0
+  version: 7.12.0
 platform: ruby
 authors:
 - Vonage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-31 00:00:00.000000000 Z
+date: 2023-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: vonage-jwt
@@ -149,6 +149,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
@@ -168,7 +172,6 @@ files:
 - lib/vonage/voice/actions/conversation.rb
 - lib/vonage/voice/actions/input.rb
 - lib/vonage/voice/actions/notify.rb
-- lib/vonage/voice/actions/pay.rb
 - lib/vonage/voice/actions/record.rb
 - lib/vonage/voice/actions/stream.rb
 - lib/vonage/voice/actions/talk.rb

data/lib/vonage/voice/actions/pay.rb

@@ -1,107 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-module Vonage
-  class Voice::Actions::Pay
-    attr_accessor :amount, :currency, :eventUrl, :prompts, :voice
-
-    def initialize(attributes= {})
-      @amount = attributes.fetch(:amount)
-      @currency = attributes.fetch(:currency, nil)
-      @eventUrl = attributes.fetch(:eventUrl, nil)
-      @prompts = attributes.fetch(:prompts, nil)
-      @voice = attributes.fetch(:voice, nil)
-
-      after_initialize!
-    end
-
-    def action
-      create_pay!(self)
-    end
-
-    def create_pay!(builder)
-      ncco = [
-        {
-          action: 'pay',
-          amount: builder.amount
-        }
-      ]
-
-      ncco[0].merge!(currency: builder.currency) if builder.currency
-      ncco[0].merge!(eventUrl: builder.eventUrl) if builder.eventUrl
-      ncco[0].merge!(prompts: builder.prompts) if builder.prompts
-      ncco[0].merge!(voice: builder.voice) if builder.voice
-
-      ncco
-    end
-
-    private
-
-    def after_initialize!
-      verify_amount
-
-      if self.eventUrl
-        verify_event_url
-      end
-
-      if self.prompts
-        verify_prompts
-      end
-
-      if self.voice
-        verify_voice
-      end
-    end
-
-    def verify_amount
-      verify_amount_class
-      verify_amount_value
-    end
-
-    def verify_event_url
-      raise ClientError.new("Expected 'eventUrl' parameter to be an Array containing a single string item") unless self.eventUrl.is_a?(Array)
-
-      uri = URI.parse(self.eventUrl[0])
-
-      raise ClientError.new("Invalid 'eventUrl' value, must be a valid URL") unless uri.kind_of?(URI::HTTP) || uri.kind_of?(URI::HTTPS)
-    end
-
-    def verify_prompts
-      verify_prompts_structure
-      verify_prompts_values
-    end
-
-    def verify_voice
-      verify_voice_structure
-      verify_voice_style if self.voice[:style]
-    end
-
-    def verify_amount_class
-      raise ClientError.new("Invalid 'amount' value, must be a float") unless self.amount.is_a?(Float)
-    end
-
-    def verify_amount_value
-      raise ClientError.new("Invalid 'amount' value, must be greater than 0") unless self.amount > 0
-    end
-
-    def verify_prompts_structure
-      raise ClientError.new("Invalid 'prompt', must be an array of at least one hash") unless self.prompts.is_a?(Array) && !self.prompts.empty? && self.prompts.all?(Hash)
-    end
-
-    def verify_prompts_values
-      self.prompts.each do |prompt|
-        prompt_keys = prompt.keys
-        [:type, :text, :errors].each do |key|
-          raise ClientError.new("Invalid 'prompt', '#{key}' is required") unless prompt_keys.include?(key)
-        end
-      end
-    end
-
-    def verify_voice_structure
-      raise ClientError.new("Expected 'voice' value to be a Hash") unless self.voice.is_a?(Hash)
-    end
-
-    def verify_voice_style
-      raise ClientError.new("Expected 'style' value to be an Integer") unless self.voice[:style].is_a?(Integer)
-    end
-  end
-end