530 lines
12 KiB
PHP
530 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* GetTransacEmailsListTransactionalEmails
|
|
*
|
|
* 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\Model;
|
|
|
|
use \ArrayAccess;
|
|
use \Brevo\Client\ObjectSerializer;
|
|
|
|
/**
|
|
* GetTransacEmailsListTransactionalEmails Class Doc Comment
|
|
*
|
|
* @category Class
|
|
* @package Brevo\Client
|
|
* @author Swagger Codegen team
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
|
*/
|
|
class GetTransacEmailsListTransactionalEmails implements ModelInterface, ArrayAccess
|
|
{
|
|
const DISCRIMINATOR = null;
|
|
|
|
/**
|
|
* The original name of the model.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $swaggerModelName = 'getTransacEmailsList_transactionalEmails';
|
|
|
|
/**
|
|
* Array of property to type mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $swaggerTypes = [
|
|
'email' => 'string',
|
|
'subject' => 'string',
|
|
'templateId' => 'int',
|
|
'messageId' => 'string',
|
|
'uuid' => 'string',
|
|
'date' => 'string',
|
|
'from' => 'string',
|
|
'tags' => 'string[]'
|
|
];
|
|
|
|
/**
|
|
* Array of property to format mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $swaggerFormats = [
|
|
'email' => 'email',
|
|
'subject' => null,
|
|
'templateId' => 'int64',
|
|
'messageId' => null,
|
|
'uuid' => null,
|
|
'date' => null,
|
|
'from' => 'email',
|
|
'tags' => 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 = [
|
|
'email' => 'email',
|
|
'subject' => 'subject',
|
|
'templateId' => 'templateId',
|
|
'messageId' => 'messageId',
|
|
'uuid' => 'uuid',
|
|
'date' => 'date',
|
|
'from' => 'from',
|
|
'tags' => 'tags'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes to setter functions (for deserialization of responses)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $setters = [
|
|
'email' => 'setEmail',
|
|
'subject' => 'setSubject',
|
|
'templateId' => 'setTemplateId',
|
|
'messageId' => 'setMessageId',
|
|
'uuid' => 'setUuid',
|
|
'date' => 'setDate',
|
|
'from' => 'setFrom',
|
|
'tags' => 'setTags'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes to getter functions (for serialization of requests)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $getters = [
|
|
'email' => 'getEmail',
|
|
'subject' => 'getSubject',
|
|
'templateId' => 'getTemplateId',
|
|
'messageId' => 'getMessageId',
|
|
'uuid' => 'getUuid',
|
|
'date' => 'getDate',
|
|
'from' => 'getFrom',
|
|
'tags' => 'getTags'
|
|
];
|
|
|
|
/**
|
|
* 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;
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
* 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['email'] = isset($data['email']) ? $data['email'] : null;
|
|
$this->container['subject'] = isset($data['subject']) ? $data['subject'] : null;
|
|
$this->container['templateId'] = isset($data['templateId']) ? $data['templateId'] : null;
|
|
$this->container['messageId'] = isset($data['messageId']) ? $data['messageId'] : null;
|
|
$this->container['uuid'] = isset($data['uuid']) ? $data['uuid'] : null;
|
|
$this->container['date'] = isset($data['date']) ? $data['date'] : null;
|
|
$this->container['from'] = isset($data['from']) ? $data['from'] : null;
|
|
$this->container['tags'] = isset($data['tags']) ? $data['tags'] : null;
|
|
}
|
|
|
|
/**
|
|
* Show all the invalid properties with reasons.
|
|
*
|
|
* @return array invalid properties with reasons
|
|
*/
|
|
public function listInvalidProperties()
|
|
{
|
|
$invalidProperties = [];
|
|
|
|
if ($this->container['email'] === null) {
|
|
$invalidProperties[] = "'email' can't be null";
|
|
}
|
|
if ($this->container['subject'] === null) {
|
|
$invalidProperties[] = "'subject' can't be null";
|
|
}
|
|
if ($this->container['messageId'] === null) {
|
|
$invalidProperties[] = "'messageId' can't be null";
|
|
}
|
|
if ($this->container['uuid'] === null) {
|
|
$invalidProperties[] = "'uuid' can't be null";
|
|
}
|
|
if ($this->container['date'] === null) {
|
|
$invalidProperties[] = "'date' 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 email
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getEmail()
|
|
{
|
|
return $this->container['email'];
|
|
}
|
|
|
|
/**
|
|
* Sets email
|
|
*
|
|
* @param string $email Email address to which transactional email has been sent
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setEmail($email)
|
|
{
|
|
$this->container['email'] = $email;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets subject
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getSubject()
|
|
{
|
|
return $this->container['subject'];
|
|
}
|
|
|
|
/**
|
|
* Sets subject
|
|
*
|
|
* @param string $subject Subject of the sent email
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setSubject($subject)
|
|
{
|
|
$this->container['subject'] = $subject;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets templateId
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getTemplateId()
|
|
{
|
|
return $this->container['templateId'];
|
|
}
|
|
|
|
/**
|
|
* Sets templateId
|
|
*
|
|
* @param int $templateId Id of the template
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setTemplateId($templateId)
|
|
{
|
|
$this->container['templateId'] = $templateId;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets messageId
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getMessageId()
|
|
{
|
|
return $this->container['messageId'];
|
|
}
|
|
|
|
/**
|
|
* Sets messageId
|
|
*
|
|
* @param string $messageId Message Id of the sent email
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setMessageId($messageId)
|
|
{
|
|
$this->container['messageId'] = $messageId;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets uuid
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getUuid()
|
|
{
|
|
return $this->container['uuid'];
|
|
}
|
|
|
|
/**
|
|
* Sets uuid
|
|
*
|
|
* @param string $uuid Unique id of the email sent to a particular contact
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setUuid($uuid)
|
|
{
|
|
$this->container['uuid'] = $uuid;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets date
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getDate()
|
|
{
|
|
return $this->container['date'];
|
|
}
|
|
|
|
/**
|
|
* Sets date
|
|
*
|
|
* @param string $date Date on which transactional email was sent
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setDate($date)
|
|
{
|
|
$this->container['date'] = $date;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets from
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getFrom()
|
|
{
|
|
return $this->container['from'];
|
|
}
|
|
|
|
/**
|
|
* Sets from
|
|
*
|
|
* @param string $from Email address of the sender from which the email was sent
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setFrom($from)
|
|
{
|
|
$this->container['from'] = $from;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets tags
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public function getTags()
|
|
{
|
|
return $this->container['tags'];
|
|
}
|
|
|
|
/**
|
|
* Sets tags
|
|
*
|
|
* @param string[] $tags Tags used for your email
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setTags($tags)
|
|
{
|
|
$this->container['tags'] = $tags;
|
|
|
|
return $this;
|
|
}
|
|
/**
|
|
* Returns true if offset exists. False otherwise.
|
|
*
|
|
* @param integer $offset Offset
|
|
*
|
|
* @return boolean
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
public function offsetExists($offset)
|
|
{
|
|
return isset($this->container[$offset]);
|
|
}
|
|
|
|
/**
|
|
* Gets offset.
|
|
*
|
|
* @param integer $offset Offset
|
|
*
|
|
* @return mixed
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
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
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
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
|
|
*/
|
|
#[\ReturnTypeWillChange]
|
|
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));
|
|
}
|
|
}
|
|
|
|
|