update readme

Author: rexlow-rm

Diff for: README.md

@@ -14,11 +14,53 @@ This is an Python SDK that maps some of the RESTful methods of Open API that are
 pip3 install rmsdk
 ```
 
-### Registration and obtain credentials
+### Prerequisite
 
 Before using the SDK, users must obtain credentials from merchant portal first. Click [here](https://github.com/RevenueMonster/RM-API-SDK-Python/blob/master/docs/merchant-portal.md) for tutorial.
 
-## Usage Examples
+
+## Supported APIs
+
+* Client Credentials (Authentication)
+  * [Generate Client Credentials](#generate-client-credentials)
+  * [Generate Refresh Token](#generate-refresh-token)
+* Merchant Related APIs
+  * [Get Merchant Profile](#get-merchant-profile)
+  * [Get Merchant Subscriptions](#get-merchant-subscriptions)
+* Store
+  * [Get Store List](#get-store-list)
+  * [Get Store By ID](#get-store-by-id)
+  * [Create Store](#create-store)
+  * [Update Store](#update-store)
+  * [Delete Store](#delete-store)
+* User
+  * [Get User Profile](#get-user-profile)
+* Payment (Quickpay QR)
+  * [QuickPay](#quickpay)
+  * [Refund](#refund)
+  * [Reverse](#reverse)
+  * [Get All Transactions](#get-all-transactions)
+  * [Get Transaction By ID](#get-transaction-by-id)
+  * [Get Transaction By Order ID](#get-transaction-by-order-id)
+  * [Get Daily Settlement Report](#get-daily-settlement-report)
+* Payment (Transaction QR)
+  * [Create Transaction](#create-transaction)
+  * [Get Transaction](#get-transaction)
+  * [Get Transaction By Code](#get-transaction-by-code)
+  * [Get List of Transactions By Code](#get-list-of-transaction-by-code)
+* Loyalty
+  * [Give Loyalty Point](#give-loyalty-point)
+  * [Get Loyalty Member](#get-loyalty-member)
+  * [Get List of Loyalty Members](#get-list-of-loyalty-members)
+  * [Get Point History](#get-point-history)
+* Voucher
+  * [Issue Voucher](#issue-voucher)
+  * [Void Voucher](#void-voucher)
+  * [Get Voucher By Code](#get-voucher-by-code)
+  * [Get Voucher Batches](#get-voucher-batches)
+  * [Get Voucher Batches By Batch Key](#get-voucher-batches-by-batch-key)
+ 
+## Usage
 
 This section explains the basic usage of the SDK. Detail usage for individual modules are prepared in the [examples](https://github.com/RevenueMonster/RM-API-SDK-Python/tree/master/examples) folder.
 
@@ -27,14 +69,12 @@ A `dictionary` that contains `clientID`, `clientSecret`, `environment` and `priv
 For instance, to use the store module, simply,
 
 ```
-response = client.store.methodName(*args)
+response = client.module.methodName(*args)
 ```
 
-For full parameter, please refer [Revenue Monster Open API Documentation](doc.revenuemonster.my).
-
-
-### Authentication
+## Authentication
 
+### Authenticate SDK
 
 ```
 from rmsdk import RMSDK
@@ -49,10 +89,110 @@ client = RMSDK(configs={
 accessToken, refreshToken = client.accessToken, client.refreshToken
 ```
 
-### Payment
+### Generate Client Credentials
+
+To get refresh token and access token(expired after 2 hours) with using provided clientID and clientSecret.
+
+```
+client = Auth({
+    "environment": "sandbox", # or production
+    "clientID": "client-id",
+    "clientSecret": "client-secret",
+    "privateKey": "path-to-private-key"
+})
+
+accessToken, refreshToken = client.clientCredentials()
+```
+
+### Generate Refresh Token
+
+To get new access token(expired after 2 hours) with using provided clientId and clientSecret (recommended to schedule to run this fucntion on every less than 2 hours) in order to avoid expired access token error.
+
+```
+accessToken, refreshToken = client.getRefreshToken(refreshToken)
+```
+
+## Merchant
+
+### Get Merchant Profile
+
+```
+result = client.merchant.getMerchantProfile(accessToken)
+```
+
+### Get Merchant Subscriptions
+
+```
+result = client.merchant.getMerchantSubcriptions(accessToken)
+```
+
+## Store
+
+### Get Store List
+
+```
+result = client.store.getStores(accessToken)
+```
+
+### Get Store By ID
+
+```
+result = client.store.getStoreByID(accessToken, storeID)
+```
+
+### Create Store
 
 ```
-quickpay_payload = {
+result = client.store.createStore(accessToken, {
+    "name": "Test store",
+    "addressLine1": "Earth",
+    "addressLine2": "Mars",
+    "postCode": "10001",
+    "city": "Petaling Jaya",
+    "state": "Selangor",
+    "country": "Malaysia",
+    "countryCode": "60",
+    "phoneNumber": "377334080"
+})
+```
+
+### Update Store
+
+```
+result = client.store.updateStore(accessToken, storeID, {
+    "name": "Test store",
+    "addressLine1": "Earth",
+    "addressLine2": "Mars",
+    "postCode": "10001",
+    "city": "Petaling Jaya",
+    "state": "Selangor",
+    "country": "Malaysia",
+    "countryCode": "60",
+    "phoneNumber": "377334080"
+})
+```
+
+### Delete Store
+
+```
+result = client.store.deleteStore(accessToken, storeID)
+```
+
+## User
+
+### Get User Profile
+
+```
+result = client.user.getUserProfile(accessToken)
+```
+
+## Payment (Quickpay QR)
+
+
+### QuickPay
+
+```
+result = client.quickPay.quickPay(accessToken, {
     "authCode": "1234567890",
     "order": {
         "amount": 100,
@@ -65,45 +205,168 @@ quickpay_payload = {
     "ipAddress": "8.8.8.8",
     "terminalId": "19382734937293999",
     "storeId": "6170506694335521334"
-}
-
-response = client.quickPay.quickPay(accessToken, quickpay_payload)
-```
-
-For full examples, please visit the [examples](https://github.com/RevenueMonster/RM-API-SDK-Python/tree/master/examples) folder
-
-
-## Covered Functions
-
-- [x] Client Credentials (Authentication)
-- [x] Refresh Token (Authentication)
-- [x] Get Merchant Profile
-- [x] Get Merchant Subscriptions
-- [x] Get Stores
-- [x] Get Stores By ID
-- [x] Create Store
-- [x] Update Store
-- [x] Delete Store
-- [x] Get User Profile
-- [x] Payment (Transaction QR) - Create Transaction QRCode/URL
-- [x] Payment (Transaction QR) - Get Transaction QRCode/URL
-- [x] Payment (Transaction QR) - Get Transaction QRCode/URL By Code
-- [x] Payment (Transaction QR) - Get Transactions By Code
-- [x] Payment (Quick Pay) - Payment
-- [x] Payment (Quick Pay) - Refund
-- [x] Payment (Quick Pay) - Reverse
-- [x] Payment (Quick Pay) - Get All Payment Transactions
-- [x] Payment (Quick Pay) - Get All Payment Transaction By ID
-- [x] Payment (Quick Pay) - Daily Settlement Report
-- [x] Give Loyalty Point
-- [x] Get Loyalty Members
-- [x] Get Loyalty Member
-- [x] Get Loyalty Member Point History
-- [x] Issue Voucher
-- [x] Void Voucher
-- [x] Get Voucher By Code
-- [x] Get Voucher Batches
-- [x] Get Voucher Batch By Key
-- [ ] Send Notification (Merchant)
-- [ ] Send Notification (Store)
-- [ ] Send Notification (User)
+})
+```
+
+### Refund
+
+```
+result = client.quickPay.refund(accessToken, {
+    "transactionId": "190109042809010428940037",
+    "refund": {
+        "type": "FULL",
+        "currencyType": "MYR",
+        "amount": 100,
+    },
+    "reason": "test"
+})
+```
+
+### Reverse
+
+```
+result = client.quickPay.reverse(accessToken, {
+    "orderId": "111222333"
+})
+```
+
+### Get All Transactions
+
+```
+result = client.quickPay.getAllTransactions(accessToken)
+```
+
+### Get Transaction By ID
+
+```
+result = client.quickPay.getTransactionByID(accessToken, transactionID)
+```
+
+### Get Transaction By Order ID
+
+```
+result = client.quickPay.getTransactionByOrder(accessToken, orderID)
+```
+
+### Get Daily Settlement Report
+
+```
+result = client.quickPay.dailySettlementReport(accessToken, {
+    "date": "2019-01-09",
+    "method": "WECHATPAY",
+    "region": "MALAYSIA",
+    "sequence": 1
+})
+```
+
+## Payment (Transaction QR)
+
+### Create Transaction
+
+```
+result = client.transaction.createTransaction(accessToken, {
+    "amount": 100,
+    "currencyType": "MYR",
+    "expiry": {
+        "type": "PERMANENT"
+    },
+    "isPreFillAmount": True,
+    "method": ['WECHATPAY'],
+    "order": {
+        "details": "Test",
+        "title": "Title"
+    },
+    "redirectUrl": 'https://www.revenuemonster.com',
+    "storeId": '1981039839353524638',
+    "type": 'DYNAMIC',
+})
+```
+
+### Get Transaction
+
+```
+result = client.transaction.getTransaction(accessToken)
+```
+
+### Get Transaction By Code
+
+```
+result = client.transaction.getTransactionByCode(accessToken, qrCode)
+```
+
+### Get List of Transactions By Code
+
+```
+result = client.transaction.getTransactionByCode(accessToken, qrCode)
+```
+
+
+## Loyalty
+
+### Give Loyalty Point
+
+```
+result = client.loyalty.giveLoyaltyPoint(accessToken, {
+    "point": 100,
+    "type": "ID",
+    "memberId": "7765269777796630408",
+    "countryCode": "60",
+    "phoneNumber": "172826990"
+})
+```
+
+### Get Loyalty Member
+
+```
+result = client.loyalty.getLoyaltyMember(accessToken, memberID)
+```
+
+### Get List of Loyalty Members
+
+```
+result = client.loyalty.getLoyaltyMembers(accessToken)
+```
+
+### Get Point History
+
+Get Loyalty point history of a member
+
+```
+result = client.loyalty.getLoyaltyMemberPointHistory(accessToken, memberID)
+```
+
+## Voucher
+
+### Issue Voucher
+
+```
+result = client.voucher.issueVoucher(accessToken, batchKey)
+```
+
+### Void Voucher
+
+```
+result = client.voucher.voidVoucher(accessToken, voucherCode)
+```
+
+### Get Voucher By Code
+
+```
+result = client.voucher.getVoucherByCode(accessToken, voucherCode)
+```
+
+### Get Voucher Batches
+
+```
+result = client.voucher.getVoucherBatches(accessToken)
+```
+
+### Get Voucher Batches By Batch Key
+
+```
+result = client.voucher.getVoucherBatchByKey(accessToken, batchKey)
+```
+
+
+Detail examples can be found at [examples](https://github.com/RevenueMonster/RM-API-SDK-Python/tree/master/examples).
+