fw4/sweepbright-api

PHP library for implementing the SweepBright API

v1.2.1 2023-08-30 11:35 UTC

Requires

• php: ^7.1|^8.0
• guzzlehttp/guzzle: ~6.0|~7.0
• league/oauth2-client: ^2.4
• ocramius/package-versions: ^2.1

Requires (Dev)

• phpunit/phpunit: ^8.4|^9.0

MIT

• api
• sdk
• sweepbright

README

PHP client for the SweepBright Website API. For terms of use and API credentials, refer to the official documentation.

Installation

composer require fw4/sweepbright-api

Usage

$client = new \SweepBright\SweepBright();
$accessToken = getAccessTokenFromDataStore();
if (empty($accessToken) || $accessToken->hasExpired()) {
    $accessToken = $client->requestAccessToken($clientId, $clientSecret);
    saveAccessTokenToDataStore($accessToken);
} else {
    $client->setAccessToken($accessToken);
}
$estate = $client->getEstate($estateId);

The API client provides the following methods:

• public function getEstate(string $estate_id): Response
• public function setEstateUrl(string $estate_id, string $url): void
• public function saveContact(array $data, ?array $preferences = null, ?array $location_preference = null): void
• public function saveEstateContact(string $estate_id, array $data): void

For more information about available request parameters and response properties, refer to the official API documentation. Properties on both requests and responses are style agnostic, and are accessible through both snake_case and camelCase.