3614 lines
137 KiB
PHP
3614 lines
137 KiB
PHP
<?php
|
|
/**
|
|
* EcommerceApi
|
|
* PHP version 5
|
|
*
|
|
* @category Class
|
|
* @package Brevo\Client
|
|
* @author Swagger Codegen team
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
|
*/
|
|
|
|
/**
|
|
* Brevo API
|
|
*
|
|
* Brevo 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/brevo **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@brevo.com
|
|
* Generated by: https://github.com/swagger-api/swagger-codegen.git
|
|
* Swagger Codegen version: 2.4.29
|
|
*/
|
|
|
|
/**
|
|
* 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 Brevo\Client\Api;
|
|
|
|
use GuzzleHttp\Client;
|
|
use GuzzleHttp\ClientInterface;
|
|
use GuzzleHttp\Exception\RequestException;
|
|
use GuzzleHttp\Psr7\MultipartStream;
|
|
use GuzzleHttp\Psr7\Request;
|
|
use GuzzleHttp\RequestOptions;
|
|
use Brevo\Client\ApiException;
|
|
use Brevo\Client\Configuration;
|
|
use Brevo\Client\HeaderSelector;
|
|
use Brevo\Client\ObjectSerializer;
|
|
|
|
/**
|
|
* EcommerceApi Class Doc Comment
|
|
*
|
|
* @category Class
|
|
* @package Brevo\Client
|
|
* @author Swagger Codegen team
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
|
*/
|
|
class EcommerceApi
|
|
{
|
|
/**
|
|
* @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 createBatchOrder
|
|
*
|
|
* Create orders in batch
|
|
*
|
|
* @param \Brevo\Client\Model\OrderBatch $orderBatch orderBatch (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return void
|
|
*/
|
|
public function createBatchOrder($orderBatch)
|
|
{
|
|
$this->createBatchOrderWithHttpInfo($orderBatch);
|
|
}
|
|
|
|
/**
|
|
* Operation createBatchOrderWithHttpInfo
|
|
*
|
|
* Create orders in batch
|
|
*
|
|
* @param \Brevo\Client\Model\OrderBatch $orderBatch (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of null, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function createBatchOrderWithHttpInfo($orderBatch)
|
|
{
|
|
$returnType = '';
|
|
$request = $this->createBatchOrderRequest($orderBatch);
|
|
|
|
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()
|
|
);
|
|
}
|
|
|
|
return [null, $statusCode, $response->getHeaders()];
|
|
|
|
} catch (ApiException $e) {
|
|
switch ($e->getCode()) {
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation createBatchOrderAsync
|
|
*
|
|
* Create orders in batch
|
|
*
|
|
* @param \Brevo\Client\Model\OrderBatch $orderBatch (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function createBatchOrderAsync($orderBatch)
|
|
{
|
|
return $this->createBatchOrderAsyncWithHttpInfo($orderBatch)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation createBatchOrderAsyncWithHttpInfo
|
|
*
|
|
* Create orders in batch
|
|
*
|
|
* @param \Brevo\Client\Model\OrderBatch $orderBatch (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function createBatchOrderAsyncWithHttpInfo($orderBatch)
|
|
{
|
|
$returnType = '';
|
|
$request = $this->createBatchOrderRequest($orderBatch);
|
|
|
|
return $this->client
|
|
->sendAsync($request, $this->createHttpClientOption())
|
|
->then(
|
|
function ($response) use ($returnType) {
|
|
return [null, $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 'createBatchOrder'
|
|
*
|
|
* @param \Brevo\Client\Model\OrderBatch $orderBatch (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function createBatchOrderRequest($orderBatch)
|
|
{
|
|
// verify the required parameter 'orderBatch' is set
|
|
if ($orderBatch === null || (is_array($orderBatch) && count($orderBatch) === 0)) {
|
|
throw new \InvalidArgumentException(
|
|
'Missing the required parameter $orderBatch when calling createBatchOrder'
|
|
);
|
|
}
|
|
|
|
$resourcePath = '/orders/status/batch';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
|
|
|
|
// body params
|
|
$_tempBody = null;
|
|
if (isset($orderBatch)) {
|
|
$_tempBody = $orderBatch;
|
|
}
|
|
|
|
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\Query::build($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\Query::build($queryParams);
|
|
return new Request(
|
|
'POST',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation createOrder
|
|
*
|
|
* Managing the status of the order
|
|
*
|
|
* @param \Brevo\Client\Model\Order $order order (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return void
|
|
*/
|
|
public function createOrder($order)
|
|
{
|
|
$this->createOrderWithHttpInfo($order);
|
|
}
|
|
|
|
/**
|
|
* Operation createOrderWithHttpInfo
|
|
*
|
|
* Managing the status of the order
|
|
*
|
|
* @param \Brevo\Client\Model\Order $order (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of null, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function createOrderWithHttpInfo($order)
|
|
{
|
|
$returnType = '';
|
|
$request = $this->createOrderRequest($order);
|
|
|
|
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()
|
|
);
|
|
}
|
|
|
|
return [null, $statusCode, $response->getHeaders()];
|
|
|
|
} catch (ApiException $e) {
|
|
switch ($e->getCode()) {
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation createOrderAsync
|
|
*
|
|
* Managing the status of the order
|
|
*
|
|
* @param \Brevo\Client\Model\Order $order (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function createOrderAsync($order)
|
|
{
|
|
return $this->createOrderAsyncWithHttpInfo($order)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation createOrderAsyncWithHttpInfo
|
|
*
|
|
* Managing the status of the order
|
|
*
|
|
* @param \Brevo\Client\Model\Order $order (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function createOrderAsyncWithHttpInfo($order)
|
|
{
|
|
$returnType = '';
|
|
$request = $this->createOrderRequest($order);
|
|
|
|
return $this->client
|
|
->sendAsync($request, $this->createHttpClientOption())
|
|
->then(
|
|
function ($response) use ($returnType) {
|
|
return [null, $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 'createOrder'
|
|
*
|
|
* @param \Brevo\Client\Model\Order $order (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function createOrderRequest($order)
|
|
{
|
|
// verify the required parameter 'order' is set
|
|
if ($order === null || (is_array($order) && count($order) === 0)) {
|
|
throw new \InvalidArgumentException(
|
|
'Missing the required parameter $order when calling createOrder'
|
|
);
|
|
}
|
|
|
|
$resourcePath = '/orders/status';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
|
|
|
|
// body params
|
|
$_tempBody = null;
|
|
if (isset($order)) {
|
|
$_tempBody = $order;
|
|
}
|
|
|
|
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\Query::build($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\Query::build($queryParams);
|
|
return new Request(
|
|
'POST',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateBatchCategory
|
|
*
|
|
* Create categories in batch
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateBatchCategory $createUpdateBatchCategory Values to create a batch of categories (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return \Brevo\Client\Model\CreateUpdateBatchCategoryModel
|
|
*/
|
|
public function createUpdateBatchCategory($createUpdateBatchCategory)
|
|
{
|
|
list($response) = $this->createUpdateBatchCategoryWithHttpInfo($createUpdateBatchCategory);
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateBatchCategoryWithHttpInfo
|
|
*
|
|
* Create categories in batch
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateBatchCategory $createUpdateBatchCategory Values to create a batch of categories (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of \Brevo\Client\Model\CreateUpdateBatchCategoryModel, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function createUpdateBatchCategoryWithHttpInfo($createUpdateBatchCategory)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\CreateUpdateBatchCategoryModel';
|
|
$request = $this->createUpdateBatchCategoryRequest($createUpdateBatchCategory);
|
|
|
|
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(),
|
|
'\Brevo\Client\Model\CreateUpdateBatchCategoryModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateBatchCategoryAsync
|
|
*
|
|
* Create categories in batch
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateBatchCategory $createUpdateBatchCategory Values to create a batch of categories (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function createUpdateBatchCategoryAsync($createUpdateBatchCategory)
|
|
{
|
|
return $this->createUpdateBatchCategoryAsyncWithHttpInfo($createUpdateBatchCategory)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateBatchCategoryAsyncWithHttpInfo
|
|
*
|
|
* Create categories in batch
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateBatchCategory $createUpdateBatchCategory Values to create a batch of categories (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function createUpdateBatchCategoryAsyncWithHttpInfo($createUpdateBatchCategory)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\CreateUpdateBatchCategoryModel';
|
|
$request = $this->createUpdateBatchCategoryRequest($createUpdateBatchCategory);
|
|
|
|
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 'createUpdateBatchCategory'
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateBatchCategory $createUpdateBatchCategory Values to create a batch of categories (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function createUpdateBatchCategoryRequest($createUpdateBatchCategory)
|
|
{
|
|
// verify the required parameter 'createUpdateBatchCategory' is set
|
|
if ($createUpdateBatchCategory === null || (is_array($createUpdateBatchCategory) && count($createUpdateBatchCategory) === 0)) {
|
|
throw new \InvalidArgumentException(
|
|
'Missing the required parameter $createUpdateBatchCategory when calling createUpdateBatchCategory'
|
|
);
|
|
}
|
|
|
|
$resourcePath = '/categories/batch';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
|
|
|
|
// body params
|
|
$_tempBody = null;
|
|
if (isset($createUpdateBatchCategory)) {
|
|
$_tempBody = $createUpdateBatchCategory;
|
|
}
|
|
|
|
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\Query::build($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\Query::build($queryParams);
|
|
return new Request(
|
|
'POST',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateBatchProducts
|
|
*
|
|
* Create products in batch
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateBatchProducts $createUpdateBatchProducts Values to create a batch of products (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return \Brevo\Client\Model\CreateUpdateBatchProductsModel
|
|
*/
|
|
public function createUpdateBatchProducts($createUpdateBatchProducts)
|
|
{
|
|
list($response) = $this->createUpdateBatchProductsWithHttpInfo($createUpdateBatchProducts);
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateBatchProductsWithHttpInfo
|
|
*
|
|
* Create products in batch
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateBatchProducts $createUpdateBatchProducts Values to create a batch of products (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of \Brevo\Client\Model\CreateUpdateBatchProductsModel, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function createUpdateBatchProductsWithHttpInfo($createUpdateBatchProducts)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\CreateUpdateBatchProductsModel';
|
|
$request = $this->createUpdateBatchProductsRequest($createUpdateBatchProducts);
|
|
|
|
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(),
|
|
'\Brevo\Client\Model\CreateUpdateBatchProductsModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateBatchProductsAsync
|
|
*
|
|
* Create products in batch
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateBatchProducts $createUpdateBatchProducts Values to create a batch of products (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function createUpdateBatchProductsAsync($createUpdateBatchProducts)
|
|
{
|
|
return $this->createUpdateBatchProductsAsyncWithHttpInfo($createUpdateBatchProducts)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateBatchProductsAsyncWithHttpInfo
|
|
*
|
|
* Create products in batch
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateBatchProducts $createUpdateBatchProducts Values to create a batch of products (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function createUpdateBatchProductsAsyncWithHttpInfo($createUpdateBatchProducts)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\CreateUpdateBatchProductsModel';
|
|
$request = $this->createUpdateBatchProductsRequest($createUpdateBatchProducts);
|
|
|
|
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 'createUpdateBatchProducts'
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateBatchProducts $createUpdateBatchProducts Values to create a batch of products (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function createUpdateBatchProductsRequest($createUpdateBatchProducts)
|
|
{
|
|
// verify the required parameter 'createUpdateBatchProducts' is set
|
|
if ($createUpdateBatchProducts === null || (is_array($createUpdateBatchProducts) && count($createUpdateBatchProducts) === 0)) {
|
|
throw new \InvalidArgumentException(
|
|
'Missing the required parameter $createUpdateBatchProducts when calling createUpdateBatchProducts'
|
|
);
|
|
}
|
|
|
|
$resourcePath = '/products/batch';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
|
|
|
|
// body params
|
|
$_tempBody = null;
|
|
if (isset($createUpdateBatchProducts)) {
|
|
$_tempBody = $createUpdateBatchProducts;
|
|
}
|
|
|
|
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\Query::build($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\Query::build($queryParams);
|
|
return new Request(
|
|
'POST',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateCategory
|
|
*
|
|
* Create/Update a category
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateCategory $createUpdateCategory Values to create/update a category (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return \Brevo\Client\Model\CreateCategoryModel
|
|
*/
|
|
public function createUpdateCategory($createUpdateCategory)
|
|
{
|
|
list($response) = $this->createUpdateCategoryWithHttpInfo($createUpdateCategory);
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateCategoryWithHttpInfo
|
|
*
|
|
* Create/Update a category
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateCategory $createUpdateCategory Values to create/update a category (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of \Brevo\Client\Model\CreateCategoryModel, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function createUpdateCategoryWithHttpInfo($createUpdateCategory)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\CreateCategoryModel';
|
|
$request = $this->createUpdateCategoryRequest($createUpdateCategory);
|
|
|
|
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(),
|
|
'\Brevo\Client\Model\CreateCategoryModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateCategoryAsync
|
|
*
|
|
* Create/Update a category
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateCategory $createUpdateCategory Values to create/update a category (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function createUpdateCategoryAsync($createUpdateCategory)
|
|
{
|
|
return $this->createUpdateCategoryAsyncWithHttpInfo($createUpdateCategory)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateCategoryAsyncWithHttpInfo
|
|
*
|
|
* Create/Update a category
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateCategory $createUpdateCategory Values to create/update a category (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function createUpdateCategoryAsyncWithHttpInfo($createUpdateCategory)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\CreateCategoryModel';
|
|
$request = $this->createUpdateCategoryRequest($createUpdateCategory);
|
|
|
|
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 'createUpdateCategory'
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateCategory $createUpdateCategory Values to create/update a category (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function createUpdateCategoryRequest($createUpdateCategory)
|
|
{
|
|
// verify the required parameter 'createUpdateCategory' is set
|
|
if ($createUpdateCategory === null || (is_array($createUpdateCategory) && count($createUpdateCategory) === 0)) {
|
|
throw new \InvalidArgumentException(
|
|
'Missing the required parameter $createUpdateCategory when calling createUpdateCategory'
|
|
);
|
|
}
|
|
|
|
$resourcePath = '/categories';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
|
|
|
|
// body params
|
|
$_tempBody = null;
|
|
if (isset($createUpdateCategory)) {
|
|
$_tempBody = $createUpdateCategory;
|
|
}
|
|
|
|
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\Query::build($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\Query::build($queryParams);
|
|
return new Request(
|
|
'POST',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateProduct
|
|
*
|
|
* Create/Update a product
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateProduct $createUpdateProduct Values to create/update a product (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return \Brevo\Client\Model\CreateProductModel
|
|
*/
|
|
public function createUpdateProduct($createUpdateProduct)
|
|
{
|
|
list($response) = $this->createUpdateProductWithHttpInfo($createUpdateProduct);
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateProductWithHttpInfo
|
|
*
|
|
* Create/Update a product
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateProduct $createUpdateProduct Values to create/update a product (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of \Brevo\Client\Model\CreateProductModel, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function createUpdateProductWithHttpInfo($createUpdateProduct)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\CreateProductModel';
|
|
$request = $this->createUpdateProductRequest($createUpdateProduct);
|
|
|
|
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(),
|
|
'\Brevo\Client\Model\CreateProductModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateProductAsync
|
|
*
|
|
* Create/Update a product
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateProduct $createUpdateProduct Values to create/update a product (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function createUpdateProductAsync($createUpdateProduct)
|
|
{
|
|
return $this->createUpdateProductAsyncWithHttpInfo($createUpdateProduct)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation createUpdateProductAsyncWithHttpInfo
|
|
*
|
|
* Create/Update a product
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateProduct $createUpdateProduct Values to create/update a product (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function createUpdateProductAsyncWithHttpInfo($createUpdateProduct)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\CreateProductModel';
|
|
$request = $this->createUpdateProductRequest($createUpdateProduct);
|
|
|
|
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 'createUpdateProduct'
|
|
*
|
|
* @param \Brevo\Client\Model\CreateUpdateProduct $createUpdateProduct Values to create/update a product (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function createUpdateProductRequest($createUpdateProduct)
|
|
{
|
|
// verify the required parameter 'createUpdateProduct' is set
|
|
if ($createUpdateProduct === null || (is_array($createUpdateProduct) && count($createUpdateProduct) === 0)) {
|
|
throw new \InvalidArgumentException(
|
|
'Missing the required parameter $createUpdateProduct when calling createUpdateProduct'
|
|
);
|
|
}
|
|
|
|
$resourcePath = '/products';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
|
|
|
|
// body params
|
|
$_tempBody = null;
|
|
if (isset($createUpdateProduct)) {
|
|
$_tempBody = $createUpdateProduct;
|
|
}
|
|
|
|
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\Query::build($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\Query::build($queryParams);
|
|
return new Request(
|
|
'POST',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation ecommerceActivatePost
|
|
*
|
|
* Activate the eCommerce app
|
|
*
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return void
|
|
*/
|
|
public function ecommerceActivatePost()
|
|
{
|
|
$this->ecommerceActivatePostWithHttpInfo();
|
|
}
|
|
|
|
/**
|
|
* Operation ecommerceActivatePostWithHttpInfo
|
|
*
|
|
* Activate the eCommerce app
|
|
*
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of null, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function ecommerceActivatePostWithHttpInfo()
|
|
{
|
|
$returnType = '';
|
|
$request = $this->ecommerceActivatePostRequest();
|
|
|
|
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()
|
|
);
|
|
}
|
|
|
|
return [null, $statusCode, $response->getHeaders()];
|
|
|
|
} catch (ApiException $e) {
|
|
switch ($e->getCode()) {
|
|
case 401:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 404:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation ecommerceActivatePostAsync
|
|
*
|
|
* Activate the eCommerce app
|
|
*
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function ecommerceActivatePostAsync()
|
|
{
|
|
return $this->ecommerceActivatePostAsyncWithHttpInfo()
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation ecommerceActivatePostAsyncWithHttpInfo
|
|
*
|
|
* Activate the eCommerce app
|
|
*
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function ecommerceActivatePostAsyncWithHttpInfo()
|
|
{
|
|
$returnType = '';
|
|
$request = $this->ecommerceActivatePostRequest();
|
|
|
|
return $this->client
|
|
->sendAsync($request, $this->createHttpClientOption())
|
|
->then(
|
|
function ($response) use ($returnType) {
|
|
return [null, $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 'ecommerceActivatePost'
|
|
*
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function ecommerceActivatePostRequest()
|
|
{
|
|
|
|
$resourcePath = '/ecommerce/activate';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
|
|
|
|
// 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\Query::build($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\Query::build($queryParams);
|
|
return new Request(
|
|
'POST',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getCategories
|
|
*
|
|
* Return all your categories
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string[] $ids Filter by category ids (optional)
|
|
* @param string $name Filter by category name (optional)
|
|
* @param string $modifiedSince Filter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return \Brevo\Client\Model\GetCategories
|
|
*/
|
|
public function getCategories($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $modifiedSince = null, $createdSince = null)
|
|
{
|
|
list($response) = $this->getCategoriesWithHttpInfo($limit, $offset, $sort, $ids, $name, $modifiedSince, $createdSince);
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Operation getCategoriesWithHttpInfo
|
|
*
|
|
* Return all your categories
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string[] $ids Filter by category ids (optional)
|
|
* @param string $name Filter by category name (optional)
|
|
* @param string $modifiedSince Filter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of \Brevo\Client\Model\GetCategories, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function getCategoriesWithHttpInfo($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $modifiedSince = null, $createdSince = null)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\GetCategories';
|
|
$request = $this->getCategoriesRequest($limit, $offset, $sort, $ids, $name, $modifiedSince, $createdSince);
|
|
|
|
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(),
|
|
'\Brevo\Client\Model\GetCategories',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation getCategoriesAsync
|
|
*
|
|
* Return all your categories
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string[] $ids Filter by category ids (optional)
|
|
* @param string $name Filter by category name (optional)
|
|
* @param string $modifiedSince Filter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getCategoriesAsync($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $modifiedSince = null, $createdSince = null)
|
|
{
|
|
return $this->getCategoriesAsyncWithHttpInfo($limit, $offset, $sort, $ids, $name, $modifiedSince, $createdSince)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getCategoriesAsyncWithHttpInfo
|
|
*
|
|
* Return all your categories
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string[] $ids Filter by category ids (optional)
|
|
* @param string $name Filter by category name (optional)
|
|
* @param string $modifiedSince Filter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getCategoriesAsyncWithHttpInfo($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $modifiedSince = null, $createdSince = null)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\GetCategories';
|
|
$request = $this->getCategoriesRequest($limit, $offset, $sort, $ids, $name, $modifiedSince, $createdSince);
|
|
|
|
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 'getCategories'
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string[] $ids Filter by category ids (optional)
|
|
* @param string $name Filter by category name (optional)
|
|
* @param string $modifiedSince Filter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function getCategoriesRequest($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $modifiedSince = null, $createdSince = null)
|
|
{
|
|
if ($limit !== null && $limit > 100) {
|
|
throw new \InvalidArgumentException('invalid value for "$limit" when calling EcommerceApi.getCategories, must be smaller than or equal to 100.');
|
|
}
|
|
|
|
|
|
$resourcePath = '/categories';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
// query params
|
|
if ($limit !== null) {
|
|
$queryParams['limit'] = ObjectSerializer::toQueryValue($limit);
|
|
}
|
|
// query params
|
|
if ($offset !== null) {
|
|
$queryParams['offset'] = ObjectSerializer::toQueryValue($offset);
|
|
}
|
|
// query params
|
|
if ($sort !== null) {
|
|
$queryParams['sort'] = ObjectSerializer::toQueryValue($sort);
|
|
}
|
|
// query params
|
|
if (is_array($ids)) {
|
|
$queryParams['ids'] = $ids;
|
|
} else
|
|
if ($ids !== null) {
|
|
$queryParams['ids'] = ObjectSerializer::toQueryValue($ids);
|
|
}
|
|
// query params
|
|
if ($name !== null) {
|
|
$queryParams['name'] = ObjectSerializer::toQueryValue($name);
|
|
}
|
|
// query params
|
|
if ($modifiedSince !== null) {
|
|
$queryParams['modifiedSince'] = ObjectSerializer::toQueryValue($modifiedSince);
|
|
}
|
|
// query params
|
|
if ($createdSince !== null) {
|
|
$queryParams['createdSince'] = ObjectSerializer::toQueryValue($createdSince);
|
|
}
|
|
|
|
|
|
// 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\Query::build($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\Query::build($queryParams);
|
|
return new Request(
|
|
'GET',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getCategoryInfo
|
|
*
|
|
* Get a category details
|
|
*
|
|
* @param string $id Category ID (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return \Brevo\Client\Model\GetCategoryDetails
|
|
*/
|
|
public function getCategoryInfo($id)
|
|
{
|
|
list($response) = $this->getCategoryInfoWithHttpInfo($id);
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Operation getCategoryInfoWithHttpInfo
|
|
*
|
|
* Get a category details
|
|
*
|
|
* @param string $id Category ID (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of \Brevo\Client\Model\GetCategoryDetails, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function getCategoryInfoWithHttpInfo($id)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\GetCategoryDetails';
|
|
$request = $this->getCategoryInfoRequest($id);
|
|
|
|
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(),
|
|
'\Brevo\Client\Model\GetCategoryDetails',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 404:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation getCategoryInfoAsync
|
|
*
|
|
* Get a category details
|
|
*
|
|
* @param string $id Category ID (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getCategoryInfoAsync($id)
|
|
{
|
|
return $this->getCategoryInfoAsyncWithHttpInfo($id)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getCategoryInfoAsyncWithHttpInfo
|
|
*
|
|
* Get a category details
|
|
*
|
|
* @param string $id Category ID (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getCategoryInfoAsyncWithHttpInfo($id)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\GetCategoryDetails';
|
|
$request = $this->getCategoryInfoRequest($id);
|
|
|
|
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 'getCategoryInfo'
|
|
*
|
|
* @param string $id Category ID (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function getCategoryInfoRequest($id)
|
|
{
|
|
// verify the required parameter 'id' is set
|
|
if ($id === null || (is_array($id) && count($id) === 0)) {
|
|
throw new \InvalidArgumentException(
|
|
'Missing the required parameter $id when calling getCategoryInfo'
|
|
);
|
|
}
|
|
|
|
$resourcePath = '/categories/{id}';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
|
|
// path params
|
|
if ($id !== null) {
|
|
$resourcePath = str_replace(
|
|
'{' . 'id' . '}',
|
|
ObjectSerializer::toPathValue($id),
|
|
$resourcePath
|
|
);
|
|
}
|
|
|
|
// 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\Query::build($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\Query::build($queryParams);
|
|
return new Request(
|
|
'GET',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getOrders
|
|
*
|
|
* Get order details
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string $modifiedSince Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return \Brevo\Client\Model\GetOrders
|
|
*/
|
|
public function getOrders($limit = '50', $offset = '0', $sort = 'desc', $modifiedSince = null, $createdSince = null)
|
|
{
|
|
list($response) = $this->getOrdersWithHttpInfo($limit, $offset, $sort, $modifiedSince, $createdSince);
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Operation getOrdersWithHttpInfo
|
|
*
|
|
* Get order details
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string $modifiedSince Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of \Brevo\Client\Model\GetOrders, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function getOrdersWithHttpInfo($limit = '50', $offset = '0', $sort = 'desc', $modifiedSince = null, $createdSince = null)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\GetOrders';
|
|
$request = $this->getOrdersRequest($limit, $offset, $sort, $modifiedSince, $createdSince);
|
|
|
|
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(),
|
|
'\Brevo\Client\Model\GetOrders',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation getOrdersAsync
|
|
*
|
|
* Get order details
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string $modifiedSince Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getOrdersAsync($limit = '50', $offset = '0', $sort = 'desc', $modifiedSince = null, $createdSince = null)
|
|
{
|
|
return $this->getOrdersAsyncWithHttpInfo($limit, $offset, $sort, $modifiedSince, $createdSince)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getOrdersAsyncWithHttpInfo
|
|
*
|
|
* Get order details
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string $modifiedSince Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getOrdersAsyncWithHttpInfo($limit = '50', $offset = '0', $sort = 'desc', $modifiedSince = null, $createdSince = null)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\GetOrders';
|
|
$request = $this->getOrdersRequest($limit, $offset, $sort, $modifiedSince, $createdSince);
|
|
|
|
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 'getOrders'
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string $modifiedSince Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function getOrdersRequest($limit = '50', $offset = '0', $sort = 'desc', $modifiedSince = null, $createdSince = null)
|
|
{
|
|
if ($limit !== null && $limit > 100) {
|
|
throw new \InvalidArgumentException('invalid value for "$limit" when calling EcommerceApi.getOrders, must be smaller than or equal to 100.');
|
|
}
|
|
|
|
|
|
$resourcePath = '/orders';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
// query params
|
|
if ($limit !== null) {
|
|
$queryParams['limit'] = ObjectSerializer::toQueryValue($limit);
|
|
}
|
|
// query params
|
|
if ($offset !== null) {
|
|
$queryParams['offset'] = ObjectSerializer::toQueryValue($offset);
|
|
}
|
|
// query params
|
|
if ($sort !== null) {
|
|
$queryParams['sort'] = ObjectSerializer::toQueryValue($sort);
|
|
}
|
|
// query params
|
|
if ($modifiedSince !== null) {
|
|
$queryParams['modifiedSince'] = ObjectSerializer::toQueryValue($modifiedSince);
|
|
}
|
|
// query params
|
|
if ($createdSince !== null) {
|
|
$queryParams['createdSince'] = ObjectSerializer::toQueryValue($createdSince);
|
|
}
|
|
|
|
|
|
// 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\Query::build($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\Query::build($queryParams);
|
|
return new Request(
|
|
'GET',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getProductInfo
|
|
*
|
|
* Get a product's details
|
|
*
|
|
* @param string $id Product ID (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return \Brevo\Client\Model\GetProductDetails
|
|
*/
|
|
public function getProductInfo($id)
|
|
{
|
|
list($response) = $this->getProductInfoWithHttpInfo($id);
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Operation getProductInfoWithHttpInfo
|
|
*
|
|
* Get a product's details
|
|
*
|
|
* @param string $id Product ID (required)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of \Brevo\Client\Model\GetProductDetails, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function getProductInfoWithHttpInfo($id)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\GetProductDetails';
|
|
$request = $this->getProductInfoRequest($id);
|
|
|
|
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(),
|
|
'\Brevo\Client\Model\GetProductDetails',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 404:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation getProductInfoAsync
|
|
*
|
|
* Get a product's details
|
|
*
|
|
* @param string $id Product ID (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getProductInfoAsync($id)
|
|
{
|
|
return $this->getProductInfoAsyncWithHttpInfo($id)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getProductInfoAsyncWithHttpInfo
|
|
*
|
|
* Get a product's details
|
|
*
|
|
* @param string $id Product ID (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getProductInfoAsyncWithHttpInfo($id)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\GetProductDetails';
|
|
$request = $this->getProductInfoRequest($id);
|
|
|
|
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 'getProductInfo'
|
|
*
|
|
* @param string $id Product ID (required)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function getProductInfoRequest($id)
|
|
{
|
|
// verify the required parameter 'id' is set
|
|
if ($id === null || (is_array($id) && count($id) === 0)) {
|
|
throw new \InvalidArgumentException(
|
|
'Missing the required parameter $id when calling getProductInfo'
|
|
);
|
|
}
|
|
|
|
$resourcePath = '/products/{id}';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
|
|
// path params
|
|
if ($id !== null) {
|
|
$resourcePath = str_replace(
|
|
'{' . 'id' . '}',
|
|
ObjectSerializer::toPathValue($id),
|
|
$resourcePath
|
|
);
|
|
}
|
|
|
|
// 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\Query::build($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\Query::build($queryParams);
|
|
return new Request(
|
|
'GET',
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
|
$headers,
|
|
$httpBody
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getProducts
|
|
*
|
|
* Return all your products
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string[] $ids Filter by product ids (optional)
|
|
* @param string $name Filter by product name, minimum 3 characters should be present for search (optional)
|
|
* @param float $priceLte Price filter for products less than and equals to particular amount (optional)
|
|
* @param float $priceGte Price filter for products greater than and equals to particular amount (optional)
|
|
* @param float $priceLt Price filter for products less than particular amount (optional)
|
|
* @param float $priceGt Price filter for products greater than particular amount (optional)
|
|
* @param float $priceEq Price filter for products equals to particular amount (optional)
|
|
* @param float $priceNe Price filter for products not equals to particular amount (optional)
|
|
* @param string[] $categories Filter by category ids (optional)
|
|
* @param string $modifiedSince Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return \Brevo\Client\Model\GetProducts
|
|
*/
|
|
public function getProducts($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $priceLte = null, $priceGte = null, $priceLt = null, $priceGt = null, $priceEq = null, $priceNe = null, $categories = null, $modifiedSince = null, $createdSince = null)
|
|
{
|
|
list($response) = $this->getProductsWithHttpInfo($limit, $offset, $sort, $ids, $name, $priceLte, $priceGte, $priceLt, $priceGt, $priceEq, $priceNe, $categories, $modifiedSince, $createdSince);
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* Operation getProductsWithHttpInfo
|
|
*
|
|
* Return all your products
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string[] $ids Filter by product ids (optional)
|
|
* @param string $name Filter by product name, minimum 3 characters should be present for search (optional)
|
|
* @param float $priceLte Price filter for products less than and equals to particular amount (optional)
|
|
* @param float $priceGte Price filter for products greater than and equals to particular amount (optional)
|
|
* @param float $priceLt Price filter for products less than particular amount (optional)
|
|
* @param float $priceGt Price filter for products greater than particular amount (optional)
|
|
* @param float $priceEq Price filter for products equals to particular amount (optional)
|
|
* @param float $priceNe Price filter for products not equals to particular amount (optional)
|
|
* @param string[] $categories Filter by category ids (optional)
|
|
* @param string $modifiedSince Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
|
* @throws \InvalidArgumentException
|
|
* @return array of \Brevo\Client\Model\GetProducts, HTTP status code, HTTP response headers (array of strings)
|
|
*/
|
|
public function getProductsWithHttpInfo($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $priceLte = null, $priceGte = null, $priceLt = null, $priceGt = null, $priceEq = null, $priceNe = null, $categories = null, $modifiedSince = null, $createdSince = null)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\GetProducts';
|
|
$request = $this->getProductsRequest($limit, $offset, $sort, $ids, $name, $priceLte, $priceGte, $priceLt, $priceGt, $priceEq, $priceNe, $categories, $modifiedSince, $createdSince);
|
|
|
|
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(),
|
|
'\Brevo\Client\Model\GetProducts',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
case 400:
|
|
$data = ObjectSerializer::deserialize(
|
|
$e->getResponseBody(),
|
|
'\Brevo\Client\Model\ErrorModel',
|
|
$e->getResponseHeaders()
|
|
);
|
|
$e->setResponseObject($data);
|
|
break;
|
|
}
|
|
throw $e;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Operation getProductsAsync
|
|
*
|
|
* Return all your products
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string[] $ids Filter by product ids (optional)
|
|
* @param string $name Filter by product name, minimum 3 characters should be present for search (optional)
|
|
* @param float $priceLte Price filter for products less than and equals to particular amount (optional)
|
|
* @param float $priceGte Price filter for products greater than and equals to particular amount (optional)
|
|
* @param float $priceLt Price filter for products less than particular amount (optional)
|
|
* @param float $priceGt Price filter for products greater than particular amount (optional)
|
|
* @param float $priceEq Price filter for products equals to particular amount (optional)
|
|
* @param float $priceNe Price filter for products not equals to particular amount (optional)
|
|
* @param string[] $categories Filter by category ids (optional)
|
|
* @param string $modifiedSince Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getProductsAsync($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $priceLte = null, $priceGte = null, $priceLt = null, $priceGt = null, $priceEq = null, $priceNe = null, $categories = null, $modifiedSince = null, $createdSince = null)
|
|
{
|
|
return $this->getProductsAsyncWithHttpInfo($limit, $offset, $sort, $ids, $name, $priceLte, $priceGte, $priceLt, $priceGt, $priceEq, $priceNe, $categories, $modifiedSince, $createdSince)
|
|
->then(
|
|
function ($response) {
|
|
return $response[0];
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Operation getProductsAsyncWithHttpInfo
|
|
*
|
|
* Return all your products
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string[] $ids Filter by product ids (optional)
|
|
* @param string $name Filter by product name, minimum 3 characters should be present for search (optional)
|
|
* @param float $priceLte Price filter for products less than and equals to particular amount (optional)
|
|
* @param float $priceGte Price filter for products greater than and equals to particular amount (optional)
|
|
* @param float $priceLt Price filter for products less than particular amount (optional)
|
|
* @param float $priceGt Price filter for products greater than particular amount (optional)
|
|
* @param float $priceEq Price filter for products equals to particular amount (optional)
|
|
* @param float $priceNe Price filter for products not equals to particular amount (optional)
|
|
* @param string[] $categories Filter by category ids (optional)
|
|
* @param string $modifiedSince Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
|
*/
|
|
public function getProductsAsyncWithHttpInfo($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $priceLte = null, $priceGte = null, $priceLt = null, $priceGt = null, $priceEq = null, $priceNe = null, $categories = null, $modifiedSince = null, $createdSince = null)
|
|
{
|
|
$returnType = '\Brevo\Client\Model\GetProducts';
|
|
$request = $this->getProductsRequest($limit, $offset, $sort, $ids, $name, $priceLte, $priceGte, $priceLt, $priceGt, $priceEq, $priceNe, $categories, $modifiedSince, $createdSince);
|
|
|
|
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 'getProducts'
|
|
*
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
|
* @param int $offset Index of the first document in the page (optional, default to 0)
|
|
* @param string $sort Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed (optional, default to desc)
|
|
* @param string[] $ids Filter by product ids (optional)
|
|
* @param string $name Filter by product name, minimum 3 characters should be present for search (optional)
|
|
* @param float $priceLte Price filter for products less than and equals to particular amount (optional)
|
|
* @param float $priceGte Price filter for products greater than and equals to particular amount (optional)
|
|
* @param float $priceLt Price filter for products less than particular amount (optional)
|
|
* @param float $priceGt Price filter for products greater than particular amount (optional)
|
|
* @param float $priceEq Price filter for products equals to particular amount (optional)
|
|
* @param float $priceNe Price filter for products not equals to particular amount (optional)
|
|
* @param string[] $categories Filter by category ids (optional)
|
|
* @param string $modifiedSince Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
* @param string $createdSince Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time format for accurate result.** (optional)
|
|
*
|
|
* @throws \InvalidArgumentException
|
|
* @return \GuzzleHttp\Psr7\Request
|
|
*/
|
|
protected function getProductsRequest($limit = '50', $offset = '0', $sort = 'desc', $ids = null, $name = null, $priceLte = null, $priceGte = null, $priceLt = null, $priceGt = null, $priceEq = null, $priceNe = null, $categories = null, $modifiedSince = null, $createdSince = null)
|
|
{
|
|
if ($limit !== null && $limit > 1000) {
|
|
throw new \InvalidArgumentException('invalid value for "$limit" when calling EcommerceApi.getProducts, must be smaller than or equal to 1000.');
|
|
}
|
|
|
|
|
|
$resourcePath = '/products';
|
|
$formParams = [];
|
|
$queryParams = [];
|
|
$headerParams = [];
|
|
$httpBody = '';
|
|
$multipart = false;
|
|
|
|
// query params
|
|
if ($limit !== null) {
|
|
$queryParams['limit'] = ObjectSerializer::toQueryValue($limit);
|
|
}
|
|
// query params
|
|
if ($offset !== null) {
|
|
$queryParams['offset'] = ObjectSerializer::toQueryValue($offset);
|
|
}
|
|
// query params
|
|
if ($sort !== null) {
|
|
$queryParams['sort'] = ObjectSerializer::toQueryValue($sort);
|
|
}
|
|
// query params
|
|
if (is_array($ids)) {
|
|
$queryParams['ids'] = $ids;
|
|
} else
|
|
if ($ids !== null) {
|
|
$queryParams['ids'] = ObjectSerializer::toQueryValue($ids);
|
|
}
|
|
// query params
|
|
if ($name !== null) {
|
|
$queryParams['name'] = ObjectSerializer::toQueryValue($name);
|
|
}
|
|
// query params
|
|
if ($priceLte !== null) {
|
|
$queryParams['price[lte]'] = ObjectSerializer::toQueryValue($priceLte);
|
|
}
|
|
// query params
|
|
if ($priceGte !== null) {
|
|
$queryParams['price[gte]'] = ObjectSerializer::toQueryValue($priceGte);
|
|
}
|
|
// query params
|
|
if ($priceLt !== null) {
|
|
$queryParams['price[lt]'] = ObjectSerializer::toQueryValue($priceLt);
|
|
}
|
|
// query params
|
|
if ($priceGt !== null) {
|
|
$queryParams['price[gt]'] = ObjectSerializer::toQueryValue($priceGt);
|
|
}
|
|
// query params
|
|
if ($priceEq !== null) {
|
|
$queryParams['price[eq]'] = ObjectSerializer::toQueryValue($priceEq);
|
|
}
|
|
// query params
|
|
if ($priceNe !== null) {
|
|
$queryParams['price[ne]'] = ObjectSerializer::toQueryValue($priceNe);
|
|
}
|
|
// query params
|
|
if (is_array($categories)) {
|
|
$queryParams['categories'] = $categories;
|
|
} else
|
|
if ($categories !== null) {
|
|
$queryParams['categories'] = ObjectSerializer::toQueryValue($categories);
|
|
}
|
|
// query params
|
|
if ($modifiedSince !== null) {
|
|
$queryParams['modifiedSince'] = ObjectSerializer::toQueryValue($modifiedSince);
|
|
}
|
|
// query params
|
|
if ($createdSince !== null) {
|
|
$queryParams['createdSince'] = ObjectSerializer::toQueryValue($createdSince);
|
|
}
|
|
|
|
|
|
// 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\Query::build($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\Query::build($queryParams);
|
|
return new Request(
|
|
'GET',
|
|
$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;
|
|
}
|
|
}
|