1563 lines
54 KiB
PHP
1563 lines
54 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* NotesApi
|
||
|
|
* 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;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* NotesApi Class Doc Comment
|
||
|
|
*
|
||
|
|
* @category Class
|
||
|
|
* @package Brevo\Client
|
||
|
|
* @author Swagger Codegen team
|
||
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
||
|
|
*/
|
||
|
|
class NotesApi
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* @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 crmNotesGet
|
||
|
|
*
|
||
|
|
* Get all notes
|
||
|
|
*
|
||
|
|
* @param string $entity Filter by note entity type (optional)
|
||
|
|
* @param string $entityIds Filter by note entity IDs (optional)
|
||
|
|
* @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional)
|
||
|
|
* @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional)
|
||
|
|
* @param int $offset Index of the first document of the page (optional)
|
||
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
||
|
|
* @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional)
|
||
|
|
*
|
||
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \Brevo\Client\Model\NoteList
|
||
|
|
*/
|
||
|
|
public function crmNotesGet($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null)
|
||
|
|
{
|
||
|
|
list($response) = $this->crmNotesGetWithHttpInfo($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort);
|
||
|
|
return $response;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesGetWithHttpInfo
|
||
|
|
*
|
||
|
|
* Get all notes
|
||
|
|
*
|
||
|
|
* @param string $entity Filter by note entity type (optional)
|
||
|
|
* @param string $entityIds Filter by note entity IDs (optional)
|
||
|
|
* @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional)
|
||
|
|
* @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional)
|
||
|
|
* @param int $offset Index of the first document of the page (optional)
|
||
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
||
|
|
* @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional)
|
||
|
|
*
|
||
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return array of \Brevo\Client\Model\NoteList, HTTP status code, HTTP response headers (array of strings)
|
||
|
|
*/
|
||
|
|
public function crmNotesGetWithHttpInfo($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null)
|
||
|
|
{
|
||
|
|
$returnType = '\Brevo\Client\Model\NoteList';
|
||
|
|
$request = $this->crmNotesGetRequest($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort);
|
||
|
|
|
||
|
|
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\NoteList',
|
||
|
|
$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 crmNotesGetAsync
|
||
|
|
*
|
||
|
|
* Get all notes
|
||
|
|
*
|
||
|
|
* @param string $entity Filter by note entity type (optional)
|
||
|
|
* @param string $entityIds Filter by note entity IDs (optional)
|
||
|
|
* @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional)
|
||
|
|
* @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional)
|
||
|
|
* @param int $offset Index of the first document of the page (optional)
|
||
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
||
|
|
* @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
||
|
|
*/
|
||
|
|
public function crmNotesGetAsync($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null)
|
||
|
|
{
|
||
|
|
return $this->crmNotesGetAsyncWithHttpInfo($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort)
|
||
|
|
->then(
|
||
|
|
function ($response) {
|
||
|
|
return $response[0];
|
||
|
|
}
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesGetAsyncWithHttpInfo
|
||
|
|
*
|
||
|
|
* Get all notes
|
||
|
|
*
|
||
|
|
* @param string $entity Filter by note entity type (optional)
|
||
|
|
* @param string $entityIds Filter by note entity IDs (optional)
|
||
|
|
* @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional)
|
||
|
|
* @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional)
|
||
|
|
* @param int $offset Index of the first document of the page (optional)
|
||
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
||
|
|
* @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
||
|
|
*/
|
||
|
|
public function crmNotesGetAsyncWithHttpInfo($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null)
|
||
|
|
{
|
||
|
|
$returnType = '\Brevo\Client\Model\NoteList';
|
||
|
|
$request = $this->crmNotesGetRequest($entity, $entityIds, $dateFrom, $dateTo, $offset, $limit, $sort);
|
||
|
|
|
||
|
|
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 'crmNotesGet'
|
||
|
|
*
|
||
|
|
* @param string $entity Filter by note entity type (optional)
|
||
|
|
* @param string $entityIds Filter by note entity IDs (optional)
|
||
|
|
* @param int $dateFrom dateFrom to date range filter type (timestamp in milliseconds) (optional)
|
||
|
|
* @param int $dateTo dateTo to date range filter type (timestamp in milliseconds) (optional)
|
||
|
|
* @param int $offset Index of the first document of the page (optional)
|
||
|
|
* @param int $limit Number of documents per page (optional, default to 50)
|
||
|
|
* @param string $sort Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed (optional)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Psr7\Request
|
||
|
|
*/
|
||
|
|
protected function crmNotesGetRequest($entity = null, $entityIds = null, $dateFrom = null, $dateTo = null, $offset = null, $limit = '50', $sort = null)
|
||
|
|
{
|
||
|
|
|
||
|
|
$resourcePath = '/crm/notes';
|
||
|
|
$formParams = [];
|
||
|
|
$queryParams = [];
|
||
|
|
$headerParams = [];
|
||
|
|
$httpBody = '';
|
||
|
|
$multipart = false;
|
||
|
|
|
||
|
|
// query params
|
||
|
|
if ($entity !== null) {
|
||
|
|
$queryParams['entity'] = ObjectSerializer::toQueryValue($entity);
|
||
|
|
}
|
||
|
|
// query params
|
||
|
|
if ($entityIds !== null) {
|
||
|
|
$queryParams['entityIds'] = ObjectSerializer::toQueryValue($entityIds);
|
||
|
|
}
|
||
|
|
// query params
|
||
|
|
if ($dateFrom !== null) {
|
||
|
|
$queryParams['dateFrom'] = ObjectSerializer::toQueryValue($dateFrom);
|
||
|
|
}
|
||
|
|
// query params
|
||
|
|
if ($dateTo !== null) {
|
||
|
|
$queryParams['dateTo'] = ObjectSerializer::toQueryValue($dateTo);
|
||
|
|
}
|
||
|
|
// query params
|
||
|
|
if ($offset !== null) {
|
||
|
|
$queryParams['offset'] = ObjectSerializer::toQueryValue($offset);
|
||
|
|
}
|
||
|
|
// query params
|
||
|
|
if ($limit !== null) {
|
||
|
|
$queryParams['limit'] = ObjectSerializer::toQueryValue($limit);
|
||
|
|
}
|
||
|
|
// query params
|
||
|
|
if ($sort !== null) {
|
||
|
|
$queryParams['sort'] = ObjectSerializer::toQueryValue($sort);
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// 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 crmNotesIdDelete
|
||
|
|
*
|
||
|
|
* Delete a note
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to delete (required)
|
||
|
|
*
|
||
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function crmNotesIdDelete($id)
|
||
|
|
{
|
||
|
|
$this->crmNotesIdDeleteWithHttpInfo($id);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesIdDeleteWithHttpInfo
|
||
|
|
*
|
||
|
|
* Delete a note
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to delete (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 crmNotesIdDeleteWithHttpInfo($id)
|
||
|
|
{
|
||
|
|
$returnType = '';
|
||
|
|
$request = $this->crmNotesIdDeleteRequest($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()
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
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;
|
||
|
|
case 404:
|
||
|
|
$data = ObjectSerializer::deserialize(
|
||
|
|
$e->getResponseBody(),
|
||
|
|
'\Brevo\Client\Model\ErrorModel',
|
||
|
|
$e->getResponseHeaders()
|
||
|
|
);
|
||
|
|
$e->setResponseObject($data);
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
throw $e;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesIdDeleteAsync
|
||
|
|
*
|
||
|
|
* Delete a note
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to delete (required)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
||
|
|
*/
|
||
|
|
public function crmNotesIdDeleteAsync($id)
|
||
|
|
{
|
||
|
|
return $this->crmNotesIdDeleteAsyncWithHttpInfo($id)
|
||
|
|
->then(
|
||
|
|
function ($response) {
|
||
|
|
return $response[0];
|
||
|
|
}
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesIdDeleteAsyncWithHttpInfo
|
||
|
|
*
|
||
|
|
* Delete a note
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to delete (required)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
||
|
|
*/
|
||
|
|
public function crmNotesIdDeleteAsyncWithHttpInfo($id)
|
||
|
|
{
|
||
|
|
$returnType = '';
|
||
|
|
$request = $this->crmNotesIdDeleteRequest($id);
|
||
|
|
|
||
|
|
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 'crmNotesIdDelete'
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to delete (required)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Psr7\Request
|
||
|
|
*/
|
||
|
|
protected function crmNotesIdDeleteRequest($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 crmNotesIdDelete'
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
$resourcePath = '/crm/notes/{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(
|
||
|
|
'DELETE',
|
||
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
||
|
|
$headers,
|
||
|
|
$httpBody
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesIdGet
|
||
|
|
*
|
||
|
|
* Get a note
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to get (required)
|
||
|
|
*
|
||
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \Brevo\Client\Model\Note
|
||
|
|
*/
|
||
|
|
public function crmNotesIdGet($id)
|
||
|
|
{
|
||
|
|
list($response) = $this->crmNotesIdGetWithHttpInfo($id);
|
||
|
|
return $response;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesIdGetWithHttpInfo
|
||
|
|
*
|
||
|
|
* Get a note
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to get (required)
|
||
|
|
*
|
||
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return array of \Brevo\Client\Model\Note, HTTP status code, HTTP response headers (array of strings)
|
||
|
|
*/
|
||
|
|
public function crmNotesIdGetWithHttpInfo($id)
|
||
|
|
{
|
||
|
|
$returnType = '\Brevo\Client\Model\Note';
|
||
|
|
$request = $this->crmNotesIdGetRequest($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\Note',
|
||
|
|
$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 crmNotesIdGetAsync
|
||
|
|
*
|
||
|
|
* Get a note
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to get (required)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
||
|
|
*/
|
||
|
|
public function crmNotesIdGetAsync($id)
|
||
|
|
{
|
||
|
|
return $this->crmNotesIdGetAsyncWithHttpInfo($id)
|
||
|
|
->then(
|
||
|
|
function ($response) {
|
||
|
|
return $response[0];
|
||
|
|
}
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesIdGetAsyncWithHttpInfo
|
||
|
|
*
|
||
|
|
* Get a note
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to get (required)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
||
|
|
*/
|
||
|
|
public function crmNotesIdGetAsyncWithHttpInfo($id)
|
||
|
|
{
|
||
|
|
$returnType = '\Brevo\Client\Model\Note';
|
||
|
|
$request = $this->crmNotesIdGetRequest($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 'crmNotesIdGet'
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to get (required)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Psr7\Request
|
||
|
|
*/
|
||
|
|
protected function crmNotesIdGetRequest($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 crmNotesIdGet'
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
$resourcePath = '/crm/notes/{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 crmNotesIdPatch
|
||
|
|
*
|
||
|
|
* Update a note
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to update (required)
|
||
|
|
* @param \Brevo\Client\Model\NoteData $body Note data to update a note (required)
|
||
|
|
*
|
||
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function crmNotesIdPatch($id, $body)
|
||
|
|
{
|
||
|
|
$this->crmNotesIdPatchWithHttpInfo($id, $body);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesIdPatchWithHttpInfo
|
||
|
|
*
|
||
|
|
* Update a note
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to update (required)
|
||
|
|
* @param \Brevo\Client\Model\NoteData $body Note data to update a note (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 crmNotesIdPatchWithHttpInfo($id, $body)
|
||
|
|
{
|
||
|
|
$returnType = '';
|
||
|
|
$request = $this->crmNotesIdPatchRequest($id, $body);
|
||
|
|
|
||
|
|
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;
|
||
|
|
case 404:
|
||
|
|
$data = ObjectSerializer::deserialize(
|
||
|
|
$e->getResponseBody(),
|
||
|
|
'\Brevo\Client\Model\ErrorModel',
|
||
|
|
$e->getResponseHeaders()
|
||
|
|
);
|
||
|
|
$e->setResponseObject($data);
|
||
|
|
break;
|
||
|
|
case 415:
|
||
|
|
$data = ObjectSerializer::deserialize(
|
||
|
|
$e->getResponseBody(),
|
||
|
|
'\Brevo\Client\Model\ErrorModel',
|
||
|
|
$e->getResponseHeaders()
|
||
|
|
);
|
||
|
|
$e->setResponseObject($data);
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
throw $e;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesIdPatchAsync
|
||
|
|
*
|
||
|
|
* Update a note
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to update (required)
|
||
|
|
* @param \Brevo\Client\Model\NoteData $body Note data to update a note (required)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
||
|
|
*/
|
||
|
|
public function crmNotesIdPatchAsync($id, $body)
|
||
|
|
{
|
||
|
|
return $this->crmNotesIdPatchAsyncWithHttpInfo($id, $body)
|
||
|
|
->then(
|
||
|
|
function ($response) {
|
||
|
|
return $response[0];
|
||
|
|
}
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesIdPatchAsyncWithHttpInfo
|
||
|
|
*
|
||
|
|
* Update a note
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to update (required)
|
||
|
|
* @param \Brevo\Client\Model\NoteData $body Note data to update a note (required)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
||
|
|
*/
|
||
|
|
public function crmNotesIdPatchAsyncWithHttpInfo($id, $body)
|
||
|
|
{
|
||
|
|
$returnType = '';
|
||
|
|
$request = $this->crmNotesIdPatchRequest($id, $body);
|
||
|
|
|
||
|
|
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 'crmNotesIdPatch'
|
||
|
|
*
|
||
|
|
* @param string $id Note ID to update (required)
|
||
|
|
* @param \Brevo\Client\Model\NoteData $body Note data to update a note (required)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Psr7\Request
|
||
|
|
*/
|
||
|
|
protected function crmNotesIdPatchRequest($id, $body)
|
||
|
|
{
|
||
|
|
// 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 crmNotesIdPatch'
|
||
|
|
);
|
||
|
|
}
|
||
|
|
// verify the required parameter 'body' is set
|
||
|
|
if ($body === null || (is_array($body) && count($body) === 0)) {
|
||
|
|
throw new \InvalidArgumentException(
|
||
|
|
'Missing the required parameter $body when calling crmNotesIdPatch'
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
$resourcePath = '/crm/notes/{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 (isset($body)) {
|
||
|
|
$_tempBody = $body;
|
||
|
|
}
|
||
|
|
|
||
|
|
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(
|
||
|
|
'PATCH',
|
||
|
|
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
|
||
|
|
$headers,
|
||
|
|
$httpBody
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesPost
|
||
|
|
*
|
||
|
|
* Create a note
|
||
|
|
*
|
||
|
|
* @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required)
|
||
|
|
*
|
||
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \Brevo\Client\Model\NoteId
|
||
|
|
*/
|
||
|
|
public function crmNotesPost($body)
|
||
|
|
{
|
||
|
|
list($response) = $this->crmNotesPostWithHttpInfo($body);
|
||
|
|
return $response;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesPostWithHttpInfo
|
||
|
|
*
|
||
|
|
* Create a note
|
||
|
|
*
|
||
|
|
* @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required)
|
||
|
|
*
|
||
|
|
* @throws \Brevo\Client\ApiException on non-2xx response
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return array of \Brevo\Client\Model\NoteId, HTTP status code, HTTP response headers (array of strings)
|
||
|
|
*/
|
||
|
|
public function crmNotesPostWithHttpInfo($body)
|
||
|
|
{
|
||
|
|
$returnType = '\Brevo\Client\Model\NoteId';
|
||
|
|
$request = $this->crmNotesPostRequest($body);
|
||
|
|
|
||
|
|
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\NoteId',
|
||
|
|
$e->getResponseHeaders()
|
||
|
|
);
|
||
|
|
$e->setResponseObject($data);
|
||
|
|
break;
|
||
|
|
case 400:
|
||
|
|
$data = ObjectSerializer::deserialize(
|
||
|
|
$e->getResponseBody(),
|
||
|
|
'\Brevo\Client\Model\ErrorModel',
|
||
|
|
$e->getResponseHeaders()
|
||
|
|
);
|
||
|
|
$e->setResponseObject($data);
|
||
|
|
break;
|
||
|
|
case 415:
|
||
|
|
$data = ObjectSerializer::deserialize(
|
||
|
|
$e->getResponseBody(),
|
||
|
|
'\Brevo\Client\Model\ErrorModel',
|
||
|
|
$e->getResponseHeaders()
|
||
|
|
);
|
||
|
|
$e->setResponseObject($data);
|
||
|
|
break;
|
||
|
|
}
|
||
|
|
throw $e;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesPostAsync
|
||
|
|
*
|
||
|
|
* Create a note
|
||
|
|
*
|
||
|
|
* @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
||
|
|
*/
|
||
|
|
public function crmNotesPostAsync($body)
|
||
|
|
{
|
||
|
|
return $this->crmNotesPostAsyncWithHttpInfo($body)
|
||
|
|
->then(
|
||
|
|
function ($response) {
|
||
|
|
return $response[0];
|
||
|
|
}
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Operation crmNotesPostAsyncWithHttpInfo
|
||
|
|
*
|
||
|
|
* Create a note
|
||
|
|
*
|
||
|
|
* @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Promise\PromiseInterface
|
||
|
|
*/
|
||
|
|
public function crmNotesPostAsyncWithHttpInfo($body)
|
||
|
|
{
|
||
|
|
$returnType = '\Brevo\Client\Model\NoteId';
|
||
|
|
$request = $this->crmNotesPostRequest($body);
|
||
|
|
|
||
|
|
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 'crmNotesPost'
|
||
|
|
*
|
||
|
|
* @param \Brevo\Client\Model\NoteData $body Note data to create a note. (required)
|
||
|
|
*
|
||
|
|
* @throws \InvalidArgumentException
|
||
|
|
* @return \GuzzleHttp\Psr7\Request
|
||
|
|
*/
|
||
|
|
protected function crmNotesPostRequest($body)
|
||
|
|
{
|
||
|
|
// verify the required parameter 'body' is set
|
||
|
|
if ($body === null || (is_array($body) && count($body) === 0)) {
|
||
|
|
throw new \InvalidArgumentException(
|
||
|
|
'Missing the required parameter $body when calling crmNotesPost'
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
$resourcePath = '/crm/notes';
|
||
|
|
$formParams = [];
|
||
|
|
$queryParams = [];
|
||
|
|
$headerParams = [];
|
||
|
|
$httpBody = '';
|
||
|
|
$multipart = false;
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
// body params
|
||
|
|
$_tempBody = null;
|
||
|
|
if (isset($body)) {
|
||
|
|
$_tempBody = $body;
|
||
|
|
}
|
||
|
|
|
||
|
|
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
|
||
|
|
);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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;
|
||
|
|
}
|
||
|
|
}
|