File "Note.php"
Full Path: /home/clickysoft/public_html/jmapi5.clickysoft.net/vendor/getbrevo/brevo-php/lib/Model/Note.php
File size: 11.72 KB
MIME-type: text/x-php
Charset: utf-8
<?php
/**
* Note
*
* 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;
/**
* Note Class Doc Comment
*
* @category Class
* @description Note Details
* @package Brevo\Client
* @author Swagger Codegen team
* @link https://github.com/swagger-api/swagger-codegen
*/
class Note implements ModelInterface, ArrayAccess
{
const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $swaggerModelName = 'Note';
/**
* Array of property to type mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $swaggerTypes = [
'id' => 'string',
'text' => 'string',
'contactIds' => 'int[]',
'dealIds' => 'string[]',
'authorId' => 'object',
'createdAt' => '\DateTime',
'updatedAt' => '\DateTime'
];
/**
* Array of property to format mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $swaggerFormats = [
'id' => null,
'text' => null,
'contactIds' => null,
'dealIds' => null,
'authorId' => 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 = [
'id' => 'id',
'text' => 'text',
'contactIds' => 'contactIds',
'dealIds' => 'dealIds',
'authorId' => 'authorId',
'createdAt' => 'createdAt',
'updatedAt' => 'updatedAt'
];
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @var string[]
*/
protected static $setters = [
'id' => 'setId',
'text' => 'setText',
'contactIds' => 'setContactIds',
'dealIds' => 'setDealIds',
'authorId' => 'setAuthorId',
'createdAt' => 'setCreatedAt',
'updatedAt' => 'setUpdatedAt'
];
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @var string[]
*/
protected static $getters = [
'id' => 'getId',
'text' => 'getText',
'contactIds' => 'getContactIds',
'dealIds' => 'getDealIds',
'authorId' => 'getAuthorId',
'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['id'] = isset($data['id']) ? $data['id'] : null;
$this->container['text'] = isset($data['text']) ? $data['text'] : null;
$this->container['contactIds'] = isset($data['contactIds']) ? $data['contactIds'] : null;
$this->container['dealIds'] = isset($data['dealIds']) ? $data['dealIds'] : null;
$this->container['authorId'] = isset($data['authorId']) ? $data['authorId'] : 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['text'] === null) {
$invalidProperties[] = "'text' can't be null";
}
if ((mb_strlen($this->container['text']) > 3000)) {
$invalidProperties[] = "invalid value for 'text', the character length must be smaller than or equal to 3000.";
}
if ((mb_strlen($this->container['text']) < 1)) {
$invalidProperties[] = "invalid value for 'text', the character length must be bigger than or equal to 1.";
}
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 id
*
* @return string
*/
public function getId()
{
return $this->container['id'];
}
/**
* Sets id
*
* @param string $id Unique note Id
*
* @return $this
*/
public function setId($id)
{
$this->container['id'] = $id;
return $this;
}
/**
* Gets text
*
* @return string
*/
public function getText()
{
return $this->container['text'];
}
/**
* Sets text
*
* @param string $text Text content of a note
*
* @return $this
*/
public function setText($text)
{
if ((mb_strlen($text) > 3000)) {
throw new \InvalidArgumentException('invalid length for $text when calling Note., must be smaller than or equal to 3000.');
}
if ((mb_strlen($text) < 1)) {
throw new \InvalidArgumentException('invalid length for $text when calling Note., must be bigger than or equal to 1.');
}
$this->container['text'] = $text;
return $this;
}
/**
* Gets contactIds
*
* @return int[]
*/
public function getContactIds()
{
return $this->container['contactIds'];
}
/**
* Sets contactIds
*
* @param int[] $contactIds Contact ids linked to a note
*
* @return $this
*/
public function setContactIds($contactIds)
{
$this->container['contactIds'] = $contactIds;
return $this;
}
/**
* Gets dealIds
*
* @return string[]
*/
public function getDealIds()
{
return $this->container['dealIds'];
}
/**
* Sets dealIds
*
* @param string[] $dealIds Deal ids linked to a note
*
* @return $this
*/
public function setDealIds($dealIds)
{
$this->container['dealIds'] = $dealIds;
return $this;
}
/**
* Gets authorId
*
* @return object
*/
public function getAuthorId()
{
return $this->container['authorId'];
}
/**
* Sets authorId
*
* @param object $authorId Account details of user which created the note
*
* @return $this
*/
public function setAuthorId($authorId)
{
$this->container['authorId'] = $authorId;
return $this;
}
/**
* Gets createdAt
*
* @return \DateTime
*/
public function getCreatedAt()
{
return $this->container['createdAt'];
}
/**
* Sets createdAt
*
* @param \DateTime $createdAt Note 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 Note 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
*/
#[\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));
}
}