paystack-gateway 0.1.1 → 0.2.0

data/lib/paystack_gateway/dedicated_virtual_account.rb

@@ -0,0 +1,353 @@
+# frozen_string_literal: true
+
+module PaystackGateway
+  # https://paystack.com/docs/api/dedicatedvirtualaccount
+  #
+  # Dedicated Virtual Accounts
+  # A collection of endpoints for creating and managing payment accounts for customers
+  module DedicatedVirtualAccount
+    include PaystackGateway::RequestModule
+
+    # Successful response from calling #list.
+    class ListResponse < PaystackGateway::Response; end
+
+    # Error response from #list.
+    class ListError < ApiError; end
+
+    # https://paystack.com/docs/api/dedicated-virtual-account/#list
+    # List Dedicated Accounts: GET /dedicated_account
+    # List dedicated virtual accounts available on your integration.
+    #
+    # @param active [Boolean]
+    #        Status of the dedicated virtual account
+    # @param customer [Integer]
+    #        The customer's ID
+    # @param currency ["NGN", "GHS"]
+    #        The currency of the dedicated virtual account
+    # @param provider_slug [String]
+    #        The bank's slug in lowercase, without spaces
+    # @param bank_id [String]
+    #        The bank's ID
+    # @param per_page [Integer]
+    #        The number of records to fetch per request
+    # @param page [Integer]
+    #        The offset to retrieve data from
+    #
+    # @return [ListResponse] successful response
+    # @raise [ListError] if the request fails
+    api_method def self.list(
+      active: nil,
+      customer: nil,
+      currency: nil,
+      provider_slug: nil,
+      bank_id: nil,
+      per_page: nil,
+      page: nil
+    )
+      use_connection do |connection|
+        connection.get(
+          '/dedicated_account',
+          {
+            active:,
+            customer:,
+            currency:,
+            provider_slug:,
+            bank_id:,
+            perPage: per_page,
+            page:,
+          }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #create.
+    class CreateResponse < PaystackGateway::Response
+      delegate :bank,
+               :account_name,
+               :account_number,
+               :assigned,
+               :currency,
+               :metadata,
+               :active,
+               :id,
+               :created_at,
+               :updated_at,
+               :assignment,
+               :customer, to: :data
+    end
+
+    # Error response from #create.
+    class CreateError < ApiError; end
+
+    # https://paystack.com/docs/api/dedicated-virtual-account/#create
+    # Create Dedicated Account: POST /dedicated_account
+    # Create a dedicated virtual account for an existing customer
+    #
+    # @param customer [String] (required)
+    #        The code for the previously created customer
+    # @param preferred_bank [String]
+    #        The bank slug for preferred bank. To get a list of available banks, use the List
+    #        Providers endpoint
+    # @param subaccount [String]
+    #        Subaccount code of the account you want to split the transaction with
+    # @param split_code [String]
+    #        Split code consisting of the lists of accounts you want to split the transaction
+    #        with
+    #
+    # @return [CreateResponse] successful response
+    # @raise [CreateError] if the request fails
+    api_method def self.create(customer:, preferred_bank: nil, subaccount: nil, split_code: nil)
+      use_connection do |connection|
+        connection.post(
+          '/dedicated_account',
+          { customer:, preferred_bank:, subaccount:, split_code: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #assign.
+    class AssignResponse < PaystackGateway::Response; end
+
+    # Error response from #assign.
+    class AssignError < ApiError; end
+
+    # https://paystack.com/docs/api/dedicated-virtual-account/#assign
+    # Assign Dedicated Account: POST /dedicated_account/assign
+    # With this endpoint, you can create a customer, validate the customer, and assign
+    # a DVA to the customer.
+    #
+    # @param email [String] (required)
+    #        Customer's email address
+    # @param first_name [String] (required)
+    #        Customer's first name
+    # @param last_name [String] (required)
+    #        Customer's last name
+    # @param phone [String] (required)
+    #        Customer's phone name
+    # @param preferred_bank [String] (required)
+    #        The bank slug for preferred bank. To get a list of available banks, use the List
+    #        Banks endpoint, passing `pay_with_bank_transfer=true` query parameter
+    # @param country ["NG", "GH"] (required)
+    #        The two letter code country
+    # @param account_number [String]
+    #        Customer's account number
+    # @param bvn [String]
+    #        Customer's Bank Verification Number
+    # @param bank_code [String]
+    #        Customer's bank code
+    # @param subaccount [String]
+    #        Subaccount code of the account you want to split the transaction with
+    # @param split_code [String]
+    #        Split code consisting of the lists of accounts you want to split the transaction
+    #        with
+    #
+    # @return [AssignResponse] successful response
+    # @raise [AssignError] if the request fails
+    api_method def self.assign(
+      email:,
+      first_name:,
+      last_name:,
+      phone:,
+      preferred_bank:,
+      country:,
+      account_number: nil,
+      bvn: nil,
+      bank_code: nil,
+      subaccount: nil,
+      split_code: nil
+    )
+      use_connection do |connection|
+        connection.post(
+          '/dedicated_account/assign',
+          {
+            email:,
+            first_name:,
+            last_name:,
+            phone:,
+            preferred_bank:,
+            country:,
+            account_number:,
+            bvn:,
+            bank_code:,
+            subaccount:,
+            split_code:,
+          }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #fetch.
+    class FetchResponse < PaystackGateway::Response
+      delegate :customer,
+               :bank,
+               :id,
+               :account_name,
+               :account_number,
+               :created_at,
+               :updated_at,
+               :currency,
+               :split_config,
+               :active,
+               :assigned, to: :data
+    end
+
+    # Error response from #fetch.
+    class FetchError < ApiError; end
+
+    # https://paystack.com/docs/api/dedicated-virtual-account/#fetch
+    # Fetch Dedicated Account: GET /dedicated_account/{id}
+    # Get details of a dedicated virtual account on your integration.
+    #
+    # @param id [String] (required)
+    #        ID of dedicated virtual account
+    #
+    # @return [FetchResponse] successful response
+    # @raise [FetchError] if the request fails
+    api_method def self.fetch(id:)
+      use_connection do |connection|
+        connection.get(
+          "/dedicated_account/#{id}",
+        )
+      end
+    end
+
+    # Successful response from calling #deactivate.
+    class DeactivateResponse < PaystackGateway::Response
+      delegate :bank,
+               :account_name,
+               :account_number,
+               :assigned,
+               :currency,
+               :metadata,
+               :active,
+               :id,
+               :created_at,
+               :updated_at,
+               :assignment, to: :data
+    end
+
+    # Error response from #deactivate.
+    class DeactivateError < ApiError; end
+
+    # https://paystack.com/docs/api/dedicated-virtual-account/#deactivate
+    # Deactivate Dedicated Account: DELETE /dedicated_account/{id}
+    # Deactivate a dedicated virtual account on your integration.
+    #
+    # @param id [String] (required)
+    #        ID of dedicated virtual account
+    #
+    # @return [DeactivateResponse] successful response
+    # @raise [DeactivateError] if the request fails
+    api_method def self.deactivate(id:)
+      use_connection do |connection|
+        connection.delete(
+          "/dedicated_account/#{id}",
+        )
+      end
+    end
+
+    # Successful response from calling #requery.
+    class RequeryResponse < PaystackGateway::Response; end
+
+    # Error response from #requery.
+    class RequeryError < ApiError; end
+
+    # https://paystack.com/docs/api/dedicated-virtual-account/#requery
+    # Requery Dedicated Account: GET /dedicated_account/requery
+    # Requery Dedicated Virtual Account for new transactions
+    #
+    # @param account_number [String]
+    #        Virtual account number to requery
+    # @param provider_slug [String]
+    #        The bank's slug in lowercase, without spaces.
+    # @param date [Time]
+    #        The day the transfer was made
+    #
+    # @return [RequeryResponse] successful response
+    # @raise [RequeryError] if the request fails
+    api_method def self.requery(account_number: nil, provider_slug: nil, date: nil)
+      use_connection do |connection|
+        connection.get(
+          '/dedicated_account/requery',
+          { account_number:, provider_slug:, date: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #add_split.
+    class AddSplitResponse < PaystackGateway::Response; end
+
+    # Error response from #add_split.
+    class AddSplitError < ApiError; end
+
+    # https://paystack.com/docs/api/dedicated-virtual-account/#add_split
+    # Split Dedicated Account Transaction: POST /dedicated_account/split
+    # Split a dedicated virtual account transaction with one or more accounts
+    #
+    # @param account_number [String] (required)
+    #        Valid Dedicated virtual account
+    # @param subaccount [String]
+    #        Subaccount code of the account you want to split the transaction with
+    # @param split_code [String]
+    #        Split code consisting of the lists of accounts you want to split the transaction
+    #        with
+    #
+    # @return [AddSplitResponse] successful response
+    # @raise [AddSplitError] if the request fails
+    api_method def self.add_split(account_number:, subaccount: nil, split_code: nil)
+      use_connection do |connection|
+        connection.post(
+          '/dedicated_account/split',
+          { account_number:, subaccount:, split_code: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #remove_split.
+    class RemoveSplitResponse < PaystackGateway::Response; end
+
+    # Error response from #remove_split.
+    class RemoveSplitError < ApiError; end
+
+    # https://paystack.com/docs/api/dedicated-virtual-account/#remove_split
+    # Remove Split from Dedicated Account: DELETE /dedicated_account/split
+    # If you've previously set up split payment for transactions on a dedicated virtual
+    # account, you can remove it with this endpoint
+    #
+    # @param account_number [String] (required)
+    #        Valid Dedicated virtual account
+    #
+    # @return [RemoveSplitResponse] successful response
+    # @raise [RemoveSplitError] if the request fails
+    api_method def self.remove_split(account_number:)
+      use_connection do |connection|
+        connection.delete(
+          '/dedicated_account/split',
+        ) do |request|
+          request.body = { account_number: }.compact
+        end
+      end
+    end
+
+    # Successful response from calling #available_providers.
+    class AvailableProvidersResponse < PaystackGateway::Response; end
+
+    # Error response from #available_providers.
+    class AvailableProvidersError < ApiError; end
+
+    # https://paystack.com/docs/api/dedicated-virtual-account/#available_providers
+    # Fetch Bank Providers: GET /dedicated_account/available_providers
+    # Get available bank providers for a dedicated virtual account
+    #
+    #
+    # @return [AvailableProvidersResponse] successful response
+    # @raise [AvailableProvidersError] if the request fails
+    api_method def self.available_providers
+      use_connection do |connection|
+        connection.get(
+          '/dedicated_account/available_providers',
+        )
+      end
+    end
+  end
+end

data/lib/paystack_gateway/dedicated_virtual_accounts.rb

@@ -1,66 +1,3 @@
 # frozen_string_literal: true
 
-module PaystackGateway
-  # The Dedicated Virtual Account API enables Nigerian merchants to manage unique
-  # payment accounts of their customers.
-  # https://paystack.com/docs/api/dedicated-virtual-account/
-  module DedicatedVirtualAccounts
-    include PaystackGateway::RequestModule
-
-    # Response from POST /dedicated_account endpoint.
-    class CreateDedicatedVirtualAccountResponse < PaystackGateway::Response; end
-
-    api_method def self.create_dedicated_virtual_account(customer_id_or_code:, subaccount_code:, preferred_bank:)
-      use_connection do |connection|
-        connection.post(
-          '/dedicated_account',
-          {
-            customer: customer_id_or_code,
-            preferred_bank:,
-            subaccount: subaccount_code,
-            phone: '+2348011111111', # phone number is required by paystack for some reason, use fake phone number
-          },
-        )
-      end
-    end
-
-    # Response from POST /dedicated_account/assign endpoint.
-    class AssignDedicatedVirtualAccountResponse < PaystackGateway::Response; end
-
-    api_method def self.assign_dedicated_virtual_account(
-      email:, first_name:, last_name:, subaccount_code:, preferred_bank:
-    )
-      use_connection do |connection|
-        connection.post(
-          '/dedicated_account/assign',
-          {
-            email:,
-            first_name:,
-            last_name:,
-            preferred_bank:,
-            country: :NG,
-            subaccount: subaccount_code,
-          },
-        )
-      end
-    end
-
-    # Response from POST /dedicated_account/split endpoint
-    class SplitDedicatedAccountTransactionResponse < PaystackGateway::Response; end
-
-    api_method def self.split_dedicated_account_transaction(customer_id_or_code:, subaccount_code:)
-      use_connection do |connection|
-        connection.post('/dedicated_account/split', { customer: customer_id_or_code, subaccount: subaccount_code })
-      end
-    end
-
-    # Response from GET /dedicated_account/requery/:account_number endpoint
-    class RequeryDedicatedAccountResponse < PaystackGateway::Response; end
-
-    api_method def self.requery_dedicated_account(account_number:, bank:)
-      use_connection do |connection|
-        connection.get('/dedicated_account/requery', { account_number:, provider_slug: bank })
-      end
-    end
-  end
-end
+require 'paystack_gateway/legacy/dedicated_virtual_accounts'

data/lib/paystack_gateway/direct_debit.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module PaystackGateway
+  # https://paystack.com/docs/api/directdebit
+  #
+  # Direct Debit
+  # A collection of endpoints for managing Direct Debit
+  module DirectDebit
+    include PaystackGateway::RequestModule
+
+    # Successful response from calling #trigger_activation_charge.
+    class TriggerActivationChargeResponse < PaystackGateway::Response; end
+
+    # Error response from #trigger_activation_charge.
+    class TriggerActivationChargeError < ApiError; end
+
+    # https://paystack.com/docs/api/direct-debit/#trigger_activation_charge
+    # Trigger Activation Charge: PUT /directdebit/activation-charge
+    # Trigger activation charge for specified customers
+    #
+    # @param customer_ids [Array<Integer>] (required)
+    #        Array of customer IDs to trigger activation charge for
+    #
+    # @return [TriggerActivationChargeResponse] successful response
+    # @raise [TriggerActivationChargeError] if the request fails
+    api_method def self.trigger_activation_charge(customer_ids:)
+      use_connection do |connection|
+        connection.put(
+          '/directdebit/activation-charge',
+          { customer_ids: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #list_mandate_authorizations.
+    class ListMandateAuthorizationsResponse < PaystackGateway::Response; end
+
+    # Error response from #list_mandate_authorizations.
+    class ListMandateAuthorizationsError < ApiError; end
+
+    # https://paystack.com/docs/api/direct-debit/#list_mandate_authorizations
+    # List Mandate Authorizations: GET /directdebit/mandate-authorizations
+    # Get a list of all the direct debit mandates on your integration
+    #
+    # @param cursor [String]
+    #        The cursor value of the next set of authorizations to fetch. You can get this from
+    #        the meta object of the response
+    # @param status ["pending", "active", "revoked"]
+    #        Filter by the authorization status
+    # @param per_page [Integer]
+    #        The number of authorizations to fetch per request
+    #
+    # @return [ListMandateAuthorizationsResponse] successful response
+    # @raise [ListMandateAuthorizationsError] if the request fails
+    api_method def self.list_mandate_authorizations(cursor: nil, status: nil, per_page: nil)
+      use_connection do |connection|
+        connection.get(
+          '/directdebit/mandate-authorizations',
+          { cursor:, status:, per_page: }.compact,
+        )
+      end
+    end
+  end
+end