paystack-gateway 0.1.1 → 0.2.0

data/lib/paystack_gateway/subaccount.rb

@@ -0,0 +1,263 @@
+# frozen_string_literal: true
+
+module PaystackGateway
+  # https://paystack.com/docs/api/subaccount
+  #
+  # Subaccounts
+  # A collection of endpoints for creating and managing accounts for sharing a transaction with
+  module Subaccount
+    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/subaccount/#list
+    # List Subaccounts: GET /subaccount
+    # 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 [Boolean]
+    #        Filter by the state of the subaccounts
+    #
+    # @return [ListResponse] successful response
+    # @raise [ListError] if the request fails
+    api_method def self.list(per_page: nil, page: nil, active: nil)
+      use_connection do |connection|
+        connection.get(
+          '/subaccount',
+          { perPage: per_page, page:, active: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #create.
+    class CreateResponse < PaystackGateway::Response
+      delegate :business_name,
+               :description,
+               :primary_contact_name,
+               :primary_contact_email,
+               :primary_contact_phone,
+               :metadata,
+               :account_number,
+               :percentage_charge,
+               :settlement_bank,
+               :currency,
+               :bank,
+               :integration,
+               :domain,
+               :managed_by_integration,
+               :product,
+               :subaccount_code,
+               :is_verified,
+               :settlement_schedule,
+               :active,
+               :migrate,
+               :id,
+               :createdAt,
+               :updatedAt, to: :data
+    end
+
+    # Error response from #create.
+    class CreateError < ApiError; end
+
+    # https://paystack.com/docs/api/subaccount/#create
+    # Create Subaccount: POST /subaccount
+    # Create a subacount for a partner
+    #
+    # @param business_name [String] (required)
+    #        Name of business for subaccount
+    # @param settlement_bank [String] (required)
+    #        Bank code for the bank. You can get the list of Bank Codes by calling the List Banks
+    #        endpoint.
+    # @param account_number [String] (required)
+    #        Bank account number
+    # @param percentage_charge [Number] (required)
+    #        Customer's phone number
+    # @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 [CreateResponse] successful response
+    # @raise [CreateError] if the request fails
+    api_method def self.create(
+      business_name:,
+      settlement_bank:,
+      account_number:,
+      percentage_charge:,
+      description: nil,
+      primary_contact_email: nil,
+      primary_contact_name: nil,
+      primary_contact_phone: nil,
+      metadata: nil
+    )
+      use_connection do |connection|
+        connection.post(
+          '/subaccount',
+          {
+            business_name:,
+            settlement_bank:,
+            account_number:,
+            percentage_charge:,
+            description:,
+            primary_contact_email:,
+            primary_contact_name:,
+            primary_contact_phone:,
+            metadata:,
+          }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #fetch.
+    class FetchResponse < PaystackGateway::Response
+      delegate :integration,
+               :bank,
+               :managed_by_integration,
+               :domain,
+               :subaccount_code,
+               :business_name,
+               :description,
+               :primary_contact_name,
+               :primary_contact_email,
+               :primary_contact_phone,
+               :metadata,
+               :percentage_charge,
+               :is_verified,
+               :settlement_bank,
+               :account_number,
+               :settlement_schedule,
+               :active,
+               :migrate,
+               :currency,
+               :product,
+               :id,
+               :createdAt,
+               :updatedAt, to: :data
+    end
+
+    # Error response from #fetch.
+    class FetchError < ApiError; end
+
+    # https://paystack.com/docs/api/subaccount/#fetch
+    # Fetch Subaccount: GET /subaccount/{code}
+    # Get details of a subaccount on your integration
+    #
+    # @param code [String] (required)
+    #        The subaccount code you want to fetch
+    #
+    # @return [FetchResponse] successful response
+    # @raise [FetchError] if the request fails
+    api_method def self.fetch(code:)
+      use_connection do |connection|
+        connection.get(
+          "/subaccount/#{code}",
+        )
+      end
+    end
+
+    # Successful response from calling #update.
+    class UpdateResponse < PaystackGateway::Response
+      delegate :domain,
+               :subaccount_code,
+               :business_name,
+               :description,
+               :primary_contact_name,
+               :primary_contact_email,
+               :primary_contact_phone,
+               :metadata,
+               :percentage_charge,
+               :is_verified,
+               :settlement_bank,
+               :account_number,
+               :settlement_schedule,
+               :active,
+               :migrate,
+               :currency,
+               :product,
+               :id,
+               :integration,
+               :bank,
+               :managed_by_integration,
+               :createdAt,
+               :updatedAt, to: :data
+    end
+
+    # Error response from #update.
+    class UpdateError < ApiError; end
+
+    # https://paystack.com/docs/api/subaccount/#update
+    # Update Subaccount: PUT /subaccount/{code}
+    # Update a subaccount details on your integration
+    #
+    # @param code [String] (required)
+    #        The subaccount code you want to fetch
+    # @param business_name [String]
+    #        Name of business for subaccount
+    # @param settlement_bank [String]
+    #        Bank code for the bank. You can get the list of Bank Codes by calling the List Banks
+    #        endpoint.
+    # @param account_number [String]
+    #        Bank account number
+    # @param active [Boolean]
+    #        Activate or deactivate a subaccount
+    # @param percentage_charge [Number]
+    #        Customer's phone number
+    # @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 [UpdateResponse] successful response
+    # @raise [UpdateError] if the request fails
+    api_method def self.update(
+      code:,
+      business_name: nil,
+      settlement_bank: 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
+    )
+      use_connection do |connection|
+        connection.put(
+          "/subaccount/#{code}",
+          {
+            business_name:,
+            settlement_bank:,
+            account_number:,
+            active:,
+            percentage_charge:,
+            description:,
+            primary_contact_email:,
+            primary_contact_name:,
+            primary_contact_phone:,
+            metadata:,
+          }.compact,
+        )
+      end
+    end
+  end
+end

data/lib/paystack_gateway/subaccounts.rb

@@ -1,37 +1,3 @@
 # frozen_string_literal: true
 
-module PaystackGateway
-  # Create and manage subaccounts https://paystack.com/docs/api/subaccount/
-  module Subaccounts
-    include PaystackGateway::RequestModule
-
-    # Response from POST /subaccount
-    class CreateSubaccountResponse < PaystackGateway::Response
-      delegate :subaccount_code, to: :data
-    end
-
-    api_method def self.create_subaccount(business_name:, settlement_bank:, account_number:, percentage_charge:)
-      use_connection do |connection|
-        connection.post(
-          '/subaccount',
-          { business_name:, settlement_bank:, account_number:, percentage_charge: }.compact,
-        )
-      end
-    end
-
-    # Response from PUT /subaccount/:id_or_code
-    class UpdateSubaccountResponse < CreateSubaccountResponse; end
-
-    api_method def self.update_subaccount(
-      subaccount_code,
-      business_name: nil, settlement_bank: nil, account_number: nil, percentage_charge: nil
-    )
-      use_connection do |connection|
-        connection.put(
-          "/subaccount/#{subaccount_code}",
-          { business_name:, settlement_bank:, account_number:, percentage_charge: }.compact,
-        )
-      end
-    end
-  end
-end
+require 'paystack_gateway/legacy/subaccounts'

data/lib/paystack_gateway/subscription.rb

@@ -0,0 +1,256 @@
+# frozen_string_literal: true
+
+module PaystackGateway
+  # https://paystack.com/docs/api/subscription
+  #
+  # Subscriptions
+  # A collection of endpoints for creating and managing recurring payments
+  module Subscription
+    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/subscription/#list
+    # List Subscriptions: GET /subscription
+    # 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 [Integer]
+    #        Plan ID
+    # @param customer [String]
+    #        Customer ID
+    # @param from [Time]
+    #        The start date
+    # @param to [Time]
+    #        The end date
+    #
+    # @return [ListResponse] successful response
+    # @raise [ListError] if the request fails
+    api_method def self.list(
+      per_page: nil,
+      page: nil,
+      plan: nil,
+      customer: nil,
+      from: nil,
+      to: nil
+    )
+      use_connection do |connection|
+        connection.get(
+          '/subscription',
+          {
+            perPage: per_page,
+            page:,
+            plan:,
+            customer:,
+            from:,
+            to:,
+          }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #create.
+    class CreateResponse < PaystackGateway::Response
+      delegate :customer,
+               :plan,
+               :integration,
+               :domain,
+               :start,
+               :quantity,
+               :amount,
+               :authorization,
+               :invoice_limit,
+               :split_code,
+               :subscription_code,
+               :email_token,
+               :id,
+               :cancelledAt,
+               :createdAt,
+               :updatedAt,
+               :cron_expression,
+               :next_payment_date,
+               :easy_cron_id,
+               :open_invoice,
+               :metadata, to: :data
+    end
+
+    # Error response from #create.
+    class CreateError < ApiError; end
+
+    # https://paystack.com/docs/api/subscription/#create
+    # Create Subscription: POST /subscription
+    # Create a subscription a customer
+    #
+    # @param customer [String] (required)
+    #        Customer's email address or customer code
+    # @param plan [String] (required)
+    #        Plan code
+    # @param authorization [String]
+    #        If customer has multiple authorizations, you can set the desired authorization you
+    #        wish to use for this subscription here. If this is not supplied, the customer's
+    #        most recent authorization would be used
+    # @param start_date [Time]
+    #        Set the date for the first debit. (ISO 8601 format) e.g. 2017-05-16T00:30:13+01:00
+    #
+    # @return [CreateResponse] successful response
+    # @raise [CreateError] if the request fails
+    api_method def self.create(customer:, plan:, authorization: nil, start_date: nil)
+      use_connection do |connection|
+        connection.post(
+          '/subscription',
+          { customer:, plan:, authorization:, start_date: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #fetch.
+    class FetchResponse < PaystackGateway::Response
+      delegate :id,
+               :domain,
+               :subscription_code,
+               :email_token,
+               :amount,
+               :cron_expression,
+               :next_payment_date,
+               :open_invoice,
+               :createdAt,
+               :cancelledAt,
+               :integration,
+               :plan,
+               :authorization,
+               :customer,
+               :invoices,
+               :invoices_history,
+               :invoice_limit,
+               :split_code,
+               :most_recent_invoice,
+               :payments_count,
+               :metadata, to: :data
+    end
+
+    # Error response from #fetch.
+    class FetchError < ApiError; end
+
+    # https://paystack.com/docs/api/subscription/#fetch
+    # Fetch Subscription: GET /subscription/{code}
+    # Get details of a customer's subscription
+    #
+    # @param code [String] (required)
+    #        The subscription code for the subscription you want to fetch
+    #
+    # @return [FetchResponse] successful response
+    # @raise [FetchError] if the request fails
+    api_method def self.fetch(code:)
+      use_connection do |connection|
+        connection.get(
+          "/subscription/#{code}",
+        )
+      end
+    end
+
+    # Successful response from calling #disable.
+    class DisableResponse < PaystackGateway::Response; end
+
+    # Error response from #disable.
+    class DisableError < ApiError; end
+
+    # https://paystack.com/docs/api/subscription/#disable
+    # Disable Subscription: POST /subscription/disable
+    # Disable a subscription on your integration
+    #
+    # @param code [String] (required)
+    #        Subscription code
+    # @param token [String] (required)
+    #        Email token
+    #
+    # @return [DisableResponse] successful response
+    # @raise [DisableError] if the request fails
+    api_method def self.disable(code:, token:)
+      use_connection do |connection|
+        connection.post(
+          '/subscription/disable',
+          { code:, token: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #enable.
+    class EnableResponse < PaystackGateway::Response; end
+
+    # Error response from #enable.
+    class EnableError < ApiError; end
+
+    # https://paystack.com/docs/api/subscription/#enable
+    # Enable Subscription: POST /subscription/enable
+    # Enable a subscription on your integration
+    #
+    # @param code [String] (required)
+    #        Subscription code
+    # @param token [String] (required)
+    #        Email token
+    #
+    # @return [EnableResponse] successful response
+    # @raise [EnableError] if the request fails
+    api_method def self.enable(code:, token:)
+      use_connection do |connection|
+        connection.post(
+          '/subscription/enable',
+          { code:, token: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #manage_link.
+    class ManageLinkResponse < PaystackGateway::Response; end
+
+    # Error response from #manage_link.
+    class ManageLinkError < ApiError; end
+
+    # https://paystack.com/docs/api/subscription/#manage_link
+    # Generate Update Subscription Link: GET /subscription/{code}/manage/link
+    # Generate a link for updating the card on a subscription
+    #
+    # @param code [String] (required)
+    #        Subscription code
+    #
+    # @return [ManageLinkResponse] successful response
+    # @raise [ManageLinkError] if the request fails
+    api_method def self.manage_link(code:)
+      use_connection do |connection|
+        connection.get(
+          "/subscription/#{code}/manage/link",
+        )
+      end
+    end
+
+    # Successful response from calling #manage_email.
+    class ManageEmailResponse < PaystackGateway::Response; end
+
+    # Error response from #manage_email.
+    class ManageEmailError < ApiError; end
+
+    # https://paystack.com/docs/api/subscription/#manage_email
+    # Send Update Subscription Link: POST /subscription/{code}/manage/email
+    # Email a customer a link for updating the card on their subscription
+    #
+    # @param code [String] (required)
+    #        Subscription code
+    #
+    # @return [ManageEmailResponse] successful response
+    # @raise [ManageEmailError] if the request fails
+    api_method def self.manage_email(code:)
+      use_connection do |connection|
+        connection.post(
+          "/subscription/#{code}/manage/email",
+        )
+      end
+    end
+  end
+end