<?php
/**
* ConversationsApi
* PHP version 5
*
* @category Class
* @package MailchimpMarketing
* @author Swagger Codegen team
* @link https://github.com/swagger-api/swagger-codegen
*/
/**
* Mailchimp Marketing API
*
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*
* OpenAPI spec version: 3.0.27
* Contact: apihelp@mailchimp.com
* Generated by: https://github.com/swagger-api/swagger-codegen.git
* Swagger Codegen version: 2.4.12
*/
/**
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen
* Do not edit the class manually.
*/
namespace MailchimpMarketing\Api;
use GuzzleHttp\Client;
use GuzzleHttp\ClientInterface;
use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\Psr7\MultipartStream;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\RequestOptions;
use MailchimpMarketing\ApiException;
use MailchimpMarketing\Configuration;
use MailchimpMarketing\HeaderSelector;
use MailchimpMarketing\ObjectSerializer;
class ConversationsApi
{
protected $client;
protected $config;
protected $headerSelector;
public function __construct(Configuration $config = null)
{
$this->client = new Client([
'defaults' => [
'timeout' => 120.0
]
]);
$this->headerSelector = new HeaderSelector();
$this->config = $config ?: new Configuration();
}
public function getConfig()
{
return $this->config;
}
public function list($fields = null, $exclude_fields = null, $count = '10', $offset = '0', $has_unread_messages = null, $list_id = null, $campaign_id = null)
{
$response = $this->listWithHttpInfo($fields, $exclude_fields, $count, $offset, $has_unread_messages, $list_id, $campaign_id);
return $response;
}
public function listWithHttpInfo($fields = null, $exclude_fields = null, $count = '10', $offset = '0', $has_unread_messages = null, $list_id = null, $campaign_id = null)
{
$request = $this->listRequest($fields, $exclude_fields, $count, $offset, $has_unread_messages, $list_id, $campaign_id);
try {
$options = $this->createHttpClientOption();
try {
$response = $this->client->send($request, $options);
} catch (RequestException $e) {
throw $e;
}
$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();
$content = $responseBody->getContents();
$content = json_decode($content);
return $content;
} catch (ApiException $e) {
throw $e->getResponseBody();
}
}
protected function listRequest($fields = null, $exclude_fields = null, $count = '10', $offset = '0', $has_unread_messages = null, $list_id = null, $campaign_id = null)
{
if ($count !== null && $count > 1000) {
throw new \InvalidArgumentException('invalid value for "$count" when calling ConversationsApi., must be smaller than or equal to 1000.');
}
$resourcePath = '/conversations';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if (is_array($fields)) {
$queryParams['fields'] = $fields;
} else
if ($fields !== null) {
$queryParams['fields'] = ObjectSerializer::toQueryValue($fields);
}
// query params
if (is_array($exclude_fields)) {
$queryParams['exclude_fields'] = $exclude_fields;
} else
if ($exclude_fields !== null) {
$queryParams['exclude_fields'] = ObjectSerializer::toQueryValue($exclude_fields);
}
// query params
if ($count !== null) {
$queryParams['count'] = ObjectSerializer::toQueryValue($count);
}
// query params
if ($offset !== null) {
$queryParams['offset'] = ObjectSerializer::toQueryValue($offset);
}
// query params
if ($has_unread_messages !== null) {
$queryParams['has_unread_messages'] = ObjectSerializer::toQueryValue($has_unread_messages);
}
// query params
if ($list_id !== null) {
$queryParams['list_id'] = ObjectSerializer::toQueryValue($list_id);
}
// query params
if ($campaign_id !== null) {
$queryParams['campaign_id'] = ObjectSerializer::toQueryValue($campaign_id);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json', 'application/problem+json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json', 'application/problem+json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
$httpBody = $_tempBody;
if($headers['Content-Type'] === 'application/json') {
if ($httpBody instanceof \stdClass) {
$httpBody = \GuzzleHttp\json_encode($httpBody);
}
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
];
}
$httpBody = new MultipartStream($multipartContents);
} elseif ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode($formParams);
} else {
$httpBody = \GuzzleHttp\Psr7\build_query($formParams);
}
}
// Basic Authentication
if (!empty($this->config->getUsername()) && !empty($this->config->getPassword())) {
$headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ":" . $this->config->getPassword());
}
// OAuth Authentication
if (!empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer ' . $this->config->getAccessToken();
}
$defaultHeaders = [];
if ($this->config->getUserAgent()) {
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
}
$headers = array_merge(
$defaultHeaders,
$headerParams,
$headers
);
$query = \GuzzleHttp\Psr7\build_query($queryParams);
return new Request(
'GET',
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
$headers,
$httpBody
);
}
public function get($conversation_id, $fields = null, $exclude_fields = null)
{
$response = $this->getWithHttpInfo($conversation_id, $fields, $exclude_fields);
return $response;
}
public function getWithHttpInfo($conversation_id, $fields = null, $exclude_fields = null)
{
$request = $this->getRequest($conversation_id, $fields, $exclude_fields);
try {
$options = $this->createHttpClientOption();
try {
$response = $this->client->send($request, $options);
} catch (RequestException $e) {
throw $e;
}
$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();
$content = $responseBody->getContents();
$content = json_decode($content);
return $content;
} catch (ApiException $e) {
throw $e->getResponseBody();
}
}
protected function getRequest($conversation_id, $fields = null, $exclude_fields = null)
{
// verify the required parameter 'conversation_id' is set
if ($conversation_id === null || (is_array($conversation_id) && count($conversation_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $conversation_id when calling '
);
}
$resourcePath = '/conversations/{conversation_id}';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if (is_array($fields)) {
$queryParams['fields'] = $fields;
} else
if ($fields !== null) {
$queryParams['fields'] = ObjectSerializer::toQueryValue($fields);
}
// query params
if (is_array($exclude_fields)) {
$queryParams['exclude_fields'] = $exclude_fields;
} else
if ($exclude_fields !== null) {
$queryParams['exclude_fields'] = ObjectSerializer::toQueryValue($exclude_fields);
}
// path params
if ($conversation_id !== null) {
$resourcePath = str_replace(
'{' . 'conversation_id' . '}',
ObjectSerializer::toPathValue($conversation_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json', 'application/problem+json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json', 'application/problem+json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
$httpBody = $_tempBody;
if($headers['Content-Type'] === 'application/json') {
if ($httpBody instanceof \stdClass) {
$httpBody = \GuzzleHttp\json_encode($httpBody);
}
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
];
}
$httpBody = new MultipartStream($multipartContents);
} elseif ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode($formParams);
} else {
$httpBody = \GuzzleHttp\Psr7\build_query($formParams);
}
}
// Basic Authentication
if (!empty($this->config->getUsername()) && !empty($this->config->getPassword())) {
$headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ":" . $this->config->getPassword());
}
// OAuth Authentication
if (!empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer ' . $this->config->getAccessToken();
}
$defaultHeaders = [];
if ($this->config->getUserAgent()) {
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
}
$headers = array_merge(
$defaultHeaders,
$headerParams,
$headers
);
$query = \GuzzleHttp\Psr7\build_query($queryParams);
return new Request(
'GET',
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
$headers,
$httpBody
);
}
public function getConversationMessages($conversation_id, $fields = null, $exclude_fields = null, $is_read = null, $before_timestamp = null, $since_timestamp = null)
{
$response = $this->getConversationMessagesWithHttpInfo($conversation_id, $fields, $exclude_fields, $is_read, $before_timestamp, $since_timestamp);
return $response;
}
public function getConversationMessagesWithHttpInfo($conversation_id, $fields = null, $exclude_fields = null, $is_read = null, $before_timestamp = null, $since_timestamp = null)
{
$request = $this->getConversationMessagesRequest($conversation_id, $fields, $exclude_fields, $is_read, $before_timestamp, $since_timestamp);
try {
$options = $this->createHttpClientOption();
try {
$response = $this->client->send($request, $options);
} catch (RequestException $e) {
throw $e;
}
$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();
$content = $responseBody->getContents();
$content = json_decode($content);
return $content;
} catch (ApiException $e) {
throw $e->getResponseBody();
}
}
protected function getConversationMessagesRequest($conversation_id, $fields = null, $exclude_fields = null, $is_read = null, $before_timestamp = null, $since_timestamp = null)
{
// verify the required parameter 'conversation_id' is set
if ($conversation_id === null || (is_array($conversation_id) && count($conversation_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $conversation_id when calling '
);
}
$resourcePath = '/conversations/{conversation_id}/messages';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if (is_array($fields)) {
$queryParams['fields'] = $fields;
} else
if ($fields !== null) {
$queryParams['fields'] = ObjectSerializer::toQueryValue($fields);
}
// query params
if (is_array($exclude_fields)) {
$queryParams['exclude_fields'] = $exclude_fields;
} else
if ($exclude_fields !== null) {
$queryParams['exclude_fields'] = ObjectSerializer::toQueryValue($exclude_fields);
}
// query params
if ($is_read !== null) {
$queryParams['is_read'] = ObjectSerializer::toQueryValue($is_read);
}
// query params
if ($before_timestamp !== null) {
$queryParams['before_timestamp'] = ObjectSerializer::toQueryValue($before_timestamp);
}
// query params
if ($since_timestamp !== null) {
$queryParams['since_timestamp'] = ObjectSerializer::toQueryValue($since_timestamp);
}
// path params
if ($conversation_id !== null) {
$resourcePath = str_replace(
'{' . 'conversation_id' . '}',
ObjectSerializer::toPathValue($conversation_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json', 'application/problem+json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json', 'application/problem+json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
$httpBody = $_tempBody;
if($headers['Content-Type'] === 'application/json') {
if ($httpBody instanceof \stdClass) {
$httpBody = \GuzzleHttp\json_encode($httpBody);
}
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
];
}
$httpBody = new MultipartStream($multipartContents);
} elseif ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode($formParams);
} else {
$httpBody = \GuzzleHttp\Psr7\build_query($formParams);
}
}
// Basic Authentication
if (!empty($this->config->getUsername()) && !empty($this->config->getPassword())) {
$headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ":" . $this->config->getPassword());
}
// OAuth Authentication
if (!empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer ' . $this->config->getAccessToken();
}
$defaultHeaders = [];
if ($this->config->getUserAgent()) {
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
}
$headers = array_merge(
$defaultHeaders,
$headerParams,
$headers
);
$query = \GuzzleHttp\Psr7\build_query($queryParams);
return new Request(
'GET',
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
$headers,
$httpBody
);
}
public function getConversationMessage($conversation_id, $message_id, $fields = null, $exclude_fields = null)
{
$response = $this->getConversationMessageWithHttpInfo($conversation_id, $message_id, $fields, $exclude_fields);
return $response;
}
public function getConversationMessageWithHttpInfo($conversation_id, $message_id, $fields = null, $exclude_fields = null)
{
$request = $this->getConversationMessageRequest($conversation_id, $message_id, $fields, $exclude_fields);
try {
$options = $this->createHttpClientOption();
try {
$response = $this->client->send($request, $options);
} catch (RequestException $e) {
throw $e;
}
$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();
$content = $responseBody->getContents();
$content = json_decode($content);
return $content;
} catch (ApiException $e) {
throw $e->getResponseBody();
}
}
protected function getConversationMessageRequest($conversation_id, $message_id, $fields = null, $exclude_fields = null)
{
// verify the required parameter 'conversation_id' is set
if ($conversation_id === null || (is_array($conversation_id) && count($conversation_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $conversation_id when calling '
);
}
// verify the required parameter 'message_id' is set
if ($message_id === null || (is_array($message_id) && count($message_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $message_id when calling '
);
}
$resourcePath = '/conversations/{conversation_id}/messages/{message_id}';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// query params
if (is_array($fields)) {
$queryParams['fields'] = $fields;
} else
if ($fields !== null) {
$queryParams['fields'] = ObjectSerializer::toQueryValue($fields);
}
// query params
if (is_array($exclude_fields)) {
$queryParams['exclude_fields'] = $exclude_fields;
} else
if ($exclude_fields !== null) {
$queryParams['exclude_fields'] = ObjectSerializer::toQueryValue($exclude_fields);
}
// path params
if ($conversation_id !== null) {
$resourcePath = str_replace(
'{' . 'conversation_id' . '}',
ObjectSerializer::toPathValue($conversation_id),
$resourcePath
);
}
// path params
if ($message_id !== null) {
$resourcePath = str_replace(
'{' . 'message_id' . '}',
ObjectSerializer::toPathValue($message_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json', 'application/problem+json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json', 'application/problem+json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
$httpBody = $_tempBody;
if($headers['Content-Type'] === 'application/json') {
if ($httpBody instanceof \stdClass) {
$httpBody = \GuzzleHttp\json_encode($httpBody);
}
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
];
}
$httpBody = new MultipartStream($multipartContents);
} elseif ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode($formParams);
} else {
$httpBody = \GuzzleHttp\Psr7\build_query($formParams);
}
}
// Basic Authentication
if (!empty($this->config->getUsername()) && !empty($this->config->getPassword())) {
$headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ":" . $this->config->getPassword());
}
// OAuth Authentication
if (!empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer ' . $this->config->getAccessToken();
}
$defaultHeaders = [];
if ($this->config->getUserAgent()) {
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
}
$headers = array_merge(
$defaultHeaders,
$headerParams,
$headers
);
$query = \GuzzleHttp\Psr7\build_query($queryParams);
return new Request(
'GET',
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
$headers,
$httpBody
);
}
public function createConversationMessage($conversation_id, $body)
{
$response = $this->createConversationMessageWithHttpInfo($conversation_id, $body);
return $response;
}
public function createConversationMessageWithHttpInfo($conversation_id, $body)
{
$request = $this->createConversationMessageRequest($conversation_id, $body);
try {
$options = $this->createHttpClientOption();
try {
$response = $this->client->send($request, $options);
} catch (RequestException $e) {
throw $e;
}
$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();
$content = $responseBody->getContents();
$content = json_decode($content);
return $content;
} catch (ApiException $e) {
throw $e->getResponseBody();
}
}
protected function createConversationMessageRequest($conversation_id, $body)
{
// verify the required parameter 'conversation_id' is set
if ($conversation_id === null || (is_array($conversation_id) && count($conversation_id) === 0)) {
throw new \InvalidArgumentException(
'Missing the required parameter $conversation_id when calling '
);
}
// 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 '
);
}
$resourcePath = '/conversations/{conversation_id}/messages';
$formParams = [];
$queryParams = [];
$headerParams = [];
$httpBody = '';
$multipart = false;
// path params
if ($conversation_id !== null) {
$resourcePath = str_replace(
'{' . 'conversation_id' . '}',
ObjectSerializer::toPathValue($conversation_id),
$resourcePath
);
}
// body params
$_tempBody = null;
if (isset($body)) {
$_tempBody = $body;
}
if ($multipart) {
$headers = $this->headerSelector->selectHeadersForMultipart(
['application/json', 'application/problem+json']
);
} else {
$headers = $this->headerSelector->selectHeaders(
['application/json', 'application/problem+json'],
['application/json']
);
}
// for model (json/xml)
if (isset($_tempBody)) {
$httpBody = $_tempBody;
if($headers['Content-Type'] === 'application/json') {
if ($httpBody instanceof \stdClass) {
$httpBody = \GuzzleHttp\json_encode($httpBody);
}
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
];
}
$httpBody = new MultipartStream($multipartContents);
} elseif ($headers['Content-Type'] === 'application/json') {
$httpBody = \GuzzleHttp\json_encode($formParams);
} else {
$httpBody = \GuzzleHttp\Psr7\build_query($formParams);
}
}
// Basic Authentication
if (!empty($this->config->getUsername()) && !empty($this->config->getPassword())) {
$headers['Authorization'] = 'Basic ' . base64_encode($this->config->getUsername() . ":" . $this->config->getPassword());
}
// OAuth Authentication
if (!empty($this->config->getAccessToken())) {
$headers['Authorization'] = 'Bearer ' . $this->config->getAccessToken();
}
$defaultHeaders = [];
if ($this->config->getUserAgent()) {
$defaultHeaders['User-Agent'] = $this->config->getUserAgent();
}
$headers = array_merge(
$defaultHeaders,
$headerParams,
$headers
);
$query = \GuzzleHttp\Psr7\build_query($queryParams);
return new Request(
'POST',
$this->config->getHost() . $resourcePath . ($query ? "?{$query}" : ''),
$headers,
$httpBody
);
}
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;
}
}