paystack-ruby 1.0.0

data/docs/dispute.md

@@ -0,0 +1,175 @@
+# Dispute
+
+A collection of endpoints for managing transactions complaint made by customers
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `download` | `GET` | `/dispute/export` | Export Disputes |
+| `evidence` | `POST` | `/dispute/{id}/evidence` | Add Evidence |
+| `fetch` | `GET` | `/dispute/{id}` | Fetch Dispute |
+| `list` | `GET` | `/dispute` | List Disputes |
+| `resolve` | `PUT` | `/dispute/{id}/resolve` | Resolve Dispute |
+| `transaction` | `GET` | `/dispute/transaction/{id}` | List Transaction Disputes |
+| `update` | `PUT` | `/dispute/{id}` | Update Dispute |
+| `upload_url` | `GET` | `/dispute/{id}/upload_url` | Fetch Upload URL |
+
+---
+
+## `download`
+
+**HTTP:** `GET`  
+**Path:** `/dispute/export`
+
+```ruby
+paystack.dispute.download({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `perPage` | false |
+| `page` | false |
+| `status` | false |
+| `from` | false |
+| `to` | false |
+
+## `evidence`
+
+**HTTP:** `POST`  
+**Path:** `/dispute/{id}/evidence`
+
+```ruby
+paystack.dispute.evidence(id, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `customer_email` | true |
+| `customer_name` | true |
+| `customer_phone` | true |
+| `service_details` | true |
+| `delivery_address` | false |
+| `delivery_date` | false |
+
+## `fetch`
+
+**HTTP:** `GET`  
+**Path:** `/dispute/{id}`
+
+```ruby
+paystack.dispute.fetch(id)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+## `list`
+
+**HTTP:** `GET`  
+**Path:** `/dispute`
+
+```ruby
+paystack.dispute.list({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `perPage` | false |
+| `page` | false |
+| `status` | false |
+| `transaction` | false |
+| `from` | false |
+| `to` | false |
+
+## `resolve`
+
+**HTTP:** `PUT`  
+**Path:** `/dispute/{id}/resolve`
+
+```ruby
+paystack.dispute.resolve(id, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `resolution` | true |
+| `message` | true |
+| `refund_amount` | true |
+| `uploaded_filename` | true |
+| `evidence` | false |
+
+## `transaction`
+
+**HTTP:** `GET`  
+**Path:** `/dispute/transaction/{id}`
+
+```ruby
+paystack.dispute.transaction(id)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+## `update`
+
+**HTTP:** `PUT`  
+**Path:** `/dispute/{id}`
+
+```ruby
+paystack.dispute.update(id, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `refund_amount` | true |
+| `uploaded_filename` | false |
+
+## `upload_url`
+
+**HTTP:** `GET`  
+**Path:** `/dispute/{id}/upload_url`
+
+```ruby
+paystack.dispute.upload_url(id)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |

data/docs/integration.md

@@ -0,0 +1,36 @@
+# Integration
+
+A collection of endpoints for managing some settings on an integration
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `fetch_payment_session_timeout` | `GET` | `/integration/payment_session_timeout` | Fetch Payment Session Timeout |
+| `update_payment_session_timeout` | `PUT` | `/integration/payment_session_timeout` | Update Payment Session Timeout |
+
+---
+
+## `fetch_payment_session_timeout`
+
+**HTTP:** `GET`  
+**Path:** `/integration/payment_session_timeout`
+
+```ruby
+paystack.integration.fetch_payment_session_timeout
+```
+
+## `update_payment_session_timeout`
+
+**HTTP:** `PUT`  
+**Path:** `/integration/payment_session_timeout`
+
+```ruby
+paystack.integration.update_payment_session_timeout({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `timeout` | true |

data/docs/miscellaneous.md

@@ -0,0 +1,52 @@
+# Miscellaneous
+
+A collection of endpoints that provides utility functions
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `avs` | `GET` | `/address_verification/states` | List States (AVS) |
+| `list_countries` | `GET` | `/country` | List Countries |
+| `resolve_card_bin` | `GET` | `/decision/bin/{bin}` | Resolve Card BIN |
+
+---
+
+## `avs`
+
+**HTTP:** `GET`  
+**Path:** `/address_verification/states`
+
+```ruby
+paystack.miscellaneous.avs({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `country` | false |
+
+## `list_countries`
+
+**HTTP:** `GET`  
+**Path:** `/country`
+
+```ruby
+paystack.miscellaneous.list_countries
+```
+
+## `resolve_card_bin`
+
+**HTTP:** `GET`  
+**Path:** `/decision/bin/{bin}`
+
+```ruby
+paystack.miscellaneous.resolve_card_bin(bin)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `bin` | true |

data/docs/order.md

@@ -0,0 +1,101 @@
+# Order
+
+A collection of endpoints for creating and managing orders
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `create` | `POST` | `/order` | Create Order |
+| `fetch` | `GET` | `/order/{id}` | Fetch Order |
+| `list` | `GET` | `/order` | List Orders |
+| `product` | `GET` | `/order/product/{id}` | Fetch Product Orders |
+| `validate` | `GET` | `/order/{code}/validate` | Validate Order |
+
+---
+
+## `create`
+
+**HTTP:** `POST`  
+**Path:** `/order`
+
+```ruby
+paystack.order.create({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `email` | true |
+| `first_name` | true |
+| `last_name` | true |
+| `phone` | true |
+| `currency` | true |
+| `items` | true |
+| `shipping` | true |
+| `is_gift` | false |
+| `pay_for_me` | false |
+
+## `fetch`
+
+**HTTP:** `GET`  
+**Path:** `/order/{id}`
+
+```ruby
+paystack.order.fetch(id)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+## `list`
+
+**HTTP:** `GET`  
+**Path:** `/order`
+
+```ruby
+paystack.order.list({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `perPage` | false |
+| `page` | false |
+| `from` | false |
+| `to` | false |
+
+## `product`
+
+**HTTP:** `GET`  
+**Path:** `/order/product/{id}`
+
+```ruby
+paystack.order.product(id)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+## `validate`
+
+**HTTP:** `GET`  
+**Path:** `/order/{code}/validate`
+
+```ruby
+paystack.order.validate(code)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `code` | true |

data/docs/page.md

@@ -0,0 +1,138 @@
+# Page
+
+A collection of endpoints for creating and managing links for the collection of payment for products
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `add_products` | `POST` | `/page/{id}/product` | Add Products |
+| `check_slug_availability` | `GET` | `/page/check_slug_availability/{slug}` | Check Slug Availability |
+| `create` | `POST` | `/page` | Create Page |
+| `fetch` | `GET` | `/page/{id}` | Fetch Page |
+| `list` | `GET` | `/page` | List Pages |
+| `update` | `PUT` | `/page/{id}` | Update Page |
+
+---
+
+## `add_products`
+
+**HTTP:** `POST`  
+**Path:** `/page/{id}/product`
+
+```ruby
+paystack.page.add_products(id, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `products` | true |
+
+## `check_slug_availability`
+
+**HTTP:** `GET`  
+**Path:** `/page/check_slug_availability/{slug}`
+
+```ruby
+paystack.page.check_slug_availability(slug)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `slug` | true |
+
+## `create`
+
+**HTTP:** `POST`  
+**Path:** `/page`
+
+```ruby
+paystack.page.create({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `name` | true |
+| `description` | false |
+| `amount` | false |
+| `currency` | false |
+| `slug` | false |
+| `type` | false |
+| `plan` | false |
+| `fixed_amount` | false |
+| `split_code` | false |
+| `metadata` | false |
+| `redirect_url` | false |
+| `success_message` | false |
+| `notification_email` | false |
+| `collect_phone` | false |
+| `custom_fields` | false |
+
+## `fetch`
+
+**HTTP:** `GET`  
+**Path:** `/page/{id}`
+
+```ruby
+paystack.page.fetch(id)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+## `list`
+
+**HTTP:** `GET`  
+**Path:** `/page`
+
+```ruby
+paystack.page.list({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `perPage` | false |
+| `page` | false |
+| `from` | false |
+| `to` | false |
+
+## `update`
+
+**HTTP:** `PUT`  
+**Path:** `/page/{id}`
+
+```ruby
+paystack.page.update(id, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `name` | false |
+| `description` | false |
+| `amount` | false |
+| `active` | false |

data/docs/payment_request.md

@@ -0,0 +1,182 @@
+# PaymentRequest
+
+A collection of endpoints for managing invoices for the payment of goods and services
+
+## Methods
+
+| Method | HTTP | Path | Summary |
+|---|---|---|---|
+| `archive` | `POST` | `/paymentrequest/archive/{id}` | Archive Payment Request |
+| `create` | `POST` | `/paymentrequest` | Create Payment Request |
+| `fetch` | `GET` | `/paymentrequest/{id}` | Fetch Payment Request |
+| `finalize` | `POST` | `/paymentrequest/finalize/{id}` | Finalize Payment Request |
+| `list` | `GET` | `/paymentrequest` | List Payment Request |
+| `notify` | `POST` | `/paymentrequest/notify/{id}` | Send Notification |
+| `totals` | `GET` | `/paymentrequest/totals` | Payment Request Total |
+| `update` | `PUT` | `/paymentrequest/{id}` | Update Payment Request |
+| `verify` | `GET` | `/paymentrequest/verify/{id}` | Verify Payment Request |
+
+---
+
+## `archive`
+
+**HTTP:** `POST`  
+**Path:** `/paymentrequest/archive/{id}`
+
+```ruby
+paystack.payment_request.archive(id)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+## `create`
+
+**HTTP:** `POST`  
+**Path:** `/paymentrequest`
+
+```ruby
+paystack.payment_request.create({ ... })
+```
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `customer` | true |
+| `amount` | true |
+| `currency` | false |
+| `due_date` | false |
+| `description` | false |
+| `line_items` | false |
+| `tax` | false |
+| `send_notification` | false |
+| `draft` | false |
+| `has_invoice` | false |
+| `invoice_number` | false |
+| `split_code` | false |
+
+## `fetch`
+
+**HTTP:** `GET`  
+**Path:** `/paymentrequest/{id}`
+
+```ruby
+paystack.payment_request.fetch(id)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+## `finalize`
+
+**HTTP:** `POST`  
+**Path:** `/paymentrequest/finalize/{id}`
+
+```ruby
+paystack.payment_request.finalize(id)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+## `list`
+
+**HTTP:** `GET`  
+**Path:** `/paymentrequest`
+
+```ruby
+paystack.payment_request.list({ ... })
+```
+
+### Query Fields
+
+| Name | Required |
+|---|---|
+| `perPage` | false |
+| `page` | false |
+| `customer` | false |
+| `status` | false |
+| `currency` | false |
+| `from` | false |
+| `to` | false |
+
+## `notify`
+
+**HTTP:** `POST`  
+**Path:** `/paymentrequest/notify/{id}`
+
+```ruby
+paystack.payment_request.notify(id)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+## `totals`
+
+**HTTP:** `GET`  
+**Path:** `/paymentrequest/totals`
+
+```ruby
+paystack.payment_request.totals
+```
+
+## `update`
+
+**HTTP:** `PUT`  
+**Path:** `/paymentrequest/{id}`
+
+```ruby
+paystack.payment_request.update(id, { ... })
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |
+
+### Body Fields
+
+| Name | Required |
+|---|---|
+| `customer` | false |
+| `amount` | false |
+| `currency` | false |
+| `due_date` | false |
+| `description` | false |
+| `line_items` | false |
+| `tax` | false |
+| `send_notification` | false |
+| `draft` | false |
+| `has_invoice` | false |
+| `invoice_number` | false |
+| `split_code` | false |
+
+## `verify`
+
+**HTTP:** `GET`  
+**Path:** `/paymentrequest/verify/{id}`
+
+```ruby
+paystack.payment_request.verify(id)
+```
+
+### Path Parameters
+
+| Name | Required |
+|---|---|
+| `id` | true |