1351 lines
53 KiB
PHP
1351 lines
53 KiB
PHP
<?php
|
|
/**
|
|
* TransactionalSMSApi
|
|
* PHP version 5
|
|
*
|
|
* @category Class
|
|
* @package SendinBlue\Client
|
|
* @author Swagger Codegen team
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
|
*/
|
|
|
|
/**
|
|
* SendinBlue API
|
|
*
|
|
* SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
|
|
*
|
|
* OpenAPI spec version: 3.0.0
|
|
* Contact: contact@sendinblue.com
|
|
* Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
* Swagger Codegen version: 2.4.12
|
|
*/
|
|
|
|
/**
|
|
* NOTE: This class is auto generated by the swagger code generator program.
|
|
* https://github.com/swagger-api/swagger-codegen
|
|
* Do not edit the class manually.
|
|
*/
|
|
|
|
namespace SendinBlue\Client\Api;
|
|
|
|
use GuzzleHttp\Client;
|
|
use GuzzleHttp\ClientInterface;
|
|
use GuzzleHttp\Exception\RequestException;
|
|
use GuzzleHttp\Psr7\MultipartStream;
|
|
use GuzzleHttp\Psr7\Request;
|
|
use GuzzleHttp\RequestOptions;
|
|
use SendinBlue\Client\ApiException;
|
|
use SendinBlue\Client\Configuration;
|
|
use SendinBlue\Client\HeaderSelector;
|
|
use SendinBlue\Client\ObjectSerializer;
|
|
|
|
/**
|
|
* TransactionalSMSApi Class Doc Comment
|
|
*
|
|
* @category Class
|
|
* @package SendinBlue\Client
|
|
* @author Swagger Codegen team
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
|
*/
|
|
class TransactionalSMSApi
|
|
{
|
|
/**
|
|
* @var ClientInterface
|
|
*/
|
|
protected $client;
|
|
|
|
/**
|
|
* @var Configuration
|
|
*/
|
|
protected $config;
|
|
|
|
/**
|
|
* @var HeaderSelector
|
|
*/
|
|
protected $headerSelector;
|
|
|
|
/**
|
|
* @param ClientInterface $client
|
|
* @param Configuration $config
|
|
* @param HeaderSelector $selector
|
|
*/
|
|
public function __construct(
|
|
ClientInterface $client = null,
|
|
Configuration $config = null,
|
|
HeaderSelector $selector = null
|
|
) {
|
|
$this->client = $client ?: new Client();
|
|
$this->config = $config ?: new Configuration();
|
|
$this->headerSelector = $selector ?: new HeaderSelector();
|
|
}
|
|
|
|
/**
|
|
* @return Configuration
|
|
*/
|
|
public function getConfig()
|
|
{
|
|
return $this->config;
|
|
}
|
|
|
|
/**
|
|
* Operation getSmsEvents
|
|
*
|
|
* Get all the SMS activity (unaggregated events)
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $offset Index of the first document of the page (optional, default to 0)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
|
|
* @param string $phoneNumber Filter the report for a specific phone number (optional)
|
|
* @param string $event Filter the report for specific events (optional)
|
|
* @param string $tags Filter the report for specific tags passed as a serialized urlencoded array (optional)
|
|
*
|
|
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return \SendinBlue\Client\Model\GetSmsEventReport
|
|
*/
|
|
public function getSmsEvents($limit = '50', $startDate = null, $endDate = null, $offset = '0', $days = null, $phoneNumber = null, $event = null, $tags = null)
|
|
{
|
|
list($response) = $this->getSmsEventsWithHttpInfo($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags);
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Operation getSmsEventsWithHttpInfo
|
|
*
|
|
* Get all the SMS activity (unaggregated events)
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $offset Index of the first document of the page (optional, default to 0)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
|
|
* @param string $phoneNumber Filter the report for a specific phone number (optional)
|
|
* @param string $event Filter the report for specific events (optional)
|
|
* @param string $tags Filter the report for specific tags passed as a serialized urlencoded array (optional)
|
|
*
|
|
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of \SendinBlue\Client\Model\GetSmsEventReport, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function getSmsEventsWithHttpInfo($limit = '50', $startDate = null, $endDate = null, $offset = '0', $days = null, $phoneNumber = null, $event = null, $tags = null)
|
|
{
|
|
$returnType = '\SendinBlue\Client\Model\GetSmsEventReport';
|
|
$request = $this->getSmsEventsRequest($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags);
|
|
|
|
try {
|
|
$options = $this->createHttpClientOption();
|
|
try {
|
|
$response = $this->client->send($request, $options);
|
|
} catch (RequestException $e) {
|
|
throw new ApiException(
|
|
"[{$e->getCode()}] {$e->getMessage()}",
|
|
$e->getCode(),
|
|
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
|
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
|
);
|
|
}
|
|
|
|
$statusCode = $response->getStatusCode();
|
|
|
|
if ($statusCode < 200 || $statusCode > 299) {
|
|
throw new ApiException(
|
|
sprintf(
|
|
'[%d] Error connecting to the API (%s)',
|
|
$statusCode,
|
|
$request->getUri()
|
|
),
|
|
$statusCode,
|
|
$response->getHeaders(),
|
|
$response->getBody()
|
|
);
|
|
}
|
|
|
|
$responseBody = $response->getBody();
|
|
if ($returnType === '\SplFileObject') {
|
|
$content = $responseBody; //stream goes to serializer
|
|
} else {
|
|
$content = $responseBody->getContents();
|
|
if ($returnType !== 'string') {
|
|
$content = json_decode($content);
|
|
}
|
|
}
|
|
|
|
return [
|
|
ObjectSerializer::deserialize($content, $returnType, []),
|
|
$response->getStatusCode(),
|
|
$response->getHeaders()
|
|
];
|
|
|
|
} catch (ApiException $e) {
|
|
switch ($e->getCode()) {
|
|
case 200:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\SendinBlue\Client\Model\GetSmsEventReport',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\SendinBlue\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation getSmsEventsAsync
|
|
*
|
|
* Get all the SMS activity (unaggregated events)
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $offset Index of the first document of the page (optional, default to 0)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
|
|
* @param string $phoneNumber Filter the report for a specific phone number (optional)
|
|
* @param string $event Filter the report for specific events (optional)
|
|
* @param string $tags Filter the report for specific tags passed as a serialized urlencoded array (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getSmsEventsAsync($limit = '50', $startDate = null, $endDate = null, $offset = '0', $days = null, $phoneNumber = null, $event = null, $tags = null)
|
|
{
|
|
return $this->getSmsEventsAsyncWithHttpInfo($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getSmsEventsAsyncWithHttpInfo
|
|
*
|
|
* Get all the SMS activity (unaggregated events)
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $offset Index of the first document of the page (optional, default to 0)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
|
|
* @param string $phoneNumber Filter the report for a specific phone number (optional)
|
|
* @param string $event Filter the report for specific events (optional)
|
|
* @param string $tags Filter the report for specific tags passed as a serialized urlencoded array (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getSmsEventsAsyncWithHttpInfo($limit = '50', $startDate = null, $endDate = null, $offset = '0', $days = null, $phoneNumber = null, $event = null, $tags = null)
|
|
{
|
|
$returnType = '\SendinBlue\Client\Model\GetSmsEventReport';
|
|
$request = $this->getSmsEventsRequest($limit, $startDate, $endDate, $offset, $days, $phoneNumber, $event, $tags);
|
|
|
|
return $this->client
|
|
->sendAsync($request, $this->createHttpClientOption())
|
|
->then(
|
|
function ($response) use ($returnType) {
|
|
$responseBody = $response->getBody();
|
|
if ($returnType === '\SplFileObject') {
|
|
$content = $responseBody; //stream goes to serializer
|
|
} else {
|
|
$content = $responseBody->getContents();
|
|
if ($returnType !== 'string') {
|
|
$content = json_decode($content);
|
|
}
|
|
}
|
|
|
|
return [
|
|
ObjectSerializer::deserialize($content, $returnType, []),
|
|
$response->getStatusCode(),
|
|
$response->getHeaders()
|
|
];
|
|
},
|
|
function ($exception) {
|
|
$response = $exception->getResponse();
|
|
$statusCode = $response->getStatusCode();
|
|
throw new ApiException(
|
|
sprintf(
|
|
'[%d] Error connecting to the API (%s)',
|
|
$statusCode,
|
|
$exception->getRequest()->getUri()
|
|
),
|
|
$statusCode,
|
|
$response->getHeaders(),
|
|
$response->getBody()
|
|
);
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Create request for operation 'getSmsEvents'
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $offset Index of the first document of the page (optional, default to 0)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
|
|
* @param string $phoneNumber Filter the report for a specific phone number (optional)
|
|
* @param string $event Filter the report for specific events (optional)
|
|
* @param string $tags Filter the report for specific tags passed as a serialized urlencoded array (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function getSmsEventsRequest($limit = '50', $startDate = null, $endDate = null, $offset = '0', $days = null, $phoneNumber = null, $event = null, $tags = null)
|
|
{
|
|
if ($limit !== null && $limit > 100) {
|
|
throw new \InvalidArgumentException('invalid value for "$limit" when calling TransactionalSMSApi.getSmsEvents, must be smaller than or equal to 100.');
|
|
}
|
|
|
|
|
|
$resourcePath = '/transactionalSMS/statistics/events';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
// query params
|
|
if ($limit !== null) {
|
|
$queryParams['limit'] = ObjectSerializer::toQueryValue($limit);
|
|
}
|
|
// query params
|
|
if ($startDate !== null) {
|
|
$queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate);
|
|
}
|
|
// query params
|
|
if ($endDate !== null) {
|
|
$queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate);
|
|
}
|
|
// query params
|
|
if ($offset !== null) {
|
|
$queryParams['offset'] = ObjectSerializer::toQueryValue($offset);
|
|
}
|
|
// query params
|
|
if ($days !== null) {
|
|
$queryParams['days'] = ObjectSerializer::toQueryValue($days);
|
|
}
|
|
// query params
|
|
if ($phoneNumber !== null) {
|
|
$queryParams['phoneNumber'] = ObjectSerializer::toQueryValue($phoneNumber);
|
|
}
|
|
// query params
|
|
if ($event !== null) {
|
|
$queryParams['event'] = ObjectSerializer::toQueryValue($event);
|
|
}
|
|
// query params
|
|
if ($tags !== null) {
|
|
$queryParams['tags'] = ObjectSerializer::toQueryValue($tags);
|
|
}
|
|
|
|
|
|
// body params
|
|
$_tempBody = null;
|
|
|
|
if ($multipart) {
|
|
$headers = $this->headerSelector->selectHeadersForMultipart(
|
|
['application/json']
|
|
);
|
|
} else {
|
|
$headers = $this->headerSelector->selectHeaders(
|
|
['application/json'],
|
|
['application/json']
|
|
);
|
|
}
|
|
|
|
// for model (json/xml)
|
|
if (isset($_tempBody)) {
|
|
// $_tempBody is the method argument, if present
|
|
$httpBody = $_tempBody;
|
|
|
|
if($headers['Content-Type'] === 'application/json') {
|
|
// \stdClass has no __toString(), so we should encode it manually
|
|
if ($httpBody instanceof \stdClass) {
|
|
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
|
}
|
|
// array has no __toString(), so we should encode it manually
|
|
if(is_array($httpBody)) {
|
|
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
|
}
|
|
}
|
|
} elseif (count($formParams) > 0) {
|
|
if ($multipart) {
|
|
$multipartContents = [];
|
|
foreach ($formParams as $formParamName => $formParamValue) {
|
|
$multipartContents[] = [
|
|
'name' => $formParamName,
|
|
'contents' => $formParamValue
|
|
];
|
|
}
|
|
// for HTTP post (form)
|
|
$httpBody = new MultipartStream($multipartContents);
|
|
|
|
} elseif ($headers['Content-Type'] === 'application/json') {
|
|
$httpBody = \GuzzleHttp\json_encode($formParams);
|
|
|
|
} else {
|
|
// for HTTP post (form)
|
|
$httpBody = \GuzzleHttp\Psr7\build_query($formParams);
|
|
}
|
|
}
|
|
|
|
// this endpoint requires API key authentication
|
|
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
|
if ($apiKey !== null) {
|
|
$headers['api-key'] = $apiKey;
|
|
}
|
|
// this endpoint requires API key authentication
|
|
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
|
if ($apiKey !== null) {
|
|
$headers['partner-key'] = $apiKey;
|
|
}
|
|
|
|
$defaultHeaders = [];
|
|
if ($this->config->getUserAgent()) {
|
|
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
|
}
|
|
|
|
$headers = array_merge(
|
|
$defaultHeaders,
|
|
$headerParams,
|
|
$headers
|
|
);
|
|
|
|
$query = \GuzzleHttp\Psr7\build_query($queryParams);
|
|
return new Request(
|
|
'GET',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getTransacAggregatedSmsReport
|
|
*
|
|
* Get your SMS activity aggregated over a period of time
|
|
*
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional)
|
|
* @param string $tag Filter on a tag (optional)
|
|
*
|
|
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return \SendinBlue\Client\Model\GetTransacAggregatedSmsReport
|
|
*/
|
|
public function getTransacAggregatedSmsReport($startDate = null, $endDate = null, $days = null, $tag = null)
|
|
{
|
|
list($response) = $this->getTransacAggregatedSmsReportWithHttpInfo($startDate, $endDate, $days, $tag);
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Operation getTransacAggregatedSmsReportWithHttpInfo
|
|
*
|
|
* Get your SMS activity aggregated over a period of time
|
|
*
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional)
|
|
* @param string $tag Filter on a tag (optional)
|
|
*
|
|
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of \SendinBlue\Client\Model\GetTransacAggregatedSmsReport, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function getTransacAggregatedSmsReportWithHttpInfo($startDate = null, $endDate = null, $days = null, $tag = null)
|
|
{
|
|
$returnType = '\SendinBlue\Client\Model\GetTransacAggregatedSmsReport';
|
|
$request = $this->getTransacAggregatedSmsReportRequest($startDate, $endDate, $days, $tag);
|
|
|
|
try {
|
|
$options = $this->createHttpClientOption();
|
|
try {
|
|
$response = $this->client->send($request, $options);
|
|
} catch (RequestException $e) {
|
|
throw new ApiException(
|
|
"[{$e->getCode()}] {$e->getMessage()}",
|
|
$e->getCode(),
|
|
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
|
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
|
);
|
|
}
|
|
|
|
$statusCode = $response->getStatusCode();
|
|
|
|
if ($statusCode < 200 || $statusCode > 299) {
|
|
throw new ApiException(
|
|
sprintf(
|
|
'[%d] Error connecting to the API (%s)',
|
|
$statusCode,
|
|
$request->getUri()
|
|
),
|
|
$statusCode,
|
|
$response->getHeaders(),
|
|
$response->getBody()
|
|
);
|
|
}
|
|
|
|
$responseBody = $response->getBody();
|
|
if ($returnType === '\SplFileObject') {
|
|
$content = $responseBody; //stream goes to serializer
|
|
} else {
|
|
$content = $responseBody->getContents();
|
|
if ($returnType !== 'string') {
|
|
$content = json_decode($content);
|
|
}
|
|
}
|
|
|
|
return [
|
|
ObjectSerializer::deserialize($content, $returnType, []),
|
|
$response->getStatusCode(),
|
|
$response->getHeaders()
|
|
];
|
|
|
|
} catch (ApiException $e) {
|
|
switch ($e->getCode()) {
|
|
case 200:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\SendinBlue\Client\Model\GetTransacAggregatedSmsReport',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\SendinBlue\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation getTransacAggregatedSmsReportAsync
|
|
*
|
|
* Get your SMS activity aggregated over a period of time
|
|
*
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional)
|
|
* @param string $tag Filter on a tag (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getTransacAggregatedSmsReportAsync($startDate = null, $endDate = null, $days = null, $tag = null)
|
|
{
|
|
return $this->getTransacAggregatedSmsReportAsyncWithHttpInfo($startDate, $endDate, $days, $tag)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getTransacAggregatedSmsReportAsyncWithHttpInfo
|
|
*
|
|
* Get your SMS activity aggregated over a period of time
|
|
*
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional)
|
|
* @param string $tag Filter on a tag (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getTransacAggregatedSmsReportAsyncWithHttpInfo($startDate = null, $endDate = null, $days = null, $tag = null)
|
|
{
|
|
$returnType = '\SendinBlue\Client\Model\GetTransacAggregatedSmsReport';
|
|
$request = $this->getTransacAggregatedSmsReportRequest($startDate, $endDate, $days, $tag);
|
|
|
|
return $this->client
|
|
->sendAsync($request, $this->createHttpClientOption())
|
|
->then(
|
|
function ($response) use ($returnType) {
|
|
$responseBody = $response->getBody();
|
|
if ($returnType === '\SplFileObject') {
|
|
$content = $responseBody; //stream goes to serializer
|
|
} else {
|
|
$content = $responseBody->getContents();
|
|
if ($returnType !== 'string') {
|
|
$content = json_decode($content);
|
|
}
|
|
}
|
|
|
|
return [
|
|
ObjectSerializer::deserialize($content, $returnType, []),
|
|
$response->getStatusCode(),
|
|
$response->getHeaders()
|
|
];
|
|
},
|
|
function ($exception) {
|
|
$response = $exception->getResponse();
|
|
$statusCode = $response->getStatusCode();
|
|
throw new ApiException(
|
|
sprintf(
|
|
'[%d] Error connecting to the API (%s)',
|
|
$statusCode,
|
|
$exception->getRequest()->getUri()
|
|
),
|
|
$statusCode,
|
|
$response->getHeaders(),
|
|
$response->getBody()
|
|
);
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Create request for operation 'getTransacAggregatedSmsReport'
|
|
*
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with startDate and endDate (optional)
|
|
* @param string $tag Filter on a tag (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function getTransacAggregatedSmsReportRequest($startDate = null, $endDate = null, $days = null, $tag = null)
|
|
{
|
|
|
|
$resourcePath = '/transactionalSMS/statistics/aggregatedReport';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
// query params
|
|
if ($startDate !== null) {
|
|
$queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate);
|
|
}
|
|
// query params
|
|
if ($endDate !== null) {
|
|
$queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate);
|
|
}
|
|
// query params
|
|
if ($days !== null) {
|
|
$queryParams['days'] = ObjectSerializer::toQueryValue($days);
|
|
}
|
|
// query params
|
|
if ($tag !== null) {
|
|
$queryParams['tag'] = ObjectSerializer::toQueryValue($tag);
|
|
}
|
|
|
|
|
|
// body params
|
|
$_tempBody = null;
|
|
|
|
if ($multipart) {
|
|
$headers = $this->headerSelector->selectHeadersForMultipart(
|
|
['application/json']
|
|
);
|
|
} else {
|
|
$headers = $this->headerSelector->selectHeaders(
|
|
['application/json'],
|
|
['application/json']
|
|
);
|
|
}
|
|
|
|
// for model (json/xml)
|
|
if (isset($_tempBody)) {
|
|
// $_tempBody is the method argument, if present
|
|
$httpBody = $_tempBody;
|
|
|
|
if($headers['Content-Type'] === 'application/json') {
|
|
// \stdClass has no __toString(), so we should encode it manually
|
|
if ($httpBody instanceof \stdClass) {
|
|
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
|
}
|
|
// array has no __toString(), so we should encode it manually
|
|
if(is_array($httpBody)) {
|
|
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
|
}
|
|
}
|
|
} elseif (count($formParams) > 0) {
|
|
if ($multipart) {
|
|
$multipartContents = [];
|
|
foreach ($formParams as $formParamName => $formParamValue) {
|
|
$multipartContents[] = [
|
|
'name' => $formParamName,
|
|
'contents' => $formParamValue
|
|
];
|
|
}
|
|
// for HTTP post (form)
|
|
$httpBody = new MultipartStream($multipartContents);
|
|
|
|
} elseif ($headers['Content-Type'] === 'application/json') {
|
|
$httpBody = \GuzzleHttp\json_encode($formParams);
|
|
|
|
} else {
|
|
// for HTTP post (form)
|
|
$httpBody = \GuzzleHttp\Psr7\build_query($formParams);
|
|
}
|
|
}
|
|
|
|
// this endpoint requires API key authentication
|
|
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
|
if ($apiKey !== null) {
|
|
$headers['api-key'] = $apiKey;
|
|
}
|
|
// this endpoint requires API key authentication
|
|
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
|
if ($apiKey !== null) {
|
|
$headers['partner-key'] = $apiKey;
|
|
}
|
|
|
|
$defaultHeaders = [];
|
|
if ($this->config->getUserAgent()) {
|
|
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
|
}
|
|
|
|
$headers = array_merge(
|
|
$defaultHeaders,
|
|
$headerParams,
|
|
$headers
|
|
);
|
|
|
|
$query = \GuzzleHttp\Psr7\build_query($queryParams);
|
|
return new Request(
|
|
'GET',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getTransacSmsReport
|
|
*
|
|
* Get your SMS activity aggregated per day
|
|
*
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
|
|
* @param string $tag Filter on a tag (optional)
|
|
*
|
|
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return \SendinBlue\Client\Model\GetTransacSmsReport
|
|
*/
|
|
public function getTransacSmsReport($startDate = null, $endDate = null, $days = null, $tag = null)
|
|
{
|
|
list($response) = $this->getTransacSmsReportWithHttpInfo($startDate, $endDate, $days, $tag);
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Operation getTransacSmsReportWithHttpInfo
|
|
*
|
|
* Get your SMS activity aggregated per day
|
|
*
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
|
|
* @param string $tag Filter on a tag (optional)
|
|
*
|
|
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of \SendinBlue\Client\Model\GetTransacSmsReport, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function getTransacSmsReportWithHttpInfo($startDate = null, $endDate = null, $days = null, $tag = null)
|
|
{
|
|
$returnType = '\SendinBlue\Client\Model\GetTransacSmsReport';
|
|
$request = $this->getTransacSmsReportRequest($startDate, $endDate, $days, $tag);
|
|
|
|
try {
|
|
$options = $this->createHttpClientOption();
|
|
try {
|
|
$response = $this->client->send($request, $options);
|
|
} catch (RequestException $e) {
|
|
throw new ApiException(
|
|
"[{$e->getCode()}] {$e->getMessage()}",
|
|
$e->getCode(),
|
|
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
|
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
|
);
|
|
}
|
|
|
|
$statusCode = $response->getStatusCode();
|
|
|
|
if ($statusCode < 200 || $statusCode > 299) {
|
|
throw new ApiException(
|
|
sprintf(
|
|
'[%d] Error connecting to the API (%s)',
|
|
$statusCode,
|
|
$request->getUri()
|
|
),
|
|
$statusCode,
|
|
$response->getHeaders(),
|
|
$response->getBody()
|
|
);
|
|
}
|
|
|
|
$responseBody = $response->getBody();
|
|
if ($returnType === '\SplFileObject') {
|
|
$content = $responseBody; //stream goes to serializer
|
|
} else {
|
|
$content = $responseBody->getContents();
|
|
if ($returnType !== 'string') {
|
|
$content = json_decode($content);
|
|
}
|
|
}
|
|
|
|
return [
|
|
ObjectSerializer::deserialize($content, $returnType, []),
|
|
$response->getStatusCode(),
|
|
$response->getHeaders()
|
|
];
|
|
|
|
} catch (ApiException $e) {
|
|
switch ($e->getCode()) {
|
|
case 200:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\SendinBlue\Client\Model\GetTransacSmsReport',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\SendinBlue\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation getTransacSmsReportAsync
|
|
*
|
|
* Get your SMS activity aggregated per day
|
|
*
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
|
|
* @param string $tag Filter on a tag (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getTransacSmsReportAsync($startDate = null, $endDate = null, $days = null, $tag = null)
|
|
{
|
|
return $this->getTransacSmsReportAsyncWithHttpInfo($startDate, $endDate, $days, $tag)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getTransacSmsReportAsyncWithHttpInfo
|
|
*
|
|
* Get your SMS activity aggregated per day
|
|
*
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
|
|
* @param string $tag Filter on a tag (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getTransacSmsReportAsyncWithHttpInfo($startDate = null, $endDate = null, $days = null, $tag = null)
|
|
{
|
|
$returnType = '\SendinBlue\Client\Model\GetTransacSmsReport';
|
|
$request = $this->getTransacSmsReportRequest($startDate, $endDate, $days, $tag);
|
|
|
|
return $this->client
|
|
->sendAsync($request, $this->createHttpClientOption())
|
|
->then(
|
|
function ($response) use ($returnType) {
|
|
$responseBody = $response->getBody();
|
|
if ($returnType === '\SplFileObject') {
|
|
$content = $responseBody; //stream goes to serializer
|
|
} else {
|
|
$content = $responseBody->getContents();
|
|
if ($returnType !== 'string') {
|
|
$content = json_decode($content);
|
|
}
|
|
}
|
|
|
|
return [
|
|
ObjectSerializer::deserialize($content, $returnType, []),
|
|
$response->getStatusCode(),
|
|
$response->getHeaders()
|
|
];
|
|
},
|
|
function ($exception) {
|
|
$response = $exception->getResponse();
|
|
$statusCode = $response->getStatusCode();
|
|
throw new ApiException(
|
|
sprintf(
|
|
'[%d] Error connecting to the API (%s)',
|
|
$statusCode,
|
|
$exception->getRequest()->getUri()
|
|
),
|
|
$statusCode,
|
|
$response->getHeaders(),
|
|
$response->getBody()
|
|
);
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Create request for operation 'getTransacSmsReport'
|
|
*
|
|
* @param string $startDate Mandatory if endDate is used. Starting date (YYYY-MM-DD) of the report (optional)
|
|
* @param string $endDate Mandatory if startDate is used. Ending date (YYYY-MM-DD) of the report (optional)
|
|
* @param int $days Number of days in the past including today (positive integer). Not compatible with 'startDate' and 'endDate' (optional)
|
|
* @param string $tag Filter on a tag (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function getTransacSmsReportRequest($startDate = null, $endDate = null, $days = null, $tag = null)
|
|
{
|
|
|
|
$resourcePath = '/transactionalSMS/statistics/reports';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
// query params
|
|
if ($startDate !== null) {
|
|
$queryParams['startDate'] = ObjectSerializer::toQueryValue($startDate);
|
|
}
|
|
// query params
|
|
if ($endDate !== null) {
|
|
$queryParams['endDate'] = ObjectSerializer::toQueryValue($endDate);
|
|
}
|
|
// query params
|
|
if ($days !== null) {
|
|
$queryParams['days'] = ObjectSerializer::toQueryValue($days);
|
|
}
|
|
// query params
|
|
if ($tag !== null) {
|
|
$queryParams['tag'] = ObjectSerializer::toQueryValue($tag);
|
|
}
|
|
|
|
|
|
// body params
|
|
$_tempBody = null;
|
|
|
|
if ($multipart) {
|
|
$headers = $this->headerSelector->selectHeadersForMultipart(
|
|
['application/json']
|
|
);
|
|
} else {
|
|
$headers = $this->headerSelector->selectHeaders(
|
|
['application/json'],
|
|
['application/json']
|
|
);
|
|
}
|
|
|
|
// for model (json/xml)
|
|
if (isset($_tempBody)) {
|
|
// $_tempBody is the method argument, if present
|
|
$httpBody = $_tempBody;
|
|
|
|
if($headers['Content-Type'] === 'application/json') {
|
|
// \stdClass has no __toString(), so we should encode it manually
|
|
if ($httpBody instanceof \stdClass) {
|
|
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
|
}
|
|
// array has no __toString(), so we should encode it manually
|
|
if(is_array($httpBody)) {
|
|
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
|
}
|
|
}
|
|
} elseif (count($formParams) > 0) {
|
|
if ($multipart) {
|
|
$multipartContents = [];
|
|
foreach ($formParams as $formParamName => $formParamValue) {
|
|
$multipartContents[] = [
|
|
'name' => $formParamName,
|
|
'contents' => $formParamValue
|
|
];
|
|
}
|
|
// for HTTP post (form)
|
|
$httpBody = new MultipartStream($multipartContents);
|
|
|
|
} elseif ($headers['Content-Type'] === 'application/json') {
|
|
$httpBody = \GuzzleHttp\json_encode($formParams);
|
|
|
|
} else {
|
|
// for HTTP post (form)
|
|
$httpBody = \GuzzleHttp\Psr7\build_query($formParams);
|
|
}
|
|
}
|
|
|
|
// this endpoint requires API key authentication
|
|
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
|
if ($apiKey !== null) {
|
|
$headers['api-key'] = $apiKey;
|
|
}
|
|
// this endpoint requires API key authentication
|
|
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
|
if ($apiKey !== null) {
|
|
$headers['partner-key'] = $apiKey;
|
|
}
|
|
|
|
$defaultHeaders = [];
|
|
if ($this->config->getUserAgent()) {
|
|
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
|
}
|
|
|
|
$headers = array_merge(
|
|
$defaultHeaders,
|
|
$headerParams,
|
|
$headers
|
|
);
|
|
|
|
$query = \GuzzleHttp\Psr7\build_query($queryParams);
|
|
return new Request(
|
|
'GET',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation sendTransacSms
|
|
*
|
|
* Send the SMS campaign to the specified mobile number
|
|
*
|
|
* @param \SendinBlue\Client\Model\SendTransacSms $sendTransacSms Values to send a transactional SMS (required)
|
|
*
|
|
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return \SendinBlue\Client\Model\SendSms
|
|
*/
|
|
public function sendTransacSms($sendTransacSms)
|
|
{
|
|
list($response) = $this->sendTransacSmsWithHttpInfo($sendTransacSms);
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Operation sendTransacSmsWithHttpInfo
|
|
*
|
|
* Send the SMS campaign to the specified mobile number
|
|
*
|
|
* @param \SendinBlue\Client\Model\SendTransacSms $sendTransacSms Values to send a transactional SMS (required)
|
|
*
|
|
* @throws \SendinBlue\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of \SendinBlue\Client\Model\SendSms, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function sendTransacSmsWithHttpInfo($sendTransacSms)
|
|
{
|
|
$returnType = '\SendinBlue\Client\Model\SendSms';
|
|
$request = $this->sendTransacSmsRequest($sendTransacSms);
|
|
|
|
try {
|
|
$options = $this->createHttpClientOption();
|
|
try {
|
|
$response = $this->client->send($request, $options);
|
|
} catch (RequestException $e) {
|
|
throw new ApiException(
|
|
"[{$e->getCode()}] {$e->getMessage()}",
|
|
$e->getCode(),
|
|
$e->getResponse() ? $e->getResponse()->getHeaders() : null,
|
|
$e->getResponse() ? $e->getResponse()->getBody()->getContents() : null
|
|
);
|
|
}
|
|
|
|
$statusCode = $response->getStatusCode();
|
|
|
|
if ($statusCode < 200 || $statusCode > 299) {
|
|
throw new ApiException(
|
|
sprintf(
|
|
'[%d] Error connecting to the API (%s)',
|
|
$statusCode,
|
|
$request->getUri()
|
|
),
|
|
$statusCode,
|
|
$response->getHeaders(),
|
|
$response->getBody()
|
|
);
|
|
}
|
|
|
|
$responseBody = $response->getBody();
|
|
if ($returnType === '\SplFileObject') {
|
|
$content = $responseBody; //stream goes to serializer
|
|
} else {
|
|
$content = $responseBody->getContents();
|
|
if ($returnType !== 'string') {
|
|
$content = json_decode($content);
|
|
}
|
|
}
|
|
|
|
return [
|
|
ObjectSerializer::deserialize($content, $returnType, []),
|
|
$response->getStatusCode(),
|
|
$response->getHeaders()
|
|
];
|
|
|
|
} catch (ApiException $e) {
|
|
switch ($e->getCode()) {
|
|
case 201:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\SendinBlue\Client\Model\SendSms',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\SendinBlue\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 402:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\SendinBlue\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation sendTransacSmsAsync
|
|
*
|
|
* Send the SMS campaign to the specified mobile number
|
|
*
|
|
* @param \SendinBlue\Client\Model\SendTransacSms $sendTransacSms Values to send a transactional SMS (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function sendTransacSmsAsync($sendTransacSms)
|
|
{
|
|
return $this->sendTransacSmsAsyncWithHttpInfo($sendTransacSms)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation sendTransacSmsAsyncWithHttpInfo
|
|
*
|
|
* Send the SMS campaign to the specified mobile number
|
|
*
|
|
* @param \SendinBlue\Client\Model\SendTransacSms $sendTransacSms Values to send a transactional SMS (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function sendTransacSmsAsyncWithHttpInfo($sendTransacSms)
|
|
{
|
|
$returnType = '\SendinBlue\Client\Model\SendSms';
|
|
$request = $this->sendTransacSmsRequest($sendTransacSms);
|
|
|
|
return $this->client
|
|
->sendAsync($request, $this->createHttpClientOption())
|
|
->then(
|
|
function ($response) use ($returnType) {
|
|
$responseBody = $response->getBody();
|
|
if ($returnType === '\SplFileObject') {
|
|
$content = $responseBody; //stream goes to serializer
|
|
} else {
|
|
$content = $responseBody->getContents();
|
|
if ($returnType !== 'string') {
|
|
$content = json_decode($content);
|
|
}
|
|
}
|
|
|
|
return [
|
|
ObjectSerializer::deserialize($content, $returnType, []),
|
|
$response->getStatusCode(),
|
|
$response->getHeaders()
|
|
];
|
|
},
|
|
function ($exception) {
|
|
$response = $exception->getResponse();
|
|
$statusCode = $response->getStatusCode();
|
|
throw new ApiException(
|
|
sprintf(
|
|
'[%d] Error connecting to the API (%s)',
|
|
$statusCode,
|
|
$exception->getRequest()->getUri()
|
|
),
|
|
$statusCode,
|
|
$response->getHeaders(),
|
|
$response->getBody()
|
|
);
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Create request for operation 'sendTransacSms'
|
|
*
|
|
* @param \SendinBlue\Client\Model\SendTransacSms $sendTransacSms Values to send a transactional SMS (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function sendTransacSmsRequest($sendTransacSms)
|
|
{
|
|
// verify the required parameter 'sendTransacSms' is set
|
|
if ($sendTransacSms === null || (is_array($sendTransacSms) && count($sendTransacSms) === 0)) {
|
|
throw new \InvalidArgumentException(
|
|
'Missing the required parameter $sendTransacSms when calling sendTransacSms'
|
|
);
|
|
}
|
|
|
|
$resourcePath = '/transactionalSMS/sms';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
|
|
|
|
// body params
|
|
$_tempBody = null;
|
|
if (isset($sendTransacSms)) {
|
|
$_tempBody = $sendTransacSms;
|
|
}
|
|
|
|
if ($multipart) {
|
|
$headers = $this->headerSelector->selectHeadersForMultipart(
|
|
['application/json']
|
|
);
|
|
} else {
|
|
$headers = $this->headerSelector->selectHeaders(
|
|
['application/json'],
|
|
['application/json']
|
|
);
|
|
}
|
|
|
|
// for model (json/xml)
|
|
if (isset($_tempBody)) {
|
|
// $_tempBody is the method argument, if present
|
|
$httpBody = $_tempBody;
|
|
|
|
if($headers['Content-Type'] === 'application/json') {
|
|
// \stdClass has no __toString(), so we should encode it manually
|
|
if ($httpBody instanceof \stdClass) {
|
|
$httpBody = \GuzzleHttp\json_encode($httpBody);
|
|
}
|
|
// array has no __toString(), so we should encode it manually
|
|
if(is_array($httpBody)) {
|
|
$httpBody = \GuzzleHttp\json_encode(ObjectSerializer::sanitizeForSerialization($httpBody));
|
|
}
|
|
}
|
|
} elseif (count($formParams) > 0) {
|
|
if ($multipart) {
|
|
$multipartContents = [];
|
|
foreach ($formParams as $formParamName => $formParamValue) {
|
|
$multipartContents[] = [
|
|
'name' => $formParamName,
|
|
'contents' => $formParamValue
|
|
];
|
|
}
|
|
// for HTTP post (form)
|
|
$httpBody = new MultipartStream($multipartContents);
|
|
|
|
} elseif ($headers['Content-Type'] === 'application/json') {
|
|
$httpBody = \GuzzleHttp\json_encode($formParams);
|
|
|
|
} else {
|
|
// for HTTP post (form)
|
|
$httpBody = \GuzzleHttp\Psr7\build_query($formParams);
|
|
}
|
|
}
|
|
|
|
// this endpoint requires API key authentication
|
|
$apiKey = $this->config->getApiKeyWithPrefix('api-key');
|
|
if ($apiKey !== null) {
|
|
$headers['api-key'] = $apiKey;
|
|
}
|
|
// this endpoint requires API key authentication
|
|
$apiKey = $this->config->getApiKeyWithPrefix('partner-key');
|
|
if ($apiKey !== null) {
|
|
$headers['partner-key'] = $apiKey;
|
|
}
|
|
|
|
$defaultHeaders = [];
|
|
if ($this->config->getUserAgent()) {
|
|
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
|
|
}
|
|
|
|
$headers = array_merge(
|
|
$defaultHeaders,
|
|
$headerParams,
|
|
$headers
|
|
);
|
|
|
|
$query = \GuzzleHttp\Psr7\build_query($queryParams);
|
|
return new Request(
|
|
'POST',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Create http client option
|
|
*
|
|
* @throws \RuntimeException on file opening failure
|
|
* @return array of http client options
|
|
*/
|
|
protected function createHttpClientOption()
|
|
{
|
|
$options = [];
|
|
if ($this->config->getDebug()) {
|
|
$options[RequestOptions::DEBUG] = fopen($this->config->getDebugFile(), 'a');
|
|
if (!$options[RequestOptions::DEBUG]) {
|
|
throw new \RuntimeException('Failed to open the debug file: ' . $this->config->getDebugFile());
|
|
}
|
|
}
|
|
|
|
return $options;
|
|
}
|
|
}
|