vonage 7.11.0 → 7.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95210747eb477199b15e3e5349e2bddfe7650928e8caae6a0275dde92381b835
-  data.tar.gz: '00917603bc90d21275328916969cd1af6b5925e6d034aa557705027ae514f7f8'
+  metadata.gz: 42d5bfc879e0b399da415f92a0f65313c3aa3f22760945c7832996290e7cbebb
+  data.tar.gz: be7e53025cad9a1fa877d9749e82ff22fa4c6ec4cb2da63ecefef136269fc810
 SHA512:
-  metadata.gz: 523f1f2cb099dfe781a065eb538fd45fd5d06bdb1b71156f10e119c3d4890f1df1c86ce29bfa17a3fb28231d8906deec0a2a66d41b8780e1fe5a892be6bea5b8
-  data.tar.gz: ecbfe4149f794e02ab6835de0fee165bc708036cb8ff4e672d77437e94bda0a4a1fef836eddc4ba0583b6058a2f8cc7ee81a5c29b0f28dad84416ccd8b694e09
+  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.11.0"
+  VERSION = "7.12.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vonage
 version: !ruby/object:Gem::Version
-  version: 7.11.0
+  version: 7.12.0
 platform: ruby
 authors:
 - Vonage
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-16 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