PHP client for the Skarabee Weblink. For detailed information about the available endpoints and parameters, refer to the official documentation.
composer require fw4/skarabee-weblink
use Skarabee\Weblink\Client;
$client = new Client('username', 'password');
Use the getPublicationSummaries
method to get a list of published properties.
$publications = $client->getPublicationSummaries();
It's possible to filter the list by change/creation date, type of property, and/or shared status.
use Skarabee\Weblink\Enums\PropertyType;
$modified_since = new DateTime('2021-01-01 12:00:00');
$property_types = [
PropertyType::Transaction,
PropertyType::Project,
];
$exclude_shared = true;
$publications = $client->getPublicationSummaries($modified_since, $property_types, $exclude_shared);
Use the getPublication
method to get the data for a single publication.
$publication = $client->getPublication($publication_id);
$bedrooms = $publication->property->numberOfBedrooms;
Use the getProjectSummaries
method to get a list of published projects.
$projects = $client->getProjectSummaries();
It's possible to filter the list by change/creation date and/or shared status.
$modified_since = new DateTime('2021-01-01 12:00:00');
$exclude_shared = true;
$projects = $client->getProjectSummaries($modified_since, $exclude_shared);
Use the getContactInfo
method to get a list of contact information of the
agent.
$info = $client->getContactInfo();
Use the getLogins
method to get a list of user accounts associated with the
agent.
$users = $client->getLogins();
Use the insertContactMes
method to submit contact form input to Skarabee. The
method has no return value, but throws an InvalidContactMeException
on error.
$client->insertContactMes([
'FirstName' => 'string',
'LastName' => 'string',
'Comments' => 'string',
'Email' => 'string',
]);
You can wrap multiple requests in a single array to batch submit data.
$client->insertContactMes([$contact1, $contact2]);
Use the feedback
method to submit updates about the publication's online
availability.
use Skarabee\Weblink\Enums\FeedbackStatus;
$client->feedback([
'PublicationID' => $publication_id,
'Status' => FeedbackStatus::Available,
'URL' => $property_url,
]);
You can wrap multiple requests in a single array to batch submit data.
$client->feedback([$feedback1, $feedback2]);
fw4/skarabee-weblink
is licensed under the MIT License (MIT). Please see LICENSE for more information.