File "GetCouponCollection.php"
Full Path: /home/clickysoft/public_html/jmapi5.clickysoft.net/vendor/getbrevo/brevo-php/lib/Model/GetCouponCollection.php
File size: 11.3 KB
MIME-type: text/x-php
Charset: utf-8
<?php
/**
* GetCouponCollection
*
* 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;
/**
* GetCouponCollection Class Doc Comment
*
* @category Class
* @package Brevo\Client
* @author Swagger Codegen team
* @link https://github.com/swagger-api/swagger-codegen
*/
class GetCouponCollection implements ModelInterface, ArrayAccess
{
const DISCRIMINATOR = null;
/**
* The original name of the model.
*
* @var string
*/
protected static $swaggerModelName = 'getCouponCollection';
/**
* Array of property to type mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $swaggerTypes = [
'id' => 'string',
'name' => 'string',
'defaultCoupon' => 'string',
'createdAt' => '\DateTime',
'totalCoupons' => 'int',
'remainingCoupons' => 'int'
];
/**
* Array of property to format mappings. Used for (de)serialization
*
* @var string[]
*/
protected static $swaggerFormats = [
'id' => 'uuidv4',
'name' => 'uuidv4',
'defaultCoupon' => null,
'createdAt' => 'date-time',
'totalCoupons' => 'int64',
'remainingCoupons' => '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',
'defaultCoupon' => 'defaultCoupon',
'createdAt' => 'createdAt',
'totalCoupons' => 'totalCoupons',
'remainingCoupons' => 'remainingCoupons'
];
/**
* Array of attributes to setter functions (for deserialization of responses)
*
* @var string[]
*/
protected static $setters = [
'id' => 'setId',
'name' => 'setName',
'defaultCoupon' => 'setDefaultCoupon',
'createdAt' => 'setCreatedAt',
'totalCoupons' => 'setTotalCoupons',
'remainingCoupons' => 'setRemainingCoupons'
];
/**
* Array of attributes to getter functions (for serialization of requests)
*
* @var string[]
*/
protected static $getters = [
'id' => 'getId',
'name' => 'getName',
'defaultCoupon' => 'getDefaultCoupon',
'createdAt' => 'getCreatedAt',
'totalCoupons' => 'getTotalCoupons',
'remainingCoupons' => 'getRemainingCoupons'
];
/**
* 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['defaultCoupon'] = isset($data['defaultCoupon']) ? $data['defaultCoupon'] : null;
$this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null;
$this->container['totalCoupons'] = isset($data['totalCoupons']) ? $data['totalCoupons'] : null;
$this->container['remainingCoupons'] = isset($data['remainingCoupons']) ? $data['remainingCoupons'] : 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['defaultCoupon'] === null) {
$invalidProperties[] = "'defaultCoupon' can't be null";
}
if ($this->container['createdAt'] === null) {
$invalidProperties[] = "'createdAt' can't be null";
}
if ($this->container['totalCoupons'] === null) {
$invalidProperties[] = "'totalCoupons' can't be null";
}
if ($this->container['remainingCoupons'] === null) {
$invalidProperties[] = "'remainingCoupons' 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 string
*/
public function getId()
{
return $this->container['id'];
}
/**
* Sets id
*
* @param string $id The id of the collection
*
* @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 The name of the collection
*
* @return $this
*/
public function setName($name)
{
$this->container['name'] = $name;
return $this;
}
/**
* Gets defaultCoupon
*
* @return string
*/
public function getDefaultCoupon()
{
return $this->container['defaultCoupon'];
}
/**
* Sets defaultCoupon
*
* @param string $defaultCoupon The default coupon of the collection
*
* @return $this
*/
public function setDefaultCoupon($defaultCoupon)
{
$this->container['defaultCoupon'] = $defaultCoupon;
return $this;
}
/**
* Gets createdAt
*
* @return \DateTime
*/
public function getCreatedAt()
{
return $this->container['createdAt'];
}
/**
* Sets createdAt
*
* @param \DateTime $createdAt Datetime on which the collection was created
*
* @return $this
*/
public function setCreatedAt($createdAt)
{
$this->container['createdAt'] = $createdAt;
return $this;
}
/**
* Gets totalCoupons
*
* @return int
*/
public function getTotalCoupons()
{
return $this->container['totalCoupons'];
}
/**
* Sets totalCoupons
*
* @param int $totalCoupons Total coupons in the collection
*
* @return $this
*/
public function setTotalCoupons($totalCoupons)
{
$this->container['totalCoupons'] = $totalCoupons;
return $this;
}
/**
* Gets remainingCoupons
*
* @return int
*/
public function getRemainingCoupons()
{
return $this->container['remainingCoupons'];
}
/**
* Sets remainingCoupons
*
* @param int $remainingCoupons Not sent coupons in the collection
*
* @return $this
*/
public function setRemainingCoupons($remainingCoupons)
{
$this->container['remainingCoupons'] = $remainingCoupons;
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));
}
}