518 lines
12 KiB
PHP
518 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* Contact
|
|
*
|
|
* 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;
|
|
|
|
/**
|
|
* Contact Class Doc Comment
|
|
*
|
|
* @category Class
|
|
* @description Contact Details
|
|
* @package Brevo\Client
|
|
* @author Swagger Codegen team
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
|
*/
|
|
class Contact implements ModelInterface, ArrayAccess
|
|
{
|
|
const DISCRIMINATOR = null;
|
|
|
|
/**
|
|
* The original name of the model.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $swaggerModelName = 'Contact';
|
|
|
|
/**
|
|
* Array of property to type mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $swaggerTypes = [
|
|
'virtualNextTask' => 'object',
|
|
'email' => 'string',
|
|
'assignToId' => 'string',
|
|
'contactsId' => 'int',
|
|
'crmLists' => 'object',
|
|
'attributes' => 'object',
|
|
'createdAt' => '\DateTime',
|
|
'updatedAt' => '\DateTime'
|
|
];
|
|
|
|
/**
|
|
* Array of property to format mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $swaggerFormats = [
|
|
'virtualNextTask' => null,
|
|
'email' => null,
|
|
'assignToId' => null,
|
|
'contactsId' => null,
|
|
'crmLists' => null,
|
|
'attributes' => null,
|
|
'createdAt' => 'date-time',
|
|
'updatedAt' => 'date-time'
|
|
];
|
|
|
|
/**
|
|
* 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 = [
|
|
'virtualNextTask' => 'virtualNextTask',
|
|
'email' => 'email',
|
|
'assignToId' => 'assignToId',
|
|
'contactsId' => 'contactsId',
|
|
'crmLists' => 'crmLists',
|
|
'attributes' => 'attributes',
|
|
'createdAt' => 'createdAt',
|
|
'updatedAt' => 'updatedAt'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes to setter functions (for deserialization of responses)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $setters = [
|
|
'virtualNextTask' => 'setVirtualNextTask',
|
|
'email' => 'setEmail',
|
|
'assignToId' => 'setAssignToId',
|
|
'contactsId' => 'setContactsId',
|
|
'crmLists' => 'setCrmLists',
|
|
'attributes' => 'setAttributes',
|
|
'createdAt' => 'setCreatedAt',
|
|
'updatedAt' => 'setUpdatedAt'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes to getter functions (for serialization of requests)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $getters = [
|
|
'virtualNextTask' => 'getVirtualNextTask',
|
|
'email' => 'getEmail',
|
|
'assignToId' => 'getAssignToId',
|
|
'contactsId' => 'getContactsId',
|
|
'crmLists' => 'getCrmLists',
|
|
'attributes' => 'getAttributes',
|
|
'createdAt' => 'getCreatedAt',
|
|
'updatedAt' => 'getUpdatedAt'
|
|
];
|
|
|
|
/**
|
|
* 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['virtualNextTask'] = isset($data['virtualNextTask']) ? $data['virtualNextTask'] : null;
|
|
$this->container['email'] = isset($data['email']) ? $data['email'] : null;
|
|
$this->container['assignToId'] = isset($data['assignToId']) ? $data['assignToId'] : null;
|
|
$this->container['contactsId'] = isset($data['contactsId']) ? $data['contactsId'] : null;
|
|
$this->container['crmLists'] = isset($data['crmLists']) ? $data['crmLists'] : null;
|
|
$this->container['attributes'] = isset($data['attributes']) ? $data['attributes'] : null;
|
|
$this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null;
|
|
$this->container['updatedAt'] = isset($data['updatedAt']) ? $data['updatedAt'] : 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['crmLists'] === null) {
|
|
$invalidProperties[] = "'crmLists' 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 virtualNextTask
|
|
*
|
|
* @return object
|
|
*/
|
|
public function getVirtualNextTask()
|
|
{
|
|
return $this->container['virtualNextTask'];
|
|
}
|
|
|
|
/**
|
|
* Sets virtualNextTask
|
|
*
|
|
* @param object $virtualNextTask Next incomplete task of contact
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setVirtualNextTask($virtualNextTask)
|
|
{
|
|
$this->container['virtualNextTask'] = $virtualNextTask;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets email
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getEmail()
|
|
{
|
|
return $this->container['email'];
|
|
}
|
|
|
|
/**
|
|
* Sets email
|
|
*
|
|
* @param string $email Contact email
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setEmail($email)
|
|
{
|
|
$this->container['email'] = $email;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets assignToId
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getAssignToId()
|
|
{
|
|
return $this->container['assignToId'];
|
|
}
|
|
|
|
/**
|
|
* Sets assignToId
|
|
*
|
|
* @param string $assignToId User id to whom contact is assigned
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setAssignToId($assignToId)
|
|
{
|
|
$this->container['assignToId'] = $assignToId;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets contactsId
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getContactsId()
|
|
{
|
|
return $this->container['contactsId'];
|
|
}
|
|
|
|
/**
|
|
* Sets contactsId
|
|
*
|
|
* @param int $contactsId Contact id
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setContactsId($contactsId)
|
|
{
|
|
$this->container['contactsId'] = $contactsId;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets crmLists
|
|
*
|
|
* @return object
|
|
*/
|
|
public function getCrmLists()
|
|
{
|
|
return $this->container['crmLists'];
|
|
}
|
|
|
|
/**
|
|
* Sets crmLists
|
|
*
|
|
* @param object $crmLists CRM lists in which contact is added
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setCrmLists($crmLists)
|
|
{
|
|
$this->container['crmLists'] = $crmLists;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets attributes
|
|
*
|
|
* @return object
|
|
*/
|
|
public function getAttributes()
|
|
{
|
|
return $this->container['attributes'];
|
|
}
|
|
|
|
/**
|
|
* Sets attributes
|
|
*
|
|
* @param object $attributes Contact attributes e.g firstname / lastname / SMS etc.
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setAttributes($attributes)
|
|
{
|
|
$this->container['attributes'] = $attributes;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets createdAt
|
|
*
|
|
* @return \DateTime
|
|
*/
|
|
public function getCreatedAt()
|
|
{
|
|
return $this->container['createdAt'];
|
|
}
|
|
|
|
/**
|
|
* Sets createdAt
|
|
*
|
|
* @param \DateTime $createdAt Contact created date/time
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setCreatedAt($createdAt)
|
|
{
|
|
$this->container['createdAt'] = $createdAt;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets updatedAt
|
|
*
|
|
* @return \DateTime
|
|
*/
|
|
public function getUpdatedAt()
|
|
{
|
|
return $this->container['updatedAt'];
|
|
}
|
|
|
|
/**
|
|
* Sets updatedAt
|
|
*
|
|
* @param \DateTime $updatedAt Contact updated date/time
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setUpdatedAt($updatedAt)
|
|
{
|
|
$this->container['updatedAt'] = $updatedAt;
|
|
|
|
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));
|
|
}
|
|
}
|
|
|
|
|