paystack-ruby 1.0.0

data/docs/transfer.md

@@ -0,0 +1,183 @@
+# Transfer
+
+A collection of endpoints for automating sending money to beneficiaries
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `bulk` | `POST` | `/transfer/bulk` | Initiate Bulk Transfer |
+| `disable_otp` | `POST` | `/transfer/disable_otp` | Disable OTP for Transfers |
+| `disable_otp_finalize` | `POST` | `/transfer/disable_otp_finalize` | Finalize Disabling OTP for Transfers |
+| `enable_otp` | `POST` | `/transfer/enable_otp` | Enable OTP requirement for Transfers |
+| `export_transfer` | `GET` | `/transfer/export` | Export Transfers |
+| `fetch` | `GET` | `/transfer/{code}` | Fetch Transfer |
+| `finalize` | `POST` | `/transfer/finalize_transfer` | Finalize Transfer |
+| `initiate` | `POST` | `/transfer` | Initiate Transfer |
+| `list` | `GET` | `/transfer` | List Transfers |
+| `resend_otp` | `POST` | `/transfer/resend_otp` | Resend OTP for Transfer |
+| `verify` | `GET` | `/transfer/verify/{reference}` | Verify Transfer |
+
+---
+
+## `bulk`
+
+**HTTP:** `POST`  
+**Path:** `/transfer/bulk`
+
+```ruby
+paystack.transfer.bulk({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `source` | true |
+| `currency` | false |
+| `transfers` | true |
+
+## `disable_otp`
+
+**HTTP:** `POST`  
+**Path:** `/transfer/disable_otp`
+
+```ruby
+paystack.transfer.disable_otp
+```
+
+## `disable_otp_finalize`
+
+**HTTP:** `POST`  
+**Path:** `/transfer/disable_otp_finalize`
+
+```ruby
+paystack.transfer.disable_otp_finalize({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `otp` | true |
+
+## `enable_otp`
+
+**HTTP:** `POST`  
+**Path:** `/transfer/enable_otp`
+
+```ruby
+paystack.transfer.enable_otp
+```
+
+## `export_transfer`
+
+**HTTP:** `GET`  
+**Path:** `/transfer/export`
+
+```ruby
+paystack.transfer.export_transfer({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `recipient` | false |
+| `status` | false |
+| `from` | false |
+| `to` | false |
+
+## `fetch`
+
+**HTTP:** `GET`  
+**Path:** `/transfer/{code}`
+
+```ruby
+paystack.transfer.fetch(code)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+## `finalize`
+
+**HTTP:** `POST`  
+**Path:** `/transfer/finalize_transfer`
+
+```ruby
+paystack.transfer.finalize({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `transfer_code` | true |
+| `otp` | true |
+
+## `initiate`
+
+**HTTP:** `POST`  
+**Path:** `/transfer`
+
+```ruby
+paystack.transfer.initiate({ ... })
+```
+
+## `list`
+
+**HTTP:** `GET`  
+**Path:** `/transfer`
+
+```ruby
+paystack.transfer.list({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `use_cursor` | false |
+| `next` | false |
+| `previous` | false |
+| `per_page` | false |
+| `page` | false |
+| `from` | false |
+| `to` | false |
+| `recipient` | false |
+| `status` | false |
+
+## `resend_otp`
+
+**HTTP:** `POST`  
+**Path:** `/transfer/resend_otp`
+
+```ruby
+paystack.transfer.resend_otp({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `transfer_code` | true |
+| `reason` | true |
+
+## `verify`
+
+**HTTP:** `GET`  
+**Path:** `/transfer/verify/{reference}`
+
+```ruby
+paystack.transfer.verify(reference)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `reference` | true |

data/docs/transfer_recipient.md

@@ -0,0 +1,124 @@
+# TransferRecipient
+
+A collection of endpoints for creating and managing beneficiaries that you send money to
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `transferrecipient_bulk` | `POST` | `/transferrecipient/bulk` | Bulk Create Transfer Recipient |
+| `transferrecipient_create` | `POST` | `/transferrecipient` | Create Transfer Recipient |
+| `transferrecipient_delete` | `DELETE` | `/transferrecipient/{code}` | Delete Transfer Recipient |
+| `transferrecipient_fetch` | `GET` | `/transferrecipient/{code}` | Fetch Transfer recipient |
+| `transferrecipient_list` | `GET` | `/transferrecipient` | List Transfer Recipients |
+| `transferrecipient_update` | `PUT` | `/transferrecipient/{code}` | Update Transfer Recipient |
+
+---
+
+## `transferrecipient_bulk`
+
+**HTTP:** `POST`  
+**Path:** `/transferrecipient/bulk`
+
+```ruby
+paystack.transfer_recipient.transferrecipient_bulk({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `batch` | true |
+
+## `transferrecipient_create`
+
+**HTTP:** `POST`  
+**Path:** `/transferrecipient`
+
+```ruby
+paystack.transfer_recipient.transferrecipient_create({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `type` | true |
+| `name` | true |
+| `account_number` | true |
+| `bank_code` | true |
+| `description` | false |
+| `currency` | false |
+| `authorization_code` | false |
+| `metadata` | false |
+
+## `transferrecipient_delete`
+
+**HTTP:** `DELETE`  
+**Path:** `/transferrecipient/{code}`
+
+```ruby
+paystack.transfer_recipient.transferrecipient_delete(code)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+## `transferrecipient_fetch`
+
+**HTTP:** `GET`  
+**Path:** `/transferrecipient/{code}`
+
+```ruby
+paystack.transfer_recipient.transferrecipient_fetch(code)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+## `transferrecipient_list`
+
+**HTTP:** `GET`  
+**Path:** `/transferrecipient`
+
+```ruby
+paystack.transfer_recipient.transferrecipient_list({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `use_cursor` | false |
+| `next` | false |
+| `previous` | false |
+| `per_page` | false |
+| `page` | false |
+
+## `transferrecipient_update`
+
+**HTTP:** `PUT`  
+**Path:** `/transferrecipient/{code}`
+
+```ruby
+paystack.transfer_recipient.transferrecipient_update(code, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `name` | false |
+| `email` | false |

data/docs/virtual_terminal.md

@@ -0,0 +1,188 @@
+# VirtualTerminal
+
+A collection of endpoints for building in-person payments without a physical terminal
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `add_split_code` | `PUT` | `/virtual_terminal/{code}/split_code` | Add Split Code to Virtual Terminal |
+| `create` | `POST` | `/virtual_terminal` | Create Virtual Terminal |
+| `deactivate` | `PUT` | `/virtual_terminal/{code}/deactivate` | Deactivate Virtual Terminal |
+| `delete_split_code` | `DELETE` | `/virtual_terminal/{code}/split_code` | Remove Split Code from Virtual Terminal |
+| `destination_assign` | `POST` | `/virtual_terminal/{code}/destination/assign` | Assign Destination to Virtual Terminal |
+| `destination_unassign` | `POST` | `/virtual_terminal/{code}/destination/unassign` | Unassign Destination from Virtual Terminal |
+| `fetch` | `GET` | `/virtual_terminal/{code}` | Fetch Virtual Terminal |
+| `list` | `GET` | `/virtual_terminal` | List Virtual Terminals |
+| `update` | `PUT` | `/virtual_terminal/{code}` | Update Virtual Terminal |
+
+---
+
+## `add_split_code`
+
+**HTTP:** `PUT`  
+**Path:** `/virtual_terminal/{code}/split_code`
+
+```ruby
+paystack.virtual_terminal.add_split_code(code, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `split_code` | true |
+
+## `create`
+
+**HTTP:** `POST`  
+**Path:** `/virtual_terminal`
+
+```ruby
+paystack.virtual_terminal.create({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `name` | true |
+| `destinations` | true |
+| `split_code` | false |
+| `metadata` | false |
+
+## `deactivate`
+
+**HTTP:** `PUT`  
+**Path:** `/virtual_terminal/{code}/deactivate`
+
+```ruby
+paystack.virtual_terminal.deactivate(code)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+## `delete_split_code`
+
+**HTTP:** `DELETE`  
+**Path:** `/virtual_terminal/{code}/split_code`
+
+```ruby
+paystack.virtual_terminal.delete_split_code(code, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `split_code` | true |
+
+## `destination_assign`
+
+**HTTP:** `POST`  
+**Path:** `/virtual_terminal/{code}/destination/assign`
+
+```ruby
+paystack.virtual_terminal.destination_assign(code, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `destinations` | true |
+
+## `destination_unassign`
+
+**HTTP:** `POST`  
+**Path:** `/virtual_terminal/{code}/destination/unassign`
+
+```ruby
+paystack.virtual_terminal.destination_unassign(code, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `targets` | true |
+
+## `fetch`
+
+**HTTP:** `GET`  
+**Path:** `/virtual_terminal/{code}`
+
+```ruby
+paystack.virtual_terminal.fetch(code)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+## `list`
+
+**HTTP:** `GET`  
+**Path:** `/virtual_terminal`
+
+```ruby
+paystack.virtual_terminal.list({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `perPage` | false |
+| `page` | false |
+
+## `update`
+
+**HTTP:** `PUT`  
+**Path:** `/virtual_terminal/{code}`
+
+```ruby
+paystack.virtual_terminal.update(code, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `name` | true |

data/lib/paystack/base_resource.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+# Autogenerated — do not edit manually
+
+module Paystack
+  class BaseResource
+    # Override .new so generated subclasses can expose #initialize as an API method.
+    def self.new(transport)
+      instance = allocate
+      instance.instance_variable_set(:@transport, transport)
+      instance
+    end
+  end
+end

data/lib/paystack/client.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+# Autogenerated — do not edit manually
+
+module Paystack
+  class Client
+    def initialize(api_key)
+      @transport = Transport.new(api_key)
+    end
+
+
+    def apple_pay
+      @apple_pay ||= Resources::ApplePay.new(@transport)
+    end
+
+
+    def balance
+      @balance ||= Resources::Balance.new(@transport)
+    end
+
+
+    def bank
+      @bank ||= Resources::Bank.new(@transport)
+    end
+
+
+    def bulk_charge
+      @bulk_charge ||= Resources::BulkCharge.new(@transport)
+    end
+
+
+    def charge
+      @charge ||= Resources::Charge.new(@transport)
+    end
+
+
+    def customer
+      @customer ||= Resources::Customer.new(@transport)
+    end
+
+
+    def dedicated_virtual_account
+      @dedicated_virtual_account ||= Resources::DedicatedVirtualAccount.new(@transport)
+    end
+
+
+    def direct_debit
+      @direct_debit ||= Resources::DirectDebit.new(@transport)
+    end
+
+
+    def dispute
+      @dispute ||= Resources::Dispute.new(@transport)
+    end
+
+
+    def integration
+      @integration ||= Resources::Integration.new(@transport)
+    end
+
+
+    def miscellaneous
+      @miscellaneous ||= Resources::Miscellaneous.new(@transport)
+    end
+
+
+    def order
+      @order ||= Resources::Order.new(@transport)
+    end
+
+
+    def page
+      @page ||= Resources::Page.new(@transport)
+    end
+
+
+    def payment_request
+      @payment_request ||= Resources::PaymentRequest.new(@transport)
+    end
+
+
+    def plan
+      @plan ||= Resources::Plan.new(@transport)
+    end
+
+
+    def product
+      @product ||= Resources::Product.new(@transport)
+    end
+
+
+    def refund
+      @refund ||= Resources::Refund.new(@transport)
+    end
+
+
+    def settlement
+      @settlement ||= Resources::Settlement.new(@transport)
+    end
+
+
+    def split
+      @split ||= Resources::Split.new(@transport)
+    end
+
+
+    def storefront
+      @storefront ||= Resources::Storefront.new(@transport)
+    end
+
+
+    def subaccount
+      @subaccount ||= Resources::Subaccount.new(@transport)
+    end
+
+
+    def subscription
+      @subscription ||= Resources::Subscription.new(@transport)
+    end
+
+
+    def terminal
+      @terminal ||= Resources::Terminal.new(@transport)
+    end
+
+
+    def transaction
+      @transaction ||= Resources::Transaction.new(@transport)
+    end
+
+
+    def transfer
+      @transfer ||= Resources::Transfer.new(@transport)
+    end
+
+
+    def transfer_recipient
+      @transfer_recipient ||= Resources::TransferRecipient.new(@transport)
+    end
+
+
+    def virtual_terminal
+      @virtual_terminal ||= Resources::VirtualTerminal.new(@transport)
+    end
+
+  end
+end

data/lib/paystack/errors.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+# Autogenerated — do not edit manually
+
+module Paystack
+  class Error < StandardError
+    attr_reader :http_status, :data
+
+    def initialize(message = nil, http_status: nil, data: nil)
+      super(message)
+      @http_status = http_status
+      @data = data
+    end
+  end
+
+  AuthenticationError = Class.new(Error)
+  ValidationError = Class.new(Error)
+  NotFoundError = Class.new(Error)
+  RateLimitError = Class.new(Error)
+  ServerError = Class.new(Error)
+end

data/lib/paystack/resources/apple_pay.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+# Generated by weaver ruby-sdk generator — do not edit manually
+
+module Paystack
+  module Resources
+    class ApplePay < BaseResource
+
+      # List Domains
+      # GET /apple-pay/domain
+      def list_domain(query = {})
+        @transport.get("/apple-pay/domain", query: query)
+      end
+
+
+      # Register Domain
+      # POST /apple-pay/domain
+      def register_domain(body = {})
+        @transport.post("/apple-pay/domain", body: body)
+      end
+
+
+      # Unregister Domain
+      # DELETE /apple-pay/domain
+      def unregister_domain(body = {})
+        @transport.delete("/apple-pay/domain", body: body)
+      end
+
+
+    end
+  end
+end

data/lib/paystack/resources/balance.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+# Generated by weaver ruby-sdk generator — do not edit manually
+
+module Paystack
+  module Resources
+    class Balance < BaseResource
+
+      # Fetch Balance
+      # GET /balance
+      def fetch()
+        @transport.get("/balance")
+      end
+
+
+      # Balance Ledger
+      # GET /balance/ledger
+      def ledger(query = {})
+        @transport.get("/balance/ledger", query: query)
+      end
+
+
+    end
+  end
+end