paystack_sdk 0.2.0 → 0.3.0

data/lib/paystack_sdk/resources/customers.rb

@@ -2,7 +2,7 @@
 
 # Generated by bin/paystack-scaffold from Paystack's OpenAPI spec (PaystackOSS/openapi@d9d444d).
 # Do not edit by hand: regenerate it with `bin/paystack-scaffold Customer`. Hand-written extras go in lib/paystack_sdk/resources/extensions/customers.rb.
-# scaffold-digest: a6f9d22c6371a27b341370a5137dda91fe7a082cd0a60f49cdfadd3789cc924d
+# scaffold-digest: 24269cd1f96877a533fed260bdce25e0dc552ebe7ca1c5636362779e27358054
 
 require_relative "base"
 
@@ -277,7 +277,7 @@ module PaystackSdk
       # @param authorization_id [Integer] The authorization ID gotten from the initiation response
       # @return [PaystackSdk::Response] The response from the Paystack API.
       # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
-      # @see https://paystack.com/docs/api/customer/#direct-debit-activation-charge
+      # @see https://paystack.com/docs/api/customer/#directdebit-activation-charge
       def direct_debit_activation_charge(id:, authorization_id:)
         validate_presence!(value: id, name: "id")
         validate_presence!(value: authorization_id, name: "authorization_id")

data/lib/paystack_sdk/resources/dedicated_virtual_accounts.rb

@@ -0,0 +1,241 @@
+# frozen_string_literal: true
+
+# Generated by bin/paystack-scaffold from Paystack's OpenAPI spec (PaystackOSS/openapi@d9d444d).
+# Do not edit by hand: regenerate it with `bin/paystack-scaffold Dedicated Virtual Account`. Hand-written extras go in lib/paystack_sdk/resources/extensions/dedicated_virtual_accounts.rb.
+# scaffold-digest: ced1a6e3ff1b259142646259b38808d9036c73b57ea1a30384a5f2ad8c7c4da5
+
+require_relative "base"
+
+module PaystackSdk
+  module Resources
+    # Dedicated Virtual Account operations.
+    class DedicatedVirtualAccounts < PaystackSdk::Resources::Base
+      # Ruby keyword => the parameter name Paystack documents.
+      WIRE_NAMES = {per_page: "perPage"}.freeze
+
+      # List Dedicated Accounts.
+      #
+      # 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 [String] The currency of the dedicated virtual account One of: NGN, GHS.
+      # @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 [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dedicated-virtual-account/#list
+      def list(
+        active: nil,
+        customer: nil,
+        currency: nil,
+        provider_slug: nil,
+        bank_id: nil,
+        per_page: nil,
+        page: nil
+      )
+        validate_allowed_values!(value: currency, allowed_values: %w[NGN GHS], name: "currency")
+        validate_positive_integer!(value: per_page, name: "perPage")
+        validate_positive_integer!(value: page, name: "page")
+
+        wire_query = to_wire(
+          {
+            active:,
+            customer:,
+            currency:,
+            provider_slug:,
+            bank_id:,
+            per_page:,
+            page:
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.get("/dedicated_account", wire_query))
+      end
+
+      # Create Dedicated Account.
+      #
+      # Create a dedicated virtual account for an existing customer
+      #
+      # @param customer [String] The code for the previously created customer
+      # @param preferred_bank [String] The bank slug for preferred bank.
+      # @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 [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dedicated-virtual-account/#create
+      def create(customer:, preferred_bank: nil, subaccount: nil, split_code: nil)
+        validate_presence!(value: customer, name: "customer")
+
+        wire_body = to_wire({customer:, preferred_bank:, subaccount:, split_code:}, WIRE_NAMES)
+
+        handle_response(@connection.post("/dedicated_account", wire_body))
+      end
+
+      # Assign Dedicated Account.
+      #
+      # With this endpoint, you can create a customer, validate the customer, and assign a DVA to the customer.
+      #
+      # @param email [String] Customer's email address
+      # @param first_name [String] Customer's first name
+      # @param last_name [String] Customer's last name
+      # @param phone [String] Customer's phone name
+      # @param preferred_bank [String] The bank slug for preferred bank.
+      # @param country [String] The two letter code country One of: NG, GH.
+      # @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 [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dedicated-virtual-account/#assign
+      def assign(
+        email:,
+        first_name:,
+        last_name:,
+        phone:,
+        preferred_bank:,
+        country:,
+        account_number: nil,
+        bvn: nil,
+        bank_code: nil,
+        subaccount: nil,
+        split_code: nil
+      )
+        validate_presence!(value: email, name: "email")
+        validate_email!(email: email, name: "email")
+        validate_presence!(value: first_name, name: "first_name")
+        validate_presence!(value: last_name, name: "last_name")
+        validate_presence!(value: phone, name: "phone")
+        validate_presence!(value: preferred_bank, name: "preferred_bank")
+        validate_presence!(value: country, name: "country")
+        validate_allowed_values!(value: country, allowed_values: %w[NG GH], name: "country")
+
+        wire_body = to_wire(
+          {
+            email:,
+            first_name:,
+            last_name:,
+            phone:,
+            preferred_bank:,
+            country:,
+            account_number:,
+            bvn:,
+            bank_code:,
+            subaccount:,
+            split_code:
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.post("/dedicated_account/assign", wire_body))
+      end
+
+      # Fetch Dedicated Account.
+      #
+      # Get details of a dedicated virtual account on your integration.
+      #
+      # @param dedicated_account_id [String] ID of dedicated virtual account
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dedicated-virtual-account/#fetch
+      def fetch(dedicated_account_id:)
+        validate_presence!(value: dedicated_account_id, name: "dedicated_account_id")
+
+        handle_response(
+          @connection.get("/dedicated_account/#{escape_path(dedicated_account_id, name: "dedicated_account_id")}")
+        )
+      end
+
+      # Deactivate Dedicated Account.
+      #
+      # Deactivate a dedicated virtual account on your integration.
+      #
+      # @param dedicated_account_id [String] ID of dedicated virtual account
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dedicated-virtual-account/#deactivate
+      def deactivate(dedicated_account_id:)
+        validate_presence!(value: dedicated_account_id, name: "dedicated_account_id")
+
+        handle_response(
+          @connection.delete("/dedicated_account/#{escape_path(dedicated_account_id, name: "dedicated_account_id")}")
+        )
+      end
+
+      # Requery Dedicated Account.
+      #
+      # 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 [String] The day the transfer was made
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dedicated-virtual-account/#requery
+      def requery(account_number: nil, provider_slug: nil, date: nil)
+        wire_query = to_wire(
+          {
+            account_number:,
+            provider_slug:,
+            date: format_datetime(date, name: "date")
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.get("/dedicated_account/requery", wire_query))
+      end
+
+      # Split Dedicated Account Transaction.
+      #
+      # Split a dedicated virtual account transaction with one or more accounts
+      #
+      # @param account_number [String] 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 [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dedicated-virtual-account/#add-split
+      def add_split(account_number:, subaccount: nil, split_code: nil)
+        validate_presence!(value: account_number, name: "account_number")
+
+        wire_body = to_wire({account_number:, subaccount:, split_code:}, WIRE_NAMES)
+
+        handle_response(@connection.post("/dedicated_account/split", wire_body))
+      end
+
+      # Remove Split from Dedicated Account.
+      #
+      # 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] Valid Dedicated virtual account
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dedicated-virtual-account/#remove-split
+      def remove_split(account_number:)
+        validate_presence!(value: account_number, name: "account_number")
+
+        wire_body = to_wire({account_number:}, WIRE_NAMES)
+
+        handle_response(
+          @connection.delete("/dedicated_account/split") { |request| request.body = wire_body }
+        )
+      end
+
+      # Fetch Bank Providers.
+      #
+      # Get available bank providers for a dedicated virtual account
+      #
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dedicated-virtual-account/#providers
+      def fetch_bank_providers
+        handle_response(@connection.get("/dedicated_account/available_providers"))
+      end
+    end
+  end
+end

data/lib/paystack_sdk/resources/disputes.rb

@@ -0,0 +1,237 @@
+# frozen_string_literal: true
+
+# Generated by bin/paystack-scaffold from Paystack's OpenAPI spec (PaystackOSS/openapi@d9d444d).
+# Do not edit by hand: regenerate it with `bin/paystack-scaffold Dispute`. Hand-written extras go in lib/paystack_sdk/resources/extensions/disputes.rb.
+# scaffold-digest: 4d21cf962908ea0d724baff713ce71427be21015014886479ba0b6ecc2785dbe
+
+require_relative "base"
+
+module PaystackSdk
+  module Resources
+    # Dispute operations.
+    class Disputes < PaystackSdk::Resources::Base
+      # Ruby keyword => the parameter name Paystack documents.
+      WIRE_NAMES = {per_page: "perPage"}.freeze
+
+      # List Disputes.
+      #
+      # List transaction disputes filed by customers
+      #
+      # @param per_page [Integer] Number of records to fetch per page
+      # @param page [Integer] The section to retrieve
+      # @param status [String] Dispute status One of: awaiting-merchant-feedback, awaiting-bank-feedback, pending, resolved.
+      # @param transaction [String] Transaction ID
+      # @param from [String] The start date
+      # @param to [String] The end date
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dispute/#list
+      def list(per_page: nil, page: nil, status: nil, transaction: nil, from: nil, to: nil)
+        validate_positive_integer!(value: per_page, name: "perPage")
+        validate_positive_integer!(value: page, name: "page")
+        validate_allowed_values!(
+          value: status,
+          allowed_values: %w[awaiting-merchant-feedback awaiting-bank-feedback pending resolved],
+          name: "status"
+        )
+
+        wire_query = to_wire(
+          {
+            per_page:,
+            page:,
+            status:,
+            transaction:,
+            from: format_datetime(from, name: "from"),
+            to: format_datetime(to, name: "to")
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.get("/dispute", wire_query))
+      end
+
+      # Fetch Dispute.
+      #
+      # Fetch a transaction dispute
+      #
+      # @param id [Integer] The unique identifier of the dispute
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dispute/#fetch
+      def fetch(id:)
+        validate_presence!(value: id, name: "id")
+
+        handle_response(@connection.get("/dispute/#{escape_path(id, name: "id")}"))
+      end
+
+      # Update Dispute.
+      #
+      # Update a transaction dispute
+      #
+      # @param id [Integer] The unique identifier of the dispute
+      # @param refund_amount [Integer] The amount to refund, in the subunit of your currency
+      # @param uploaded_filename [String] Filename of attachment returned via response from the Dispute upload URL
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dispute/#update
+      def update(id:, refund_amount:, uploaded_filename: nil)
+        validate_presence!(value: id, name: "id")
+        validate_presence!(value: refund_amount, name: "refund_amount")
+
+        wire_body = to_wire({refund_amount:, uploaded_filename:}, WIRE_NAMES)
+
+        handle_response(@connection.put("/dispute/#{escape_path(id, name: "id")}", wire_body))
+      end
+
+      # Fetch Upload URL.
+      #
+      # Get the URL to upload a dispute evidence
+      #
+      # @param id [Integer] The unique identifier of the dispute
+      # @param upload_filename [String] The file name, with its extension, that you want to upload (for example filename.pdf).
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dispute/#upload-url
+      def fetch_upload_url(id:, upload_filename: nil)
+        validate_presence!(value: id, name: "id")
+
+        wire_query = to_wire({upload_filename:}, WIRE_NAMES)
+
+        handle_response(
+          @connection.get("/dispute/#{escape_path(id, name: "id")}/upload_url", wire_query)
+        )
+      end
+
+      # Export Disputes.
+      #
+      # Export the disputes available on your integration
+      #
+      # @param per_page [Integer] Number of records to fetch per page
+      # @param page [Integer] The section to retrieve
+      # @param status [String] One of: awaiting-merchant-feedback, awaiting-bank-feedback, pending, resolved.
+      # @param from [String] The start date
+      # @param to [String] The end date
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dispute/#export
+      def export(per_page: nil, page: nil, status: nil, from: nil, to: nil)
+        validate_positive_integer!(value: per_page, name: "perPage")
+        validate_positive_integer!(value: page, name: "page")
+        validate_allowed_values!(
+          value: status,
+          allowed_values: %w[awaiting-merchant-feedback awaiting-bank-feedback pending resolved],
+          name: "status"
+        )
+
+        wire_query = to_wire(
+          {
+            per_page:,
+            page:,
+            status:,
+            from: format_datetime(from, name: "from"),
+            to: format_datetime(to, name: "to")
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.get("/dispute/export", wire_query))
+      end
+
+      # List Transaction Disputes.
+      #
+      # List all disputes filed for a transaction
+      #
+      # @param id [Integer] The unique identifier of the transaction
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dispute/#transaction
+      def list_transaction(id:)
+        validate_presence!(value: id, name: "id")
+
+        handle_response(@connection.get("/dispute/transaction/#{escape_path(id, name: "id")}"))
+      end
+
+      # Resolve Dispute.
+      #
+      # Resolve a transaction dispute
+      #
+      # @param id [Integer] The unique identifier of the dispute
+      # @param resolution [String] Dispute resolution.
+      # @param message [String] Reason for resolving
+      # @param refund_amount [Integer] The amount to refund, in the subunit of your integration currency
+      # @param uploaded_filename [String] Filename of attachment returned via response from the Dispute upload URL
+      # @param evidence [Integer] Evidence Id for fraud claims
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dispute/#resolve
+      def resolve(id:, resolution:, message:, refund_amount:, uploaded_filename:, evidence: nil)
+        validate_presence!(value: id, name: "id")
+        validate_presence!(value: resolution, name: "resolution")
+        validate_presence!(value: message, name: "message")
+        validate_presence!(value: refund_amount, name: "refund_amount")
+        validate_presence!(value: uploaded_filename, name: "uploaded_filename")
+
+        wire_body = to_wire(
+          {
+            resolution:,
+            message:,
+            refund_amount:,
+            uploaded_filename:,
+            evidence:
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(
+          @connection.put("/dispute/#{escape_path(id, name: "id")}/resolve", wire_body)
+        )
+      end
+
+      # Add Evidence.
+      #
+      # Provide evidence for a dispute
+      #
+      # @param id [Integer] The unique identifier of the dispute
+      # @param customer_email [String] Customer email
+      # @param customer_name [String] Customer name
+      # @param customer_phone [String] Customer mobile number
+      # @param service_details [String] Details of service offered
+      # @param delivery_address [String] Delivery address
+      # @param delivery_date [String] ISO 8601 representation of delivery date (YYYY-MM-DD)
+      # @return [PaystackSdk::Response] The response from the Paystack API.
+      # @raise [PaystackSdk::Error] If a parameter is invalid or the API request fails.
+      # @see https://paystack.com/docs/api/dispute/#evidence
+      def add_evidence(
+        id:,
+        customer_email:,
+        customer_name:,
+        customer_phone:,
+        service_details:,
+        delivery_address: nil,
+        delivery_date: nil
+      )
+        validate_presence!(value: id, name: "id")
+        validate_presence!(value: customer_email, name: "customer_email")
+        validate_presence!(value: customer_name, name: "customer_name")
+        validate_presence!(value: customer_phone, name: "customer_phone")
+        validate_presence!(value: service_details, name: "service_details")
+
+        wire_body = to_wire(
+          {
+            customer_email:,
+            customer_name:,
+            customer_phone:,
+            service_details:,
+            delivery_address:,
+            delivery_date: format_datetime(delivery_date, name: "delivery_date")
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(
+          @connection.post("/dispute/#{escape_path(id, name: "id")}/evidence", wire_body)
+        )
+      end
+    end
+  end
+end