From de1d9d60fb81de99ec77c4178db131a64451fd68 Mon Sep 17 00:00:00 2001
From: fgibaux <florent.gibaux@gmail.com>
Date: Mon, 12 Jun 2023 13:33:49 +0100
Subject: [PATCH] add missing types to phphdoc

---
 src/Resources/CallLogs.php      |  2 +-
 src/Resources/Deals.php         | 44 ++++++++++++++++-----------------
 src/Resources/EmailThreads.php  |  2 +-
 src/Resources/Files.php         | 20 +++++++--------
 src/Resources/ItemSearch.php    | 12 ++++-----
 src/Resources/Leads.php         |  5 ++--
 src/Resources/Mailbox.php       | 12 ++++-----
 src/Resources/Organizations.php |  2 +-
 src/Resources/Roles.php         | 10 ++++----
 src/Resources/Users.php         |  2 +-
 src/Resources/Webhooks.php      |  4 +--
 11 files changed, 58 insertions(+), 57 deletions(-)

diff --git a/src/Resources/CallLogs.php b/src/Resources/CallLogs.php
index f34edbe..abdf8dd 100644
--- a/src/Resources/CallLogs.php
+++ b/src/Resources/CallLogs.php
@@ -12,7 +12,7 @@ class CallLogs extends Resource
     /**
      * Upload a recording file (audio) to a callLog
      *
-     * @param $id
+     * @param int $id
      * @param \SplFileInfo $file
      * @return Response
      */
diff --git a/src/Resources/Deals.php b/src/Resources/Deals.php
index c99f614..2d4ac05 100644
--- a/src/Resources/Deals.php
+++ b/src/Resources/Deals.php
@@ -15,11 +15,11 @@ class Deals extends Entity
     /**
      * Get the deals timeline.
      *
-     * @param       $start_date
-     * @param       $interval
-     * @param       $amount
-     * @param       $field_key
-     * @param array $options
+     * @param string $start_date
+     * @param string $interval
+     * @param int    $amount
+     * @param string $field_key
+     * @param array  $options
      * @return Response
      */
     public function timeline($start_date, $interval, $amount, $field_key, $options = [])
@@ -35,8 +35,8 @@ public function timeline($start_date, $interval, $amount, $field_key, $options =
     /**
      * Add a participant to a deal.
      *
-     * @param $id
-     * @param $person_id
+     * @param int $id
+     * @param int $person_id
      * @return Response
      */
     public function addParticipant($id, $person_id)
@@ -47,7 +47,7 @@ public function addParticipant($id, $person_id)
     /**
      * Get the participants of a deal.
      *
-     * @param       $id
+     * @param int   $id
      * @param array $options
      * @return Response
      */
@@ -61,8 +61,8 @@ public function participants($id, $options = [])
     /**
      * Delete a participant from a deal.
      *
-     * @param $id
-     * @param $deal_participant_id
+     * @param int $id
+     * @param int $deal_participant_id
      * @return Response
      */
     public function deleteParticipant($id, $deal_participant_id)
@@ -73,10 +73,10 @@ public function deleteParticipant($id, $deal_participant_id)
     /**
      * Add a product to the deal.
      *
-     * @param       $id
-     * @param       $product_id
+     * @param int   $id
+     * @param int   $product_id
      * @param       $item_price
-     * @param       $quantity
+     * @param int   $quantity
      * @param array $options
      * @return Response
      */
@@ -91,12 +91,12 @@ public function addProduct($id, $product_id, $item_price, $quantity, $options =
     }
 
     /**
-     * Update the deatils of an attached product.
+     * Update the details of an attached product.
      *
-     * @param       $id
-     * @param       $deal_product_id
+     * @param int   $id
+     * @param int   $deal_product_id
      * @param       $item_price
-     * @param       $quantity
+     * @param int   $quantity
      * @param array $options
      * @return Response
      */
@@ -113,8 +113,8 @@ public function updateProduct($id, $deal_product_id, $item_price, $quantity, $op
     /**
      * Delete an attached product from a deal.
      *
-     * @param $id
-     * @param $product_attachment_id
+     * @param int $id
+     * @param int $product_attachment_id
      * @return Response
      */
     public function deleteProduct($id, $product_attachment_id)
@@ -128,7 +128,7 @@ public function deleteProduct($id, $product_attachment_id)
     /**
      * Duplicate a deal.
      *
-     * @param $id The deal id
+     * @param int $id The deal id
      * @return Response
      */
     public function duplicate($id)
@@ -139,7 +139,7 @@ public function duplicate($id)
     /**
      * Get the email messages for a deal.
      * 
-     * @param $id The deal id
+     * @param int $id The deal id
      * @return Response
      */
     public function mailMessages($id)
@@ -150,7 +150,7 @@ public function mailMessages($id)
     /**
      * Get the files for a deal.
      *
-     * @param $id The deal id
+     * @param int $id The deal id
      * @return Response
      */
     public function files($id)
diff --git a/src/Resources/EmailThreads.php b/src/Resources/EmailThreads.php
index a832faa..1df09bb 100644
--- a/src/Resources/EmailThreads.php
+++ b/src/Resources/EmailThreads.php
@@ -17,7 +17,7 @@ class EmailThreads extends Resource
     /**
      * Get the messages inside a thread.
      *
-     * @param       $id
+     * @param int   $id
      * @param array $options
      * @return Response
      */
diff --git a/src/Resources/Files.php b/src/Resources/Files.php
index f82c9ac..0e99eb9 100644
--- a/src/Resources/Files.php
+++ b/src/Resources/Files.php
@@ -17,11 +17,11 @@ class Files extends Resource
     /**
      * Create a remote file and link it to an item.
      *
-     * @param $file_type
-     * @param $title
-     * @param $item_type
-     * @param $item_id
-     * @param $remote_location
+     * @param string $file_type
+     * @param string $title
+     * @param string $item_type
+     * @param int    $item_id
+     * @param string $remote_location
      * @return Response
      */
     public function createRemote($file_type, $title, $item_type, $item_id, $remote_location)
@@ -35,10 +35,10 @@ public function createRemote($file_type, $title, $item_type, $item_id, $remote_l
     /**
      * Link a remote file to an item.
      *
-     * @param $item_type
-     * @param $item_id
-     * @param $remote_id
-     * @param $remote_location
+     * @param string $item_type
+     * @param int    $item_id
+     * @param string $remote_id
+     * @param string $remote_location
      * @return Response
      */
     public function linkRemote($item_type, $item_id, $remote_id, $remote_location)
@@ -52,7 +52,7 @@ public function linkRemote($item_type, $item_id, $remote_id, $remote_location)
     /**
      * Initializes a file download.
      *
-     * @param $id
+     * @param int $id
      * @return Response
      */
     public function download($id) {
diff --git a/src/Resources/ItemSearch.php b/src/Resources/ItemSearch.php
index 838d0d2..82e8d79 100644
--- a/src/Resources/ItemSearch.php
+++ b/src/Resources/ItemSearch.php
@@ -17,8 +17,8 @@ class ItemSearch extends Resource
     /**
      * Search.
      *
-     * @param       $term
-     * @param array $options
+     * @param string $term
+     * @param array  $options
      * @return Response
      */
     public function search($term, $options = [])
@@ -31,10 +31,10 @@ public function search($term, $options = [])
     /**
      * Search from a specific field.
      *
-     * @param       $term
-     * @param       $field_type
-     * @param       $field_key
-     * @param array $options
+     * @param string $term
+     * @param string $field_type
+     * @param string $field_key
+     * @param array  $options
      * @return Response
      */
     public function searchFromField($term, $field_type, $field_key, $options = [])
diff --git a/src/Resources/Leads.php b/src/Resources/Leads.php
index b09bf26..86e2ca5 100644
--- a/src/Resources/Leads.php
+++ b/src/Resources/Leads.php
@@ -49,6 +49,7 @@ public function addLabel(array $values = [])
     /**
      * Delete a label.
      *
+     * @var int $id
      * @return Response
      */
     public function deleteLabel($id)
@@ -59,7 +60,7 @@ public function deleteLabel($id)
     }
 
     /**
-     * @param $id
+     * @param int   $id
      * @param array $values
      * @return Response
      */
@@ -71,7 +72,7 @@ public function updateLabel($id, array $values = [])
     }
 
     /**
-     * @param $id
+     * @param int   $id
      * @param array $values
      * @return Response
      */
diff --git a/src/Resources/Mailbox.php b/src/Resources/Mailbox.php
index 6e7a544..0fddb8d 100644
--- a/src/Resources/Mailbox.php
+++ b/src/Resources/Mailbox.php
@@ -10,7 +10,7 @@ class Mailbox extends Resource
     /**
      * Get the Mail threads details by ID.
      *
-     * @param $id   Mail threads ID to find.
+     * @param int $id   Mail threads ID to find.
 	 * @return Response
      */
     public function find($id)
@@ -21,7 +21,7 @@ public function find($id)
     /**
      * Delete Mail threads by ID.
      *
-     * @param $id   Mail threads ID to delete.
+     * @param int $id   Mail threads ID to delete.
 	 * @return Response
      */
     public function delete($id)
@@ -32,7 +32,7 @@ public function delete($id)
     /**
      * Update Mail threads by ID.
      *
-     * @param       $id
+     * @param int   $id
      * @param array $values
 	 * @return Response
      */
@@ -45,8 +45,8 @@ public function update($id, array $values)
     /**
      * Get list of mail threads
      *
-     * @param       $folder
-     * @param array $options
+     * @param string $folder
+     * @param array  $options
 	 * @return Response 
      */
     public function mailThreads($folder, array $options = [])
@@ -59,7 +59,7 @@ public function mailThreads($folder, array $options = [])
     /**
      * Get mail messages inside specified mail thread by ID.
      *
-     * @param $id   Mail threads ID to find messages.
+     * @param int $id   Mail threads ID to find messages.
 	 * @return Response
      */
     public function mailMessages($id, $params=[])
diff --git a/src/Resources/Organizations.php b/src/Resources/Organizations.php
index ae13863..a2b72a5 100644
--- a/src/Resources/Organizations.php
+++ b/src/Resources/Organizations.php
@@ -15,7 +15,7 @@ class Organizations extends Entity
     /**
      * List the persons of a resource.
      *
-     * @param       $id      The resource id
+     * @param int   $id      The resource id
      * @param array $options Extra parameters
      * @return Response
      */
diff --git a/src/Resources/Roles.php b/src/Resources/Roles.php
index 6c166a2..0665fc5 100644
--- a/src/Resources/Roles.php
+++ b/src/Resources/Roles.php
@@ -20,7 +20,7 @@ class Roles extends Resource
     /**
      * List the role subroles.
      *
-     * @param       $id
+     * @param int   $id
      * @param array $options
      * @return Response
      */
@@ -34,7 +34,7 @@ public function subRoles($id, $options = [])
     /**
      * List the role settings.
      *
-     * @param $id
+     * @param int $id
      * @return Response
      */
     public function settings($id)
@@ -45,9 +45,9 @@ public function settings($id)
     /**
      * Add or update a setting value.
      *
-     * @param $id
-     * @param $setting_key
-     * @param $value
+     * @param int    $id
+     * @param string $setting_key
+     * @param int    $value
      * @return Response
      */
     public function setSetting($id, $setting_key, $value)
diff --git a/src/Resources/Users.php b/src/Resources/Users.php
index 27535bd..d3ff3f8 100644
--- a/src/Resources/Users.php
+++ b/src/Resources/Users.php
@@ -28,7 +28,7 @@ class Users extends Resource
     /**
      * Get the user permissions.
      *
-     * @param $id
+     * @param int $id
      * @return Response
      */
     public function permissions($id)
diff --git a/src/Resources/Webhooks.php b/src/Resources/Webhooks.php
index f70c784..64f9635 100644
--- a/src/Resources/Webhooks.php
+++ b/src/Resources/Webhooks.php
@@ -33,7 +33,7 @@ class Webhooks extends Resource
     /**
      * Get the entity details by ID.
      *
-     * @param $id   Entity ID to find.
+     * @param int $id   Entity ID to find.
      * @return \Devio\Pipedrive\Http\Response|void
      * @throws PipedriveException
      */
@@ -44,7 +44,7 @@ public function find($id)
 
     /**
      * Update an entity by ID.
-     * @param $id
+     * @param int   $id
      * @param array $values
      *
      * @return \Devio\Pipedrive\Http\Response|void