paystack-gateway 0.1.0 → 0.2.0

data/lib/paystack_gateway/settlement.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module PaystackGateway
+  # https://paystack.com/docs/api/settlement
+  #
+  # Settlements
+  # A collection of endpoints for gaining insights into payouts
+  module Settlement
+    include PaystackGateway::RequestModule
+
+    # Successful response from calling #fetch.
+    class FetchResponse < PaystackGateway::Response; end
+
+    # Error response from #fetch.
+    class FetchError < ApiError; end
+
+    # https://paystack.com/docs/api/settlement/#fetch
+    # List Settlements: GET /settlement
+    # List settlements made to your settlement accounts
+    #
+    # @param per_page [Integer]
+    #        The number of records to fetch per request
+    # @param page [Integer]
+    #        The offset to retrieve data from
+    #
+    # @return [FetchResponse] successful response
+    # @raise [FetchError] if the request fails
+    api_method def self.fetch(per_page: nil, page: nil)
+      use_connection do |connection|
+        connection.get(
+          '/settlement',
+          { perPage: per_page, page: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #transaction.
+    class TransactionResponse < PaystackGateway::Response; end
+
+    # Error response from #transaction.
+    class TransactionError < ApiError; end
+
+    # https://paystack.com/docs/api/settlement/#transaction
+    # Fetch Settlement Transactions: GET /settlement/{id}/transactions
+    # Get the transactions that make up a particular settlement
+    #
+    # @param id [Integer] (required)
+    #        The settlement ID in which you want to fetch its transactions
+    #
+    # @return [TransactionResponse] successful response
+    # @raise [TransactionError] if the request fails
+    api_method def self.transaction(id:)
+      use_connection do |connection|
+        connection.get(
+          "/settlement/#{id}/transactions",
+        )
+      end
+    end
+  end
+end

data/lib/paystack_gateway/split.rb

@@ -0,0 +1,286 @@
+# frozen_string_literal: true
+
+module PaystackGateway
+  # https://paystack.com/docs/api/split
+  #
+  # Transaction Splits
+  # A collection of endpoints for spliting a transaction and managing the splits
+  module Split
+    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/split/#list
+    # List Splits: GET /split
+    # 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 [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(
+      subaccount_code: nil,
+      name: nil,
+      active: nil,
+      per_page: nil,
+      page: nil,
+      from: nil,
+      to: nil
+    )
+      use_connection do |connection|
+        connection.get(
+          '/split',
+          {
+            subaccount_code:,
+            name:,
+            active:,
+            per_page:,
+            page:,
+            from:,
+            to:,
+          }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #create.
+    class CreateResponse < PaystackGateway::Response
+      delegate :id,
+               :name,
+               :type,
+               :currency,
+               :integration,
+               :domain,
+               :split_code,
+               :active,
+               :bearer_type,
+               :createdAt,
+               :updatedAt,
+               :is_dynamic,
+               :subaccounts,
+               :total_subaccounts, to: :data
+    end
+
+    # Error response from #create.
+    class CreateError < ApiError; end
+
+    # https://paystack.com/docs/api/split/#create
+    # Create Split: POST /split
+    # Create a split configuration for transactions
+    #
+    # @param name [String] (required)
+    #        Name of the transaction split
+    # @param type ["percentage", "flat"] (required)
+    #        The type of transaction split you want to create.
+    # @param subaccounts [Array<Hash>] (required)
+    #        A list of object containing subaccount code and number of shares
+    # @param currency ["NGN", "GHS", "ZAR", "USD"] (required)
+    #        The transaction currency
+    # @param bearer_type ["subaccount", "account", "all-proportional", "all"]
+    #        This allows you specify how the transaction charge should be processed
+    # @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 [CreateResponse] successful response
+    # @raise [CreateError] if the request fails
+    api_method def self.create(
+      name:,
+      type:,
+      subaccounts:,
+      currency:,
+      bearer_type: nil,
+      bearer_subaccount: nil
+    )
+      use_connection do |connection|
+        connection.post(
+          '/split',
+          {
+            name:,
+            type:,
+            subaccounts:,
+            currency:,
+            bearer_type:,
+            bearer_subaccount:,
+          }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #fetch.
+    class FetchResponse < PaystackGateway::Response
+      delegate :id,
+               :name,
+               :type,
+               :currency,
+               :integration,
+               :domain,
+               :split_code,
+               :active,
+               :bearer_type,
+               :bearer_subaccount,
+               :createdAt,
+               :updatedAt,
+               :is_dynamic,
+               :subaccounts,
+               :total_subaccounts, to: :data
+    end
+
+    # Error response from #fetch.
+    class FetchError < ApiError; end
+
+    # https://paystack.com/docs/api/split/#fetch
+    # Fetch Split: GET /split/{id}
+    # Get details of a split configuration for a transaction
+    #
+    # @param id [Integer] (required)
+    #        The ID of the split configuration to fetch
+    #
+    # @return [FetchResponse] successful response
+    # @raise [FetchError] if the request fails
+    api_method def self.fetch(id:)
+      use_connection do |connection|
+        connection.get(
+          "/split/#{id}",
+        )
+      end
+    end
+
+    # Successful response from calling #update.
+    class UpdateResponse < PaystackGateway::Response
+      delegate :id,
+               :name,
+               :type,
+               :currency,
+               :integration,
+               :domain,
+               :split_code,
+               :active,
+               :bearer_type,
+               :bearer_subaccount,
+               :createdAt,
+               :updatedAt,
+               :is_dynamic,
+               :subaccounts,
+               :total_subaccounts, to: :data
+    end
+
+    # Error response from #update.
+    class UpdateError < ApiError; end
+
+    # https://paystack.com/docs/api/split/#update
+    # Update Split: PUT /split/{id}
+    # Update a split configuration for transactions
+    #
+    # @param id [String] (required)
+    # @param name [String]
+    #        Name of the transaction split
+    # @param active [Boolean]
+    #        Toggle status of split. When true, the split is active, else it's inactive
+    # @param bearer_type ["subaccount", "account", "all-proportional", "all"]
+    #        This allows you specify how the transaction charge should be processed
+    # @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 [UpdateResponse] successful response
+    # @raise [UpdateError] if the request fails
+    api_method def self.update(id:, name: nil, active: nil, bearer_type: nil, bearer_subaccount: nil)
+      use_connection do |connection|
+        connection.put(
+          "/split/#{id}",
+          { name:, active:, bearer_type:, bearer_subaccount: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #add_subaccount.
+    class AddSubaccountResponse < PaystackGateway::Response
+      delegate :id,
+               :name,
+               :type,
+               :currency,
+               :integration,
+               :domain,
+               :split_code,
+               :active,
+               :bearer_type,
+               :bearer_subaccount,
+               :createdAt,
+               :updatedAt,
+               :is_dynamic,
+               :subaccounts,
+               :total_subaccounts, to: :data
+    end
+
+    # Error response from #add_subaccount.
+    class AddSubaccountError < ApiError; end
+
+    # https://paystack.com/docs/api/split/#add_subaccount
+    # Add Subaccount to Split: POST /split/{id}/subaccount/add
+    # Add a subaccount to a split configuration, or update the share of an existing subaccount
+    #
+    # @param id [Integer] (required)
+    #        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 [AddSubaccountResponse] successful response
+    # @raise [AddSubaccountError] if the request fails
+    api_method def self.add_subaccount(id:, subaccount: nil, share: nil)
+      use_connection do |connection|
+        connection.post(
+          "/split/#{id}/subaccount/add",
+          { subaccount:, share: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #remove_subaccount.
+    class RemoveSubaccountResponse < PaystackGateway::Response; end
+
+    # Error response from #remove_subaccount.
+    class RemoveSubaccountError < ApiError; end
+
+    # https://paystack.com/docs/api/split/#remove_subaccount
+    # Remove Subaccount from split: POST /split/{id}/subaccount/remove
+    # Remove a subaccount from a split configuration
+    #
+    # @param id [Integer] (required)
+    #        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 [RemoveSubaccountResponse] successful response
+    # @raise [RemoveSubaccountError] if the request fails
+    api_method def self.remove_subaccount(id:, subaccount: nil, share: nil)
+      use_connection do |connection|
+        connection.post(
+          "/split/#{id}/subaccount/remove",
+          { subaccount:, share: }.compact,
+        )
+      end
+    end
+  end
+end

data/lib/paystack_gateway/storefront.rb

@@ -0,0 +1,329 @@
+# frozen_string_literal: true
+
+module PaystackGateway
+  # https://paystack.com/docs/api/storefront
+  #
+  # Storefronts
+  # A collection of endpoints for creating and managing storefronts
+  module Storefront
+    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/storefront/#list
+    # List Storefronts: GET /storefront
+    # List the storefronts you previously created
+    #
+    # @param per_page [Integer]
+    #        Number of records to fetch per request
+    # @param page [Integer]
+    #        The offset to retrieve data from
+    # @param status ["active", "inactive"]
+    #
+    # @return [ListResponse] successful response
+    # @raise [ListError] if the request fails
+    api_method def self.list(per_page: nil, page: nil, status: nil)
+      use_connection do |connection|
+        connection.get(
+          '/storefront',
+          { perPage: per_page, page:, status: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #create.
+    class CreateResponse < PaystackGateway::Response
+      delegate :social_media,
+               :contacts,
+               :name,
+               :slug,
+               :currency,
+               :welcome_message,
+               :success_message,
+               :redirect_url,
+               :description,
+               :delivery_note,
+               :background_color,
+               :shippable,
+               :integration,
+               :domain,
+               :digital_product_expiry,
+               :id,
+               :createdAt,
+               :updatedAt,
+               :products,
+               :shipping_fees, to: :data
+    end
+
+    # Error response from #create.
+    class CreateError < ApiError; end
+
+    # https://paystack.com/docs/api/storefront/#create
+    # Create Storefront: POST /storefront
+    # Create a digital shop to manage and display your products
+    #
+    # @param name [String] (required)
+    #        Name of the storefront
+    # @param slug [String] (required)
+    #        A unique identifier to access your store. Once the storefront is created, it can
+    #        be accessed from https://paystack.shop/your-slug
+    # @param currency ["GHS", "KES", "NGN", "USD", "ZAR"] (required)
+    #        Currency for prices of products in your storefront.
+    # @param description [String]
+    #        The description of the storefront
+    #
+    # @return [CreateResponse] successful response
+    # @raise [CreateError] if the request fails
+    api_method def self.create(name:, slug:, currency:, description: nil)
+      use_connection do |connection|
+        connection.post(
+          '/storefront',
+          { name:, slug:, currency:, description: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #fetch.
+    class FetchResponse < PaystackGateway::Response
+      delegate :social_media,
+               :contacts,
+               :name,
+               :slug,
+               :currency,
+               :welcome_message,
+               :success_message,
+               :redirect_url,
+               :description,
+               :delivery_note,
+               :background_color,
+               :shippable,
+               :integration,
+               :domain,
+               :digital_product_expiry,
+               :id,
+               :createdAt,
+               :updatedAt,
+               :products,
+               :shipping_fees, to: :data
+    end
+
+    # Error response from #fetch.
+    class FetchError < ApiError; end
+
+    # https://paystack.com/docs/api/storefront/#fetch
+    # Fetch Storefront: GET /storefront/{id}
+    # Get the details of a previously created Storefront
+    #
+    # @param id [Integer] (required)
+    #        The unique identifier of the Storefront
+    #
+    # @return [FetchResponse] successful response
+    # @raise [FetchError] if the request fails
+    api_method def self.fetch(id:)
+      use_connection do |connection|
+        connection.get(
+          "/storefront/#{id}",
+        )
+      end
+    end
+
+    # Successful response from calling #update.
+    class UpdateResponse < PaystackGateway::Response; end
+
+    # Error response from #update.
+    class UpdateError < ApiError; end
+
+    # https://paystack.com/docs/api/storefront/#update
+    # Update Storefront: PUT /storefront/{id}
+    # Update the details of a previously created Storefront
+    #
+    # @param id [Integer] (required)
+    #        The unique identifier of the Storefront
+    # @param name [String]
+    #        Name of the storefront
+    # @param slug [String]
+    #        A unique identifier to access your store. Once the storefront is created, it can
+    #        be accessed from https://paystack.shop/your-slug
+    # @param description [String]
+    #        The description of the storefront
+    #
+    # @return [UpdateResponse] successful response
+    # @raise [UpdateError] if the request fails
+    api_method def self.update(id:, name: nil, slug: nil, description: nil)
+      use_connection do |connection|
+        connection.put(
+          "/storefront/#{id}",
+          { name:, slug:, description: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #delete.
+    class DeleteResponse < PaystackGateway::Response; end
+
+    # Error response from #delete.
+    class DeleteError < ApiError; end
+
+    # https://paystack.com/docs/api/storefront/#delete
+    # Delete Storefront: DELETE /storefront/{id}
+    # Delete a previously created Storefront
+    #
+    # @param id [Integer] (required)
+    #        The unique identifier of the Storefront
+    #
+    # @return [DeleteResponse] successful response
+    # @raise [DeleteError] if the request fails
+    api_method def self.delete(id:)
+      use_connection do |connection|
+        connection.delete(
+          "/storefront/#{id}",
+        )
+      end
+    end
+
+    # Successful response from calling #verify_slug.
+    class VerifySlugResponse < PaystackGateway::Response; end
+
+    # Error response from #verify_slug.
+    class VerifySlugError < ApiError; end
+
+    # https://paystack.com/docs/api/storefront/#verify_slug
+    # Verify Storefront Slug: GET /storefront/verify/{slug}
+    # Verify the availability of a slug before using it for your Storefront
+    #
+    # @param slug [String] (required)
+    #        The custom slug to check
+    #
+    # @return [VerifySlugResponse] successful response
+    # @raise [VerifySlugError] if the request fails
+    api_method def self.verify_slug(slug:)
+      use_connection do |connection|
+        connection.get(
+          "/storefront/verify/#{slug}",
+        )
+      end
+    end
+
+    # Successful response from calling #fetch_orders.
+    class FetchOrdersResponse < PaystackGateway::Response; end
+
+    # Error response from #fetch_orders.
+    class FetchOrdersError < ApiError; end
+
+    # https://paystack.com/docs/api/storefront/#fetch_orders
+    # Fetch Storefront Orders: GET /storefront/{id}/order
+    # Fetch all orders in your Storefront
+    #
+    # @param id [Integer] (required)
+    #        The unique identifier of the Storefront
+    #
+    # @return [FetchOrdersResponse] successful response
+    # @raise [FetchOrdersError] if the request fails
+    api_method def self.fetch_orders(id:)
+      use_connection do |connection|
+        connection.get(
+          "/storefront/#{id}/order",
+        )
+      end
+    end
+
+    # Successful response from calling #list_products.
+    class ListProductsResponse < PaystackGateway::Response; end
+
+    # Error response from #list_products.
+    class ListProductsError < ApiError; end
+
+    # https://paystack.com/docs/api/storefront/#list_products
+    # List Storefront Products: GET /storefront/{id}/product
+    # List the products in a Storefront
+    #
+    # @param id [Integer] (required)
+    #        The unique identifier of the Storefront
+    #
+    # @return [ListProductsResponse] successful response
+    # @raise [ListProductsError] if the request fails
+    api_method def self.list_products(id:)
+      use_connection do |connection|
+        connection.get(
+          "/storefront/#{id}/product",
+        )
+      end
+    end
+
+    # Successful response from calling #add_products.
+    class AddProductsResponse < PaystackGateway::Response; end
+
+    # Error response from #add_products.
+    class AddProductsError < ApiError; end
+
+    # https://paystack.com/docs/api/storefront/#add_products
+    # Add Products to Storefront: POST /storefront/{id}/product
+    # Add previously created products to a Storefront
+    #
+    # @param id [Integer] (required)
+    #        The unique identifier of the Storefront
+    # @param products [Array<Integer>] (required)
+    #        An array of product IDs
+    #
+    # @return [AddProductsResponse] successful response
+    # @raise [AddProductsError] if the request fails
+    api_method def self.add_products(id:, products:)
+      use_connection do |connection|
+        connection.post(
+          "/storefront/#{id}/product",
+          { products: }.compact,
+        )
+      end
+    end
+
+    # Successful response from calling #publish.
+    class PublishResponse < PaystackGateway::Response; end
+
+    # Error response from #publish.
+    class PublishError < ApiError; end
+
+    # https://paystack.com/docs/api/storefront/#publish
+    # Publish Storefront: POST /storefront/{id}/publish
+    # Make your Storefront publicly available
+    #
+    # @param id [Integer] (required)
+    #        The unique identifier of the Storefront
+    #
+    # @return [PublishResponse] successful response
+    # @raise [PublishError] if the request fails
+    api_method def self.publish(id:)
+      use_connection do |connection|
+        connection.post(
+          "/storefront/#{id}/publish",
+        )
+      end
+    end
+
+    # Successful response from calling #duplicate.
+    class DuplicateResponse < PaystackGateway::Response; end
+
+    # Error response from #duplicate.
+    class DuplicateError < ApiError; end
+
+    # https://paystack.com/docs/api/storefront/#duplicate
+    # Duplicate Storefront: POST /storefront/{id}/duplicate
+    # Duplicate a previously created Storefront
+    #
+    # @param id [Integer] (required)
+    #        The unique identifier of the Storefront
+    #
+    # @return [DuplicateResponse] successful response
+    # @raise [DuplicateError] if the request fails
+    api_method def self.duplicate(id:)
+      use_connection do |connection|
+        connection.post(
+          "/storefront/#{id}/duplicate",
+        )
+      end
+    end
+  end
+end