Skip to content

Commit

Permalink
Merge pull request #130 from fgibaux/add-missing-types-phpdoc
Browse files Browse the repository at this point in the history 
add missing types to phphdoc
  • Loading branch information
@IsraelOrtuno
IsraelOrtuno authored Jun 12, 2023
2 parents 8eb3130 + de1d9d6 commit 52f698e
Show file tree
Hide file tree
Showing 11 changed files with 58 additions and 57 deletions.
2 changes: 1 addition & 1 deletion src/Resources/CallLogs.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
44 changes: 22 additions & 22 deletions src/Resources/Deals.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [])
Expand All @@ -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)
Expand All @@ -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
*/
Expand All @@ -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)
Expand All @@ -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
*/
Expand All @@ -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
*/
Expand All @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/EmailThreads.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ class EmailThreads extends Resource
/**
* Get the messages inside a thread.
*
* @param $id
* @param int $id
* @param array $options
* @return Response
*/
Expand Down
20 changes: 10 additions & 10 deletions src/Resources/Files.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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) {
Expand Down
12 changes: 6 additions & 6 deletions src/Resources/ItemSearch.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 = [])
Expand All @@ -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 = [])
Expand Down
5 changes: 3 additions & 2 deletions src/Resources/Leads.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ public function addLabel(array $values = [])
/**
* Delete a label.
*
* @var int $id
* @return Response
*/
public function deleteLabel($id)
Expand All @@ -59,7 +60,7 @@ public function deleteLabel($id)
}

/**
* @param $id
* @param int $id
* @param array $values
* @return Response
*/
Expand All @@ -71,7 +72,7 @@ public function updateLabel($id, array $values = [])
}

/**
* @param $id
* @param int $id
* @param array $values
* @return Response
*/
Expand Down
12 changes: 6 additions & 6 deletions src/Resources/Mailbox.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -32,7 +32,7 @@ public function delete($id)
/**
* Update Mail threads by ID.
*
* @param $id
* @param int $id
* @param array $values
* @return Response
*/
Expand All @@ -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 = [])
Expand All @@ -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=[])
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Organizations.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
10 changes: 5 additions & 5 deletions src/Resources/Roles.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class Roles extends Resource
/**
* List the role subroles.
*
* @param $id
* @param int $id
* @param array $options
* @return Response
*/
Expand All @@ -34,7 +34,7 @@ public function subRoles($id, $options = [])
/**
* List the role settings.
*
* @param $id
* @param int $id
* @return Response
*/
public function settings($id)
Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion src/Resources/Users.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class Users extends Resource
/**
* Get the user permissions.
*
* @param $id
* @param int $id
* @return Response
*/
public function permissions($id)
Expand Down
4 changes: 2 additions & 2 deletions src/Resources/Webhooks.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand All @@ -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
Expand Down

0 comments on commit 52f698e

Please sign in to comment.