code review of contacts

HubSpot · Jan 9, 2020 · c3510e4 · c3510e4
1 parent 507b621
commit c3510e4
Show file tree

Hide file tree

Showing 3 changed files with 107 additions and 101 deletions.
diff --git a/src/Factory.php b/src/Factory.php
@@ -19,6 +19,7 @@
  * @method \SevenShores\Hubspot\Resources\ContactProperties contactProperties()
  * @method \SevenShores\Hubspot\Resources\Contacts          contacts()
  * @method \SevenShores\Hubspot\Resources\CrmAssociations   crmAssociations()
+ * @method \SevenShores\Hubspot\Resources\CrmPipelines      crmPipelines()
  * @method \SevenShores\Hubspot\Resources\Email             email()
  * @method \SevenShores\Hubspot\Resources\EmailEvents       emailEvents()
  * @method \SevenShores\Hubspot\Resources\Engagements       engagements()

diff --git a/src/Resources/Contacts.php b/src/Resources/Contacts.php
@@ -2,9 +2,14 @@
 
 namespace SevenShores\Hubspot\Resources;
 
+/**
+ * @see https://developers.hubspot.com/docs/methods/contacts/contacts-overview
+ */
 class Contacts extends Resource
 {
     /**
+     * Create a new contact.
+     *
      * @param array $properties array of contact properties
      *
      * @return \SevenShores\Hubspot\Http\Response
@@ -21,6 +26,8 @@ public function create(array $properties)
     }
 
     /**
+     * Update an existing contact.
+     *
      * @param int   $id         the contact id
      * @param array $properties the contact properties to update
      *
@@ -38,6 +45,8 @@ public function update($id, array $properties)
     }
 
     /**
+     * Update an existing contact by email.
+     *
      * @param string $email      the contact's email address
      * @param array  $properties the contact properties to update
      *
@@ -55,6 +64,8 @@ public function updateByEmail($email, array $properties)
     }
 
     /**
+     * Create or update a contact.
+     *
      * @param string $email      the contact's email address
      * @param array  $properties the contact properties
      *
@@ -72,6 +83,8 @@ public function createOrUpdate($email, array $properties = [])
     }
 
     /**
+     * Create or update a group of contacts.
+     *
      * @param array $contacts the contacts and properties
      * @param array $params   Array of optional parameters ['auditId']
      *
@@ -91,6 +104,8 @@ public function createOrUpdateBatch(array $contacts, array $params = [])
     }
 
     /**
+     * Delete a contact.
+     *
      * @param int $id
      *
      * @return \SevenShores\Hubspot\Http\Response
@@ -172,6 +187,8 @@ public function recentNew(array $params = [])
     }
 
     /**
+     * Get a contact by vid(id).
+     *
      * @param int   $id
      * @param array $params Array of optional parameters ['property', 'propertyMode', 'formSubmissionMode',
      *                      'showListMemberships']
@@ -216,6 +233,8 @@ public function getBatchByIds(array $vids, array $params = [])
     }
 
     /**
+     * Get a contact by email address.
+     *
      * @param string $email
      * @param array  $params Array of optional parameters ['property', 'propertyMode', 'formSubmissionMode',
      *                       'showListMemberships']
@@ -259,6 +278,8 @@ public function getBatchByEmails($emails, array $params = [])
     }
 
     /**
+     * Get a contact by its user token.
+     *
      * @param string $utk
      * @param array  $params Array of optional parameters ['property', 'propertyMode', 'formSubmissionMode',
      *                       'showListMemberships']
@@ -333,6 +354,8 @@ public function search($query, array $params = [])
     }
 
     /**
+     * @deprecated
+     *
      * @return \SevenShores\Hubspot\Http\Response
      */
     public function statistics()
@@ -362,4 +385,18 @@ public function merge($id, $vidToMerge)
 
         return $this->client->request('post', $endpoint, $options);
     }
+
+    /**
+     * Get Lifecycle Stage metrics for Contacts.
+     *
+     * @see https://developers.hubspot.com/docs/methods/contacts/get-lifecycle-stage-metrics-for-contacts
+     *
+     * @return \SevenShores\Hubspot\Http\Response
+     */
+    public function getLifecycleStageMetrics(array $params = [])
+    {
+        $endpoint = 'https://api.hubapi.com/contacts/v1/contacts/statistics';
+
+        return $this->client->request('get', $endpoint, [], build_query_string($params));
+    }
 }