462 lines
11 KiB
PHP
462 lines
11 KiB
PHP
|
<?php
|
|||
|
|
/**
|
|||
|
|
* Body10
|
|||
|
|
*
|
|||
|
|
* 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;
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Body10 Class Doc Comment
|
|||
|
|
*
|
|||
|
|
* @category Class
|
|||
|
|
* @package Brevo\Client
|
|||
|
|
* @author Swagger Codegen team
|
|||
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
|||
|
|
*/
|
|||
|
|
class Body10 implements ModelInterface, ArrayAccess
|
|||
|
|
{
|
|||
|
|
const DISCRIMINATOR = null;
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* The original name of the model.
|
|||
|
|
*
|
|||
|
|
* @var string
|
|||
|
|
*/
|
|||
|
|
protected static $swaggerModelName = 'body_10';
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Array of property to type mappings. Used for (de)serialization
|
|||
|
|
*
|
|||
|
|
* @var string[]
|
|||
|
|
*/
|
|||
|
|
protected static $swaggerTypes = [
|
|||
|
|
'visitorId' => 'string',
|
|||
|
|
'text' => 'string',
|
|||
|
|
'agentId' => 'string',
|
|||
|
|
'receivedFrom' => 'string',
|
|||
|
|
'agentEmail' => 'string',
|
|||
|
|
'agentName' => 'string'
|
|||
|
|
];
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Array of property to format mappings. Used for (de)serialization
|
|||
|
|
*
|
|||
|
|
* @var string[]
|
|||
|
|
*/
|
|||
|
|
protected static $swaggerFormats = [
|
|||
|
|
'visitorId' => null,
|
|||
|
|
'text' => null,
|
|||
|
|
'agentId' => null,
|
|||
|
|
'receivedFrom' => null,
|
|||
|
|
'agentEmail' => 'email',
|
|||
|
|
'agentName' => 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 = [
|
|||
|
|
'visitorId' => 'visitorId',
|
|||
|
|
'text' => 'text',
|
|||
|
|
'agentId' => 'agentId',
|
|||
|
|
'receivedFrom' => 'receivedFrom',
|
|||
|
|
'agentEmail' => 'agentEmail',
|
|||
|
|
'agentName' => 'agentName'
|
|||
|
|
];
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Array of attributes to setter functions (for deserialization of responses)
|
|||
|
|
*
|
|||
|
|
* @var string[]
|
|||
|
|
*/
|
|||
|
|
protected static $setters = [
|
|||
|
|
'visitorId' => 'setVisitorId',
|
|||
|
|
'text' => 'setText',
|
|||
|
|
'agentId' => 'setAgentId',
|
|||
|
|
'receivedFrom' => 'setReceivedFrom',
|
|||
|
|
'agentEmail' => 'setAgentEmail',
|
|||
|
|
'agentName' => 'setAgentName'
|
|||
|
|
];
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Array of attributes to getter functions (for serialization of requests)
|
|||
|
|
*
|
|||
|
|
* @var string[]
|
|||
|
|
*/
|
|||
|
|
protected static $getters = [
|
|||
|
|
'visitorId' => 'getVisitorId',
|
|||
|
|
'text' => 'getText',
|
|||
|
|
'agentId' => 'getAgentId',
|
|||
|
|
'receivedFrom' => 'getReceivedFrom',
|
|||
|
|
'agentEmail' => 'getAgentEmail',
|
|||
|
|
'agentName' => 'getAgentName'
|
|||
|
|
];
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* 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['visitorId'] = isset($data['visitorId']) ? $data['visitorId'] : null;
|
|||
|
|
$this->container['text'] = isset($data['text']) ? $data['text'] : null;
|
|||
|
|
$this->container['agentId'] = isset($data['agentId']) ? $data['agentId'] : null;
|
|||
|
|
$this->container['receivedFrom'] = isset($data['receivedFrom']) ? $data['receivedFrom'] : null;
|
|||
|
|
$this->container['agentEmail'] = isset($data['agentEmail']) ? $data['agentEmail'] : null;
|
|||
|
|
$this->container['agentName'] = isset($data['agentName']) ? $data['agentName'] : null;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Show all the invalid properties with reasons.
|
|||
|
|
*
|
|||
|
|
* @return array invalid properties with reasons
|
|||
|
|
*/
|
|||
|
|
public function listInvalidProperties()
|
|||
|
|
{
|
|||
|
|
$invalidProperties = [];
|
|||
|
|
|
|||
|
|
if ($this->container['visitorId'] === null) {
|
|||
|
|
$invalidProperties[] = "'visitorId' can't be null";
|
|||
|
|
}
|
|||
|
|
if ($this->container['text'] === null) {
|
|||
|
|
$invalidProperties[] = "'text' 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 visitorId
|
|||
|
|
*
|
|||
|
|
* @return string
|
|||
|
|
*/
|
|||
|
|
public function getVisitorId()
|
|||
|
|
{
|
|||
|
|
return $this->container['visitorId'];
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Sets visitorId
|
|||
|
|
*
|
|||
|
|
* @param string $visitorId visitor’s ID received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a> or generated by you to <a href=\"https://developers.brevo.com/docs/customize-the-widget#identifying-existing-users\">bind existing user account to Conversations</a>
|
|||
|
|
*
|
|||
|
|
* @return $this
|
|||
|
|
*/
|
|||
|
|
public function setVisitorId($visitorId)
|
|||
|
|
{
|
|||
|
|
$this->container['visitorId'] = $visitorId;
|
|||
|
|
|
|||
|
|
return $this;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Gets text
|
|||
|
|
*
|
|||
|
|
* @return string
|
|||
|
|
*/
|
|||
|
|
public function getText()
|
|||
|
|
{
|
|||
|
|
return $this->container['text'];
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Sets text
|
|||
|
|
*
|
|||
|
|
* @param string $text message text
|
|||
|
|
*
|
|||
|
|
* @return $this
|
|||
|
|
*/
|
|||
|
|
public function setText($text)
|
|||
|
|
{
|
|||
|
|
$this->container['text'] = $text;
|
|||
|
|
|
|||
|
|
return $this;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Gets agentId
|
|||
|
|
*
|
|||
|
|
* @return string
|
|||
|
|
*/
|
|||
|
|
public function getAgentId()
|
|||
|
|
{
|
|||
|
|
return $this->container['agentId'];
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Sets agentId
|
|||
|
|
*
|
|||
|
|
* @param string $agentId agent ID. It can be found on agent’s page or received <a href=\"https://developers.brevo.com/docs/conversations-webhooks\">from a webhook</a>. Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required).
|
|||
|
|
*
|
|||
|
|
* @return $this
|
|||
|
|
*/
|
|||
|
|
public function setAgentId($agentId)
|
|||
|
|
{
|
|||
|
|
$this->container['agentId'] = $agentId;
|
|||
|
|
|
|||
|
|
return $this;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Gets receivedFrom
|
|||
|
|
*
|
|||
|
|
* @return string
|
|||
|
|
*/
|
|||
|
|
public function getReceivedFrom()
|
|||
|
|
{
|
|||
|
|
return $this->container['receivedFrom'];
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Sets receivedFrom
|
|||
|
|
*
|
|||
|
|
* @param string $receivedFrom mark your messages to distinguish messages created by you from the others.
|
|||
|
|
*
|
|||
|
|
* @return $this
|
|||
|
|
*/
|
|||
|
|
public function setReceivedFrom($receivedFrom)
|
|||
|
|
{
|
|||
|
|
$this->container['receivedFrom'] = $receivedFrom;
|
|||
|
|
|
|||
|
|
return $this;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Gets agentEmail
|
|||
|
|
*
|
|||
|
|
* @return string
|
|||
|
|
*/
|
|||
|
|
public function getAgentEmail()
|
|||
|
|
{
|
|||
|
|
return $this->container['agentEmail'];
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Sets agentEmail
|
|||
|
|
*
|
|||
|
|
* @param string $agentEmail agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address.
|
|||
|
|
*
|
|||
|
|
* @return $this
|
|||
|
|
*/
|
|||
|
|
public function setAgentEmail($agentEmail)
|
|||
|
|
{
|
|||
|
|
$this->container['agentEmail'] = $agentEmail;
|
|||
|
|
|
|||
|
|
return $this;
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Gets agentName
|
|||
|
|
*
|
|||
|
|
* @return string
|
|||
|
|
*/
|
|||
|
|
public function getAgentName()
|
|||
|
|
{
|
|||
|
|
return $this->container['agentName'];
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
/**
|
|||
|
|
* Sets agentName
|
|||
|
|
*
|
|||
|
|
* @param string $agentName agent name
|
|||
|
|
*
|
|||
|
|
* @return $this
|
|||
|
|
*/
|
|||
|
|
public function setAgentName($agentName)
|
|||
|
|
{
|
|||
|
|
$this->container['agentName'] = $agentName;
|
|||
|
|
|
|||
|
|
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));
|
|||
|
|
}
|
|||
|
|
}
|
|||
|
|
|
|||
|
|
|