Merge pull request #90 from emperorsixpacks/main1

Main1

Author: andela-sjames

docs/bulk_charge.md

@@ -55,7 +55,7 @@ response = BulkCharge.fetch_bulk_batch(
 ```
 
 *Arguments*
-- `id_or_code`: An ID or code for the transfer whose details you want to retrieve.
+- `id_or_code`: An ID or code for the transfer whose details you want to retrieve details.
 
 *Returns*
 

docs/charge.md

@@ -1,6 +1,6 @@
 Charge
 --------------------
-#### `Charge.start_charge(**kwargs)` - Start a Charge
+#### `Charge.start_charge(**kwargs)` - Start a charge
 
 *Usage*
 
@@ -37,7 +37,7 @@ response = Charge.start_charge(
 
 JSON data from Paystack API.
 
-#### `Charge.submit_pin(**kwargs)` - Submit PIN to continue a charge.
+#### `Charge.submit_pin(**kwargs)` - Submit PIN to continue the charge.
 
 *Usage*
 
@@ -59,7 +59,7 @@ response = Charge.submit_pin(
 JSON data from Paystack API.
 
 
-#### `Charge.submit_otp(**kwargs)` - Submit OTP to complete a charge.
+#### `Charge.submit_otp(**kwargs)` - Submit OTP to complete the charge.
 
 *Usage*
 
@@ -81,7 +81,7 @@ response = Charge.submit_otp(
 JSON data from Paystack API.
 
 
-#### `Charge.submit_phone(**kwargs)` - Submit Phone when requested.
+#### `Charge.submit_phone(**kwargs)` - Submit phone when requested.
 
 *Usage*
 
@@ -101,7 +101,7 @@ response = Charge.submit_phone(
 
 JSON data from Paystack API.
 
-#### `Charge.submit_birthday(**kwargs)` - Submit Birthday when requested.
+#### `Charge.submit_birthday(**kwargs)` - Submit birthday when requested.
 
 *Usage*
 

docs/customers.md

@@ -35,7 +35,7 @@ response = Customer.get(customer_id=24)
 
 JSON data from paystack API.
 
-##### `Customer.list(perPage=50, page=6)` - List paystack customers
+##### `Customer.list(perPage=50, page=6)` - List Paystack customers
 
 ```python
 from paystackapi.customer import Customer
@@ -45,7 +45,7 @@ response = Customer.list(perPage=50, page=6)
 *Arguments*
 
 - `perPage`: Specify how many records you want to retrieve per page.
-            If not specify we use a default value of 50. (Integer)
+            If not specified we use a default value of 50. (Integer)
 
 - `page`: Specify exactly what page you want to retrieve.
           defaults to 1 if not present(Integer)
@@ -60,7 +60,7 @@ response = Customer.list(perPage=50, page=6)
 
 JSON data from paystack API.
 
-##### `Customer.update(customer_id, first_name=None, last_name=None, email=None, phone=None)` - Update paystack customer data by id.
+##### `Customer.update(customer_id, first_name=None, last_name=None, email=None, phone=None)` - Update paystack customer data by ID.
 
 ```python
 from paystackapi.customer import Customer
@@ -70,12 +70,12 @@ response = Customer.update(customer_id=24, first_name=None,
 ```
 
 *Arguments*
-- `customer_id`: paystack customer id.
+- `customer_id`: paystack customer ID.
 - `first_name`: customer's first name(optional).
 - `last_name`: customer's last name(optional).
 - `email`: customer's email address(optional).
 - `phone`: customer's phone number(optional).
 
 *Returns*
 
-JSON data from paystack API.
+JSON data from the Paystack API.

docs/invoices.md

@@ -64,7 +64,7 @@ response = Invoice.view(
 ```
 
 *Arguments*
-- `invoice_id_or_code`: invoice ID or Code (string)
+- `invoice_id_or_code`: invoice ID or code (string)
 
 *Returns*
 

docs/payment_page.md

@@ -52,7 +52,7 @@ response = Page.fetch(id_or_slug="5nApBwZkvY")
 
 JSON data from Paystack API.
 
-#### `Page.update(id_or_slug)` - Update a Page by id_or_slug
+#### `Page.update(id_or_slug)` - Update a Page by ID or slug
 
 *Usage*
 
@@ -62,14 +62,14 @@ response = Page.update(id_or_slug="5nApBwZkvY", **kwargs)
 ```
 
 *Arguments*
-- `id_or_slug`: id or slug
+- `id_or_slug`: ID or slug
 - `**kwargs`
 
 *Returns*
 
 JSON data from Paystack API.
 
-#### `Page.is_slug_available(id_or_slug)` - Check Slug Availability
+#### `Page.is_slug_available(id_or_slug)` - Check Slug availability
 
 *Usage*
 
@@ -79,7 +79,7 @@ response = Page.is_slug_available(slug="new_or_existing_slug")
 ```
 
 *Arguments*
-- `slug`: URL slug to be confirmed
+- `slug`: URL slug to be checked
 
 *Returns*
 
@@ -99,8 +99,8 @@ response = Page.add_products(
 
 *Arguments*
 
-- `payment_page_id`: Id of the payment page (Integer)
-- `product`: Ids of all the products i.e. [473, 292]
+- `payment_page_id`: ID of the payment page (Integer)
+- `product`: IDs of all the products i.e. [473, 292]
 
 *Returns*
 

docs/plans.md

@@ -7,25 +7,25 @@ from paystackapi.plan import Plan
 response = Plan.create(name='value', description='value',
                        amount=amount, interval='value',
                        send_invoices='value',
-                       send_sms='value',
-                       hosted_page='value',
-                       hosted_page_url='value',
-                       hosted_page_summary='value',
-                       currency='value')
+                       send_sms=True,
+                       hosted_page=False,
+                       hosted_page_url=None,
+                       hosted_page_summary=None,
+                       currency='NGN')
 ```
 
 *Arguments*
 
-- `name`: plan's name.
-- `description`: description of the plan.
-- `amount`: amount for the plan in kobo
-- `interval`: plan's interval(daily...etc)
-- `send_invoices`: boolean
-- `send_sms`: (optional)
-- `hosted_page`: (optional)
+- `name`: plan name.
+- `description`: plan description.
+- `amount`: plan amount in kobo.
+- `interval`: plan interval (daily...etc)
+- `send_invoices`: Boolean
+- `send_sms`: Boolean (optional) 
+- `hosted_page`: Boolean (optional)
 - `hosted_page_url`: url of hosted page (optional)
 - `hosted_page_summary`: summary of the hosted page
-- `currency`: plans currency (NGN)
+- `currency`: plan currency (NGN)
 
 *Returns*
 
@@ -67,24 +67,23 @@ JSON data from paystack API.
 from paystackapi.plan import Plan
 response = Plan.update(plan_id=23, name=None, description=None,
                        amount=None, interval=None,
-                       send_invoices=None, send_sms=None,
+                       send_invoices=None, send_sms=True,
                        hosted_page=None, hosted_page_url=None,
-                       hosted_page_summary=None, currency=None)
+                       hosted_page_summary=None, currency=NGN)
 ```
 
 *Arguments*
 
-- `plan_id`: plan identity number.
-- `name`: name of plan
-- `description`: plan description(optional)
-- `amount`: plan amount in Kobo
-- `interval`: plan interval9(monthly, yearly, quarterly...etc)
-- `send_invoice`: (optional)
-- `send_sms`: (optional)
-- `hosted_page`: (optional)
-- `hosted_page_url`: (optional)
-- `hosted_page_summary`: (optional)
-- `currency`: Naira in kobo(NGN)
+-  `name`: plan name.
+- `description`: plan description.
+- `amount`: plan amount in kobo.
+- `interval`: plan interval (daily...etc)
+- `send_invoices`: Boolean
+- `send_sms`: Boolean (optional) 
+- `hosted_page`: Boolean (optional)
+- `hosted_page_url`: url of hosted page (optional)
+- `hosted_page_summary`: summary of the hosted page
+- `currency`: plan currency (NGN)
 
 *Returns*
 

docs/product.md

@@ -1,13 +1,13 @@
 Product
 -------
-#### `Product.create(**kwargs)` - Create a Product
+#### `Product.create(**kwargs)` - Create a product
 
 *Usage*
 
 ```python
 from paystackapi.product import Product
-response = Product.create(name="Product pypaystack test",
-						  description="my test description",
+response = Product.create(name="Product PyPaystack test",
+						  description="Description of the product",
                           price=500000, currency="NGN", **kwargs)
 ```
 
@@ -16,15 +16,15 @@ response = Product.create(name="Product pypaystack test",
 - `name`: Name of the product
 - `description`: Description of product
 - `price`: Price of the product, in kobo(Integer)
-- `currency`: Currency in which amount should be charged
+- `currency`: Currency in which the amount should be charged
 - **kwargs
 
 *Returns*
 
 JSON data from Paystack API.
 
 
-#### `Product.list()` - list created Products
+#### `Product.list()` - List created products
 
 *Usage*
 
@@ -42,7 +42,7 @@ No argument required.
 JSON data from Paystack API.
 
 
-#### `Product.fetch(product_id)` - fetch created Products by id
+#### `Product.fetch(product_id)` - Fetch created Products by ID
 
 *Usage*
 
@@ -53,14 +53,14 @@ response = Product.fetch(product_id=5499)
 
 *Arguments*
 
-- `product_id`: Product id(integer).
+- `product_id`: Product ID (integer).
 
 *Returns*
 
 JSON data from Paystack API.
 
 
-#### `Product.update(product_id, **kwargs)` - update a created Product by id
+#### `Product.update(product_id, **kwargs)` - Update a created product by ID
 
 *Usage*
 
@@ -75,7 +75,7 @@ response = Product.update(product_id=5499, **kwargs)
 - `name`: Name of the product
 - `description`: Description of product
 - `price`: Price of the product, in kobo(Integer)
-- `currency`: Currency in which amount should be charged
+- `currency`: Currency in which the amount should be charged
 - `**kwargs`
 
 *Returns*

docs/refunds.md

@@ -1,6 +1,6 @@
 Refunds
 -------
-#### `Refund.create(**kwargs)` - This creates a refund which is then processed by the Paystack team
+#### `Refund.create(**kwargs)` - Create a refund, which is then processed by the Paystack team.
 
 ```python
 from paystackapi.refund import Refund
@@ -9,32 +9,33 @@ response = Refund.create(**kwargs)
 ```
 *Arguments*
 - `transaction`: Transaction reference or id
-- `amount`: How much in kobo to be refunded to the customer - Optional
-- `currency`: Three-letter ISO currency - Optional
-- `customer_note`: Customer reason - Optional
-- `merchant_note`: Merchant reason - Optional
+- `amount`: Amount in kobo to be refunded to the customer (optional).
+- `currency`: Three-letter ISO currency (Optional)
+- `customer_note`: Customer reason 
+(Optional)
+- `merchant_note`: Merchant reason (Optional)
 
 *Returns*
 
 JSON data from paystack API.
 
 
-#### `Refund.list(**kwargs)` - Get a list of refunds
+#### `Refund.list(**kwargs)` - Get a list of refunds.
 
 ```python
 from paystackapi.refund import Refund
 response = Refund.list(**kwargs)
 
 ```
 *Arguments*
-- `reference`: Identifier for transaction to be refunded - Optional
-- `currency`: Three-letter ISO currency - Optional
+- `reference`: Identifier for transaction to be refunded (Optional)
+- `currency`: Three-letter ISO currency - (Optional)
 
 *Returns*
 
 JSON data from paystack API.
 
-#### `Refund.fetch(refund_id)` - Get a refund by its id
+#### `Refund.fetch(refund_id)` - Get a refund by its ID
 
 ```python
 from paystackapi.refund import Refund

docs/sub_account.md

@@ -1,6 +1,6 @@
 SubAccount
 -------
-#### `SubAccount.create(**kwargs)` - Create a SubAccount
+#### `SubAccount.create(**kwargs)` - Create a subaccount
 
 *Usage*
 
@@ -38,7 +38,7 @@ response = SubAccount.list(perPage=3, page=1)
 *Arguments*
 
 - `perPage`: Records you want to retrieve per page (Integer)
-- `page`: What page you want to retrieve (Integer)
+- `page`: What page you want to retrieve? (Integer)
 - `**kwargs`
 
 *Returns*
@@ -52,12 +52,12 @@ JSON data from Paystack API.
 
 ```python
 from paystackapi.subaccount import SubAccount
-response = SubAccount.fetch(id_or_slug="some_slug_like_subaccount_code_or_id)
+response = SubAccount.fetch(id_or_slug="some_slug_like_subaccount_code_or_id")
 ```
 
 *Arguments*
 
-- `id_or_slug`: ID or Subaccount_Code
+- `id_or_slug`: ID or subaccount code
 
 *Returns*
 
@@ -71,7 +71,7 @@ JSON data from Paystack API.
 ```python
 from paystackapi.subaccount import SubAccount
 response = SubAccount.update(
-            id_or_slug="some_slug_like_subaccount_code_or_id),
+            id_or_slug="some_slug_like_subaccount_code_or_id",
             **kwargs
         )
 ```