Properties

$configuration

$configuration : \ElasticEmailClient\ApiConfiguration

Type

\ElasticEmailClient\ApiConfiguration — ApiConfiguration

$httpClient

$httpClient : \GuzzleHttp\ClientInterface

Type

\GuzzleHttp\ClientInterface

Methods

__construct()

__construct(\ElasticEmailClient\ApiConfiguration  $apiConfiguration) 

Parameters

\ElasticEmailClient\ApiConfiguration $apiConfiguration

setHttpClient()

setHttpClient(  $client) 

Parameters

$client

getHttpClient()

getHttpClient() : \GuzzleHttp\ClientInterface

Returns

\GuzzleHttp\ClientInterface

setConfiguration()

setConfiguration(\ElasticEmailClient\ApiConfiguration  $config) : $this

Parameters

\ElasticEmailClient\ApiConfiguration $config

Returns

$this

getConfiguration()

getConfiguration() : \ElasticEmailClient\ApiConfiguration

Returns

\ElasticEmailClient\ApiConfiguration

EEDelete()

EEDelete(\ElasticEmailApi\Guid  $publicSurveyID) 

Deletes the survey

Parameters

\ElasticEmailApi\Guid $publicSurveyID

Survey identifier

Export()

Export(\ElasticEmailApi\Guid  $publicSurveyID, string  $fileName, \ElasticEmailEnums\ExportFileFormats  $fileFormat = \ElasticEmailEnums\ExportFileFormats::Csv, \ElasticEmailEnums\CompressionFormat  $compressionFormat = \ElasticEmailEnums\CompressionFormat::None) : \ElasticEmailEnums\ExportLink

Export given survey's data to provided format

Parameters

\ElasticEmailApi\Guid $publicSurveyID

Survey identifier

string $fileName

Name of your file.

\ElasticEmailEnums\ExportFileFormats $fileFormat

Format of the exported file

\ElasticEmailEnums\CompressionFormat $compressionFormat

FileResponse compression format. None or Zip.

Returns

\ElasticEmailEnums\ExportLink

EEList()

EEList() : \ElasticEmailApi\Array<\ElasticEmailEnums\Survey>

Shows all your existing surveys

Returns

\ElasticEmailApi\Array<\ElasticEmailEnums\Survey>

LoadResponseList()

LoadResponseList(\ElasticEmailApi\Guid  $publicSurveyID) : \ElasticEmailApi\Array<\ElasticEmailEnums\SurveyResultInfo>

Get list of personal answers for the specific survey

Parameters

\ElasticEmailApi\Guid $publicSurveyID

Survey identifier

Returns

\ElasticEmailApi\Array<\ElasticEmailEnums\SurveyResultInfo>

LoadResults()

LoadResults(\ElasticEmailApi\Guid  $publicSurveyID) : \ElasticEmailEnums\SurveyResultsSummaryInfo

Get general results of the specific survey

Parameters

\ElasticEmailApi\Guid $publicSurveyID

Survey identifier

Returns

\ElasticEmailEnums\SurveyResultsSummaryInfo

sendRequest()

sendRequest(string  $url, array  $data = array(), string  $method = 'POST', array  $attachments = array()) : \Psr\Http\Message\ResponseInterface

Parameters

string $url
array $data
string $method
array $attachments

Throws

\Exception

Returns

\Psr\Http\Message\ResponseInterface

parseMultipart()

parseMultipart(array  $attachments, array  $params) : array

Parameters

array $attachments
array $params

Returns

array