Conversations

Extends \mixisLv\Reamaze\BaseApi

Class Conversations

package

mixisLv\Reamaze\Api

author

Mikus Rozenbergs mikus.rozenbergs@gmail.com

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

Creating Conversations

create(\mixisLv\Reamaze\Params\Conversations\CreateParams $params) : \stdClass
see https://www.reamaze.com/api/post_conversations
Throws
\mixisLv\Reamaze\Exceptions\ApiException

Arguments

$params

\mixisLv\Reamaze\Params\Conversations\CreateParams

$conversation = new \mixisLv\Reamaze\Params\Conversations\CreateParams([ "subject" => "new conversation", "category" => "support", "tagList" => ["API", "test"], "message" => [ "body" => "Nullam rutrum cursus arcu, et viverra nisl finibus molestie.", "recipients" => ["recipient@example.com"], ], "user" => [ "name" => "Lorem Ipsum", "email" => "lorem.ipsum@example.com", ] ]); $response = $reamaze->conversations->create($conversation);

Response

\stdClass

Get Conversation

get(\mixisLv\Reamaze\Params\Conversations\GetParams $params) : \stdClass

$params = new \mixisLv\Reamaze\Params\Conversations\GetParams(['slug' => 'support']); $response = $reamaze->channels->conversations($params);

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

Arguments

Response

\stdClass

getAction

getAction(string $slug = null) : string
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

$slug

string

Response

string

prepareCreateParams

prepareCreateParams(\mixisLv\Reamaze\Params\Conversations\CreateParams $params) : array
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

Response

array

prepareRetrieveParams

prepareRetrieveParams(\mixisLv\Reamaze\Params\Conversations\RetrieveParams $params) : array
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

$params

\mixisLv\Reamaze\Params\Conversations\RetrieveParams

Response

array

Retrieving Conversations

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

$params = new \mixisLv\Reamaze\Params\Conversations\RetrieveParams([ 'filter'=> RetrieveParams::FILTER_ALL ]); $response = $reamaze->conversations->retrieve($params);

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

Arguments

$params

\mixisLv\Reamaze\Params\Conversations\RetrieveParams|null

Response

\stdClass

Properties

api

api : 
inherited

Type(s)