<?php
/**
* SendReportEmail
*
* PHP version 5
*
* @category Class
* @package SendinBlue\Client
* @author Swagger Codegen team
* @link https://github.com/swagger-api/swagger-codegen
*/
/**
* SendinBlue API
*
* SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | | 406 | Error. Not Acceptable |
*
* OpenAPI spec version: 3.0.0
* Contact: contact@sendinblue.com
* Generated by: https://github.com/swagger-api/swagger-codegen.git
* Swagger Codegen version: 2.4.12
*/
/**
* NOTE: This class is auto generated by the swagger code generator program.
* https://github.com/swagger-api/swagger-codegen
* Do not edit the class manually.
*/
namespace SendinBlue\Client\Model;
use \ArrayAccess;
use \SendinBlue\Client\ObjectSerializer;
/**
* SendReportEmail Class Doc Comment
*
* @category Class
* @description Email sending credentials including subject, body, to, cc etc.
* @package SendinBlue\Client
* @author Swagger Codegen team
* @link https://github.com/swagger-api/swagger-codegen
*/
class SendReportEmail implements ModelInterface, ArrayAccess
{
const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $swaggerModelName = 'sendReport_email';
/**
* Array of property to type mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $swaggerTypes = [
'subject' => 'string',
'to' => 'string[]',
'contentType' => 'string',
'bcc' => 'string[]',
'cc' => 'string[]',
'body' => 'string'
];
/**
* Array of property to format mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $swaggerFormats = [
'subject' => null,
'to' => 'email',
'contentType' => null,
'bcc' => 'email',
'cc' => 'email',
'body' => null
];
/**
* Array of property to type mappings. Used for (de)serialization
*
* @return array
*/
public static function swaggerTypes()
{
return self::$swaggerTypes;
}
/**
* Array of property to format mappings. Used for (de)serialization
*
* @return array
*/
public static function swaggerFormats()
{
return self::$swaggerFormats;
}
/**
* Array of attributes where the key is the local name,
* and the value is the original name
*
* @var string[]
*/
protected static $attributeMap = [
'subject' => 'subject',
'to' => 'to',
'contentType' => 'contentType',
'bcc' => 'bcc',
'cc' => 'cc',
'body' => 'body'
];
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @var string[]
*/
protected static $setters = [
'subject' => 'setSubject',
'to' => 'setTo',
'contentType' => 'setContentType',
'bcc' => 'setBcc',
'cc' => 'setCc',
'body' => 'setBody'
];
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @var string[]
*/
protected static $getters = [
'subject' => 'getSubject',
'to' => 'getTo',
'contentType' => 'getContentType',
'bcc' => 'getBcc',
'cc' => 'getCc',
'body' => 'getBody'
];
/**
* Array of attributes where the key is the local name,
* and the value is the original name
*
* @return array
*/
public static function attributeMap()
{
return self::$attributeMap;
}
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @return array
*/
public static function setters()
{
return self::$setters;
}
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @return array
*/
public static function getters()
{
return self::$getters;
}
/**
* The original name of the model.
*
* @return string
*/
public function getModelName()
{
return self::$swaggerModelName;
}
const CONTENT_TYPE_TEXT = 'text';
const CONTENT_TYPE_HTML = 'html';
/**
* Gets allowable values of the enum
*
* @return string[]
*/
public function getContentTypeAllowableValues()
{
return [
self::CONTENT_TYPE_TEXT,
self::CONTENT_TYPE_HTML,
];
}
/**
* Associative array for storing property values
*
* @var mixed[]
*/
protected $container = [];
/**
* Constructor
*
* @param mixed[] $data Associated array of property values
* initializing the model
*/
public function __construct(array $data = null)
{
$this->container['subject'] = isset($data['subject']) ? $data['subject'] : null;
$this->container['to'] = isset($data['to']) ? $data['to'] : null;
$this->container['contentType'] = isset($data['contentType']) ? $data['contentType'] : 'html';
$this->container['bcc'] = isset($data['bcc']) ? $data['bcc'] : null;
$this->container['cc'] = isset($data['cc']) ? $data['cc'] : null;
$this->container['body'] = isset($data['body']) ? $data['body'] : null;
}
/**
* Show all the invalid properties with reasons.
*
* @return array invalid properties with reasons
*/
public function listInvalidProperties()
{
$invalidProperties = [];
if ($this->container['subject'] === null) {
$invalidProperties[] = "'subject' can't be null";
}
if ($this->container['to'] === null) {
$invalidProperties[] = "'to' can't be null";
}
$allowedValues = $this->getContentTypeAllowableValues();
if (!is_null($this->container['contentType']) && !in_array($this->container['contentType'], $allowedValues, true)) {
$invalidProperties[] = sprintf(
"invalid value for 'contentType', must be one of '%s'",
implode("', '", $allowedValues)
);
}
if ($this->container['body'] === null) {
$invalidProperties[] = "'body' can't be null";
}
return $invalidProperties;
}
/**
* Validate all the properties in the model
* return true if all passed
*
* @return bool True if all properties are valid
*/
public function valid()
{
return count($this->listInvalidProperties()) === 0;
}
/**
* Gets subject
*
* @return string
*/
public function getSubject()
{
return $this->container['subject'];
}
/**
* Sets subject
*
* @param string $subject Subject of the email message
*
* @return $this
*/
public function setSubject($subject)
{
$this->container['subject'] = $subject;
return $this;
}
/**
* Gets to
*
* @return string[]
*/
public function getTo()
{
return $this->container['to'];
}
/**
* Sets to
*
* @param string[] $to Email addresses of the recipients
*
* @return $this
*/
public function setTo($to)
{
$this->container['to'] = $to;
return $this;
}
/**
* Gets contentType
*
* @return string
*/
public function getContentType()
{
return $this->container['contentType'];
}
/**
* Sets contentType
*
* @param string $contentType Type of the message body
*
* @return $this
*/
public function setContentType($contentType)
{
$allowedValues = $this->getContentTypeAllowableValues();
if (!is_null($contentType) && !in_array($contentType, $allowedValues, true)) {
throw new \InvalidArgumentException(
sprintf(
"Invalid value for 'contentType', must be one of '%s'",
implode("', '", $allowedValues)
)
);
}
$this->container['contentType'] = $contentType;
return $this;
}
/**
* Gets bcc
*
* @return string[]
*/
public function getBcc()
{
return $this->container['bcc'];
}
/**
* Sets bcc
*
* @param string[] $bcc Email addresses of the recipients in bcc
*
* @return $this
*/
public function setBcc($bcc)
{
$this->container['bcc'] = $bcc;
return $this;
}
/**
* Gets cc
*
* @return string[]
*/
public function getCc()
{
return $this->container['cc'];
}
/**
* Sets cc
*
* @param string[] $cc Email addresses of the recipients in cc
*
* @return $this
*/
public function setCc($cc)
{
$this->container['cc'] = $cc;
return $this;
}
/**
* Gets body
*
* @return string
*/
public function getBody()
{
return $this->container['body'];
}
/**
* Sets body
*
* @param string $body Body of the email message
*
* @return $this
*/
public function setBody($body)
{
$this->container['body'] = $body;
return $this;
}
/**
* Returns true if offset exists. False otherwise.
*
* @param integer $offset Offset
*
* @return boolean
*/
public function offsetExists($offset)
{
return isset($this->container[$offset]);
}
/**
* Gets offset.
*
* @param integer $offset Offset
*
* @return mixed
*/
public function offsetGet($offset)
{
return isset($this->container[$offset]) ? $this->container[$offset] : null;
}
/**
* Sets value based on offset.
*
* @param integer $offset Offset
* @param mixed $value Value to be set
*
* @return void
*/
public function offsetSet($offset, $value)
{
if (is_null($offset)) {
$this->container[] = $value;
} else {
$this->container[$offset] = $value;
}
}
/**
* Unsets offset.
*
* @param integer $offset Offset
*
* @return void
*/
public function offsetUnset($offset)
{
unset($this->container[$offset]);
}
/**
* Gets the string presentation of the object
*
* @return string
*/
public function __toString()
{
if (defined('JSON_PRETTY_PRINT')) { // use JSON pretty print
return json_encode(
ObjectSerializer::sanitizeForSerialization($this),
JSON_PRETTY_PRINT
);
}
return json_encode(ObjectSerializer::sanitizeForSerialization($this));
}
}