Contacts

Extends \mixisLv\Reamaze\BaseApi

package

Default

Methods

__construct

__construct(\mixisLv\Reamaze\Api $api) 
inherited
Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar://C:/WinNMP/bin/phpDocumentor/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Arguments

Create Contacts

create(\mixisLv\Reamaze\Params\Contacts\CreateParams $params) : \stdClass

$contact = new \mixisLv\Reamaze\Params\Contacts\CreateParams([ 'id' => '123', 'name' => 'bob', 'email' => 'bob@example.com', ]); $response = $reamaze->contacts->create($contact);

see https://www.reamaze.com/api/post_contacts
Throws
\mixisLv\Reamaze\Exceptions\ApiException

Arguments

Response

\stdClass

Create Identities

createIdentities(string $email, \mixisLv\Reamaze\Params\Contacts\CreateIdentitiesParams $params) : \stdClass

$identity = new \mixisLv\Reamaze\Params\Contacts\CreateIdentitiesParams([ 'type' => \mixisLv\Reamaze\Params\Contacts\CreateIdentitiesParams::TYPE_MOBILE, 'identifier' => '+99999999999', ]);

 $response = $reamaze->contacts->createIdentities('recipient@example.com', $identity);

see https://www.reamaze.com/api/post_identities
Throws
\mixisLv\Reamaze\Exceptions\ApiException

Arguments

$email

string

$params

\mixisLv\Reamaze\Params\Contacts\CreateIdentitiesParams

Response

\stdClass

Get Contact Identities

getIdentities(string $email) : \stdClass

$response = $reamaze->contacts->getIdentities('recipient@example.com');

see https://www.reamaze.com/api/get_identities
Throws
\mixisLv\Reamaze\Exceptions\ApiException

Arguments

$email

string

Response

\stdClass

Retrieving Contacts

retrieve(\mixisLv\Reamaze\Params\Contacts\RetrieveParams|null $params = null) : \stdClass

$params = new \mixisLv\Reamaze\Params\Contacts\RetrieveParams(); $params->page = 1; $params->q = 'example' $response = $reamaze->contacts->retrieve($params);

see https://www.reamaze.com/api/get_contacts
Throws
\mixisLv\Reamaze\Exceptions\ApiException

Arguments

$params

\mixisLv\Reamaze\Params\Contacts\RetrieveParams|null

Response

\stdClass

Update Contacts

update(string $email, \mixisLv\Reamaze\Params\Contacts\UpdateParams $params) : \stdClass

$contact = new \mixisLv\Reamaze\Params\Contacts\UpdateParams([ 'name' => 'My Test Contact 2' ]); $response = $reamaze->contacts->update('recipient@example.com', $contact);

see https://www.reamaze.com/api/put_contacts
Throws
\mixisLv\Reamaze\Exceptions\ApiException

Arguments

$email

string

Response

\stdClass

Properties

api

api : 
inherited

Type(s)