add phpdoc to public properties

Invoiced · May 25, 2020 · 2bd2fea · 2bd2fea
1 parent defa9e0
commit 2bd2fea
Showing 1 changed file with 43 additions and 11 deletions.
diff --git a/src/Client.php b/src/Client.php
@@ -18,21 +18,53 @@ class Client
     const CONNECT_TIMEOUT = 30;
     const READ_TIMEOUT = 60;
 
-    /** @deprecated  */
+    /**
+     * @deprecated
+     *
+     * @var CatalogItem
+     */
     public $CatalogItem;
+
+    /** @var Coupon */
     public $Coupon;
+
+    /** @var CreditNote */
     public $CreditNote;
+
+    /** @var Customer */
     public $Customer;
+
+    /** @var Estimate */
     public $Estimate;
+
+    /** @var Event */
     public $Event;
+
+    /** @var File */
     public $File;
+
+    /** @var Invoice */
     public $Invoice;
+
+    /** @var Item */
     public $Item;
+
+    /** @var Note */
     public $Note;
+
+    /** @var Plan */
     public $Plan;
+
+    /** @var Subscription */
     public $Subscription;
+
+    /** @var Task */
     public $Task;
+
+    /** @var TaxRate */
     public $TaxRate;
+
+    /** @var Transaction */
     public $Transaction;
 
     /**
@@ -84,7 +116,7 @@ public function __construct($apiKey, $sandbox = false, $ssoKey = false, $handler
 
         $this->client = new GuzzleClient([
             'base_uri' => $this->endpoint(),
-            'handler'  => $handlerStack,
+            'handler' => $handlerStack,
         ]);
 
         // object endpoints
@@ -142,13 +174,13 @@ public function request($method, $endpoint, array $params = [], array $opts = []
         $method = strtolower($method);
 
         $request = [
-            'auth'            => [$this->apiKey, ''],
-            'headers'         => $this->buildHeaders($opts),
-            'query'           => [],
-            'http_errors'     => false,
-            'verify'          => $this->caBundleFile,
+            'auth' => [$this->apiKey, ''],
+            'headers' => $this->buildHeaders($opts),
+            'query' => [],
+            'http_errors' => false,
+            'verify' => $this->caBundleFile,
             'connect_timeout' => self::CONNECT_TIMEOUT,
-            'read_timeout'    => self::READ_TIMEOUT,
+            'read_timeout' => self::READ_TIMEOUT,
         ];
 
         // these methods have no request body
@@ -187,9 +219,9 @@ public function request($method, $endpoint, array $params = [], array $opts = []
             }
 
             return [
-                'code'    => $code,
+                'code' => $code,
                 'headers' => $parsedHeaders,
-                'body'    => $parsed,
+                'body' => $parsed,
             ];
         } else {
             $error = json_decode($body, true);
@@ -223,7 +255,7 @@ private function buildHeaders(array $opts)
     {
         $headers = [
             'Content-Type' => 'application/json',
-            'User-Agent'   => 'Invoiced PHP/'.self::VERSION,
+            'User-Agent' => 'Invoiced PHP/'.self::VERSION,
         ];
 
         if (isset($opts['idempotency_key']) && $opts['idempotency_key']) {