Skip to content

Commit

Permalink
Added Address Search Feature for the US Address Enrichment API
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric Devenport authored and Eric Devenport committed Sep 6, 2024
1 parent d936041 commit f9c5f6b
Show file tree
Hide file tree
Showing 4 changed files with 195 additions and 33 deletions.
19 changes: 18 additions & 1 deletion examples/USEnrichmentExample.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@
require_once(dirname(dirname(__FILE__)) . '/src/StaticCredentials.php');
require_once(dirname(dirname(__FILE__)) . '/src/ClientBuilder.php');
require_once(dirname(dirname(__FILE__)) . '/src/US_Enrichment/Client.php');
require_once(dirname(dirname(__FILE__)) . '/src/US_Enrichment/Lookup.php');

use SmartyStreets\PhpSdk\StaticCredentials;
use SmartyStreets\PhpSdk\ClientBuilder;
use SmartyStreets\PhpSdk\US_Enrichment\Result;
use SmartyStreets\PhpSdk\US_Enrichment\Lookup;

$lookupExample = new USEnrichmentExample();
$lookupExample->run();
Expand All @@ -31,10 +33,25 @@ public function run()
$client = (new ClientBuilder($staticCredentials)) ->withLicenses(["us-property-data-principal-cloud"])
->buildUsEnrichmentApiClient();

$smartyKey = "1682393594";
$smartyKey = "325023201";

$lookup = new Lookup();

$lookup->setStreet("56 Union Ave");
$lookup->setCity("Somerville");
$lookup->setState("NJ");
$lookup->setZipcode("08876");

// You can also send an address in freeform by uncommenting the line below
// $lookup->setFreeform("56 Union Ave Somerville NJ 08876");

try {
// Call the API with only a smarty key using the line below
$result = $client->sendPropertyPrincipalLookup($smartyKey);

// Or call the API with an address using the lookup object with the commented line below
// $result = $client->sendPropertyPrincipalLookup($lookup);

if ($result != null) {
$this->displayResult($result[0]);
}
Expand Down
135 changes: 108 additions & 27 deletions src/US_Enrichment/Client.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,40 +21,106 @@ public function __construct(Sender $sender, Serializer $serializer = null) {
$this->serializer = $serializer;
}

public function sendPropertyFinancialLookup($smartyKey){
$lookup = new Lookup($smartyKey, "property", "financial");
$this->sendLookup($lookup);
return $lookup->getResponse();
public function sendPropertyFinancialLookup($financialLookup){
if (is_string($financialLookup)) {
$lookup = new Lookup($financialLookup, "property", "financial");
$this->sendLookup($lookup);
return $lookup->getResponse();
}
else if (is_object($financialLookup)) {
$financialLookup->setDataSetName("property");
$financialLookup->setDataSubSetName("financial");
$this->sendLookup($financialLookup);
return $financialLookup->getResponse();
}
else {
return null;
}
}

public function sendPropertyPrincipalLookup($smartyKey){
$lookup = new Lookup($smartyKey, "property", "principal");
$this->sendLookup($lookup);
return $lookup->getResponse();
public function sendPropertyPrincipalLookup($principalLookup){
if (is_string($principalLookup)) {
$lookup = new Lookup($principalLookup, "property", "principal");
$this->sendLookup($lookup);
return $lookup->getResponse();
}
else if (is_object($principalLookup)) {
$principalLookup->setDataSetName("property");
$principalLookup->setDataSubSetName("principal");
$this->sendLookup($principalLookup);
return $principalLookup->getResponse();
}
else {
return null;
}
}

public function sendGeoReferenceLookup($smartyKey){
$lookup = new Lookup($smartyKey, "geo-reference", null);
$this->sendLookup($lookup);
return $lookup->getResponse();
public function sendGeoReferenceLookup($geoReferenceLookup){
if (is_string($geoReferenceLookup)) {
$lookup = new Lookup($geoReferenceLookup, "geo-reference");
$this->sendLookup($lookup);
return $lookup->getResponse();
}
else if (is_object($geoReferenceLookup)) {
$geoReferenceLookup->setDataSetName("geo-reference");
$geoReferenceLookup->setDataSubSetName(null);
$this->sendLookup($geoReferenceLookup);
return $geoReferenceLookup->getResponse();
}
else {
return null;
}
}

public function sendSecondaryLookup($smartyKey){
$lookup = new Lookup($smartyKey, "secondary", null);
$this->sendLookup($lookup);
return $lookup->getResponse();
public function sendSecondaryLookup($secondaryLookup){
if (is_string($secondaryLookup)) {
$lookup = new Lookup($secondaryLookup, "secondary");
$this->sendLookup($lookup);
return $lookup->getResponse();
}
else if (is_object($secondaryLookup)) {
$secondaryLookup->setDataSetName("secondary");
$secondaryLookup->setDataSubSetName(null);
$this->sendLookup($secondaryLookup);
return $secondaryLookup->getResponse();
}
else {
return null;
}
}

public function sendSecondaryCountLookup($smartyKey){
$lookup = new Lookup($smartyKey, "secondary", "count");
$this->sendLookup($lookup);
return $lookup->getResponse();
public function sendSecondaryCountLookup($secondaryCountLookup){
if (is_string($secondaryCountLookup)) {
$lookup = new Lookup($secondaryCountLookup, "secondary", "count");
$this->sendLookup($lookup);
return $lookup->getResponse();
}
else if (is_object($secondaryCountLookup)) {
$secondaryCountLookup->setDataSetName("secondary");
$secondaryCountLookup->setDataSubSetName("count");
$this->sendLookup($secondaryCountLookup);
return $secondaryCountLookup->getResponse();
}
else {
return null;
}
}

public function sendGenericLookup($smartyKey, $dataSetName, $dataSubsetName){
$lookup = new Lookup($smartyKey, $dataSetName, $dataSubsetName);
$this->sendLookup($lookup);
return $lookup->getResponse();
public function sendGenericLookup($genericLookup, $dataSetName, $dataSubsetName){
if (is_string($genericLookup)) {
$lookup = new Lookup($genericLookup, $dataSetName, $dataSubsetName);
$this->sendLookup($lookup);
return $lookup->getResponse();
}
else if (is_object($genericLookup)) {
$genericLookup->setDataSetName($dataSetName);
$genericLookup->setDataSubSetName($dataSubsetName);
$this->sendLookup($genericLookup);
return $genericLookup->getResponse();
}
else {
return null;
}
}

private function sendLookup(Lookup $lookup) {
Expand Down Expand Up @@ -83,13 +149,28 @@ private function buildRequest(Lookup $lookup) {

$request->setUrlComponents($this->getUrlPrefix($lookup));

if ($lookup->getSmartyKey() == null) {
$request->setParameter("freeform", $lookup->getFreeform());
$request->setParameter("street", $lookup->getStreet());
$request->setParameter("city", $lookup->getCity());
$request->setParameter("state", $lookup->getState());
$request->setParameter("zipcode", $lookup->getZipcode());
}
return $request;
}

private function getUrlPrefix($lookup){
if ($lookup->getDataSubsetName() == null) {
return $lookup->getSmartyKey() . "/" . $lookup->getDataSetName();
if ($lookup->getSmartyKey() == null) {
if ($lookup->getDataSubsetName() == null) {
return "search/" . $lookup->getDataSetName();
}
return "search/" . $lookup->getDataSetName() . "/" . $lookup->getDataSubsetName();
}
else {
if ($lookup->getDataSubsetName() == null) {
return $lookup->getSmartyKey() . "/" . $lookup->getDataSetName();
}
return $lookup->getSmartyKey() . "/" . $lookup->getDataSetName() . "/" . $lookup->getDataSubsetName();
}
return $lookup->getSmartyKey() . "/" . $lookup->getDataSetName() . "/" . $lookup->getDataSubsetName();
}
}
66 changes: 64 additions & 2 deletions src/US_Enrichment/Lookup.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,54 @@ class Lookup {
//region [ Fields ]

private $smartyKey,
$freeform,
$street,
$city,
$state,
$zipcode,
$dataSetName,
$dataSubsetName,
$response;

//endregion

public function __construct($smartyKey, $dataSetName, $dataSubsetName) {
public function __construct($smartyKey = null, $dataSetName = null, $dataSubsetName = null, $freeform = null, $street = null, $city = null, $state = null,
$zipcode = null) {
$this->smartyKey = $smartyKey;
$this->dataSetName = $dataSetName;
$this->dataSubsetName = $dataSubsetName;
$this->freeform = $freeform;
$this->street = $street;
$this->city = $city;
$this->state = $state;
$this->zipcode = $zipcode;
$this->response = null;

}

public function getSmartyKey(){
return $this->smartyKey;
}

public function getFreeform(){
return $this->freeform;
}

public function getStreet(){
return $this->street;
}

public function getCity(){
return $this->city;
}

public function getState(){
return $this->state;
}

public function getZipcode(){
return $this->zipcode;
}

public function getDataSetName(){
return $this->dataSetName;
}
Expand All @@ -37,6 +67,38 @@ public function getResponse() {
return $this->response;
}

public function setSmartyKey($smartyKey) {
$this->smartyKey = $smartyKey;
}

public function setDataSetName($dataSetName) {
$this->dataSetName = $dataSetName;
}

public function setDataSubsetName($dataSubsetName) {
$this->dataSubsetName = $dataSubsetName;
}

public function setFreeform($freeform) {
$this->freeform = $freeform;
}

public function setStreet($street){
$this->street = $street;
}

public function setCity($city){
$this->city = $city;
}

public function setState($state){
$this->state = $state;
}

public function setZipcode($zipcode){
$this->zipcode = $zipcode;
}

public function setResponse($response){
$this->response = $response;
}
Expand Down
8 changes: 5 additions & 3 deletions src/US_Enrichment/SecondaryAttributes.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,16 @@ private function createRootAddress($rootAddress){
}

private function createAliases($aliasesArray){
foreach($aliasesArray as $value){
$this->aliases = new AliasesEntry($value);
if ($aliasesArray != null) {
foreach($aliasesArray as $value){
$this->aliases[] = new AliasesEntry($value);
}
}
}

private function createSecondaries($secondariesArray){
foreach($secondariesArray as $value){
$this->secondaries = new SecondariesEntry($value);
$this->secondaries[] = new SecondariesEntry($value);
}
}
}

0 comments on commit f9c5f6b

Please sign in to comment.