paystack-ruby 1.0.0

data/docs/charge.md

@@ -0,0 +1,124 @@
+# Charge
+
+A collection of endpoints for configuring and managing the payment channels when initiating a payment
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `check` | `GET` | `/charge/{reference}` | Check pending charge |
+| `create` | `POST` | `/charge` | Create Charge |
+| `submit_address` | `POST` | `/charge/submit_address` | Submit Address |
+| `submit_birthday` | `POST` | `/charge/submit_birthday` | Submit Birthday |
+| `submit_otp` | `POST` | `/charge/submit_otp` | Submit OTP |
+| `submit_phone` | `POST` | `/charge/submit_phone` | Submit Phone |
+| `submit_pin` | `POST` | `/charge/submit_pin` | Submit PIN |
+
+---
+
+## `check`
+
+**HTTP:** `GET`  
+**Path:** `/charge/{reference}`
+
+```ruby
+paystack.charge.check(reference)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `reference` | true |
+
+## `create`
+
+**HTTP:** `POST`  
+**Path:** `/charge`
+
+```ruby
+paystack.charge.create({ ... })
+```
+
+## `submit_address`
+
+**HTTP:** `POST`  
+**Path:** `/charge/submit_address`
+
+```ruby
+paystack.charge.submit_address({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `address` | true |
+| `city` | true |
+| `state` | true |
+| `zip_code` | true |
+| `reference` | true |
+
+## `submit_birthday`
+
+**HTTP:** `POST`  
+**Path:** `/charge/submit_birthday`
+
+```ruby
+paystack.charge.submit_birthday({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `birthday` | true |
+| `reference` | true |
+
+## `submit_otp`
+
+**HTTP:** `POST`  
+**Path:** `/charge/submit_otp`
+
+```ruby
+paystack.charge.submit_otp({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `otp` | true |
+| `reference` | true |
+
+## `submit_phone`
+
+**HTTP:** `POST`  
+**Path:** `/charge/submit_phone`
+
+```ruby
+paystack.charge.submit_phone({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `phone` | true |
+| `reference` | true |
+
+## `submit_pin`
+
+**HTTP:** `POST`  
+**Path:** `/charge/submit_pin`
+
+```ruby
+paystack.charge.submit_pin({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `pin` | true |
+| `reference` | true |

data/docs/customer.md

@@ -0,0 +1,253 @@
+# Customer
+
+A collection of endpoints for creating and managing customers on an integration
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `create` | `POST` | `/customer` | Create Customer |
+| `deactivate_authorization` | `POST` | `/customer/authorization/deactivate` | Deactivate Authorization |
+| `direct_debit_activation_charge` | `PUT` | `/customer/{id}/directdebit-activation-charge` | Direct Debit Activation Charge |
+| `fetch` | `GET` | `/customer/{code}` | Fetch Customer |
+| `fetch_mandate_authorizations` | `GET` | `/customer/{id}/directdebit-mandate-authorizations` | Fetch Mandate Authorizations |
+| `initialize_authorization` | `POST` | `/customer/authorization/initialize` | Initialize Authorization |
+| `initialize_direct_debit` | `POST` | `/customer/{id}/initialize-direct-debit` | Initialize Direct Debit |
+| `list` | `GET` | `/customer` | List Customers |
+| `risk_action` | `POST` | `/customer/set_risk_action` | Set Risk Action |
+| `update` | `PUT` | `/customer/{code}` | Update Customer |
+| `validate` | `POST` | `/customer/{code}/identification` | Validate Customer |
+| `verify_authorization` | `GET` | `/customer/authorization/verify/{reference}` | Verify Authorization |
+
+---
+
+## `create`
+
+**HTTP:** `POST`  
+**Path:** `/customer`
+
+```ruby
+paystack.customer.create({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `email` | true |
+| `first_name` | false |
+| `last_name` | false |
+| `phone` | false |
+| `metadata` | false |
+
+## `deactivate_authorization`
+
+**HTTP:** `POST`  
+**Path:** `/customer/authorization/deactivate`
+
+```ruby
+paystack.customer.deactivate_authorization({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `authorization_code` | true |
+
+## `direct_debit_activation_charge`
+
+**HTTP:** `PUT`  
+**Path:** `/customer/{id}/directdebit-activation-charge`
+
+```ruby
+paystack.customer.direct_debit_activation_charge(id, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `authorization_id` | true |
+
+## `fetch`
+
+**HTTP:** `GET`  
+**Path:** `/customer/{code}`
+
+```ruby
+paystack.customer.fetch(code)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+## `fetch_mandate_authorizations`
+
+**HTTP:** `GET`  
+**Path:** `/customer/{id}/directdebit-mandate-authorizations`
+
+```ruby
+paystack.customer.fetch_mandate_authorizations(id)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+## `initialize_authorization`
+
+**HTTP:** `POST`  
+**Path:** `/customer/authorization/initialize`
+
+```ruby
+paystack.customer.initialize_authorization({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `email` | true |
+| `channel` | true |
+| `callback_url` | false |
+| `account` | false |
+| `address` | false |
+
+## `initialize_direct_debit`
+
+**HTTP:** `POST`  
+**Path:** `/customer/{id}/initialize-direct-debit`
+
+```ruby
+paystack.customer.initialize_direct_debit(id, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `account` | true |
+| `address` | true |
+
+## `list`
+
+**HTTP:** `GET`  
+**Path:** `/customer`
+
+```ruby
+paystack.customer.list({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `use_cursor` | false |
+| `next` | false |
+| `previous` | false |
+| `from` | false |
+| `to` | false |
+| `perPage` | false |
+| `page` | false |
+
+## `risk_action`
+
+**HTTP:** `POST`  
+**Path:** `/customer/set_risk_action`
+
+```ruby
+paystack.customer.risk_action({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `customer` | true |
+| `risk_action` | false |
+
+## `update`
+
+**HTTP:** `PUT`  
+**Path:** `/customer/{code}`
+
+```ruby
+paystack.customer.update(code, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `first_name` | false |
+| `last_name` | false |
+| `phone` | false |
+| `metadata` | false |
+
+## `validate`
+
+**HTTP:** `POST`  
+**Path:** `/customer/{code}/identification`
+
+```ruby
+paystack.customer.validate(code, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `first_name` | true |
+| `middle_name` | false |
+| `last_name` | true |
+| `type` | true |
+| `value` | false |
+| `country` | true |
+| `bvn` | true |
+| `bank_code` | true |
+| `account_number` | true |
+
+## `verify_authorization`
+
+**HTTP:** `GET`  
+**Path:** `/customer/authorization/verify/{reference}`
+
+```ruby
+paystack.customer.verify_authorization(reference)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `reference` | true |

data/docs/dedicated_virtual_account.md

@@ -0,0 +1,171 @@
+# DedicatedVirtualAccount
+
+A collection of endpoints for creating and managing payment accounts for customers
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `dedicated_account_add_split` | `POST` | `/dedicated_account/split` | Split Dedicated Account Transaction |
+| `dedicated_account_assign` | `POST` | `/dedicated_account/assign` | Assign Dedicated Account |
+| `dedicated_account_available_providers` | `GET` | `/dedicated_account/available_providers` | Fetch Bank Providers |
+| `dedicated_account_create` | `POST` | `/dedicated_account` | Create Dedicated Account |
+| `dedicated_account_deactivate` | `DELETE` | `/dedicated_account/{id}` | Deactivate Dedicated Account |
+| `dedicated_account_fetch` | `GET` | `/dedicated_account/{id}` | Fetch Dedicated Account |
+| `dedicated_account_list` | `GET` | `/dedicated_account` | List Dedicated Accounts |
+| `dedicated_account_remove_split` | `DELETE` | `/dedicated_account/split` | Remove Split from Dedicated Account |
+| `dedicated_account_requery` | `GET` | `/dedicated_account/requery` | Requery Dedicated Account |
+
+---
+
+## `dedicated_account_add_split`
+
+**HTTP:** `POST`  
+**Path:** `/dedicated_account/split`
+
+```ruby
+paystack.dedicated_virtual_account.dedicated_account_add_split({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `account_number` | true |
+| `subaccount` | false |
+| `split_code` | false |
+
+## `dedicated_account_assign`
+
+**HTTP:** `POST`  
+**Path:** `/dedicated_account/assign`
+
+```ruby
+paystack.dedicated_virtual_account.dedicated_account_assign({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `email` | true |
+| `first_name` | true |
+| `last_name` | true |
+| `phone` | true |
+| `preferred_bank` | true |
+| `country` | true |
+| `account_number` | false |
+| `bvn` | false |
+| `bank_code` | false |
+| `subaccount` | false |
+| `split_code` | false |
+
+## `dedicated_account_available_providers`
+
+**HTTP:** `GET`  
+**Path:** `/dedicated_account/available_providers`
+
+```ruby
+paystack.dedicated_virtual_account.dedicated_account_available_providers
+```
+
+## `dedicated_account_create`
+
+**HTTP:** `POST`  
+**Path:** `/dedicated_account`
+
+```ruby
+paystack.dedicated_virtual_account.dedicated_account_create({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `customer` | true |
+| `preferred_bank` | false |
+| `subaccount` | false |
+| `split_code` | false |
+
+## `dedicated_account_deactivate`
+
+**HTTP:** `DELETE`  
+**Path:** `/dedicated_account/{id}`
+
+```ruby
+paystack.dedicated_virtual_account.dedicated_account_deactivate(id)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+## `dedicated_account_fetch`
+
+**HTTP:** `GET`  
+**Path:** `/dedicated_account/{id}`
+
+```ruby
+paystack.dedicated_virtual_account.dedicated_account_fetch(id)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+## `dedicated_account_list`
+
+**HTTP:** `GET`  
+**Path:** `/dedicated_account`
+
+```ruby
+paystack.dedicated_virtual_account.dedicated_account_list({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `active` | false |
+| `customer` | false |
+| `currency` | false |
+| `provider_slug` | false |
+| `bank_id` | false |
+| `perPage` | false |
+| `page` | false |
+
+## `dedicated_account_remove_split`
+
+**HTTP:** `DELETE`  
+**Path:** `/dedicated_account/split`
+
+```ruby
+paystack.dedicated_virtual_account.dedicated_account_remove_split({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `account_number` | true |
+
+## `dedicated_account_requery`
+
+**HTTP:** `GET`  
+**Path:** `/dedicated_account/requery`
+
+```ruby
+paystack.dedicated_virtual_account.dedicated_account_requery({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `account_number` | false |
+| `provider_slug` | false |
+| `date` | false |

data/docs/direct_debit.md

@@ -0,0 +1,44 @@
+# DirectDebit
+
+A collection of endpoints for managing Direct Debit
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `directdebit_list_mandate_authorizations` | `GET` | `/directdebit/mandate-authorizations` | List Mandate Authorizations |
+| `directdebit_trigger_activation_charge` | `PUT` | `/directdebit/activation-charge` | Trigger Activation Charge |
+
+---
+
+## `directdebit_list_mandate_authorizations`
+
+**HTTP:** `GET`  
+**Path:** `/directdebit/mandate-authorizations`
+
+```ruby
+paystack.direct_debit.directdebit_list_mandate_authorizations({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `cursor` | false |
+| `status` | false |
+| `per_page` | false |
+
+## `directdebit_trigger_activation_charge`
+
+**HTTP:** `PUT`  
+**Path:** `/directdebit/activation-charge`
+
+```ruby
+paystack.direct_debit.directdebit_trigger_activation_charge({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `customer_ids` | true |