paystack_sdk 0.2.0 → 0.3.0

data/lib/paystack_sdk/resources/splits.rb

@@ -0,0 +1,186 @@
+# 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 Split`. Hand-written extras go in lib/paystack_sdk/resources/extensions/splits.rb.
+# scaffold-digest: 7edb268cf2271c4fb1af0cf5284840af3e3adbafe31ea1cbc2acfd4dc2c88d10
+
+require_relative "base"
+
+module PaystackSdk
+  module Resources
+    # Split operations.
+    class Splits < PaystackSdk::Resources::Base
+      # Ruby keyword => the parameter name Paystack documents.
+      WIRE_NAMES = {per_page: "perPage"}.freeze
+
+      # List Splits.
+      #
+      # List the transaction splits available on your integration
+      #
+      # @param subaccount_code [String] Filter by subaccount code
+      # @param name [String] The name of the split
+      # @param active [Boolean] The status of the split
+      # @param per_page [Integer] The number of records to fetch per request
+      # @param page [Integer] The offset to retrieve data from
+      # @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/split/#list
+      def list(
+        subaccount_code: nil,
+        name: nil,
+        active: nil,
+        per_page: nil,
+        page: nil,
+        from: nil,
+        to: nil
+      )
+        validate_positive_integer!(value: per_page, name: "perPage")
+        validate_positive_integer!(value: page, name: "page")
+
+        wire_query = to_wire(
+          {
+            subaccount_code:,
+            name:,
+            active:,
+            per_page:,
+            page:,
+            from: format_datetime(from, name: "from"),
+            to: format_datetime(to, name: "to")
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.get("/split", wire_query))
+      end
+
+      # Create Split.
+      #
+      # Create a split configuration for transactions
+      #
+      # @param name [String] Name of the transaction split
+      # @param type [String] The type of transaction split you want to create. One of: percentage, flat.
+      # @param subaccounts [Array] A list of object containing subaccount code and number of shares
+      # @param currency [String] The transaction currency One of: NGN, GHS, ZAR, USD.
+      # @param bearer_type [String] This allows you specify how the transaction charge should be processed One of: subaccount, account, all-proportional, all.
+      # @param bearer_subaccount [String] This is the subaccount code of the customer or partner that would bear the transaction charge if you specified subaccount as the bearer type
+      # @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/split/#create
+      def create(name:, type:, subaccounts:, currency:, bearer_type: nil, bearer_subaccount: nil)
+        validate_presence!(value: name, name: "name")
+        validate_presence!(value: type, name: "type")
+        validate_allowed_values!(value: type, allowed_values: %w[percentage flat], name: "type")
+        validate_presence!(value: subaccounts, name: "subaccounts")
+        validate_presence!(value: currency, name: "currency")
+        validate_allowed_values!(
+          value: currency,
+          allowed_values: %w[NGN GHS ZAR USD],
+          name: "currency"
+        )
+        validate_allowed_values!(
+          value: bearer_type,
+          allowed_values: %w[subaccount account all-proportional all],
+          name: "bearer_type"
+        )
+
+        wire_body = to_wire(
+          {
+            name:,
+            type:,
+            subaccounts:,
+            currency:,
+            bearer_type:,
+            bearer_subaccount:
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.post("/split", wire_body))
+      end
+
+      # Fetch Split.
+      #
+      # Get details of a split configuration for a transaction
+      #
+      # @param id [String] The ID of the split configuration to fetch
+      # @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/split/#fetch
+      def fetch(id:)
+        validate_presence!(value: id, name: "id")
+
+        handle_response(@connection.get("/split/#{escape_path(id, name: "id")}"))
+      end
+
+      # Update Split.
+      #
+      # Update a split configuration for transactions
+      #
+      # @param id [String]
+      # @param name [String] Name of the transaction split
+      # @param active [Boolean] Toggle status of split.
+      # @param bearer_type [String] This allows you specify how the transaction charge should be processed One of: subaccount, account, all-proportional, all.
+      # @param bearer_subaccount [String] This is the subaccount code of the customer or partner that would bear the transaction charge if you specified subaccount as the bearer type
+      # @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/split/#update
+      def update(id:, name: nil, active: nil, bearer_type: nil, bearer_subaccount: nil)
+        validate_presence!(value: id, name: "id")
+        validate_allowed_values!(
+          value: bearer_type,
+          allowed_values: %w[subaccount account all-proportional all],
+          name: "bearer_type"
+        )
+
+        wire_body = to_wire({name:, active:, bearer_type:, bearer_subaccount:}, WIRE_NAMES)
+
+        handle_response(@connection.put("/split/#{escape_path(id, name: "id")}", wire_body))
+      end
+
+      # Add Subaccount to Split.
+      #
+      # Add a subaccount to a split configuration, or update the share of an existing subaccount
+      #
+      # @param id [Integer] The ID of the split configuration to fetch
+      # @param subaccount [String] Subaccount code of the customer or partner
+      # @param share [Integer] The percentage or flat quota of the customer or partner
+      # @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/split/#add-subaccount
+      def add_subaccount(id:, subaccount:, share:)
+        validate_presence!(value: id, name: "id")
+        validate_presence!(value: subaccount, name: "subaccount")
+        validate_presence!(value: share, name: "share")
+
+        wire_body = to_wire({subaccount:, share:}, WIRE_NAMES)
+
+        handle_response(
+          @connection.post("/split/#{escape_path(id, name: "id")}/subaccount/add", wire_body)
+        )
+      end
+
+      # Remove Subaccount from split.
+      #
+      # Remove a subaccount from a split configuration
+      #
+      # @param id [Integer] The ID of the split configuration to fetch
+      # @param subaccount [String] Subaccount code of the customer or partner
+      # @param share [Integer] Not used when removing a subaccount; the docs do not list it, and Paystack removes the subaccount whatever share is sent.
+      # @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/split/#remove-subaccount
+      def remove_subaccount(id:, subaccount:, share: nil)
+        validate_presence!(value: id, name: "id")
+        validate_presence!(value: subaccount, name: "subaccount")
+
+        wire_body = to_wire({subaccount:, share:}, WIRE_NAMES)
+
+        handle_response(
+          @connection.post("/split/#{escape_path(id, name: "id")}/subaccount/remove", wire_body)
+        )
+      end
+    end
+  end
+end

data/lib/paystack_sdk/resources/subaccounts.rb

@@ -0,0 +1,156 @@
+# 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 Subaccount`. Hand-written extras go in lib/paystack_sdk/resources/extensions/subaccounts.rb.
+# scaffold-digest: 138fb843a635fcc0bbe5279df7a324b6973fecc6652458cc3e422999a716bc37
+
+require_relative "base"
+
+module PaystackSdk
+  module Resources
+    # Subaccount operations.
+    class Subaccounts < PaystackSdk::Resources::Base
+      # Ruby keyword => the parameter name Paystack documents.
+      WIRE_NAMES = {per_page: "perPage"}.freeze
+
+      # List Subaccounts.
+      #
+      # List subaccounts available on your integration
+      #
+      # @param per_page [Integer] Number of records to fetch per request
+      # @param page [Integer] The offset to retrieve data from
+      # @param active [Integer] Filter by the state of the subaccounts
+      # @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/subaccount/#list
+      def list(per_page: nil, page: nil, active: nil)
+        validate_positive_integer!(value: per_page, name: "perPage")
+        validate_positive_integer!(value: page, name: "page")
+
+        wire_query = to_wire({per_page:, page:, active:}, WIRE_NAMES)
+
+        handle_response(@connection.get("/subaccount", wire_query))
+      end
+
+      # Create Subaccount.
+      #
+      # Create a subacount for a partner
+      #
+      # @param business_name [String] Name of business for subaccount
+      # @param bank_code [String] Bank code for the bank, from the List Banks endpoint.
+      # @param account_number [String] Bank account number
+      # @param percentage_charge [Numeric] The percentage the main account receives from each payment made to the subaccount.
+      # @param description [String] A description for this subaccount
+      # @param primary_contact_email [String] A contact email for the subaccount
+      # @param primary_contact_name [String] The name of the contact person for this subaccount
+      # @param primary_contact_phone [String] A phone number to call for this subaccount
+      # @param metadata [String] Stringified JSON object of custom data
+      # @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/subaccount/#create
+      def create(
+        business_name:,
+        bank_code:,
+        account_number:,
+        percentage_charge:,
+        description: nil,
+        primary_contact_email: nil,
+        primary_contact_name: nil,
+        primary_contact_phone: nil,
+        metadata: nil
+      )
+        validate_presence!(value: business_name, name: "business_name")
+        validate_presence!(value: bank_code, name: "bank_code")
+        validate_presence!(value: account_number, name: "account_number")
+        validate_presence!(value: percentage_charge, name: "percentage_charge")
+
+        wire_body = to_wire(
+          {
+            business_name:,
+            bank_code:,
+            account_number:,
+            percentage_charge:,
+            description:,
+            primary_contact_email:,
+            primary_contact_name:,
+            primary_contact_phone:,
+            metadata: stringify_json(metadata)
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.post("/subaccount", wire_body))
+      end
+
+      # Fetch Subaccount.
+      #
+      # Get details of a subaccount on your integration
+      #
+      # @param id_or_code [String] The subaccount code you want to fetch
+      # @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/subaccount/#fetch
+      def fetch(id_or_code:)
+        validate_presence!(value: id_or_code, name: "id_or_code")
+
+        handle_response(
+          @connection.get("/subaccount/#{escape_path(id_or_code, name: "id_or_code")}")
+        )
+      end
+
+      # Update Subaccount.
+      #
+      # Update a subaccount details on your integration
+      #
+      # @param id_or_code [String] The subaccount code you want to fetch
+      # @param business_name [String] Name of business for subaccount
+      # @param bank_code [String] Bank code for the bank, from the List Banks endpoint.
+      # @param account_number [String] Bank account number
+      # @param active [Boolean] Activate or deactivate a subaccount
+      # @param percentage_charge [Numeric] The default percentage charged when receiving on behalf of this subaccount.
+      # @param description [String] A description for this subaccount
+      # @param primary_contact_email [String] A contact email for the subaccount
+      # @param primary_contact_name [String] The name of the contact person for this subaccount
+      # @param primary_contact_phone [String] A phone number to call for this subaccount
+      # @param metadata [String] Stringified JSON object of custom data
+      # @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/subaccount/#update
+      def update(
+        id_or_code:,
+        business_name: nil,
+        bank_code: nil,
+        account_number: nil,
+        active: nil,
+        percentage_charge: nil,
+        description: nil,
+        primary_contact_email: nil,
+        primary_contact_name: nil,
+        primary_contact_phone: nil,
+        metadata: nil
+      )
+        validate_presence!(value: id_or_code, name: "id_or_code")
+
+        wire_body = to_wire(
+          {
+            business_name:,
+            bank_code:,
+            account_number:,
+            active:,
+            percentage_charge:,
+            description:,
+            primary_contact_email:,
+            primary_contact_name:,
+            primary_contact_phone:,
+            metadata: stringify_json(metadata)
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(
+          @connection.put("/subaccount/#{escape_path(id_or_code, name: "id_or_code")}", wire_body)
+        )
+      end
+    end
+  end
+end

data/lib/paystack_sdk/resources/subscriptions.rb

@@ -0,0 +1,161 @@
+# 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 Subscription`. Hand-written extras go in lib/paystack_sdk/resources/extensions/subscriptions.rb.
+# scaffold-digest: bf9e49fa6de4d23b295572c9c4fc3aa74477986410dd3f858145f2e4239d0444
+
+require_relative "base"
+
+module PaystackSdk
+  module Resources
+    # Subscription operations.
+    class Subscriptions < PaystackSdk::Resources::Base
+      # Ruby keyword => the parameter name Paystack documents.
+      WIRE_NAMES = {per_page: "perPage", plan_id: "plan", customer_id: "customer"}.freeze
+
+      # List Subscriptions.
+      #
+      # List all subscriptions available on your integration
+      #
+      # @param per_page [Integer] Number of records to fetch per page
+      # @param page [Integer] The section to retrieve
+      # @param plan_id [Integer] Plan ID
+      # @param customer_id [Integer] Customer 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/subscription/#list
+      def list(per_page: nil, page: nil, plan_id: nil, customer_id: nil, from: nil, to: nil)
+        validate_positive_integer!(value: per_page, name: "perPage")
+        validate_positive_integer!(value: page, name: "page")
+
+        wire_query = to_wire(
+          {
+            per_page:,
+            page:,
+            plan_id:,
+            customer_id:,
+            from: format_datetime(from, name: "from"),
+            to: format_datetime(to, name: "to")
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.get("/subscription", wire_query))
+      end
+
+      # Create Subscription.
+      #
+      # Create a subscription a customer
+      #
+      # @param customer [String] Customer's email address or customer code
+      # @param plan [String] Plan code
+      # @param authorization [String] If customer has multiple authorizations, you can set the desired authorization you wish to use for this subscription here.
+      # @param start_date [String] Set the date for the first debit.
+      # @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/subscription/#create
+      def create(customer:, plan:, authorization: nil, start_date: nil)
+        validate_presence!(value: customer, name: "customer")
+        validate_presence!(value: plan, name: "plan")
+
+        wire_body = to_wire(
+          {
+            customer:,
+            plan:,
+            authorization:,
+            start_date: format_datetime(start_date, name: "start_date")
+          },
+          WIRE_NAMES
+        )
+
+        handle_response(@connection.post("/subscription", wire_body))
+      end
+
+      # Fetch Subscription.
+      #
+      # Get details of a customer's subscription
+      #
+      # @param id_or_code [String] The subscription code for the subscription you want to fetch
+      # @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/subscription/#fetch
+      def fetch(id_or_code:)
+        validate_presence!(value: id_or_code, name: "id_or_code")
+
+        handle_response(
+          @connection.get("/subscription/#{escape_path(id_or_code, name: "id_or_code")}")
+        )
+      end
+
+      # Disable Subscription.
+      #
+      # Disable a subscription on your integration
+      #
+      # @param code [String] Subscription code
+      # @param token [String] Email token
+      # @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/subscription/#disable
+      def disable(code:, token:)
+        validate_presence!(value: code, name: "code")
+        validate_presence!(value: token, name: "token")
+
+        wire_body = to_wire({code:, token:}, WIRE_NAMES)
+
+        handle_response(@connection.post("/subscription/disable", wire_body))
+      end
+
+      # Enable Subscription.
+      #
+      # Enable a subscription on your integration
+      #
+      # @param code [String] Subscription code
+      # @param token [String] Email token
+      # @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/subscription/#enable
+      def enable(code:, token:)
+        validate_presence!(value: code, name: "code")
+        validate_presence!(value: token, name: "token")
+
+        wire_body = to_wire({code:, token:}, WIRE_NAMES)
+
+        handle_response(@connection.post("/subscription/enable", wire_body))
+      end
+
+      # Generate Update Subscription Link.
+      #
+      # Generate a link for updating the card on a subscription
+      #
+      # @param code [String] Subscription code
+      # @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/subscription/#manage-link
+      def generate_update_link(code:)
+        validate_presence!(value: code, name: "code")
+
+        handle_response(
+          @connection.get("/subscription/#{escape_path(code, name: "code")}/manage/link")
+        )
+      end
+
+      # Send Update Subscription Link.
+      #
+      # Email a customer a link for updating the card on their subscription
+      #
+      # @param code [String] Subscription code
+      # @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/subscription/#manage-email
+      def send_update_link(code:)
+        validate_presence!(value: code, name: "code")
+
+        handle_response(
+          @connection.post("/subscription/#{escape_path(code, name: "code")}/manage/email")
+        )
+      end
+    end
+  end
+end

data/lib/paystack_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PaystackSdk
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: paystack_sdk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Maxwell Nana Forson (theLazyProgrammer)
@@ -165,13 +165,22 @@ files:
 - lib/paystack_sdk/client.rb
 - lib/paystack_sdk/middleware/transport_errors.rb
 - lib/paystack_sdk/request_helpers.rb
+- lib/paystack_sdk/resources/balances.rb
 - lib/paystack_sdk/resources/banks.rb
 - lib/paystack_sdk/resources/base.rb
 - lib/paystack_sdk/resources/charges.rb
 - lib/paystack_sdk/resources/customers.rb
+- lib/paystack_sdk/resources/dedicated_virtual_accounts.rb
+- lib/paystack_sdk/resources/disputes.rb
 - lib/paystack_sdk/resources/extensions/charges.rb
 - lib/paystack_sdk/resources/miscellaneous.rb
+- lib/paystack_sdk/resources/payment_requests.rb
+- lib/paystack_sdk/resources/plans.rb
 - lib/paystack_sdk/resources/refunds.rb
+- lib/paystack_sdk/resources/settlements.rb
+- lib/paystack_sdk/resources/splits.rb
+- lib/paystack_sdk/resources/subaccounts.rb
+- lib/paystack_sdk/resources/subscriptions.rb
 - lib/paystack_sdk/resources/transactions.rb
 - lib/paystack_sdk/resources/transfer_recipients.rb
 - lib/paystack_sdk/resources/transfers.rb