441 lines
11 KiB
PHP
441 lines
11 KiB
PHP
|
<?php
|
||
|
|
/**
|
||
|
|
* GetList
|
||
|
|
*
|
||
|
|
* 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;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* GetList Class Doc Comment
|
||
|
|
*
|
||
|
|
* @category Class
|
||
|
|
* @package Brevo\Client
|
||
|
|
* @author Swagger Codegen team
|
||
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
||
|
|
*/
|
||
|
|
class GetList implements ModelInterface, ArrayAccess
|
||
|
|
{
|
||
|
|
const DISCRIMINATOR = null;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The original name of the model.
|
||
|
|
*
|
||
|
|
* @var string
|
||
|
|
*/
|
||
|
|
protected static $swaggerModelName = 'getList';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Array of property to type mappings. Used for (de)serialization
|
||
|
|
*
|
||
|
|
* @var string[]
|
||
|
|
*/
|
||
|
|
protected static $swaggerTypes = [
|
||
|
|
'id' => 'int',
|
||
|
|
'name' => 'string',
|
||
|
|
'totalBlacklisted' => 'int',
|
||
|
|
'totalSubscribers' => 'int',
|
||
|
|
'uniqueSubscribers' => 'int'
|
||
|
|
];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Array of property to format mappings. Used for (de)serialization
|
||
|
|
*
|
||
|
|
* @var string[]
|
||
|
|
*/
|
||
|
|
protected static $swaggerFormats = [
|
||
|
|
'id' => 'int64',
|
||
|
|
'name' => null,
|
||
|
|
'totalBlacklisted' => 'int64',
|
||
|
|
'totalSubscribers' => 'int64',
|
||
|
|
'uniqueSubscribers' => 'int64'
|
||
|
|
];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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',
|
||
|
|
'name' => 'name',
|
||
|
|
'totalBlacklisted' => 'totalBlacklisted',
|
||
|
|
'totalSubscribers' => 'totalSubscribers',
|
||
|
|
'uniqueSubscribers' => 'uniqueSubscribers'
|
||
|
|
];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Array of attributes to setter functions (for deserialization of responses)
|
||
|
|
*
|
||
|
|
* @var string[]
|
||
|
|
*/
|
||
|
|
protected static $setters = [
|
||
|
|
'id' => 'setId',
|
||
|
|
'name' => 'setName',
|
||
|
|
'totalBlacklisted' => 'setTotalBlacklisted',
|
||
|
|
'totalSubscribers' => 'setTotalSubscribers',
|
||
|
|
'uniqueSubscribers' => 'setUniqueSubscribers'
|
||
|
|
];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Array of attributes to getter functions (for serialization of requests)
|
||
|
|
*
|
||
|
|
* @var string[]
|
||
|
|
*/
|
||
|
|
protected static $getters = [
|
||
|
|
'id' => 'getId',
|
||
|
|
'name' => 'getName',
|
||
|
|
'totalBlacklisted' => 'getTotalBlacklisted',
|
||
|
|
'totalSubscribers' => 'getTotalSubscribers',
|
||
|
|
'uniqueSubscribers' => 'getUniqueSubscribers'
|
||
|
|
];
|
||
|
|
|
||
|
|
/**
|
||
|
|
* 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['name'] = isset($data['name']) ? $data['name'] : null;
|
||
|
|
$this->container['totalBlacklisted'] = isset($data['totalBlacklisted']) ? $data['totalBlacklisted'] : null;
|
||
|
|
$this->container['totalSubscribers'] = isset($data['totalSubscribers']) ? $data['totalSubscribers'] : null;
|
||
|
|
$this->container['uniqueSubscribers'] = isset($data['uniqueSubscribers']) ? $data['uniqueSubscribers'] : null;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Show all the invalid properties with reasons.
|
||
|
|
*
|
||
|
|
* @return array invalid properties with reasons
|
||
|
|
*/
|
||
|
|
public function listInvalidProperties()
|
||
|
|
{
|
||
|
|
$invalidProperties = [];
|
||
|
|
|
||
|
|
if ($this->container['id'] === null) {
|
||
|
|
$invalidProperties[] = "'id' can't be null";
|
||
|
|
}
|
||
|
|
if ($this->container['name'] === null) {
|
||
|
|
$invalidProperties[] = "'name' can't be null";
|
||
|
|
}
|
||
|
|
if ($this->container['totalBlacklisted'] === null) {
|
||
|
|
$invalidProperties[] = "'totalBlacklisted' can't be null";
|
||
|
|
}
|
||
|
|
if ($this->container['totalSubscribers'] === null) {
|
||
|
|
$invalidProperties[] = "'totalSubscribers' can't be null";
|
||
|
|
}
|
||
|
|
if ($this->container['uniqueSubscribers'] === null) {
|
||
|
|
$invalidProperties[] = "'uniqueSubscribers' 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 id
|
||
|
|
*
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
public function getId()
|
||
|
|
{
|
||
|
|
return $this->container['id'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets id
|
||
|
|
*
|
||
|
|
* @param int $id ID of the list
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setId($id)
|
||
|
|
{
|
||
|
|
$this->container['id'] = $id;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets name
|
||
|
|
*
|
||
|
|
* @return string
|
||
|
|
*/
|
||
|
|
public function getName()
|
||
|
|
{
|
||
|
|
return $this->container['name'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets name
|
||
|
|
*
|
||
|
|
* @param string $name Name of the list
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setName($name)
|
||
|
|
{
|
||
|
|
$this->container['name'] = $name;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets totalBlacklisted
|
||
|
|
*
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
public function getTotalBlacklisted()
|
||
|
|
{
|
||
|
|
return $this->container['totalBlacklisted'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets totalBlacklisted
|
||
|
|
*
|
||
|
|
* @param int $totalBlacklisted Number of blacklisted contacts in the list
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setTotalBlacklisted($totalBlacklisted)
|
||
|
|
{
|
||
|
|
$this->container['totalBlacklisted'] = $totalBlacklisted;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets totalSubscribers
|
||
|
|
*
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
public function getTotalSubscribers()
|
||
|
|
{
|
||
|
|
return $this->container['totalSubscribers'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets totalSubscribers
|
||
|
|
*
|
||
|
|
* @param int $totalSubscribers Number of contacts in the list
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setTotalSubscribers($totalSubscribers)
|
||
|
|
{
|
||
|
|
$this->container['totalSubscribers'] = $totalSubscribers;
|
||
|
|
|
||
|
|
return $this;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Gets uniqueSubscribers
|
||
|
|
*
|
||
|
|
* @return int
|
||
|
|
*/
|
||
|
|
public function getUniqueSubscribers()
|
||
|
|
{
|
||
|
|
return $this->container['uniqueSubscribers'];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets uniqueSubscribers
|
||
|
|
*
|
||
|
|
* @param int $uniqueSubscribers Number of unique contacts in the list
|
||
|
|
*
|
||
|
|
* @return $this
|
||
|
|
*/
|
||
|
|
public function setUniqueSubscribers($uniqueSubscribers)
|
||
|
|
{
|
||
|
|
$this->container['uniqueSubscribers'] = $uniqueSubscribers;
|
||
|
|
|
||
|
|
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));
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
|