628 lines
15 KiB
PHP
628 lines
15 KiB
PHP
<?php
|
|
/**
|
|
* GetWebhook
|
|
*
|
|
* 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;
|
|
|
|
/**
|
|
* GetWebhook Class Doc Comment
|
|
*
|
|
* @category Class
|
|
* @package Brevo\Client
|
|
* @author Swagger Codegen team
|
|
* @link https://github.com/swagger-api/swagger-codegen
|
|
*/
|
|
class GetWebhook implements ModelInterface, ArrayAccess
|
|
{
|
|
const DISCRIMINATOR = null;
|
|
|
|
/**
|
|
* The original name of the model.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $swaggerModelName = 'getWebhook';
|
|
|
|
/**
|
|
* Array of property to type mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $swaggerTypes = [
|
|
'url' => 'string',
|
|
'id' => 'int',
|
|
'description' => 'string',
|
|
'events' => 'string[]',
|
|
'type' => 'string',
|
|
'createdAt' => 'string',
|
|
'modifiedAt' => 'string',
|
|
'batched' => 'bool',
|
|
'auth' => '\Brevo\Client\Model\GetWebhookAuth',
|
|
'headers' => '\Brevo\Client\Model\GetWebhookHeaders[]'
|
|
];
|
|
|
|
/**
|
|
* Array of property to format mappings. Used for (de)serialization
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $swaggerFormats = [
|
|
'url' => 'url',
|
|
'id' => 'int64',
|
|
'description' => null,
|
|
'events' => null,
|
|
'type' => null,
|
|
'createdAt' => null,
|
|
'modifiedAt' => null,
|
|
'batched' => null,
|
|
'auth' => null,
|
|
'headers' => 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 = [
|
|
'url' => 'url',
|
|
'id' => 'id',
|
|
'description' => 'description',
|
|
'events' => 'events',
|
|
'type' => 'type',
|
|
'createdAt' => 'createdAt',
|
|
'modifiedAt' => 'modifiedAt',
|
|
'batched' => 'batched',
|
|
'auth' => 'auth',
|
|
'headers' => 'headers'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes to setter functions (for deserialization of responses)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $setters = [
|
|
'url' => 'setUrl',
|
|
'id' => 'setId',
|
|
'description' => 'setDescription',
|
|
'events' => 'setEvents',
|
|
'type' => 'setType',
|
|
'createdAt' => 'setCreatedAt',
|
|
'modifiedAt' => 'setModifiedAt',
|
|
'batched' => 'setBatched',
|
|
'auth' => 'setAuth',
|
|
'headers' => 'setHeaders'
|
|
];
|
|
|
|
/**
|
|
* Array of attributes to getter functions (for serialization of requests)
|
|
*
|
|
* @var string[]
|
|
*/
|
|
protected static $getters = [
|
|
'url' => 'getUrl',
|
|
'id' => 'getId',
|
|
'description' => 'getDescription',
|
|
'events' => 'getEvents',
|
|
'type' => 'getType',
|
|
'createdAt' => 'getCreatedAt',
|
|
'modifiedAt' => 'getModifiedAt',
|
|
'batched' => 'getBatched',
|
|
'auth' => 'getAuth',
|
|
'headers' => 'getHeaders'
|
|
];
|
|
|
|
/**
|
|
* 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;
|
|
}
|
|
|
|
const TYPE_MARKETING = 'marketing';
|
|
const TYPE_TRANSACTIONAL = 'transactional';
|
|
|
|
|
|
|
|
/**
|
|
* Gets allowable values of the enum
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public function getTypeAllowableValues()
|
|
{
|
|
return [
|
|
self::TYPE_MARKETING,
|
|
self::TYPE_TRANSACTIONAL,
|
|
];
|
|
}
|
|
|
|
|
|
/**
|
|
* 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['url'] = isset($data['url']) ? $data['url'] : null;
|
|
$this->container['id'] = isset($data['id']) ? $data['id'] : null;
|
|
$this->container['description'] = isset($data['description']) ? $data['description'] : null;
|
|
$this->container['events'] = isset($data['events']) ? $data['events'] : null;
|
|
$this->container['type'] = isset($data['type']) ? $data['type'] : null;
|
|
$this->container['createdAt'] = isset($data['createdAt']) ? $data['createdAt'] : null;
|
|
$this->container['modifiedAt'] = isset($data['modifiedAt']) ? $data['modifiedAt'] : null;
|
|
$this->container['batched'] = isset($data['batched']) ? $data['batched'] : null;
|
|
$this->container['auth'] = isset($data['auth']) ? $data['auth'] : null;
|
|
$this->container['headers'] = isset($data['headers']) ? $data['headers'] : null;
|
|
}
|
|
|
|
/**
|
|
* Show all the invalid properties with reasons.
|
|
*
|
|
* @return array invalid properties with reasons
|
|
*/
|
|
public function listInvalidProperties()
|
|
{
|
|
$invalidProperties = [];
|
|
|
|
if ($this->container['url'] === null) {
|
|
$invalidProperties[] = "'url' can't be null";
|
|
}
|
|
if ($this->container['id'] === null) {
|
|
$invalidProperties[] = "'id' can't be null";
|
|
}
|
|
if ($this->container['description'] === null) {
|
|
$invalidProperties[] = "'description' can't be null";
|
|
}
|
|
if ($this->container['events'] === null) {
|
|
$invalidProperties[] = "'events' can't be null";
|
|
}
|
|
if ($this->container['type'] === null) {
|
|
$invalidProperties[] = "'type' can't be null";
|
|
}
|
|
$allowedValues = $this->getTypeAllowableValues();
|
|
if (!is_null($this->container['type']) && !in_array($this->container['type'], $allowedValues, true)) {
|
|
$invalidProperties[] = sprintf(
|
|
"invalid value for 'type', must be one of '%s'",
|
|
implode("', '", $allowedValues)
|
|
);
|
|
}
|
|
|
|
if ($this->container['createdAt'] === null) {
|
|
$invalidProperties[] = "'createdAt' can't be null";
|
|
}
|
|
if ($this->container['modifiedAt'] === null) {
|
|
$invalidProperties[] = "'modifiedAt' 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 url
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getUrl()
|
|
{
|
|
return $this->container['url'];
|
|
}
|
|
|
|
/**
|
|
* Sets url
|
|
*
|
|
* @param string $url URL of the webhook
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setUrl($url)
|
|
{
|
|
$this->container['url'] = $url;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets id
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getId()
|
|
{
|
|
return $this->container['id'];
|
|
}
|
|
|
|
/**
|
|
* Sets id
|
|
*
|
|
* @param int $id ID of the webhook
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setId($id)
|
|
{
|
|
$this->container['id'] = $id;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets description
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getDescription()
|
|
{
|
|
return $this->container['description'];
|
|
}
|
|
|
|
/**
|
|
* Sets description
|
|
*
|
|
* @param string $description Description of the webhook
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setDescription($description)
|
|
{
|
|
$this->container['description'] = $description;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets events
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public function getEvents()
|
|
{
|
|
return $this->container['events'];
|
|
}
|
|
|
|
/**
|
|
* Sets events
|
|
*
|
|
* @param string[] $events events
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setEvents($events)
|
|
{
|
|
$this->container['events'] = $events;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets type
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getType()
|
|
{
|
|
return $this->container['type'];
|
|
}
|
|
|
|
/**
|
|
* Sets type
|
|
*
|
|
* @param string $type Type of webhook (marketing or transactional)
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setType($type)
|
|
{
|
|
$allowedValues = $this->getTypeAllowableValues();
|
|
if (!in_array($type, $allowedValues, true)) {
|
|
throw new \InvalidArgumentException(
|
|
sprintf(
|
|
"Invalid value for 'type', must be one of '%s'",
|
|
implode("', '", $allowedValues)
|
|
)
|
|
);
|
|
}
|
|
$this->container['type'] = $type;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets createdAt
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getCreatedAt()
|
|
{
|
|
return $this->container['createdAt'];
|
|
}
|
|
|
|
/**
|
|
* Sets createdAt
|
|
*
|
|
* @param string $createdAt Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setCreatedAt($createdAt)
|
|
{
|
|
$this->container['createdAt'] = $createdAt;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets modifiedAt
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getModifiedAt()
|
|
{
|
|
return $this->container['modifiedAt'];
|
|
}
|
|
|
|
/**
|
|
* Sets modifiedAt
|
|
*
|
|
* @param string $modifiedAt Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setModifiedAt($modifiedAt)
|
|
{
|
|
$this->container['modifiedAt'] = $modifiedAt;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets batched
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function getBatched()
|
|
{
|
|
return $this->container['batched'];
|
|
}
|
|
|
|
/**
|
|
* Sets batched
|
|
*
|
|
* @param bool $batched To send batched webhooks
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setBatched($batched)
|
|
{
|
|
$this->container['batched'] = $batched;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets auth
|
|
*
|
|
* @return \Brevo\Client\Model\GetWebhookAuth
|
|
*/
|
|
public function getAuth()
|
|
{
|
|
return $this->container['auth'];
|
|
}
|
|
|
|
/**
|
|
* Sets auth
|
|
*
|
|
* @param \Brevo\Client\Model\GetWebhookAuth $auth auth
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setAuth($auth)
|
|
{
|
|
$this->container['auth'] = $auth;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Gets headers
|
|
*
|
|
* @return \Brevo\Client\Model\GetWebhookHeaders[]
|
|
*/
|
|
public function getHeaders()
|
|
{
|
|
return $this->container['headers'];
|
|
}
|
|
|
|
/**
|
|
* Sets headers
|
|
*
|
|
* @param \Brevo\Client\Model\GetWebhookHeaders[] $headers Custom headers to be send with webhooks
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setHeaders($headers)
|
|
{
|
|
$this->container['headers'] = $headers;
|
|
|
|
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));
|
|
}
|
|
}
|
|
|
|
|