olaoluwa-98 / laravel-payant

src/Payant.php

Indentation +141 added lines, -141 removed lines

@@ -28,7 +28,7 @@ 
 
     /**
      * @var $private_key
-    */
+     */
     protected $private_key;
     
 
@@ -36,14 +36,14 @@ 
      *
      * @var $base_uri
      *
-    */
+     */
     protected $base_uri = 'https://api.demo.payant.ng';
     
     
     /**
      * @var $client
      *
-    */
+     */
     protected $client;
 
     
@@ -58,8 +58,8 @@ 
     }
 
     /**
-    * Get Base Url from Payant config file
-    */
+     * Get Base Url from Payant config file
+     */
     public function setBaseUrl()
     {
         if(Config::get('payant.mode') == 'LIVE')
@@ -82,7 +82,7 @@ 
      */
     private function setRequestOptions()
     {       
-       $authorization_string = 'Bearer '. $this->private_key;
+        $authorization_string = 'Bearer '. $this->private_key;
 
         //Set up Guzzle
         $this->client = new Client( [
@@ -100,7 +100,7 @@ 
     /**
      * [getBanks Get Banks and their ids (Nigeria)]
      * @return object [list of banks and their respective bank_ids]
-    */
+     */
     public function getBanks(){
         return $this->sendRequest('get', '/banks');
     }
@@ -112,13 +112,13 @@ 
      * @param array $client_data [description]
      * Required fields - 'settlement_bank', 'account_number'
      * @return object
-    */
+     */
     public function resolveAccount( array $client_data){
         // Mandatory fields
         $required_values = ['settlement_bank', 'account_number'];
 
         if(!array_keys_exist($client_data, $required_values)){
-         throw new RequiredValuesMissing("Missing required values :(");
+            throw new RequiredValuesMissing("Missing required values :(");
         }
 
         $url = '/resolve-account';
@@ -135,13 +135,13 @@ 
      * Required fields - 'first_name', 'last_name', 'email', 'phone'
      * Optional - 'address', 'company_name', 'type', 'settlement_bank', 'account_number'
      * @return object
-    */
+     */
     public function addClient( array $client_data){
         // Mandatory fields
         $required_values = ['first_name', 'last_name', 'email', 'phone'];
 
         if(!array_keys_exist($client_data, $required_values)){
-         throw new RequiredValuesMissing("Missing required values :(");
+            throw new RequiredValuesMissing("Missing required values :(");
         }
 
         $url = '/clients';
@@ -156,7 +156,7 @@ 
      * [getClient Get client Details]
      * @param  string $client_id
      * @return object
-    */
+     */
     public function getClient($client_id = null){
         if(!$client_id){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid Client Id");
@@ -172,15 +172,15 @@ 
 
 
     /**
-    * [editClient - Edit Existing Client]
-    * @param string $client_id
-    * @param array $client_data
-    *        Required fields - 'first_name', 'last_name', 'email', 'phone'
-    *        Optional - 'address', 'company_name', 'type', 'settlement_bank', 'account_number'
-    */
+     * [editClient - Edit Existing Client]
+     * @param string $client_id
+     * @param array $client_data
+     *        Required fields - 'first_name', 'last_name', 'email', 'phone'
+     *        Optional - 'address', 'company_name', 'type', 'settlement_bank', 'account_number'
+     */
     public function editClient( $client_id, array $client_data){
         if(!$client_id){
-           throw new IsNullOrInvalid("Error Processing Request - Null/Invalid Client Id");
+            throw new IsNullOrInvalid("Error Processing Request - Null/Invalid Client Id");
         }
 
         $url = "/clients/{$client_id}";
@@ -189,7 +189,7 @@ 
         $required_values = ['first_name', 'last_name', 'email', 'phone'];
 
         if(!array_keys_exist($client_data, $required_values)){
-             throw new RequiredValuesMissing("Missing required values :(");
+                throw new RequiredValuesMissing("Missing required values :(");
         }
 
         return $this->sendRequest('put', $url, ['form_params' => $client_data]);
@@ -273,10 +273,10 @@ 
 
 
     /**
-    * [getInvoice ]
-    * @param  string $reference_code [Mandatory - Invoice Reference Code]
-    * @return object               
-    */
+     * [getInvoice ]
+     * @param  string $reference_code [Mandatory - Invoice Reference Code]
+     * @return object               
+     */
     public function getInvoice(string $reference_code){
         if(!$reference_code){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
@@ -292,10 +292,10 @@ 
 
 
     /**
-    * [sendInvoice]
-    * @param  string $reference_code [Mandatory - Invoice Reference Code]
-    * @return object               
-    */
+     * [sendInvoice]
+     * @param  string $reference_code [Mandatory - Invoice Reference Code]
+     * @return object               
+     */
     public function sendInvoice(string $reference_code = null){
         if(!$reference_code){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
@@ -311,12 +311,12 @@ 
 
 
     /**
-    * [getInvoiceHistory]
-    * @param  string $period [Mandatory || Valid Options ["today", "week", "month", "30", "90", "year", "custom"]]
-    * @param  string $start  [Format - DD/MM/YYYY]
-    * @param  string $end    [Format - DD/MM/YYYY]
-    * @return object         
-    */
+     * [getInvoiceHistory]
+     * @param  string $period [Mandatory || Valid Options ["today", "week", "month", "30", "90", "year", "custom"]]
+     * @param  string $start  [Format - DD/MM/YYYY]
+     * @param  string $end    [Format - DD/MM/YYYY]
+     * @return object         
+     */
     public function getInvoiceHistory($period, $start = null, $end = null){
         if(!$period){
             throw new RequiredValueMissing("Error Processing Request - period Missing");
@@ -334,10 +334,10 @@ 
 
 
     /**
-    * [deleteInvoice]
-    * @param  string $reference_code [Mandatory - Invoice Reference Code]
-    * @return object                 
-    */
+     * [deleteInvoice]
+     * @param  string $reference_code [Mandatory - Invoice Reference Code]
+     * @return object                 
+     */
     public function deleteInvoice(string $reference_code){
         if(!$reference_code){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
@@ -387,10 +387,10 @@ 
 
 
     /**
-    * [getTransfer ]
-    * @param  string $reference_code [Mandatory - Transfer Reference Code]
-    * @return object               
-    */
+     * [getTransfer ]
+     * @param  string $reference_code [Mandatory - Transfer Reference Code]
+     * @return object               
+     */
     public function getTransfer(string $reference_code){
         if(!$reference_code){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
@@ -407,12 +407,12 @@ 
 
 
     /**
-    * [getTransferHistory]
-    * @param  string $period [Mandatory || Valid Options ["today", "week", "month", "30", "90", "year", "custom"]]
-    * @param  string $start  [Format - DD/MM/YYYY]
-    * @param  string $end    [Format - DD/MM/YYYY]
-    * @return object         
-    */
+     * [getTransferHistory]
+     * @param  string $period [Mandatory || Valid Options ["today", "week", "month", "30", "90", "year", "custom"]]
+     * @param  string $start  [Format - DD/MM/YYYY]
+     * @param  string $end    [Format - DD/MM/YYYY]
+     * @return object         
+     */
     public function getTransferHistory($period, $start = null, $end = null){
         if(!$period){
             throw new RequiredValueMissing("Error Processing Request - period Missing");
@@ -431,10 +431,10 @@ 
 
 
     /**
-    * [deleteTransfer]
-    * @param  string $reference_code [Mandatory - Invoice Reference Code]
-    * @return object                 
-    */
+     * [deleteTransfer]
+     * @param  string $reference_code [Mandatory - Invoice Reference Code]
+     * @return object                 
+     */
     public function deleteTransfer(string $reference_code){
         if(!$reference_code){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
@@ -451,13 +451,13 @@ 
 
 
     /**
-    * [addPayment]
-    * @param string $reference_code [Mandatory - Invoice Reference Code]
-    * @param string $due_date           [Mandatory - [Format - DD/MM/YYYY]]
-    * @param string $amount         [Mandatory]
-    * @param string $channel        [Mandatory - valid ["Cash", "BankTransfer", "POS", "Cheque"]]
-    * @return object
-    */
+     * [addPayment]
+     * @param string $reference_code [Mandatory - Invoice Reference Code]
+     * @param string $due_date           [Mandatory - [Format - DD/MM/YYYY]]
+     * @param string $amount         [Mandatory]
+     * @param string $channel        [Mandatory - valid ["Cash", "BankTransfer", "POS", "Cheque"]]
+     * @return object
+     */
     public function addPayment(string $reference_code, string $due_date, string $amount, string $channel){
         if(!$reference_code){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
@@ -496,10 +496,10 @@ 
 
 
     /**
-    * [getPayment]
-    * @param string $reference_code [Mandatory - Invoice Reference Code]
-    * @return object
-    */
+     * [getPayment]
+     * @param string $reference_code [Mandatory - Invoice Reference Code]
+     * @return object
+     */
     public function getPayment(string $reference_code){
         if(!$reference_code){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
@@ -515,12 +515,12 @@ 
 
 
     /**
-    * [getPaymentHistory]
-    * @param  string $period [Mandatory || Valid Options ["today", "week", "month", "30", "90", "year", "custom"]]
-    * @param  string $start  [Format - DD/MM/YYYY || Optional if $period !== 'custom']
-    * @param  string $end    [Format - DD/MM/YYYY || Optional if $period !== 'custom']
-    * @return object         
-    */
+     * [getPaymentHistory]
+     * @param  string $period [Mandatory || Valid Options ["today", "week", "month", "30", "90", "year", "custom"]]
+     * @param  string $start  [Format - DD/MM/YYYY || Optional if $period !== 'custom']
+     * @param  string $end    [Format - DD/MM/YYYY || Optional if $period !== 'custom']
+     * @return object         
+     */
     public function getPaymentHistory(string $period, string $start, string $end){
         if(!$period){
             throw new RequiredValueMissing("Error Processing Request - period Missing");
@@ -539,11 +539,11 @@ 
 
 
     /**
-    * [addWallet]
-    * @param string $name        [Mandatory - Wallet's name]
-    * @param string $passcode [Mandatory - Wallet's passcode]
-    * @return object
-    */
+     * [addWallet]
+     * @param string $name        [Mandatory - Wallet's name]
+     * @param string $passcode [Mandatory - Wallet's passcode]
+     * @return object
+     */
     public function addWallet(string $name, string $passcode){
         if(!$name){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid name");
@@ -568,10 +568,10 @@ 
 
 
     /**
-    * [getWallet]
-    * @param  string $reference_code [Mandatory - Wallet's Reference Code]
-    * @return object 
-    */
+     * [getWallet]
+     * @param  string $reference_code [Mandatory - Wallet's Reference Code]
+     * @return object 
+     */
     public function getWallet(string $reference_code){
         if(!$reference_code){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
@@ -587,12 +587,12 @@ 
 
 
     /**
-    * [changeWalletPasscode]
-    * @param  string $reference_code [Mandatory - Wallet's Reference Code]
-    * @param  string $old_passcode [Mandatory - Wallet's Old Passcode]
-    * @param  string $passcode [Mandatory - Wallet's Passcode]    
-    * @return object 
-    */
+     * [changeWalletPasscode]
+     * @param  string $reference_code [Mandatory - Wallet's Reference Code]
+     * @param  string $old_passcode [Mandatory - Wallet's Old Passcode]
+     * @param  string $passcode [Mandatory - Wallet's Passcode]    
+     * @return object 
+     */
     public function changeWalletPasscode(string $reference_code, string $old_passcode, string $passcode){
         if(!$reference_code){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
@@ -621,9 +621,9 @@ 
 
 
     /**
-    * [getWallets]
-    * @return object
-    */
+     * [getWallets]
+     * @return object
+     */
     public function getWallets(){
 
         $url = "/wallets";
@@ -636,10 +636,10 @@ 
 
 
     /**
-    * [setWalletStatus]
-    * @param  string $reference_code [Mandatory - Wallet's Reference Code]
-    * @return object 
-    */
+     * [setWalletStatus]
+     * @param  string $reference_code [Mandatory - Wallet's Reference Code]
+     * @return object 
+     */
     public function setWalletStatus(string $reference_code){
         if(!$reference_code){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
@@ -655,14 +655,14 @@ 
 
 
     /**
-    * [withdrawFromWallet]
-    * @param  string $reference_code [Mandatory - Wallet's Reference Code]
-    * @param  array $client_data [Mandatory - Client Data]
-    * Required fields - 'settlement_bank', 'account_number'
-    * @param  string $amount [Mandatory - Amount to send]
-    * @param  string $passcode [Mandatory - Wallet's Passcode]
-    * @return object 
-    */
+     * [withdrawFromWallet]
+     * @param  string $reference_code [Mandatory - Wallet's Reference Code]
+     * @param  array $client_data [Mandatory - Client Data]
+     * Required fields - 'settlement_bank', 'account_number'
+     * @param  string $amount [Mandatory - Amount to send]
+     * @param  string $passcode [Mandatory - Wallet's Passcode]
+     * @return object 
+     */
     public function withdrawFromWallet(string $reference_code, array $client_data, string $amount, string $passcode){
         if(!$reference_code){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
@@ -672,7 +672,7 @@ 
         $required_values = ['settlement_bank', 'account_number'];
 
         if(!array_keys_exist($client_data, $required_values)){
-         throw new RequiredValuesMissing("Missing required values :(");
+            throw new RequiredValuesMissing("Missing required values :(");
         }
 
         if(!$amount){
@@ -700,13 +700,13 @@ 
 
 
     /**
-    * [getWalletTransactions]
-    * @param  string $reference_code [Mandatory - Wallet's Reference Code]
-    * @param  string $period [Mandatory || Valid Options ["today", "week", "month", "30", "90", "year", "custom"]]
-    * @param  string $start  [Format - DD/MM/YYYY]
-    * @param  string $end    [Format - DD/MM/YYYY]
-    * @return object         
-    */
+     * [getWalletTransactions]
+     * @param  string $reference_code [Mandatory - Wallet's Reference Code]
+     * @param  string $period [Mandatory || Valid Options ["today", "week", "month", "30", "90", "year", "custom"]]
+     * @param  string $start  [Format - DD/MM/YYYY]
+     * @param  string $end    [Format - DD/MM/YYYY]
+     * @return object         
+     */
     public function getWalletTransactions(string $reference_code, $period, $start = null, $end = null){
         if(!$reference_code){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid reference_code");
@@ -728,13 +728,13 @@ 
 
 
     /**
-    * [addProduct]
-    * @param string $name        [Mandatory - Product's name]
-    * @param string $description [Mandatory - Product's description]
-    * @param string $unit_cost   [Mandatory - Product's unit cost]
-    * @param string $type        [Mandatory - Product type 'product' or 'service']
-    * @return object
-    */
+     * [addProduct]
+     * @param string $name        [Mandatory - Product's name]
+     * @param string $description [Mandatory - Product's description]
+     * @param string $unit_cost   [Mandatory - Product's unit cost]
+     * @param string $type        [Mandatory - Product type 'product' or 'service']
+     * @return object
+     */
     public function addProduct(string $name, string $description, string $unit_cost, string $type){
         if(!$name){
             throw new IsNull("Error Processing Request - Null/Invalid name");
@@ -774,10 +774,10 @@ 
 
 
     /**
-    * [getProduct]
-    * @param  int $product_id [Mandatory - Product ID]
-    * @return object 
-    */
+     * [getProduct]
+     * @param  int $product_id [Mandatory - Product ID]
+     * @return object 
+     */
     public function getProduct($product_id){
         if(!$product_id){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid product_id");
@@ -793,14 +793,14 @@ 
 
 
     /**
-    * [editProduct]
-    * @param  string $product_id   [Mandatory - Product ID]
-    * @param  array  $product_data [description]
-    * @return object               
-    */
+     * [editProduct]
+     * @param  string $product_id   [Mandatory - Product ID]
+     * @param  array  $product_data [description]
+     * @return object               
+     */
     public function editProduct($product_id, array $product_data){
         if(!$product_id){
-               throw new IsNullOrInvalid("Error Processing Request - Null/Invalid Product Id");
+                throw new IsNullOrInvalid("Error Processing Request - Null/Invalid Product Id");
         }
 
         //Validate Type
@@ -814,13 +814,13 @@ 
             throw new IsInvalid("Invalid Type - Available options: 'product' or 'service'");
         }
 
-       $url = "/products/{$product_id}";
+        $url = "/products/{$product_id}";
 
-       // Mandatory fields
-       $required_values = ['name', 'description', 'unit_cost', 'type'];
+        // Mandatory fields
+        $required_values = ['name', 'description', 'unit_cost', 'type'];
 
         if(!array_keys_exist($product_data, $required_values)){
-             throw new RequiredValuesMissing("Missing required values :(");
+                throw new RequiredValuesMissing("Missing required values :(");
         }
 
         return $this->sendRequest('put', $url, ['form_params' => $product_data]);
@@ -830,9 +830,9 @@ 
 
 
     /**
-    * [getProducts]
-    * @return object
-    */
+     * [getProducts]
+     * @return object
+     */
     public function getProducts(){
         $url = "/products";
 
@@ -843,10 +843,10 @@ 
 
 
     /**
-    * [deleteProduct]
-    * @param $product_id [Mandatory - Product ID]
-    * @return object           
-    */
+     * [deleteProduct]
+     * @param $product_id [Mandatory - Product ID]
+     * @return object           
+     */
     public function deleteProduct($product_id){
         if(!$product_id){
             throw new IsNullOrInvalid("Error Processing Request - Null/Invalid Product Id");
@@ -860,12 +860,12 @@ 
 
 
     /**
-    * [sendRequest]
-    * @param string $method       [Mandatory - request method <get | post | put | delete> ]
-    * @param string $url           [Mandatory - url to send request to]
-    * @param array $params         [data to post to request url]
-    * @return object
-    */
+     * [sendRequest]
+     * @param string $method       [Mandatory - request method <get | post | put | delete> ]
+     * @param string $url           [Mandatory - url to send request to]
+     * @param array $params         [data to post to request url]
+     * @return object
+     */
     public function sendRequest($method, $url, $params=[])
     {
         try{